java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<TokenInfo,TokenInfo.Builder>
com.google.protobuf.GeneratedMessageLite.Builder<TokenInfo,TokenInfo.Builder>
com.hedera.hashgraph.sdk.proto.TokenInfo.Builder
- All Implemented Interfaces:
com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,TokenInfoOrBuilder,Cloneable
- Enclosing class:
TokenInfo
public static final class TokenInfo.Builder
extends com.google.protobuf.GeneratedMessageLite.Builder<TokenInfo,TokenInfo.Builder>
implements TokenInfoOrBuilder
* An Hedera Token Service(HTS) token. A token SHALL represent a fungible or non-fungible unit of exchange.<br/> The specified Treasury Account SHALL receive the initial supply of tokens and SHALL determine distribution of all tokens once minted.Protobuf type
proto.TokenInfo-
Field Summary
Fields inherited from class com.google.protobuf.GeneratedMessageLite.Builder
instance -
Method Summary
Modifier and TypeMethodDescriptionaddAllCustomFees(Iterable<? extends CustomFee> values) * A custom fee schedule for this token.addCustomFees(int index, CustomFee value) * A custom fee schedule for this token.addCustomFees(int index, CustomFee.Builder builderForValue) * A custom fee schedule for this token.addCustomFees(CustomFee value) * A custom fee schedule for this token.addCustomFees(CustomFee.Builder builderForValue) * A custom fee schedule for this token.* Access control for general modification of this token.* An identifier for the account (if any) that the network will attempt to charge for this token's auto-renewal upon expiration.* A duration by which the network should automatically extend this token's expiration.* A custom fee schedule for this token.* A number of decimal places for this token.* A flag indicating if accounts associated to this token are frozen by default, not frozen, or freeze is not applicable.* A flag indicating if accounts associated with this token are granted KYC by default, revoked by default, or KYC is not applicable.* A flag indicating that this token is deleted.* An expiration time for this token, in seconds since the epoch.* Access control of the `custom_fees` field for this token.* Access control to freeze this token.* Access control for KYC for this token.* The ledger ID of the network that generated this response.* A maximum supply of this token.<br/> This is the maximum number of tokens of this type that may be issued.* A short description of this token.* A Token "Metadata".* Access Control of metadata update for this token.* A human-readable name for this token.* Access control of pause/unpause for this token.* A flag indicating that this token is paused.<br/> A token may be paused, unpaused, or pause not applicable.* Access control of token mint/burn for this token.* A supply type for this token.* A human-readable symbol for the token.* A unique identifier for this token.* A type for this token.* A _current_ total supply of this token, expressed in the smallest unit of the token.* A treasury account identifier for this token.* Access control of account wipe for this token.* Access control for general modification of this token.* An identifier for the account (if any) that the network will attempt to charge for this token's auto-renewal upon expiration.* A duration by which the network should automatically extend this token's expiration.getCustomFees(int index) * A custom fee schedule for this token.int* A custom fee schedule for this token.* A custom fee schedule for this token.int* A number of decimal places for this token.* A flag indicating if accounts associated to this token are frozen by default, not frozen, or freeze is not applicable.int* A flag indicating if accounts associated to this token are frozen by default, not frozen, or freeze is not applicable.* A flag indicating if accounts associated with this token are granted KYC by default, revoked by default, or KYC is not applicable.int* A flag indicating if accounts associated with this token are granted KYC by default, revoked by default, or KYC is not applicable.boolean* A flag indicating that this token is deleted.* An expiration time for this token, in seconds since the epoch.* Access control of the `custom_fees` field for this token.* Access control to freeze this token.* Access control for KYC for this token.com.google.protobuf.ByteString* The ledger ID of the network that generated this response.long* A maximum supply of this token.<br/> This is the maximum number of tokens of this type that may be issued.getMemo()* A short description of this token.com.google.protobuf.ByteString* A short description of this token.com.google.protobuf.ByteString* A Token "Metadata".* Access Control of metadata update for this token.getName()* A human-readable name for this token.com.google.protobuf.ByteString* A human-readable name for this token.* Access control of pause/unpause for this token.* A flag indicating that this token is paused.<br/> A token may be paused, unpaused, or pause not applicable.int* A flag indicating that this token is paused.<br/> A token may be paused, unpaused, or pause not applicable.* Access control of token mint/burn for this token.* A supply type for this token.int* A supply type for this token.* A human-readable symbol for the token.com.google.protobuf.ByteString* A human-readable symbol for the token.* A unique identifier for this token.* A type for this token.int* A type for this token.long* A _current_ total supply of this token, expressed in the smallest unit of the token.* A treasury account identifier for this token.* Access control of account wipe for this token.boolean* Access control for general modification of this token.boolean* An identifier for the account (if any) that the network will attempt to charge for this token's auto-renewal upon expiration.boolean* A duration by which the network should automatically extend this token's expiration.boolean* An expiration time for this token, in seconds since the epoch.boolean* Access control of the `custom_fees` field for this token.boolean* Access control to freeze this token.boolean* Access control for KYC for this token.boolean* Access Control of metadata update for this token.boolean* Access control of pause/unpause for this token.boolean* Access control of token mint/burn for this token.boolean* A unique identifier for this token.boolean* A treasury account identifier for this token.boolean* Access control of account wipe for this token.mergeAdminKey(Key value) * Access control for general modification of this token.mergeAutoRenewAccount(AccountID value) * An identifier for the account (if any) that the network will attempt to charge for this token's auto-renewal upon expiration.mergeAutoRenewPeriod(Duration value) * A duration by which the network should automatically extend this token's expiration.mergeExpiry(Timestamp value) * An expiration time for this token, in seconds since the epoch.mergeFeeScheduleKey(Key value) * Access control of the `custom_fees` field for this token.mergeFreezeKey(Key value) * Access control to freeze this token.mergeKycKey(Key value) * Access control for KYC for this token.mergeMetadataKey(Key value) * Access Control of metadata update for this token.mergePauseKey(Key value) * Access control of pause/unpause for this token.mergeSupplyKey(Key value) * Access control of token mint/burn for this token.mergeTokenId(TokenID value) * A unique identifier for this token.mergeTreasury(AccountID value) * A treasury account identifier for this token.mergeWipeKey(Key value) * Access control of account wipe for this token.removeCustomFees(int index) * A custom fee schedule for this token.setAdminKey(Key value) * Access control for general modification of this token.setAdminKey(Key.Builder builderForValue) * Access control for general modification of this token.setAutoRenewAccount(AccountID value) * An identifier for the account (if any) that the network will attempt to charge for this token's auto-renewal upon expiration.setAutoRenewAccount(AccountID.Builder builderForValue) * An identifier for the account (if any) that the network will attempt to charge for this token's auto-renewal upon expiration.setAutoRenewPeriod(Duration value) * A duration by which the network should automatically extend this token's expiration.setAutoRenewPeriod(Duration.Builder builderForValue) * A duration by which the network should automatically extend this token's expiration.setCustomFees(int index, CustomFee value) * A custom fee schedule for this token.setCustomFees(int index, CustomFee.Builder builderForValue) * A custom fee schedule for this token.setDecimals(int value) * A number of decimal places for this token.* A flag indicating if accounts associated to this token are frozen by default, not frozen, or freeze is not applicable.setDefaultFreezeStatusValue(int value) * A flag indicating if accounts associated to this token are frozen by default, not frozen, or freeze is not applicable.* A flag indicating if accounts associated with this token are granted KYC by default, revoked by default, or KYC is not applicable.setDefaultKycStatusValue(int value) * A flag indicating if accounts associated with this token are granted KYC by default, revoked by default, or KYC is not applicable.setDeleted(boolean value) * A flag indicating that this token is deleted.* An expiration time for this token, in seconds since the epoch.setExpiry(Timestamp.Builder builderForValue) * An expiration time for this token, in seconds since the epoch.setFeeScheduleKey(Key value) * Access control of the `custom_fees` field for this token.setFeeScheduleKey(Key.Builder builderForValue) * Access control of the `custom_fees` field for this token.setFreezeKey(Key value) * Access control to freeze this token.setFreezeKey(Key.Builder builderForValue) * Access control to freeze this token.* Access control for KYC for this token.setKycKey(Key.Builder builderForValue) * Access control for KYC for this token.setLedgerId(com.google.protobuf.ByteString value) * The ledger ID of the network that generated this response.setMaxSupply(long value) * A maximum supply of this token.<br/> This is the maximum number of tokens of this type that may be issued.* A short description of this token.setMemoBytes(com.google.protobuf.ByteString value) * A short description of this token.setMetadata(com.google.protobuf.ByteString value) * A Token "Metadata".setMetadataKey(Key value) * Access Control of metadata update for this token.setMetadataKey(Key.Builder builderForValue) * Access Control of metadata update for this token.* A human-readable name for this token.setNameBytes(com.google.protobuf.ByteString value) * A human-readable name for this token.setPauseKey(Key value) * Access control of pause/unpause for this token.setPauseKey(Key.Builder builderForValue) * Access control of pause/unpause for this token.setPauseStatus(TokenPauseStatus value) * A flag indicating that this token is paused.<br/> A token may be paused, unpaused, or pause not applicable.setPauseStatusValue(int value) * A flag indicating that this token is paused.<br/> A token may be paused, unpaused, or pause not applicable.setSupplyKey(Key value) * Access control of token mint/burn for this token.setSupplyKey(Key.Builder builderForValue) * Access control of token mint/burn for this token.setSupplyType(TokenSupplyType value) * A supply type for this token.setSupplyTypeValue(int value) * A supply type for this token.* A human-readable symbol for the token.setSymbolBytes(com.google.protobuf.ByteString value) * A human-readable symbol for the token.setTokenId(TokenID value) * A unique identifier for this token.setTokenId(TokenID.Builder builderForValue) * A unique identifier for this token.setTokenType(TokenType value) * A type for this token.setTokenTypeValue(int value) * A type for this token.setTotalSupply(long value) * A _current_ total supply of this token, expressed in the smallest unit of the token.setTreasury(AccountID value) * A treasury account identifier for this token.setTreasury(AccountID.Builder builderForValue) * A treasury account identifier for this token.setWipeKey(Key value) * Access control of account wipe for this token.setWipeKey(Key.Builder builderForValue) * Access control of account wipe for this token.Methods inherited from class com.google.protobuf.GeneratedMessageLite.Builder
build, buildPartial, clear, clone, copyOnWrite, copyOnWriteInternal, getDefaultInstanceForType, internalMergeFrom, isInitialized, mergeFrom, mergeFrom, mergeFrom, mergeFromMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType, isInitialized
-
Method Details
-
hasTokenId
public boolean hasTokenId()* A unique identifier for this token.
.proto.TokenID tokenId = 1;- Specified by:
hasTokenIdin interfaceTokenInfoOrBuilder- Returns:
- Whether the tokenId field is set.
-
getTokenId
* A unique identifier for this token.
.proto.TokenID tokenId = 1;- Specified by:
getTokenIdin interfaceTokenInfoOrBuilder- Returns:
- The tokenId.
-
setTokenId
* A unique identifier for this token.
.proto.TokenID tokenId = 1; -
setTokenId
* A unique identifier for this token.
.proto.TokenID tokenId = 1; -
mergeTokenId
* A unique identifier for this token.
.proto.TokenID tokenId = 1; -
clearTokenId
* A unique identifier for this token.
.proto.TokenID tokenId = 1; -
getName
* A human-readable name for this token. <p> This value MAY NOT be unique.<br/> This value SHALL NOT exceed 100 bytes when encoded as UTF-8.
string name = 2;- Specified by:
getNamein interfaceTokenInfoOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()* A human-readable name for this token. <p> This value MAY NOT be unique.<br/> This value SHALL NOT exceed 100 bytes when encoded as UTF-8.
string name = 2;- Specified by:
getNameBytesin interfaceTokenInfoOrBuilder- Returns:
- The bytes for name.
-
setName
* A human-readable name for this token. <p> This value MAY NOT be unique.<br/> This value SHALL NOT exceed 100 bytes when encoded as UTF-8.
string name = 2;- Parameters:
value- The name to set.- Returns:
- This builder for chaining.
-
clearName
* A human-readable name for this token. <p> This value MAY NOT be unique.<br/> This value SHALL NOT exceed 100 bytes when encoded as UTF-8.
string name = 2;- Returns:
- This builder for chaining.
-
setNameBytes
* A human-readable name for this token. <p> This value MAY NOT be unique.<br/> This value SHALL NOT exceed 100 bytes when encoded as UTF-8.
string name = 2;- Parameters:
value- The bytes for name to set.- Returns:
- This builder for chaining.
-
getSymbol
* A human-readable symbol for the token. <p> This value SHALL NOT be unique.<br/> This value SHALL NOT exceed 100 bytes when encoded as UTF-8.
string symbol = 3;- Specified by:
getSymbolin interfaceTokenInfoOrBuilder- Returns:
- The symbol.
-
getSymbolBytes
public com.google.protobuf.ByteString getSymbolBytes()* A human-readable symbol for the token. <p> This value SHALL NOT be unique.<br/> This value SHALL NOT exceed 100 bytes when encoded as UTF-8.
string symbol = 3;- Specified by:
getSymbolBytesin interfaceTokenInfoOrBuilder- Returns:
- The bytes for symbol.
-
setSymbol
* A human-readable symbol for the token. <p> This value SHALL NOT be unique.<br/> This value SHALL NOT exceed 100 bytes when encoded as UTF-8.
string symbol = 3;- Parameters:
value- The symbol to set.- Returns:
- This builder for chaining.
-
clearSymbol
* A human-readable symbol for the token. <p> This value SHALL NOT be unique.<br/> This value SHALL NOT exceed 100 bytes when encoded as UTF-8.
string symbol = 3;- Returns:
- This builder for chaining.
-
setSymbolBytes
* A human-readable symbol for the token. <p> This value SHALL NOT be unique.<br/> This value SHALL NOT exceed 100 bytes when encoded as UTF-8.
string symbol = 3;- Parameters:
value- The bytes for symbol to set.- Returns:
- This builder for chaining.
-
getDecimals
public int getDecimals()* A number of decimal places for this token. <p> If decimals are 8 or 11, then the number of whole tokens can be at most billions or millions, respectively. More decimals allows for a more finely-divided token, but also limits the maximum total supply. <p> Examples <ul> <li>Bitcoin satoshis (21 million whole tokens with 8 decimals).</li> <li>Hedera tinybar (50 billion whole tokens with 8 decimals).</li> <li>Bitcoin milli-satoshis (21 million whole tokens with 11 decimals).</li> <li>Theoretical limit is roughly 92.2 billion with 8 decimals, or 92.2 million with 11 decimals.</li> </ul> All token amounts in the network are stored as integer amounts, with each unit representing 10<sup>-decimals</sup> whole tokens. <p> For tokens with `token_type` set to `NON_FUNGIBLE_UNIQUE` this MUST be 0.
uint32 decimals = 4;- Specified by:
getDecimalsin interfaceTokenInfoOrBuilder- Returns:
- The decimals.
-
setDecimals
* A number of decimal places for this token. <p> If decimals are 8 or 11, then the number of whole tokens can be at most billions or millions, respectively. More decimals allows for a more finely-divided token, but also limits the maximum total supply. <p> Examples <ul> <li>Bitcoin satoshis (21 million whole tokens with 8 decimals).</li> <li>Hedera tinybar (50 billion whole tokens with 8 decimals).</li> <li>Bitcoin milli-satoshis (21 million whole tokens with 11 decimals).</li> <li>Theoretical limit is roughly 92.2 billion with 8 decimals, or 92.2 million with 11 decimals.</li> </ul> All token amounts in the network are stored as integer amounts, with each unit representing 10<sup>-decimals</sup> whole tokens. <p> For tokens with `token_type` set to `NON_FUNGIBLE_UNIQUE` this MUST be 0.
uint32 decimals = 4;- Parameters:
value- The decimals to set.- Returns:
- This builder for chaining.
-
clearDecimals
* A number of decimal places for this token. <p> If decimals are 8 or 11, then the number of whole tokens can be at most billions or millions, respectively. More decimals allows for a more finely-divided token, but also limits the maximum total supply. <p> Examples <ul> <li>Bitcoin satoshis (21 million whole tokens with 8 decimals).</li> <li>Hedera tinybar (50 billion whole tokens with 8 decimals).</li> <li>Bitcoin milli-satoshis (21 million whole tokens with 11 decimals).</li> <li>Theoretical limit is roughly 92.2 billion with 8 decimals, or 92.2 million with 11 decimals.</li> </ul> All token amounts in the network are stored as integer amounts, with each unit representing 10<sup>-decimals</sup> whole tokens. <p> For tokens with `token_type` set to `NON_FUNGIBLE_UNIQUE` this MUST be 0.
uint32 decimals = 4;- Returns:
- This builder for chaining.
-
getTotalSupply
public long getTotalSupply()* A _current_ total supply of this token, expressed in the smallest unit of the token. <p> The number of _whole_ tokens this represents is (total_supply / 10<sup>decimals</sup>). The value of total supply, MUST be within the positive range of a twos-compliment signed 64-bit integer. The `total_supply`, therefore MUST be between 1, and 9,223,372,036,854,775,807, inclusive. <p> This value SHALL be reduced when a `token_burn` or `token_wipe_account` operation is executed, and SHALL be increased when a `token_mint` operation is executed.
uint64 totalSupply = 5;- Specified by:
getTotalSupplyin interfaceTokenInfoOrBuilder- Returns:
- The totalSupply.
-
setTotalSupply
* A _current_ total supply of this token, expressed in the smallest unit of the token. <p> The number of _whole_ tokens this represents is (total_supply / 10<sup>decimals</sup>). The value of total supply, MUST be within the positive range of a twos-compliment signed 64-bit integer. The `total_supply`, therefore MUST be between 1, and 9,223,372,036,854,775,807, inclusive. <p> This value SHALL be reduced when a `token_burn` or `token_wipe_account` operation is executed, and SHALL be increased when a `token_mint` operation is executed.
uint64 totalSupply = 5;- Parameters:
value- The totalSupply to set.- Returns:
- This builder for chaining.
-
clearTotalSupply
* A _current_ total supply of this token, expressed in the smallest unit of the token. <p> The number of _whole_ tokens this represents is (total_supply / 10<sup>decimals</sup>). The value of total supply, MUST be within the positive range of a twos-compliment signed 64-bit integer. The `total_supply`, therefore MUST be between 1, and 9,223,372,036,854,775,807, inclusive. <p> This value SHALL be reduced when a `token_burn` or `token_wipe_account` operation is executed, and SHALL be increased when a `token_mint` operation is executed.
uint64 totalSupply = 5;- Returns:
- This builder for chaining.
-
hasTreasury
public boolean hasTreasury()* A treasury account identifier for this token. <p> When the token is created, the initial supply given in the token create transaction SHALL be minted and deposited in the treasury account.<br/> All token mint transactions for this token SHALL deposit the new minted tokens in the treasury account.<br/> All token burn transactions for this token SHALL remove the tokens to be burned from the treasury account.
.proto.AccountID treasury = 6;- Specified by:
hasTreasuryin interfaceTokenInfoOrBuilder- Returns:
- Whether the treasury field is set.
-
getTreasury
* A treasury account identifier for this token. <p> When the token is created, the initial supply given in the token create transaction SHALL be minted and deposited in the treasury account.<br/> All token mint transactions for this token SHALL deposit the new minted tokens in the treasury account.<br/> All token burn transactions for this token SHALL remove the tokens to be burned from the treasury account.
.proto.AccountID treasury = 6;- Specified by:
getTreasuryin interfaceTokenInfoOrBuilder- Returns:
- The treasury.
-
setTreasury
* A treasury account identifier for this token. <p> When the token is created, the initial supply given in the token create transaction SHALL be minted and deposited in the treasury account.<br/> All token mint transactions for this token SHALL deposit the new minted tokens in the treasury account.<br/> All token burn transactions for this token SHALL remove the tokens to be burned from the treasury account.
.proto.AccountID treasury = 6; -
setTreasury
* A treasury account identifier for this token. <p> When the token is created, the initial supply given in the token create transaction SHALL be minted and deposited in the treasury account.<br/> All token mint transactions for this token SHALL deposit the new minted tokens in the treasury account.<br/> All token burn transactions for this token SHALL remove the tokens to be burned from the treasury account.
.proto.AccountID treasury = 6; -
mergeTreasury
* A treasury account identifier for this token. <p> When the token is created, the initial supply given in the token create transaction SHALL be minted and deposited in the treasury account.<br/> All token mint transactions for this token SHALL deposit the new minted tokens in the treasury account.<br/> All token burn transactions for this token SHALL remove the tokens to be burned from the treasury account.
.proto.AccountID treasury = 6; -
clearTreasury
* A treasury account identifier for this token. <p> When the token is created, the initial supply given in the token create transaction SHALL be minted and deposited in the treasury account.<br/> All token mint transactions for this token SHALL deposit the new minted tokens in the treasury account.<br/> All token burn transactions for this token SHALL remove the tokens to be burned from the treasury account.
.proto.AccountID treasury = 6; -
hasAdminKey
public boolean hasAdminKey()* Access control for general modification of this token. <p> This key MUST sign any `token_update` transaction that changes any attribute of the token other than expiration_time. Other attributes of this token MAY be changed by transactions other than `token_update`, and MUST be signed by one of the other purpose-specific keys assigned to the token.<br/> This value can be set during token creation, and SHALL NOT be modified thereafter, unless the update transaction is signed by both the existing `admin_key` and the new `admin_key`.<br/> If the `admin_key` is not set for a token, that token SHALL be immutable.
.proto.Key adminKey = 7;- Specified by:
hasAdminKeyin interfaceTokenInfoOrBuilder- Returns:
- Whether the adminKey field is set.
-
getAdminKey
* Access control for general modification of this token. <p> This key MUST sign any `token_update` transaction that changes any attribute of the token other than expiration_time. Other attributes of this token MAY be changed by transactions other than `token_update`, and MUST be signed by one of the other purpose-specific keys assigned to the token.<br/> This value can be set during token creation, and SHALL NOT be modified thereafter, unless the update transaction is signed by both the existing `admin_key` and the new `admin_key`.<br/> If the `admin_key` is not set for a token, that token SHALL be immutable.
.proto.Key adminKey = 7;- Specified by:
getAdminKeyin interfaceTokenInfoOrBuilder- Returns:
- The adminKey.
-
setAdminKey
* Access control for general modification of this token. <p> This key MUST sign any `token_update` transaction that changes any attribute of the token other than expiration_time. Other attributes of this token MAY be changed by transactions other than `token_update`, and MUST be signed by one of the other purpose-specific keys assigned to the token.<br/> This value can be set during token creation, and SHALL NOT be modified thereafter, unless the update transaction is signed by both the existing `admin_key` and the new `admin_key`.<br/> If the `admin_key` is not set for a token, that token SHALL be immutable.
.proto.Key adminKey = 7; -
setAdminKey
* Access control for general modification of this token. <p> This key MUST sign any `token_update` transaction that changes any attribute of the token other than expiration_time. Other attributes of this token MAY be changed by transactions other than `token_update`, and MUST be signed by one of the other purpose-specific keys assigned to the token.<br/> This value can be set during token creation, and SHALL NOT be modified thereafter, unless the update transaction is signed by both the existing `admin_key` and the new `admin_key`.<br/> If the `admin_key` is not set for a token, that token SHALL be immutable.
.proto.Key adminKey = 7; -
mergeAdminKey
* Access control for general modification of this token. <p> This key MUST sign any `token_update` transaction that changes any attribute of the token other than expiration_time. Other attributes of this token MAY be changed by transactions other than `token_update`, and MUST be signed by one of the other purpose-specific keys assigned to the token.<br/> This value can be set during token creation, and SHALL NOT be modified thereafter, unless the update transaction is signed by both the existing `admin_key` and the new `admin_key`.<br/> If the `admin_key` is not set for a token, that token SHALL be immutable.
.proto.Key adminKey = 7; -
clearAdminKey
* Access control for general modification of this token. <p> This key MUST sign any `token_update` transaction that changes any attribute of the token other than expiration_time. Other attributes of this token MAY be changed by transactions other than `token_update`, and MUST be signed by one of the other purpose-specific keys assigned to the token.<br/> This value can be set during token creation, and SHALL NOT be modified thereafter, unless the update transaction is signed by both the existing `admin_key` and the new `admin_key`.<br/> If the `admin_key` is not set for a token, that token SHALL be immutable.
.proto.Key adminKey = 7; -
hasKycKey
public boolean hasKycKey()* Access control for KYC for this token. <p> Know Your Customer (KYC) status may be granted for an account by a token grant kyc transaction signed by this key.<br/> If this key is not set, then KYC status cannot be granted to an account for this token, and any `TokenGrantKyc` transaction attempting to grant kyc to an account for this token SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key kycKey = 8;- Specified by:
hasKycKeyin interfaceTokenInfoOrBuilder- Returns:
- Whether the kycKey field is set.
-
getKycKey
* Access control for KYC for this token. <p> Know Your Customer (KYC) status may be granted for an account by a token grant kyc transaction signed by this key.<br/> If this key is not set, then KYC status cannot be granted to an account for this token, and any `TokenGrantKyc` transaction attempting to grant kyc to an account for this token SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key kycKey = 8;- Specified by:
getKycKeyin interfaceTokenInfoOrBuilder- Returns:
- The kycKey.
-
setKycKey
* Access control for KYC for this token. <p> Know Your Customer (KYC) status may be granted for an account by a token grant kyc transaction signed by this key.<br/> If this key is not set, then KYC status cannot be granted to an account for this token, and any `TokenGrantKyc` transaction attempting to grant kyc to an account for this token SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key kycKey = 8; -
setKycKey
* Access control for KYC for this token. <p> Know Your Customer (KYC) status may be granted for an account by a token grant kyc transaction signed by this key.<br/> If this key is not set, then KYC status cannot be granted to an account for this token, and any `TokenGrantKyc` transaction attempting to grant kyc to an account for this token SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key kycKey = 8; -
mergeKycKey
* Access control for KYC for this token. <p> Know Your Customer (KYC) status may be granted for an account by a token grant kyc transaction signed by this key.<br/> If this key is not set, then KYC status cannot be granted to an account for this token, and any `TokenGrantKyc` transaction attempting to grant kyc to an account for this token SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key kycKey = 8; -
clearKycKey
* Access control for KYC for this token. <p> Know Your Customer (KYC) status may be granted for an account by a token grant kyc transaction signed by this key.<br/> If this key is not set, then KYC status cannot be granted to an account for this token, and any `TokenGrantKyc` transaction attempting to grant kyc to an account for this token SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key kycKey = 8; -
hasFreezeKey
public boolean hasFreezeKey()* Access control to freeze this token. <p> A token may be frozen for an account, preventing any transaction from transferring that token for that specified account, by a token freeze account transaction signed by this key.<br/> If this key is not set, the token cannot be frozen, and any transaction attempting to freeze the token for an account SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key freezeKey = 9;- Specified by:
hasFreezeKeyin interfaceTokenInfoOrBuilder- Returns:
- Whether the freezeKey field is set.
-
getFreezeKey
* Access control to freeze this token. <p> A token may be frozen for an account, preventing any transaction from transferring that token for that specified account, by a token freeze account transaction signed by this key.<br/> If this key is not set, the token cannot be frozen, and any transaction attempting to freeze the token for an account SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key freezeKey = 9;- Specified by:
getFreezeKeyin interfaceTokenInfoOrBuilder- Returns:
- The freezeKey.
-
setFreezeKey
* Access control to freeze this token. <p> A token may be frozen for an account, preventing any transaction from transferring that token for that specified account, by a token freeze account transaction signed by this key.<br/> If this key is not set, the token cannot be frozen, and any transaction attempting to freeze the token for an account SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key freezeKey = 9; -
setFreezeKey
* Access control to freeze this token. <p> A token may be frozen for an account, preventing any transaction from transferring that token for that specified account, by a token freeze account transaction signed by this key.<br/> If this key is not set, the token cannot be frozen, and any transaction attempting to freeze the token for an account SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key freezeKey = 9; -
mergeFreezeKey
* Access control to freeze this token. <p> A token may be frozen for an account, preventing any transaction from transferring that token for that specified account, by a token freeze account transaction signed by this key.<br/> If this key is not set, the token cannot be frozen, and any transaction attempting to freeze the token for an account SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key freezeKey = 9; -
clearFreezeKey
* Access control to freeze this token. <p> A token may be frozen for an account, preventing any transaction from transferring that token for that specified account, by a token freeze account transaction signed by this key.<br/> If this key is not set, the token cannot be frozen, and any transaction attempting to freeze the token for an account SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key freezeKey = 9; -
hasWipeKey
public boolean hasWipeKey()* Access control of account wipe for this token. <p> A token may be wiped, removing and burning tokens from a specific account, by a token wipe transaction, which MUST be signed by this key. The `treasury_account` cannot be subjected to a token wipe. A token burn transaction, signed by the `supply_key`, serves to burn tokens held by the `treasury_account` instead.<br/> If this key is not set, the token cannot be wiped, and any transaction attempting to wipe the token from an account SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key wipeKey = 10;- Specified by:
hasWipeKeyin interfaceTokenInfoOrBuilder- Returns:
- Whether the wipeKey field is set.
-
getWipeKey
* Access control of account wipe for this token. <p> A token may be wiped, removing and burning tokens from a specific account, by a token wipe transaction, which MUST be signed by this key. The `treasury_account` cannot be subjected to a token wipe. A token burn transaction, signed by the `supply_key`, serves to burn tokens held by the `treasury_account` instead.<br/> If this key is not set, the token cannot be wiped, and any transaction attempting to wipe the token from an account SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key wipeKey = 10;- Specified by:
getWipeKeyin interfaceTokenInfoOrBuilder- Returns:
- The wipeKey.
-
setWipeKey
* Access control of account wipe for this token. <p> A token may be wiped, removing and burning tokens from a specific account, by a token wipe transaction, which MUST be signed by this key. The `treasury_account` cannot be subjected to a token wipe. A token burn transaction, signed by the `supply_key`, serves to burn tokens held by the `treasury_account` instead.<br/> If this key is not set, the token cannot be wiped, and any transaction attempting to wipe the token from an account SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key wipeKey = 10; -
setWipeKey
* Access control of account wipe for this token. <p> A token may be wiped, removing and burning tokens from a specific account, by a token wipe transaction, which MUST be signed by this key. The `treasury_account` cannot be subjected to a token wipe. A token burn transaction, signed by the `supply_key`, serves to burn tokens held by the `treasury_account` instead.<br/> If this key is not set, the token cannot be wiped, and any transaction attempting to wipe the token from an account SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key wipeKey = 10; -
mergeWipeKey
* Access control of account wipe for this token. <p> A token may be wiped, removing and burning tokens from a specific account, by a token wipe transaction, which MUST be signed by this key. The `treasury_account` cannot be subjected to a token wipe. A token burn transaction, signed by the `supply_key`, serves to burn tokens held by the `treasury_account` instead.<br/> If this key is not set, the token cannot be wiped, and any transaction attempting to wipe the token from an account SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key wipeKey = 10; -
clearWipeKey
* Access control of account wipe for this token. <p> A token may be wiped, removing and burning tokens from a specific account, by a token wipe transaction, which MUST be signed by this key. The `treasury_account` cannot be subjected to a token wipe. A token burn transaction, signed by the `supply_key`, serves to burn tokens held by the `treasury_account` instead.<br/> If this key is not set, the token cannot be wiped, and any transaction attempting to wipe the token from an account SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key wipeKey = 10; -
hasSupplyKey
public boolean hasSupplyKey()* Access control of token mint/burn for this token. <p> A token mint transaction MUST be signed by this key, and any token mint transaction not signed by the current `supply_key` for that token SHALL NOT succeed.<br/> A token burn transaction MUST be signed by this key, and any token burn transaction not signed by the current `supply_key` for that token SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key supplyKey = 11;- Specified by:
hasSupplyKeyin interfaceTokenInfoOrBuilder- Returns:
- Whether the supplyKey field is set.
-
getSupplyKey
* Access control of token mint/burn for this token. <p> A token mint transaction MUST be signed by this key, and any token mint transaction not signed by the current `supply_key` for that token SHALL NOT succeed.<br/> A token burn transaction MUST be signed by this key, and any token burn transaction not signed by the current `supply_key` for that token SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key supplyKey = 11;- Specified by:
getSupplyKeyin interfaceTokenInfoOrBuilder- Returns:
- The supplyKey.
-
setSupplyKey
* Access control of token mint/burn for this token. <p> A token mint transaction MUST be signed by this key, and any token mint transaction not signed by the current `supply_key` for that token SHALL NOT succeed.<br/> A token burn transaction MUST be signed by this key, and any token burn transaction not signed by the current `supply_key` for that token SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key supplyKey = 11; -
setSupplyKey
* Access control of token mint/burn for this token. <p> A token mint transaction MUST be signed by this key, and any token mint transaction not signed by the current `supply_key` for that token SHALL NOT succeed.<br/> A token burn transaction MUST be signed by this key, and any token burn transaction not signed by the current `supply_key` for that token SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key supplyKey = 11; -
mergeSupplyKey
* Access control of token mint/burn for this token. <p> A token mint transaction MUST be signed by this key, and any token mint transaction not signed by the current `supply_key` for that token SHALL NOT succeed.<br/> A token burn transaction MUST be signed by this key, and any token burn transaction not signed by the current `supply_key` for that token SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key supplyKey = 11; -
clearSupplyKey
* Access control of token mint/burn for this token. <p> A token mint transaction MUST be signed by this key, and any token mint transaction not signed by the current `supply_key` for that token SHALL NOT succeed.<br/> A token burn transaction MUST be signed by this key, and any token burn transaction not signed by the current `supply_key` for that token SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key supplyKey = 11; -
getDefaultFreezeStatusValue
public int getDefaultFreezeStatusValue()* A flag indicating if accounts associated to this token are frozen by default, not frozen, or freeze is not applicable. <p> Accounts frozen by default and newly associated with this token CANNOT transact in the token until unfrozen.<br/> This SHALL NOT prevent a `tokenReject` transaction to return the tokens from an account to the treasury account.
.proto.TokenFreezeStatus defaultFreezeStatus = 12;- Specified by:
getDefaultFreezeStatusValuein interfaceTokenInfoOrBuilder- Returns:
- The enum numeric value on the wire for defaultFreezeStatus.
-
setDefaultFreezeStatusValue
* A flag indicating if accounts associated to this token are frozen by default, not frozen, or freeze is not applicable. <p> Accounts frozen by default and newly associated with this token CANNOT transact in the token until unfrozen.<br/> This SHALL NOT prevent a `tokenReject` transaction to return the tokens from an account to the treasury account.
.proto.TokenFreezeStatus defaultFreezeStatus = 12;- Parameters:
value- The defaultFreezeStatus to set.- Returns:
- This builder for chaining.
- Throws:
IllegalArgumentException- if UNRECOGNIZED is provided.
-
getDefaultFreezeStatus
* A flag indicating if accounts associated to this token are frozen by default, not frozen, or freeze is not applicable. <p> Accounts frozen by default and newly associated with this token CANNOT transact in the token until unfrozen.<br/> This SHALL NOT prevent a `tokenReject` transaction to return the tokens from an account to the treasury account.
.proto.TokenFreezeStatus defaultFreezeStatus = 12;- Specified by:
getDefaultFreezeStatusin interfaceTokenInfoOrBuilder- Returns:
- The defaultFreezeStatus.
-
setDefaultFreezeStatus
* A flag indicating if accounts associated to this token are frozen by default, not frozen, or freeze is not applicable. <p> Accounts frozen by default and newly associated with this token CANNOT transact in the token until unfrozen.<br/> This SHALL NOT prevent a `tokenReject` transaction to return the tokens from an account to the treasury account.
.proto.TokenFreezeStatus defaultFreezeStatus = 12;- Parameters:
value- The enum numeric value on the wire for defaultFreezeStatus to set.- Returns:
- This builder for chaining.
-
clearDefaultFreezeStatus
* A flag indicating if accounts associated to this token are frozen by default, not frozen, or freeze is not applicable. <p> Accounts frozen by default and newly associated with this token CANNOT transact in the token until unfrozen.<br/> This SHALL NOT prevent a `tokenReject` transaction to return the tokens from an account to the treasury account.
.proto.TokenFreezeStatus defaultFreezeStatus = 12;- Returns:
- This builder for chaining.
-
getDefaultKycStatusValue
public int getDefaultKycStatusValue()* A flag indicating if accounts associated with this token are granted KYC by default, revoked by default, or KYC is not applicable.
.proto.TokenKycStatus defaultKycStatus = 13;- Specified by:
getDefaultKycStatusValuein interfaceTokenInfoOrBuilder- Returns:
- The enum numeric value on the wire for defaultKycStatus.
-
setDefaultKycStatusValue
* A flag indicating if accounts associated with this token are granted KYC by default, revoked by default, or KYC is not applicable.
.proto.TokenKycStatus defaultKycStatus = 13;- Parameters:
value- The defaultKycStatus to set.- Returns:
- This builder for chaining.
- Throws:
IllegalArgumentException- if UNRECOGNIZED is provided.
-
getDefaultKycStatus
* A flag indicating if accounts associated with this token are granted KYC by default, revoked by default, or KYC is not applicable.
.proto.TokenKycStatus defaultKycStatus = 13;- Specified by:
getDefaultKycStatusin interfaceTokenInfoOrBuilder- Returns:
- The defaultKycStatus.
-
setDefaultKycStatus
* A flag indicating if accounts associated with this token are granted KYC by default, revoked by default, or KYC is not applicable.
.proto.TokenKycStatus defaultKycStatus = 13;- Parameters:
value- The enum numeric value on the wire for defaultKycStatus to set.- Returns:
- This builder for chaining.
-
clearDefaultKycStatus
* A flag indicating if accounts associated with this token are granted KYC by default, revoked by default, or KYC is not applicable.
.proto.TokenKycStatus defaultKycStatus = 13;- Returns:
- This builder for chaining.
-
getDeleted
public boolean getDeleted()* A flag indicating that this token is deleted. <p> A transaction involving a deleted token MUST NOT succeed.
bool deleted = 14;- Specified by:
getDeletedin interfaceTokenInfoOrBuilder- Returns:
- The deleted.
-
setDeleted
* A flag indicating that this token is deleted. <p> A transaction involving a deleted token MUST NOT succeed.
bool deleted = 14;- Parameters:
value- The deleted to set.- Returns:
- This builder for chaining.
-
clearDeleted
* A flag indicating that this token is deleted. <p> A transaction involving a deleted token MUST NOT succeed.
bool deleted = 14;- Returns:
- This builder for chaining.
-
hasAutoRenewAccount
public boolean hasAutoRenewAccount()* An identifier for the account (if any) that the network will attempt to charge for this token's auto-renewal upon expiration. <p> This field is OPTIONAL. If it is not set then renewal fees SHALL be charged to the account identified by `treasury`.
.proto.AccountID autoRenewAccount = 15;- Specified by:
hasAutoRenewAccountin interfaceTokenInfoOrBuilder- Returns:
- Whether the autoRenewAccount field is set.
-
getAutoRenewAccount
* An identifier for the account (if any) that the network will attempt to charge for this token's auto-renewal upon expiration. <p> This field is OPTIONAL. If it is not set then renewal fees SHALL be charged to the account identified by `treasury`.
.proto.AccountID autoRenewAccount = 15;- Specified by:
getAutoRenewAccountin interfaceTokenInfoOrBuilder- Returns:
- The autoRenewAccount.
-
setAutoRenewAccount
* An identifier for the account (if any) that the network will attempt to charge for this token's auto-renewal upon expiration. <p> This field is OPTIONAL. If it is not set then renewal fees SHALL be charged to the account identified by `treasury`.
.proto.AccountID autoRenewAccount = 15; -
setAutoRenewAccount
* An identifier for the account (if any) that the network will attempt to charge for this token's auto-renewal upon expiration. <p> This field is OPTIONAL. If it is not set then renewal fees SHALL be charged to the account identified by `treasury`.
.proto.AccountID autoRenewAccount = 15; -
mergeAutoRenewAccount
* An identifier for the account (if any) that the network will attempt to charge for this token's auto-renewal upon expiration. <p> This field is OPTIONAL. If it is not set then renewal fees SHALL be charged to the account identified by `treasury`.
.proto.AccountID autoRenewAccount = 15; -
clearAutoRenewAccount
* An identifier for the account (if any) that the network will attempt to charge for this token's auto-renewal upon expiration. <p> This field is OPTIONAL. If it is not set then renewal fees SHALL be charged to the account identified by `treasury`.
.proto.AccountID autoRenewAccount = 15; -
hasAutoRenewPeriod
public boolean hasAutoRenewPeriod()* A duration by which the network should automatically extend this token's expiration. <p> If the token has a valid auto-renew account, and is not deleted upon expiration, the network SHALL attempt to automatically renew this token.<br/> The default values for the minimum period and maximum period are 30 days and 90 days, respectively.
.proto.Duration autoRenewPeriod = 16;- Specified by:
hasAutoRenewPeriodin interfaceTokenInfoOrBuilder- Returns:
- Whether the autoRenewPeriod field is set.
-
getAutoRenewPeriod
* A duration by which the network should automatically extend this token's expiration. <p> If the token has a valid auto-renew account, and is not deleted upon expiration, the network SHALL attempt to automatically renew this token.<br/> The default values for the minimum period and maximum period are 30 days and 90 days, respectively.
.proto.Duration autoRenewPeriod = 16;- Specified by:
getAutoRenewPeriodin interfaceTokenInfoOrBuilder- Returns:
- The autoRenewPeriod.
-
setAutoRenewPeriod
* A duration by which the network should automatically extend this token's expiration. <p> If the token has a valid auto-renew account, and is not deleted upon expiration, the network SHALL attempt to automatically renew this token.<br/> The default values for the minimum period and maximum period are 30 days and 90 days, respectively.
.proto.Duration autoRenewPeriod = 16; -
setAutoRenewPeriod
* A duration by which the network should automatically extend this token's expiration. <p> If the token has a valid auto-renew account, and is not deleted upon expiration, the network SHALL attempt to automatically renew this token.<br/> The default values for the minimum period and maximum period are 30 days and 90 days, respectively.
.proto.Duration autoRenewPeriod = 16; -
mergeAutoRenewPeriod
* A duration by which the network should automatically extend this token's expiration. <p> If the token has a valid auto-renew account, and is not deleted upon expiration, the network SHALL attempt to automatically renew this token.<br/> The default values for the minimum period and maximum period are 30 days and 90 days, respectively.
.proto.Duration autoRenewPeriod = 16; -
clearAutoRenewPeriod
* A duration by which the network should automatically extend this token's expiration. <p> If the token has a valid auto-renew account, and is not deleted upon expiration, the network SHALL attempt to automatically renew this token.<br/> The default values for the minimum period and maximum period are 30 days and 90 days, respectively.
.proto.Duration autoRenewPeriod = 16; -
hasExpiry
public boolean hasExpiry()* An expiration time for this token, in seconds since the epoch. <p> For this purpose, `epoch` SHALL be the UNIX epoch with 0 at `1970-01-01T00:00:00.000Z`.
.proto.Timestamp expiry = 17;- Specified by:
hasExpiryin interfaceTokenInfoOrBuilder- Returns:
- Whether the expiry field is set.
-
getExpiry
* An expiration time for this token, in seconds since the epoch. <p> For this purpose, `epoch` SHALL be the UNIX epoch with 0 at `1970-01-01T00:00:00.000Z`.
.proto.Timestamp expiry = 17;- Specified by:
getExpiryin interfaceTokenInfoOrBuilder- Returns:
- The expiry.
-
setExpiry
* An expiration time for this token, in seconds since the epoch. <p> For this purpose, `epoch` SHALL be the UNIX epoch with 0 at `1970-01-01T00:00:00.000Z`.
.proto.Timestamp expiry = 17; -
setExpiry
* An expiration time for this token, in seconds since the epoch. <p> For this purpose, `epoch` SHALL be the UNIX epoch with 0 at `1970-01-01T00:00:00.000Z`.
.proto.Timestamp expiry = 17; -
mergeExpiry
* An expiration time for this token, in seconds since the epoch. <p> For this purpose, `epoch` SHALL be the UNIX epoch with 0 at `1970-01-01T00:00:00.000Z`.
.proto.Timestamp expiry = 17; -
clearExpiry
* An expiration time for this token, in seconds since the epoch. <p> For this purpose, `epoch` SHALL be the UNIX epoch with 0 at `1970-01-01T00:00:00.000Z`.
.proto.Timestamp expiry = 17; -
getMemo
* A short description of this token. <p> This value, if set, MUST NOT exceed `transaction.maxMemoUtf8Bytes` (default 100) bytes when encoded as UTF-8.
string memo = 18;- Specified by:
getMemoin interfaceTokenInfoOrBuilder- Returns:
- The memo.
-
getMemoBytes
public com.google.protobuf.ByteString getMemoBytes()* A short description of this token. <p> This value, if set, MUST NOT exceed `transaction.maxMemoUtf8Bytes` (default 100) bytes when encoded as UTF-8.
string memo = 18;- Specified by:
getMemoBytesin interfaceTokenInfoOrBuilder- Returns:
- The bytes for memo.
-
setMemo
* A short description of this token. <p> This value, if set, MUST NOT exceed `transaction.maxMemoUtf8Bytes` (default 100) bytes when encoded as UTF-8.
string memo = 18;- Parameters:
value- The memo to set.- Returns:
- This builder for chaining.
-
clearMemo
* A short description of this token. <p> This value, if set, MUST NOT exceed `transaction.maxMemoUtf8Bytes` (default 100) bytes when encoded as UTF-8.
string memo = 18;- Returns:
- This builder for chaining.
-
setMemoBytes
* A short description of this token. <p> This value, if set, MUST NOT exceed `transaction.maxMemoUtf8Bytes` (default 100) bytes when encoded as UTF-8.
string memo = 18;- Parameters:
value- The bytes for memo to set.- Returns:
- This builder for chaining.
-
getTokenTypeValue
public int getTokenTypeValue()* A type for this token. <p> A token SHALL be either `FUNGIBLE_COMMON` or `NON_FUNGIBLE_UNIQUE`.<br/> If this value was omitted during token creation, `FUNGIBLE_COMMON` SHALL be used.<br/> The value `FUNGIBLE_COMMON` SHALL represent a fungible/common token. The value `NON_FUNGIBLE_UNIQUE` SHALL represent a non-fungible/unique token.
.proto.TokenType tokenType = 19;- Specified by:
getTokenTypeValuein interfaceTokenInfoOrBuilder- Returns:
- The enum numeric value on the wire for tokenType.
-
setTokenTypeValue
* A type for this token. <p> A token SHALL be either `FUNGIBLE_COMMON` or `NON_FUNGIBLE_UNIQUE`.<br/> If this value was omitted during token creation, `FUNGIBLE_COMMON` SHALL be used.<br/> The value `FUNGIBLE_COMMON` SHALL represent a fungible/common token. The value `NON_FUNGIBLE_UNIQUE` SHALL represent a non-fungible/unique token.
.proto.TokenType tokenType = 19;- Parameters:
value- The tokenType to set.- Returns:
- This builder for chaining.
- Throws:
IllegalArgumentException- if UNRECOGNIZED is provided.
-
getTokenType
* A type for this token. <p> A token SHALL be either `FUNGIBLE_COMMON` or `NON_FUNGIBLE_UNIQUE`.<br/> If this value was omitted during token creation, `FUNGIBLE_COMMON` SHALL be used.<br/> The value `FUNGIBLE_COMMON` SHALL represent a fungible/common token. The value `NON_FUNGIBLE_UNIQUE` SHALL represent a non-fungible/unique token.
.proto.TokenType tokenType = 19;- Specified by:
getTokenTypein interfaceTokenInfoOrBuilder- Returns:
- The tokenType.
-
setTokenType
* A type for this token. <p> A token SHALL be either `FUNGIBLE_COMMON` or `NON_FUNGIBLE_UNIQUE`.<br/> If this value was omitted during token creation, `FUNGIBLE_COMMON` SHALL be used.<br/> The value `FUNGIBLE_COMMON` SHALL represent a fungible/common token. The value `NON_FUNGIBLE_UNIQUE` SHALL represent a non-fungible/unique token.
.proto.TokenType tokenType = 19;- Parameters:
value- The enum numeric value on the wire for tokenType to set.- Returns:
- This builder for chaining.
-
clearTokenType
* A type for this token. <p> A token SHALL be either `FUNGIBLE_COMMON` or `NON_FUNGIBLE_UNIQUE`.<br/> If this value was omitted during token creation, `FUNGIBLE_COMMON` SHALL be used.<br/> The value `FUNGIBLE_COMMON` SHALL represent a fungible/common token. The value `NON_FUNGIBLE_UNIQUE` SHALL represent a non-fungible/unique token.
.proto.TokenType tokenType = 19;- Returns:
- This builder for chaining.
-
getSupplyTypeValue
public int getSupplyTypeValue()* A supply type for this token. <p> A token SHALL have either `INFINITE` or `FINITE` supply type.<br/> If this value was omitted during token creation, the value `INFINITE` SHALL be used.
.proto.TokenSupplyType supplyType = 20;- Specified by:
getSupplyTypeValuein interfaceTokenInfoOrBuilder- Returns:
- The enum numeric value on the wire for supplyType.
-
setSupplyTypeValue
* A supply type for this token. <p> A token SHALL have either `INFINITE` or `FINITE` supply type.<br/> If this value was omitted during token creation, the value `INFINITE` SHALL be used.
.proto.TokenSupplyType supplyType = 20;- Parameters:
value- The supplyType to set.- Returns:
- This builder for chaining.
- Throws:
IllegalArgumentException- if UNRECOGNIZED is provided.
-
getSupplyType
* A supply type for this token. <p> A token SHALL have either `INFINITE` or `FINITE` supply type.<br/> If this value was omitted during token creation, the value `INFINITE` SHALL be used.
.proto.TokenSupplyType supplyType = 20;- Specified by:
getSupplyTypein interfaceTokenInfoOrBuilder- Returns:
- The supplyType.
-
setSupplyType
* A supply type for this token. <p> A token SHALL have either `INFINITE` or `FINITE` supply type.<br/> If this value was omitted during token creation, the value `INFINITE` SHALL be used.
.proto.TokenSupplyType supplyType = 20;- Parameters:
value- The enum numeric value on the wire for supplyType to set.- Returns:
- This builder for chaining.
-
clearSupplyType
* A supply type for this token. <p> A token SHALL have either `INFINITE` or `FINITE` supply type.<br/> If this value was omitted during token creation, the value `INFINITE` SHALL be used.
.proto.TokenSupplyType supplyType = 20;- Returns:
- This builder for chaining.
-
getMaxSupply
public long getMaxSupply()* A maximum supply of this token.<br/> This is the maximum number of tokens of this type that may be issued. <p> This limit SHALL apply regardless of `token_type`.<br/> If `supply_type` is `INFINITE` then this value MUST be 0.<br/> If `supply_type` is `FINITE`, then this value MUST be greater than 0.
int64 maxSupply = 21;- Specified by:
getMaxSupplyin interfaceTokenInfoOrBuilder- Returns:
- The maxSupply.
-
setMaxSupply
* A maximum supply of this token.<br/> This is the maximum number of tokens of this type that may be issued. <p> This limit SHALL apply regardless of `token_type`.<br/> If `supply_type` is `INFINITE` then this value MUST be 0.<br/> If `supply_type` is `FINITE`, then this value MUST be greater than 0.
int64 maxSupply = 21;- Parameters:
value- The maxSupply to set.- Returns:
- This builder for chaining.
-
clearMaxSupply
* A maximum supply of this token.<br/> This is the maximum number of tokens of this type that may be issued. <p> This limit SHALL apply regardless of `token_type`.<br/> If `supply_type` is `INFINITE` then this value MUST be 0.<br/> If `supply_type` is `FINITE`, then this value MUST be greater than 0.
int64 maxSupply = 21;- Returns:
- This builder for chaining.
-
hasFeeScheduleKey
public boolean hasFeeScheduleKey()* Access control of the `custom_fees` field for this token. <p> The token custom fee schedule may be changed, modifying the fees charged for transferring that token, by a token update transaction, which MUST be signed by this key.<br/> If this key is not set, the token custom fee schedule cannot be changed, and any transaction attempting to change the custom fee schedule for this token SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key fee_schedule_key = 22;- Specified by:
hasFeeScheduleKeyin interfaceTokenInfoOrBuilder- Returns:
- Whether the feeScheduleKey field is set.
-
getFeeScheduleKey
* Access control of the `custom_fees` field for this token. <p> The token custom fee schedule may be changed, modifying the fees charged for transferring that token, by a token update transaction, which MUST be signed by this key.<br/> If this key is not set, the token custom fee schedule cannot be changed, and any transaction attempting to change the custom fee schedule for this token SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key fee_schedule_key = 22;- Specified by:
getFeeScheduleKeyin interfaceTokenInfoOrBuilder- Returns:
- The feeScheduleKey.
-
setFeeScheduleKey
* Access control of the `custom_fees` field for this token. <p> The token custom fee schedule may be changed, modifying the fees charged for transferring that token, by a token update transaction, which MUST be signed by this key.<br/> If this key is not set, the token custom fee schedule cannot be changed, and any transaction attempting to change the custom fee schedule for this token SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key fee_schedule_key = 22; -
setFeeScheduleKey
* Access control of the `custom_fees` field for this token. <p> The token custom fee schedule may be changed, modifying the fees charged for transferring that token, by a token update transaction, which MUST be signed by this key.<br/> If this key is not set, the token custom fee schedule cannot be changed, and any transaction attempting to change the custom fee schedule for this token SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key fee_schedule_key = 22; -
mergeFeeScheduleKey
* Access control of the `custom_fees` field for this token. <p> The token custom fee schedule may be changed, modifying the fees charged for transferring that token, by a token update transaction, which MUST be signed by this key.<br/> If this key is not set, the token custom fee schedule cannot be changed, and any transaction attempting to change the custom fee schedule for this token SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key fee_schedule_key = 22; -
clearFeeScheduleKey
* Access control of the `custom_fees` field for this token. <p> The token custom fee schedule may be changed, modifying the fees charged for transferring that token, by a token update transaction, which MUST be signed by this key.<br/> If this key is not set, the token custom fee schedule cannot be changed, and any transaction attempting to change the custom fee schedule for this token SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key fee_schedule_key = 22; -
getCustomFeesList
* A custom fee schedule for this token.
repeated .proto.CustomFee custom_fees = 23;- Specified by:
getCustomFeesListin interfaceTokenInfoOrBuilder
-
getCustomFeesCount
public int getCustomFeesCount()* A custom fee schedule for this token.
repeated .proto.CustomFee custom_fees = 23;- Specified by:
getCustomFeesCountin interfaceTokenInfoOrBuilder
-
getCustomFees
* A custom fee schedule for this token.
repeated .proto.CustomFee custom_fees = 23;- Specified by:
getCustomFeesin interfaceTokenInfoOrBuilder
-
setCustomFees
* A custom fee schedule for this token.
repeated .proto.CustomFee custom_fees = 23; -
setCustomFees
* A custom fee schedule for this token.
repeated .proto.CustomFee custom_fees = 23; -
addCustomFees
* A custom fee schedule for this token.
repeated .proto.CustomFee custom_fees = 23; -
addCustomFees
* A custom fee schedule for this token.
repeated .proto.CustomFee custom_fees = 23; -
addCustomFees
* A custom fee schedule for this token.
repeated .proto.CustomFee custom_fees = 23; -
addCustomFees
* A custom fee schedule for this token.
repeated .proto.CustomFee custom_fees = 23; -
addAllCustomFees
* A custom fee schedule for this token.
repeated .proto.CustomFee custom_fees = 23; -
clearCustomFees
* A custom fee schedule for this token.
repeated .proto.CustomFee custom_fees = 23; -
removeCustomFees
* A custom fee schedule for this token.
repeated .proto.CustomFee custom_fees = 23; -
hasPauseKey
public boolean hasPauseKey()* Access control of pause/unpause for this token. <p> A token may be paused, preventing any transaction from transferring that token, by a token update transaction signed by this key.<br/> If this key is not set, the token cannot be paused, and any transaction attempting to pause the token SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key pause_key = 24;- Specified by:
hasPauseKeyin interfaceTokenInfoOrBuilder- Returns:
- Whether the pauseKey field is set.
-
getPauseKey
* Access control of pause/unpause for this token. <p> A token may be paused, preventing any transaction from transferring that token, by a token update transaction signed by this key.<br/> If this key is not set, the token cannot be paused, and any transaction attempting to pause the token SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key pause_key = 24;- Specified by:
getPauseKeyin interfaceTokenInfoOrBuilder- Returns:
- The pauseKey.
-
setPauseKey
* Access control of pause/unpause for this token. <p> A token may be paused, preventing any transaction from transferring that token, by a token update transaction signed by this key.<br/> If this key is not set, the token cannot be paused, and any transaction attempting to pause the token SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key pause_key = 24; -
setPauseKey
* Access control of pause/unpause for this token. <p> A token may be paused, preventing any transaction from transferring that token, by a token update transaction signed by this key.<br/> If this key is not set, the token cannot be paused, and any transaction attempting to pause the token SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key pause_key = 24; -
mergePauseKey
* Access control of pause/unpause for this token. <p> A token may be paused, preventing any transaction from transferring that token, by a token update transaction signed by this key.<br/> If this key is not set, the token cannot be paused, and any transaction attempting to pause the token SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key pause_key = 24; -
clearPauseKey
* Access control of pause/unpause for this token. <p> A token may be paused, preventing any transaction from transferring that token, by a token update transaction signed by this key.<br/> If this key is not set, the token cannot be paused, and any transaction attempting to pause the token SHALL NOT succeed.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key pause_key = 24; -
getPauseStatusValue
public int getPauseStatusValue()* A flag indicating that this token is paused.<br/> A token may be paused, unpaused, or pause not applicable. <p> A transaction involving a paused token, other than token_unpause, MUST NOT succeed.
.proto.TokenPauseStatus pause_status = 25;- Specified by:
getPauseStatusValuein interfaceTokenInfoOrBuilder- Returns:
- The enum numeric value on the wire for pauseStatus.
-
setPauseStatusValue
* A flag indicating that this token is paused.<br/> A token may be paused, unpaused, or pause not applicable. <p> A transaction involving a paused token, other than token_unpause, MUST NOT succeed.
.proto.TokenPauseStatus pause_status = 25;- Parameters:
value- The pauseStatus to set.- Returns:
- This builder for chaining.
- Throws:
IllegalArgumentException- if UNRECOGNIZED is provided.
-
getPauseStatus
* A flag indicating that this token is paused.<br/> A token may be paused, unpaused, or pause not applicable. <p> A transaction involving a paused token, other than token_unpause, MUST NOT succeed.
.proto.TokenPauseStatus pause_status = 25;- Specified by:
getPauseStatusin interfaceTokenInfoOrBuilder- Returns:
- The pauseStatus.
-
setPauseStatus
* A flag indicating that this token is paused.<br/> A token may be paused, unpaused, or pause not applicable. <p> A transaction involving a paused token, other than token_unpause, MUST NOT succeed.
.proto.TokenPauseStatus pause_status = 25;- Parameters:
value- The enum numeric value on the wire for pauseStatus to set.- Returns:
- This builder for chaining.
-
clearPauseStatus
* A flag indicating that this token is paused.<br/> A token may be paused, unpaused, or pause not applicable. <p> A transaction involving a paused token, other than token_unpause, MUST NOT succeed.
.proto.TokenPauseStatus pause_status = 25;- Returns:
- This builder for chaining.
-
getLedgerId
public com.google.protobuf.ByteString getLedgerId()* The ledger ID of the network that generated this response. <p> This value SHALL identify the distributed ledger that responded to this query.
bytes ledger_id = 26;- Specified by:
getLedgerIdin interfaceTokenInfoOrBuilder- Returns:
- The ledgerId.
-
setLedgerId
* The ledger ID of the network that generated this response. <p> This value SHALL identify the distributed ledger that responded to this query.
bytes ledger_id = 26;- Parameters:
value- The ledgerId to set.- Returns:
- This builder for chaining.
-
clearLedgerId
* The ledger ID of the network that generated this response. <p> This value SHALL identify the distributed ledger that responded to this query.
bytes ledger_id = 26;- Returns:
- This builder for chaining.
-
getMetadata
public com.google.protobuf.ByteString getMetadata()* A Token "Metadata". <p> This value, if set, SHALL NOT exceed 100 bytes.
bytes metadata = 27;- Specified by:
getMetadatain interfaceTokenInfoOrBuilder- Returns:
- The metadata.
-
setMetadata
* A Token "Metadata". <p> This value, if set, SHALL NOT exceed 100 bytes.
bytes metadata = 27;- Parameters:
value- The metadata to set.- Returns:
- This builder for chaining.
-
clearMetadata
* A Token "Metadata". <p> This value, if set, SHALL NOT exceed 100 bytes.
bytes metadata = 27;- Returns:
- This builder for chaining.
-
hasMetadataKey
public boolean hasMetadataKey()* Access Control of metadata update for this token. <p> A transaction to update the `metadata` field of this token MUST be signed by this key.<br/> If this token is a non-fungible/unique token type, a transaction to update the `metadata` field of any individual serialized unique token of this type MUST be signed by this key.<br/> If this key is not set, the token metadata SHALL NOT be changed after it is created.<br/> If this key is not set, the metadata for any individual serialized token of this type SHALL NOT be changed after it is created.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key metadata_key = 28;- Specified by:
hasMetadataKeyin interfaceTokenInfoOrBuilder- Returns:
- Whether the metadataKey field is set.
-
getMetadataKey
* Access Control of metadata update for this token. <p> A transaction to update the `metadata` field of this token MUST be signed by this key.<br/> If this token is a non-fungible/unique token type, a transaction to update the `metadata` field of any individual serialized unique token of this type MUST be signed by this key.<br/> If this key is not set, the token metadata SHALL NOT be changed after it is created.<br/> If this key is not set, the metadata for any individual serialized token of this type SHALL NOT be changed after it is created.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key metadata_key = 28;- Specified by:
getMetadataKeyin interfaceTokenInfoOrBuilder- Returns:
- The metadataKey.
-
setMetadataKey
* Access Control of metadata update for this token. <p> A transaction to update the `metadata` field of this token MUST be signed by this key.<br/> If this token is a non-fungible/unique token type, a transaction to update the `metadata` field of any individual serialized unique token of this type MUST be signed by this key.<br/> If this key is not set, the token metadata SHALL NOT be changed after it is created.<br/> If this key is not set, the metadata for any individual serialized token of this type SHALL NOT be changed after it is created.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key metadata_key = 28; -
setMetadataKey
* Access Control of metadata update for this token. <p> A transaction to update the `metadata` field of this token MUST be signed by this key.<br/> If this token is a non-fungible/unique token type, a transaction to update the `metadata` field of any individual serialized unique token of this type MUST be signed by this key.<br/> If this key is not set, the token metadata SHALL NOT be changed after it is created.<br/> If this key is not set, the metadata for any individual serialized token of this type SHALL NOT be changed after it is created.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key metadata_key = 28; -
mergeMetadataKey
* Access Control of metadata update for this token. <p> A transaction to update the `metadata` field of this token MUST be signed by this key.<br/> If this token is a non-fungible/unique token type, a transaction to update the `metadata` field of any individual serialized unique token of this type MUST be signed by this key.<br/> If this key is not set, the token metadata SHALL NOT be changed after it is created.<br/> If this key is not set, the metadata for any individual serialized token of this type SHALL NOT be changed after it is created.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key metadata_key = 28; -
clearMetadataKey
* Access Control of metadata update for this token. <p> A transaction to update the `metadata` field of this token MUST be signed by this key.<br/> If this token is a non-fungible/unique token type, a transaction to update the `metadata` field of any individual serialized unique token of this type MUST be signed by this key.<br/> If this key is not set, the token metadata SHALL NOT be changed after it is created.<br/> If this key is not set, the metadata for any individual serialized token of this type SHALL NOT be changed after it is created.<br/> This key MAY be set when the token is created, and MAY be set or modified via a token update transaction signed by the `admin_key`.<br/> If `admin_key` is not set, this value, whether set or unset, SHALL be immutable.
.proto.Key metadata_key = 28;
-