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

Class Token.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<Token,Token.Builder>
com.google.protobuf.GeneratedMessageLite.Builder<Token,Token.Builder>
com.hedera.hashgraph.sdk.proto.Token.Builder
All Implemented Interfaces:
com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, TokenOrBuilder, Cloneable
Enclosing class:
Token
public static final class Token.Builder extends com.google.protobuf.GeneratedMessageLite.Builder<Token,Token.Builder> implements TokenOrBuilder
 *
 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.Token

  • Method Details

    • hasTokenId

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

    • getTokenId

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

    • setTokenId

      public Token.Builder setTokenId(TokenID value)
       *
 A unique identifier for this token.
      .proto.TokenID token_id = 1;

    • setTokenId

      public Token.Builder setTokenId(TokenID.Builder builderForValue)
       *
 A unique identifier for this token.
      .proto.TokenID token_id = 1;

    • mergeTokenId

      public Token.Builder mergeTokenId(TokenID value)
       *
 A unique identifier for this token.
      .proto.TokenID token_id = 1;

    • clearTokenId

      public Token.Builder clearTokenId()
       *
 A unique identifier for this token.
      .proto.TokenID token_id = 1;

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

    • setName

      public Token.Builder setName(String value)
       *
 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

      public Token.Builder 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

      public Token.Builder setNameBytes(com.google.protobuf.ByteString value)
       *
 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

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

    • setSymbol

      public Token.Builder setSymbol(String value)
       *
 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

      public Token.Builder 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

      public Token.Builder setSymbolBytes(com.google.protobuf.ByteString value)
       *
 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.
      int32 decimals = 4;
      Specified by:
      getDecimals in interface TokenOrBuilder
      Returns:
      The decimals.

    • setDecimals

      public Token.Builder setDecimals(int value)
       *
 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;
      Parameters:
      value - The decimals to set.
      Returns:
      This builder for chaining.

    • clearDecimals

      public Token.Builder 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.
      int32 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.
      int64 total_supply = 5;
      Specified by:
      getTotalSupply in interface TokenOrBuilder
      Returns:
      The totalSupply.

    • setTotalSupply

      public Token.Builder setTotalSupply(long value)
       *
 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;
      Parameters:
      value - The totalSupply to set.
      Returns:
      This builder for chaining.

    • clearTotalSupply

      public Token.Builder 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.
      int64 total_supply = 5;
      Returns:
      This builder for chaining.

    • hasTreasuryAccountId

      public 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;
      Specified by:
      hasTreasuryAccountId in interface TokenOrBuilder
      Returns:
      Whether the treasuryAccountId field is set.

    • getTreasuryAccountId

      public 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;
      Specified by:
      getTreasuryAccountId in interface TokenOrBuilder
      Returns:
      The treasuryAccountId.

    • setTreasuryAccountId

      public Token.Builder setTreasuryAccountId(AccountID value)
       *
 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;

    • setTreasuryAccountId

      public Token.Builder setTreasuryAccountId(AccountID.Builder builderForValue)
       *
 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;

    • mergeTreasuryAccountId

      public Token.Builder mergeTreasuryAccountId(AccountID value)
       *
 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;

    • clearTreasuryAccountId

      public Token.Builder clearTreasuryAccountId()
       *
 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;

    • 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 admin_key = 7;
      Specified by:
      hasAdminKey in interface TokenOrBuilder
      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 admin_key = 7;
      Specified by:
      getAdminKey in interface TokenOrBuilder
      Returns:
      The adminKey.

    • setAdminKey

      public Token.Builder setAdminKey(Key value)
       *
 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;

    • setAdminKey

      public Token.Builder setAdminKey(Key.Builder builderForValue)
       *
 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;

    • mergeAdminKey

      public Token.Builder mergeAdminKey(Key value)
       *
 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;

    • clearAdminKey

      public Token.Builder 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 admin_key = 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 kyc_key = 8;
      Specified by:
      hasKycKey in interface TokenOrBuilder
      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 kyc_key = 8;
      Specified by:
      getKycKey in interface TokenOrBuilder
      Returns:
      The kycKey.

    • setKycKey

      public Token.Builder setKycKey(Key value)
       *
 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;

    • setKycKey

      public Token.Builder setKycKey(Key.Builder builderForValue)
       *
 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;

    • mergeKycKey

      public Token.Builder mergeKycKey(Key value)
       *
 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;

    • clearKycKey

      public Token.Builder 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 kyc_key = 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 freeze_key = 9;
      Specified by:
      hasFreezeKey in interface TokenOrBuilder
      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 freeze_key = 9;
      Specified by:
      getFreezeKey in interface TokenOrBuilder
      Returns:
      The freezeKey.

    • setFreezeKey

      public Token.Builder setFreezeKey(Key value)
       *
 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;

    • setFreezeKey

      public Token.Builder setFreezeKey(Key.Builder builderForValue)
       *
 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;

    • mergeFreezeKey

      public Token.Builder mergeFreezeKey(Key value)
       *
 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;

    • clearFreezeKey

      public Token.Builder 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 freeze_key = 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 wipe_key = 10;
      Specified by:
      hasWipeKey in interface TokenOrBuilder
      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 wipe_key = 10;
      Specified by:
      getWipeKey in interface TokenOrBuilder
      Returns:
      The wipeKey.

    • setWipeKey

      public Token.Builder setWipeKey(Key value)
       *
 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;

    • setWipeKey

      public Token.Builder setWipeKey(Key.Builder builderForValue)
       *
 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;

    • mergeWipeKey

      public Token.Builder mergeWipeKey(Key value)
       *
 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;

    • clearWipeKey

      public Token.Builder 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 wipe_key = 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 supply_key = 11;
      Specified by:
      hasSupplyKey in interface TokenOrBuilder
      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 supply_key = 11;
      Specified by:
      getSupplyKey in interface TokenOrBuilder
      Returns:
      The supplyKey.

    • setSupplyKey

      public Token.Builder setSupplyKey(Key value)
       *
 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;

    • setSupplyKey

      public Token.Builder setSupplyKey(Key.Builder builderForValue)
       *
 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;

    • mergeSupplyKey

      public Token.Builder mergeSupplyKey(Key value)
       *
 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;

    • clearSupplyKey

      public Token.Builder 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 supply_key = 11;

    • 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 = 12;
      Specified by:
      hasFeeScheduleKey in interface TokenOrBuilder
      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 = 12;
      Specified by:
      getFeeScheduleKey in interface TokenOrBuilder
      Returns:
      The feeScheduleKey.

    • setFeeScheduleKey

      public Token.Builder setFeeScheduleKey(Key value)
       *
 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;

    • setFeeScheduleKey

      public Token.Builder setFeeScheduleKey(Key.Builder builderForValue)
       *
 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;

    • mergeFeeScheduleKey

      public Token.Builder mergeFeeScheduleKey(Key value)
       *
 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;

    • clearFeeScheduleKey

      public Token.Builder 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 = 12;

    • 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 = 13;
      Specified by:
      hasPauseKey in interface TokenOrBuilder
      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 = 13;
      Specified by:
      getPauseKey in interface TokenOrBuilder
      Returns:
      The pauseKey.

    • setPauseKey

      public Token.Builder setPauseKey(Key value)
       *
 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;

    • setPauseKey

      public Token.Builder setPauseKey(Key.Builder builderForValue)
       *
 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;

    • mergePauseKey

      public Token.Builder mergePauseKey(Key value)
       *
 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;

    • clearPauseKey

      public Token.Builder 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 = 13;

    • getLastUsedSerialNumber

      public 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;
      Specified by:
      getLastUsedSerialNumber in interface TokenOrBuilder
      Returns:
      The lastUsedSerialNumber.

    • setLastUsedSerialNumber

      public Token.Builder setLastUsedSerialNumber(long value)
       *
 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;
      Parameters:
      value - The lastUsedSerialNumber to set.
      Returns:
      This builder for chaining.

    • clearLastUsedSerialNumber

      public Token.Builder clearLastUsedSerialNumber()
       *
 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:
      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 = 15;
      Specified by:
      getDeleted in interface TokenOrBuilder
      Returns:
      The deleted.

    • setDeleted

      public Token.Builder setDeleted(boolean value)
       *
 A flag indicating that this token is deleted.
 <p>
 A transaction involving a deleted token MUST NOT succeed.
      bool deleted = 15;
      Parameters:
      value - The deleted to set.
      Returns:
      This builder for chaining.

    • clearDeleted

      public Token.Builder clearDeleted()
       *
 A flag indicating that this token is deleted.
 <p>
 A transaction involving a deleted token MUST NOT succeed.
      bool deleted = 15;
      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.
      .proto.TokenType token_type = 16;
      Specified by:
      getTokenTypeValue in interface TokenOrBuilder
      Returns:
      The enum numeric value on the wire for tokenType.

    • setTokenTypeValue

      public Token.Builder setTokenTypeValue(int value)
       *
 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;
      Parameters:
      value - The tokenType to set.
      Returns:
      This builder for chaining.
      Throws:
      IllegalArgumentException - if UNRECOGNIZED is provided.

    • 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.
      .proto.TokenType token_type = 16;
      Specified by:
      getTokenType in interface TokenOrBuilder
      Returns:
      The tokenType.

    • setTokenType

      public Token.Builder setTokenType(TokenType value)
       *
 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;
      Parameters:
      value - The enum numeric value on the wire for tokenType to set.
      Returns:
      This builder for chaining.

    • clearTokenType

      public Token.Builder 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.
      .proto.TokenType token_type = 16;
      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 supply_type = 17;
      Specified by:
      getSupplyTypeValue in interface TokenOrBuilder
      Returns:
      The enum numeric value on the wire for supplyType.

    • setSupplyTypeValue

      public Token.Builder setSupplyTypeValue(int value)
       *
 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;
      Parameters:
      value - The supplyType to set.
      Returns:
      This builder for chaining.
      Throws:
      IllegalArgumentException - if UNRECOGNIZED is provided.

    • 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 supply_type = 17;
      Specified by:
      getSupplyType in interface TokenOrBuilder
      Returns:
      The supplyType.

    • setSupplyType

      public Token.Builder setSupplyType(TokenSupplyType value)
       *
 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;
      Parameters:
      value - The enum numeric value on the wire for supplyType to set.
      Returns:
      This builder for chaining.

    • clearSupplyType

      public Token.Builder 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 supply_type = 17;
      Returns:
      This builder for chaining.

    • hasAutoRenewAccountId

      public 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;
      Specified by:
      hasAutoRenewAccountId in interface TokenOrBuilder
      Returns:
      Whether the autoRenewAccountId field is set.

    • getAutoRenewAccountId

      public 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;
      Specified by:
      getAutoRenewAccountId in interface TokenOrBuilder
      Returns:
      The autoRenewAccountId.

    • setAutoRenewAccountId

      public Token.Builder setAutoRenewAccountId(AccountID value)
       *
 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;

    • setAutoRenewAccountId

      public Token.Builder setAutoRenewAccountId(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.
 <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;

    • mergeAutoRenewAccountId

      public Token.Builder mergeAutoRenewAccountId(AccountID value)
       *
 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;

    • clearAutoRenewAccountId

      public Token.Builder clearAutoRenewAccountId()
       *
 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;

    • getAutoRenewSeconds

      public 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;
      Specified by:
      getAutoRenewSeconds in interface TokenOrBuilder
      Returns:
      The autoRenewSeconds.

    • setAutoRenewSeconds

      public Token.Builder setAutoRenewSeconds(long value)
       *
 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;
      Parameters:
      value - The autoRenewSeconds to set.
      Returns:
      This builder for chaining.

    • clearAutoRenewSeconds

      public Token.Builder clearAutoRenewSeconds()
       *
 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:
      This builder for chaining.

    • getExpirationSecond

      public 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;
      Specified by:
      getExpirationSecond in interface TokenOrBuilder
      Returns:
      The expirationSecond.

    • setExpirationSecond

      public Token.Builder setExpirationSecond(long value)
       *
 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;
      Parameters:
      value - The expirationSecond to set.
      Returns:
      This builder for chaining.

    • clearExpirationSecond

      public Token.Builder clearExpirationSecond()
       *
 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:
      This builder for chaining.

    • 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 = 21;
      Specified by:
      getMemo in interface TokenOrBuilder
      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 = 21;
      Specified by:
      getMemoBytes in interface TokenOrBuilder
      Returns:
      The bytes for memo.

    • setMemo

      public Token.Builder setMemo(String value)
       *
 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;
      Parameters:
      value - The memo to set.
      Returns:
      This builder for chaining.

    • clearMemo

      public Token.Builder 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 = 21;
      Returns:
      This builder for chaining.

    • setMemoBytes

      public Token.Builder setMemoBytes(com.google.protobuf.ByteString value)
       *
 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;
      Parameters:
      value - The bytes for memo to set.
      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 max_supply = 22;
      Specified by:
      getMaxSupply in interface TokenOrBuilder
      Returns:
      The maxSupply.

    • setMaxSupply

      public Token.Builder setMaxSupply(long value)
       *
 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;
      Parameters:
      value - The maxSupply to set.
      Returns:
      This builder for chaining.

    • clearMaxSupply

      public Token.Builder 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 max_supply = 22;
      Returns:
      This builder for chaining.

    • getPaused

      public 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;
      Specified by:
      getPaused in interface TokenOrBuilder
      Returns:
      The paused.

    • setPaused

      public Token.Builder setPaused(boolean value)
       *
 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;
      Parameters:
      value - The paused to set.
      Returns:
      This builder for chaining.

    • clearPaused

      public Token.Builder clearPaused()
       *
 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:
      This builder for chaining.

    • getAccountsFrozenByDefault

      public 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;
      Specified by:
      getAccountsFrozenByDefault in interface TokenOrBuilder
      Returns:
      The accountsFrozenByDefault.

    • setAccountsFrozenByDefault

      public Token.Builder setAccountsFrozenByDefault(boolean value)
       *
 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;
      Parameters:
      value - The accountsFrozenByDefault to set.
      Returns:
      This builder for chaining.

    • clearAccountsFrozenByDefault

      public Token.Builder clearAccountsFrozenByDefault()
       *
 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:
      This builder for chaining.

    • getAccountsKycGrantedByDefault

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

    • setAccountsKycGrantedByDefault

      public Token.Builder setAccountsKycGrantedByDefault(boolean value)
       *
 A flag indicating that accounts associated with this token are granted
 KYC by default.
      bool accounts_kyc_granted_by_default = 25;
      Parameters:
      value - The accountsKycGrantedByDefault to set.
      Returns:
      This builder for chaining.

    • clearAccountsKycGrantedByDefault

      public Token.Builder clearAccountsKycGrantedByDefault()
       *
 A flag indicating that accounts associated with this token are granted
 KYC by default.
      bool accounts_kyc_granted_by_default = 25;
      Returns:
      This builder for chaining.

    • getCustomFeesList

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

    • getCustomFeesCount

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

    • getCustomFees

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

    • setCustomFees

      public Token.Builder setCustomFees(int index, CustomFee value)
       *
 A custom fee schedule for this token.
      repeated .proto.CustomFee custom_fees = 26;

    • setCustomFees

      public Token.Builder setCustomFees(int index, CustomFee.Builder builderForValue)
       *
 A custom fee schedule for this token.
      repeated .proto.CustomFee custom_fees = 26;

    • addCustomFees

      public Token.Builder addCustomFees(CustomFee value)
       *
 A custom fee schedule for this token.
      repeated .proto.CustomFee custom_fees = 26;

    • addCustomFees

      public Token.Builder addCustomFees(int index, CustomFee value)
       *
 A custom fee schedule for this token.
      repeated .proto.CustomFee custom_fees = 26;

    • addCustomFees

      public Token.Builder addCustomFees(CustomFee.Builder builderForValue)
       *
 A custom fee schedule for this token.
      repeated .proto.CustomFee custom_fees = 26;

    • addCustomFees

      public Token.Builder addCustomFees(int index, CustomFee.Builder builderForValue)
       *
 A custom fee schedule for this token.
      repeated .proto.CustomFee custom_fees = 26;

    • addAllCustomFees

      public Token.Builder addAllCustomFees(Iterable<? extends CustomFee> values)
       *
 A custom fee schedule for this token.
      repeated .proto.CustomFee custom_fees = 26;

    • clearCustomFees

      public Token.Builder clearCustomFees()
       *
 A custom fee schedule for this token.
      repeated .proto.CustomFee custom_fees = 26;

    • removeCustomFees

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

    • 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 TokenOrBuilder
      Returns:
      The metadata.

    • setMetadata

      public Token.Builder setMetadata(com.google.protobuf.ByteString value)
       *
 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

      public Token.Builder 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:
      hasMetadataKey in interface TokenOrBuilder
      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 TokenOrBuilder
      Returns:
      The metadataKey.

    • setMetadataKey

      public Token.Builder setMetadataKey(Key value)
       *
 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

      public Token.Builder setMetadataKey(Key.Builder builderForValue)
       *
 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

      public Token.Builder mergeMetadataKey(Key value)
       *
 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

      public Token.Builder 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;