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

Interface TokenOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
Token, Token.Builder
@Generated public interface TokenOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getAccountsFrozenByDefault()
    * A flag indicating that accounts associated to this token are frozen by default.
    boolean
    getAccountsKycGrantedByDefault()
    * A flag indicating that accounts associated with this token are granted KYC by default.
    Key
    getAdminKey()
    * Access control for general modification of this token.
    AccountID
    getAutoRenewAccountId()
    * An identifier for the account (if any) that the network will attempt to charge for this token's auto-renewal upon expiration.
    long
    getAutoRenewSeconds()
    * A number of seconds by which the network should automatically extend this token's expiration.
    CustomFee
    getCustomFees(int index)
    * A custom fee schedule for this token.
    int
    getCustomFeesCount()
    * A custom fee schedule for this token.
    List<CustomFee>
    getCustomFeesList()
    * A custom fee schedule for this token.
    int
    getDecimals()
    * A number of decimal places for this token.
    boolean
    getDeleted()
    * A flag indicating that this token is deleted.
    long
    getExpirationSecond()
    * An expiration time for this token, in seconds since the epoch.
    Key
    getFeeScheduleKey()
    * Access control of the `custom_fees` field for this token.
    Key
    getFreezeKey()
    * Access control to freeze this token.
    Key
    getKycKey()
    * Access control for KYC for this token.
    long
    getLastUsedSerialNumber()
    * A last used serial number for this token.
    long
    getMaxSupply()
    * A maximum supply of this token.<br/> This is the maximum number of tokens of this type that may be issued.
    String
    getMemo()
    * A short description of this token.
    com.google.protobuf.ByteString
    getMemoBytes()
    * A short description of this token.
    com.google.protobuf.ByteString
    getMetadata()
    * A Token "Metadata".
    Key
    getMetadataKey()
    * Access Control of metadata update for this token.
    String
    getName()
    * A human-readable name for this token.
    com.google.protobuf.ByteString
    getNameBytes()
    * A human-readable name for this token.
    boolean
    getPaused()
    * A flag indicating that this token is paused.
    Key
    getPauseKey()
    * Access control of pause/unpause for this token.
    Key
    getSupplyKey()
    * Access control of token mint/burn for this token.
    TokenSupplyType
    getSupplyType()
    * A supply type for this token.
    int
    getSupplyTypeValue()
    * A supply type for this token.
    String
    getSymbol()
    * A human-readable symbol for the token.
    com.google.protobuf.ByteString
    getSymbolBytes()
    * A human-readable symbol for the token.
    TokenID
    getTokenId()
    * A unique identifier for this token.
    TokenType
    getTokenType()
    * A type for this token.
    int
    getTokenTypeValue()
    * A type for this token.
    long
    getTotalSupply()
    * A _current_ total supply of this token, expressed in the smallest unit of the token.
    AccountID
    getTreasuryAccountId()
    * A treasury account identifier for this token.
    Key
    getWipeKey()
    * Access control of account wipe for this token.
    boolean
    hasAdminKey()
    * Access control for general modification of this token.
    boolean
    hasAutoRenewAccountId()
    * An identifier for the account (if any) that the network will attempt to charge for this token's auto-renewal upon expiration.
    boolean
    hasFeeScheduleKey()
    * Access control of the `custom_fees` field for this token.
    boolean
    hasFreezeKey()
    * Access control to freeze this token.
    boolean
    hasKycKey()
    * Access control for KYC for this token.
    boolean
    hasMetadataKey()
    * Access Control of metadata update for this token.
    boolean
    hasPauseKey()
    * Access control of pause/unpause for this token.
    boolean
    hasSupplyKey()
    * Access control of token mint/burn for this token.
    boolean
    hasTokenId()
    * A unique identifier for this token.
    boolean
    hasTreasuryAccountId()
    * A treasury account identifier for this token.
    boolean
    hasWipeKey()
    * Access control of account wipe for this token.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • hasTokenId

      boolean hasTokenId()
       *
 A unique identifier for this token.
      .proto.TokenID token_id = 1;
      Returns:
      Whether the tokenId field is set.

    • getTokenId

      TokenID getTokenId()
       *
 A unique identifier for this token.
      .proto.TokenID token_id = 1;
      Returns:
      The tokenId.

    • getName

      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;
      Returns:
      The name.

    • getNameBytes

      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;
      Returns:
      The bytes for name.

    • getSymbol

      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;
      Returns:
      The symbol.

    • getSymbolBytes

      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;
      Returns:
      The bytes for symbol.

    • getDecimals

      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.
      int32 decimals = 4;
      Returns:
      The decimals.

    • getTotalSupply

      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.
      int64 total_supply = 5;
      Returns:
      The totalSupply.

    • hasTreasuryAccountId

      boolean hasTreasuryAccountId()
       *
 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_account_id = 6;
      Returns:
      Whether the treasuryAccountId field is set.

    • getTreasuryAccountId

      AccountID getTreasuryAccountId()
       *
 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_account_id = 6;
      Returns:
      The treasuryAccountId.

    • hasAdminKey

      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 admin_key = 7;
      Returns:
      Whether the adminKey field is set.

    • getAdminKey

      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 admin_key = 7;
      Returns:
      The adminKey.

    • hasKycKey

      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 kyc_key = 8;
      Returns:
      Whether the kycKey field is set.

    • getKycKey

      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 kyc_key = 8;
      Returns:
      The kycKey.

    • hasFreezeKey

      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 freeze_key = 9;
      Returns:
      Whether the freezeKey field is set.

    • getFreezeKey

      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 freeze_key = 9;
      Returns:
      The freezeKey.

    • hasWipeKey

      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 wipe_key = 10;
      Returns:
      Whether the wipeKey field is set.

    • getWipeKey

      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 wipe_key = 10;
      Returns:
      The wipeKey.

    • hasSupplyKey

      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 supply_key = 11;
      Returns:
      Whether the supplyKey field is set.

    • getSupplyKey

      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 supply_key = 11;
      Returns:
      The supplyKey.

    • hasFeeScheduleKey

      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 = 12;
      Returns:
      Whether the feeScheduleKey field is set.

    • getFeeScheduleKey

      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 = 12;
      Returns:
      The feeScheduleKey.

    • hasPauseKey

      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 = 13;
      Returns:
      Whether the pauseKey field is set.

    • getPauseKey

      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 = 13;
      Returns:
      The pauseKey.

    • getLastUsedSerialNumber

      long getLastUsedSerialNumber()
       *
 A last used serial number for this token.
 <p>
 This SHALL apply only to non-fungible tokens.<br/>
 When a new NFT is minted, the serial number to apply SHALL be calculated
 from this value.
      int64 last_used_serial_number = 14;
      Returns:
      The lastUsedSerialNumber.

    • getDeleted

      boolean getDeleted()
       *
 A flag indicating that this token is deleted.
 <p>
 A transaction involving a deleted token MUST NOT succeed.
      bool deleted = 15;
      Returns:
      The deleted.

    • getTokenTypeValue

      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.
      .proto.TokenType token_type = 16;
      Returns:
      The enum numeric value on the wire for tokenType.

    • getTokenType

      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.
      .proto.TokenType token_type = 16;
      Returns:
      The tokenType.

    • getSupplyTypeValue

      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 supply_type = 17;
      Returns:
      The enum numeric value on the wire for supplyType.

    • getSupplyType

      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 supply_type = 17;
      Returns:
      The supplyType.

    • hasAutoRenewAccountId

      boolean hasAutoRenewAccountId()
       *
 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_account_id`.
      .proto.AccountID auto_renew_account_id = 18;
      Returns:
      Whether the autoRenewAccountId field is set.

    • getAutoRenewAccountId

      AccountID getAutoRenewAccountId()
       *
 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_account_id`.
      .proto.AccountID auto_renew_account_id = 18;
      Returns:
      The autoRenewAccountId.

    • getAutoRenewSeconds

      long getAutoRenewSeconds()
       *
 A number of seconds 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/>
 If this is not provided in an allowed range on token creation, the
 transaction SHALL fail with `INVALID_AUTO_RENEWAL_PERIOD`.<br/>
 The default values for the minimum period and maximum period are 30 days
 and 90 days, respectively.
      int64 auto_renew_seconds = 19;
      Returns:
      The autoRenewSeconds.

    • getExpirationSecond

      long getExpirationSecond()
       *
 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`.
      int64 expiration_second = 20;
      Returns:
      The expirationSecond.

    • getMemo

      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 = 21;
      Returns:
      The memo.

    • getMemoBytes

      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 = 21;
      Returns:
      The bytes for memo.

    • getMaxSupply

      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 max_supply = 22;
      Returns:
      The maxSupply.

    • getPaused

      boolean getPaused()
       *
 A flag indicating that this token is paused.
 <p>
 A transaction involving a paused token, other than token_unpause,
 MUST NOT succeed.
      bool paused = 23;
      Returns:
      The paused.

    • getAccountsFrozenByDefault

      boolean getAccountsFrozenByDefault()
       *
 A flag indicating that accounts associated to this token are frozen by
 default.
 <p>
 Accounts 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.
      bool accounts_frozen_by_default = 24;
      Returns:
      The accountsFrozenByDefault.

    • getAccountsKycGrantedByDefault

      boolean getAccountsKycGrantedByDefault()
       *
 A flag indicating that accounts associated with this token are granted
 KYC by default.
      bool accounts_kyc_granted_by_default = 25;
      Returns:
      The accountsKycGrantedByDefault.

    • getCustomFeesList

      List<CustomFee> getCustomFeesList()
       *
 A custom fee schedule for this token.
      repeated .proto.CustomFee custom_fees = 26;

    • getCustomFees

      CustomFee getCustomFees(int index)
       *
 A custom fee schedule for this token.
      repeated .proto.CustomFee custom_fees = 26;

    • getCustomFeesCount

      int getCustomFeesCount()
       *
 A custom fee schedule for this token.
      repeated .proto.CustomFee custom_fees = 26;

    • getMetadata

      com.google.protobuf.ByteString getMetadata()
       *
 A Token "Metadata".
 <p>
 This value, if set, SHALL NOT exceed 100 bytes.
      bytes metadata = 27;
      Returns:
      The metadata.

    • hasMetadataKey

      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;
      Returns:
      Whether the metadataKey field is set.

    • getMetadataKey

      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;
      Returns:
      The metadataKey.