Module com.hedera.hashgraph.sdk
Package com.hedera.hashgraph.sdk.proto

Class TokenInfo

java.lang.Object
com.google.protobuf.AbstractMessageLite<TokenInfo,TokenInfo.Builder>
com.google.protobuf.GeneratedMessageLite<TokenInfo,TokenInfo.Builder>
com.hedera.hashgraph.sdk.proto.TokenInfo
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, TokenInfoOrBuilder
@Generated public final class TokenInfo extends com.google.protobuf.GeneratedMessageLite<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 Details

    • TOKENID_FIELD_NUMBER

      public static final int TOKENID_FIELD_NUMBER
      See Also:

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • SYMBOL_FIELD_NUMBER

      public static final int SYMBOL_FIELD_NUMBER
      See Also:

    • DECIMALS_FIELD_NUMBER

      public static final int DECIMALS_FIELD_NUMBER
      See Also:

    • TOTALSUPPLY_FIELD_NUMBER

      public static final int TOTALSUPPLY_FIELD_NUMBER
      See Also:

    • TREASURY_FIELD_NUMBER

      public static final int TREASURY_FIELD_NUMBER
      See Also:

    • ADMINKEY_FIELD_NUMBER

      public static final int ADMINKEY_FIELD_NUMBER
      See Also:

    • KYCKEY_FIELD_NUMBER

      public static final int KYCKEY_FIELD_NUMBER
      See Also:

    • FREEZEKEY_FIELD_NUMBER

      public static final int FREEZEKEY_FIELD_NUMBER
      See Also:

    • WIPEKEY_FIELD_NUMBER

      public static final int WIPEKEY_FIELD_NUMBER
      See Also:

    • SUPPLYKEY_FIELD_NUMBER

      public static final int SUPPLYKEY_FIELD_NUMBER
      See Also:

    • DEFAULTFREEZESTATUS_FIELD_NUMBER

      public static final int DEFAULTFREEZESTATUS_FIELD_NUMBER
      See Also:

    • DEFAULTKYCSTATUS_FIELD_NUMBER

      public static final int DEFAULTKYCSTATUS_FIELD_NUMBER
      See Also:

    • DELETED_FIELD_NUMBER

      public static final int DELETED_FIELD_NUMBER
      See Also:

    • AUTORENEWACCOUNT_FIELD_NUMBER

      public static final int AUTORENEWACCOUNT_FIELD_NUMBER
      See Also:

    • AUTORENEWPERIOD_FIELD_NUMBER

      public static final int AUTORENEWPERIOD_FIELD_NUMBER
      See Also:

    • EXPIRY_FIELD_NUMBER

      public static final int EXPIRY_FIELD_NUMBER
      See Also:

    • MEMO_FIELD_NUMBER

      public static final int MEMO_FIELD_NUMBER
      See Also:

    • TOKENTYPE_FIELD_NUMBER

      public static final int TOKENTYPE_FIELD_NUMBER
      See Also:

    • SUPPLYTYPE_FIELD_NUMBER

      public static final int SUPPLYTYPE_FIELD_NUMBER
      See Also:

    • MAXSUPPLY_FIELD_NUMBER

      public static final int MAXSUPPLY_FIELD_NUMBER
      See Also:

    • FEE_SCHEDULE_KEY_FIELD_NUMBER

      public static final int FEE_SCHEDULE_KEY_FIELD_NUMBER
      See Also:

    • CUSTOM_FEES_FIELD_NUMBER

      public static final int CUSTOM_FEES_FIELD_NUMBER
      See Also:

    • PAUSE_KEY_FIELD_NUMBER

      public static final int PAUSE_KEY_FIELD_NUMBER
      See Also:

    • PAUSE_STATUS_FIELD_NUMBER

      public static final int PAUSE_STATUS_FIELD_NUMBER
      See Also:

    • LEDGER_ID_FIELD_NUMBER

      public static final int LEDGER_ID_FIELD_NUMBER
      See Also:

    • METADATA_FIELD_NUMBER

      public static final int METADATA_FIELD_NUMBER
      See Also:

    • METADATA_KEY_FIELD_NUMBER

      public static final int METADATA_KEY_FIELD_NUMBER
      See Also:

  • Method Details

    • hasTokenId

      public boolean hasTokenId()
       *
 A unique identifier for this token.
      .proto.TokenID tokenId = 1;
      Specified by:
      hasTokenId in interface TokenInfoOrBuilder
      Returns:
      Whether the tokenId field is set.

    • getTokenId

      public TokenID getTokenId()
       *
 A unique identifier for this token.
      .proto.TokenID tokenId = 1;
      Specified by:
      getTokenId in interface TokenInfoOrBuilder
      Returns:
      The tokenId.

    • getName

      public String 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:
      getName in interface TokenInfoOrBuilder
      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:
      getNameBytes in interface TokenInfoOrBuilder
      Returns:
      The bytes for name.

    • getSymbol

      public String 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:
      getSymbol in interface TokenInfoOrBuilder
      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:
      getSymbolBytes in interface TokenInfoOrBuilder
      Returns:
      The bytes for symbol.

    • 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:
      getDecimals in interface TokenInfoOrBuilder
      Returns:
      The decimals.

    • 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:
      getTotalSupply in interface TokenInfoOrBuilder
      Returns:
      The totalSupply.

    • 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:
      hasTreasury in interface TokenInfoOrBuilder
      Returns:
      Whether the treasury field is set.

    • getTreasury

      public AccountID 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:
      getTreasury in interface TokenInfoOrBuilder
      Returns:
      The treasury.

    • 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:
      hasAdminKey in interface TokenInfoOrBuilder
      Returns:
      Whether the adminKey field is set.

    • getAdminKey

      public Key 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:
      getAdminKey in interface TokenInfoOrBuilder
      Returns:
      The adminKey.

    • 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:
      hasKycKey in interface TokenInfoOrBuilder
      Returns:
      Whether the kycKey field is set.

    • getKycKey

      public Key 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:
      getKycKey in interface TokenInfoOrBuilder
      Returns:
      The kycKey.

    • 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:
      hasFreezeKey in interface TokenInfoOrBuilder
      Returns:
      Whether the freezeKey field is set.

    • getFreezeKey

      public Key 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:
      getFreezeKey in interface TokenInfoOrBuilder
      Returns:
      The freezeKey.

    • 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:
      hasWipeKey in interface TokenInfoOrBuilder
      Returns:
      Whether the wipeKey field is set.

    • getWipeKey

      public Key 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:
      getWipeKey in interface TokenInfoOrBuilder
      Returns:
      The wipeKey.

    • 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:
      hasSupplyKey in interface TokenInfoOrBuilder
      Returns:
      Whether the supplyKey field is set.

    • getSupplyKey

      public Key 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:
      getSupplyKey in interface TokenInfoOrBuilder
      Returns:
      The supplyKey.

    • 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:
      getDefaultFreezeStatusValue in interface TokenInfoOrBuilder
      Returns:
      The enum numeric value on the wire for defaultFreezeStatus.

    • getDefaultFreezeStatus

      public TokenFreezeStatus 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:
      getDefaultFreezeStatus in interface TokenInfoOrBuilder
      Returns:
      The defaultFreezeStatus.

    • 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:
      getDefaultKycStatusValue in interface TokenInfoOrBuilder
      Returns:
      The enum numeric value on the wire for defaultKycStatus.

    • getDefaultKycStatus

      public TokenKycStatus 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:
      getDefaultKycStatus in interface TokenInfoOrBuilder
      Returns:
      The defaultKycStatus.

    • 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:
      getDeleted in interface TokenInfoOrBuilder
      Returns:
      The deleted.

    • 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:
      hasAutoRenewAccount in interface TokenInfoOrBuilder
      Returns:
      Whether the autoRenewAccount field is set.

    • getAutoRenewAccount

      public AccountID 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:
      getAutoRenewAccount in interface TokenInfoOrBuilder
      Returns:
      The autoRenewAccount.

    • 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:
      hasAutoRenewPeriod in interface TokenInfoOrBuilder
      Returns:
      Whether the autoRenewPeriod field is set.

    • getAutoRenewPeriod

      public Duration 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:
      getAutoRenewPeriod in interface TokenInfoOrBuilder
      Returns:
      The autoRenewPeriod.

    • 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:
      hasExpiry in interface TokenInfoOrBuilder
      Returns:
      Whether the expiry field is set.

    • getExpiry

      public Timestamp 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:
      getExpiry in interface TokenInfoOrBuilder
      Returns:
      The expiry.

    • getMemo

      public String 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:
      getMemo in interface TokenInfoOrBuilder
      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:
      getMemoBytes in interface TokenInfoOrBuilder
      Returns:
      The bytes for memo.

    • 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:
      getTokenTypeValue in interface TokenInfoOrBuilder
      Returns:
      The enum numeric value on the wire for tokenType.

    • getTokenType

      public TokenType 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:
      getTokenType in interface TokenInfoOrBuilder
      Returns:
      The tokenType.

    • 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:
      getSupplyTypeValue in interface TokenInfoOrBuilder
      Returns:
      The enum numeric value on the wire for supplyType.

    • getSupplyType

      public TokenSupplyType 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:
      getSupplyType in interface TokenInfoOrBuilder
      Returns:
      The supplyType.

    • 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:
      getMaxSupply in interface TokenInfoOrBuilder
      Returns:
      The maxSupply.

    • 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:
      hasFeeScheduleKey in interface TokenInfoOrBuilder
      Returns:
      Whether the feeScheduleKey field is set.

    • getFeeScheduleKey

      public Key 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:
      getFeeScheduleKey in interface TokenInfoOrBuilder
      Returns:
      The feeScheduleKey.

    • getCustomFeesList

      public List<CustomFee> getCustomFeesList()
       *
 A custom fee schedule for this token.
      repeated .proto.CustomFee custom_fees = 23;
      Specified by:
      getCustomFeesList in interface TokenInfoOrBuilder

    • getCustomFeesOrBuilderList

      public List<? extends CustomFeeOrBuilder> getCustomFeesOrBuilderList()
       *
 A custom fee schedule for this token.
      repeated .proto.CustomFee custom_fees = 23;

    • getCustomFeesCount

      public int getCustomFeesCount()
       *
 A custom fee schedule for this token.
      repeated .proto.CustomFee custom_fees = 23;
      Specified by:
      getCustomFeesCount in interface TokenInfoOrBuilder

    • getCustomFees

      public CustomFee getCustomFees(int index)
       *
 A custom fee schedule for this token.
      repeated .proto.CustomFee custom_fees = 23;
      Specified by:
      getCustomFees in interface TokenInfoOrBuilder

    • getCustomFeesOrBuilder

      public CustomFeeOrBuilder getCustomFeesOrBuilder(int index)
       *
 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:
      hasPauseKey in interface TokenInfoOrBuilder
      Returns:
      Whether the pauseKey field is set.

    • getPauseKey

      public Key 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:
      getPauseKey in interface TokenInfoOrBuilder
      Returns:
      The pauseKey.

    • 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:
      getPauseStatusValue in interface TokenInfoOrBuilder
      Returns:
      The enum numeric value on the wire for pauseStatus.

    • getPauseStatus

      public TokenPauseStatus 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:
      getPauseStatus in interface TokenInfoOrBuilder
      Returns:
      The pauseStatus.

    • 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:
      getLedgerId in interface TokenInfoOrBuilder
      Returns:
      The ledgerId.

    • 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:
      getMetadata in interface TokenInfoOrBuilder
      Returns:
      The metadata.

    • 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:
      hasMetadataKey in interface TokenInfoOrBuilder
      Returns:
      Whether the metadataKey field is set.

    • getMetadataKey

      public Key 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:
      getMetadataKey in interface TokenInfoOrBuilder
      Returns:
      The metadataKey.

    • parseFrom

      public static TokenInfo parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TokenInfo parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TokenInfo parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TokenInfo parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TokenInfo parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TokenInfo parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TokenInfo parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TokenInfo parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TokenInfo parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TokenInfo parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TokenInfo parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TokenInfo parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilder

      public static TokenInfo.Builder newBuilder()

    • newBuilder

      public static TokenInfo.Builder newBuilder(TokenInfo prototype)

    • dynamicMethod

      protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Specified by:
      dynamicMethod in class com.google.protobuf.GeneratedMessageLite<TokenInfo,TokenInfo.Builder>

    • getDefaultInstance

      public static TokenInfo getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<TokenInfo> parser()