Module com.hedera.hashgraph.sdk
Package com.hedera.hashgraph.sdk.proto
Class TokenUpdateTransactionBody
java.lang.Object
com.google.protobuf.AbstractMessageLite<TokenUpdateTransactionBody,TokenUpdateTransactionBody.Builder>
com.google.protobuf.GeneratedMessageLite<TokenUpdateTransactionBody,TokenUpdateTransactionBody.Builder>
com.hedera.hashgraph.sdk.proto.TokenUpdateTransactionBody
- All Implemented Interfaces:
com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,TokenUpdateTransactionBodyOrBuilder
@Generated
public final class TokenUpdateTransactionBody
extends com.google.protobuf.GeneratedMessageLite<TokenUpdateTransactionBody,TokenUpdateTransactionBody.Builder>
implements TokenUpdateTransactionBodyOrBuilder
* Update an existing token. This transaction SHALL NOT update any field that is not set.<br/> Most changes MUST be signed by the current `admin_key` of the token. If the token does not currently have a valid `admin_key`, then this transaction MUST NOT set any value other than `expiry` or a non-admin key.<br/> If the `treasury` is set to a new account, the new account MUST sign this transaction.<br/> If the `treasury` is set to a new account for a _non-fungible/unique_ token, The current treasury MAY hold some tokens. #### Requirements for Keys Any of the key values may be changed, even without an admin key, but the key to be changed MUST have an existing valid key assigned, and both the current key and the new key MUST sign the transaction.<br/> A key value MAY be set to an empty `KeyList`. In this case the existing key MUST sign this transaction, but the new value is not a valid key, and the update SHALL effectively remove the existing key. ### Block Stream Effects NoneProtobuf type
proto.TokenUpdateTransactionBody-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class* Update an existing token.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite
com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType, BuilderType>, BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType, BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType, BuilderType>, BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType, BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType, BuilderType>, BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType, BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite, Type>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageLite
unknownFieldsFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionprotected final ObjectdynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1) * An Hedera key for token administration.* An identifier for the account to be charged renewal fees at the token's expiry to extend the lifetime of the token.* A duration between token automatic renewals.<br/> All entities in state may be charged "rent" occasionally (typically every 90 days) to prevent unnecessary growth of the ledger.static TokenUpdateTransactionBody* An expiration timestamp.* An Hedera key for managing the token custom fee schedule.* An Hedera key for managing asset "freeze".* Set a key validation mode.<br/> Any key may be updated by a transaction signed by the token `admin_key`.int* Set a key validation mode.<br/> Any key may be updated by a transaction signed by the token `admin_key`.* An Hedera key for managing account KYC.com.google.protobuf.StringValuegetMemo()* A short description for this token.com.google.protobuf.BytesValue* Token "Metadata".* An Hedera key for managing the token `metadata`.getName()* A new name for the token.<br/> This is generally the "full name" displayed in wallet software.com.google.protobuf.ByteString* A new name for the token.<br/> This is generally the "full name" displayed in wallet software.* An Hedera key for managing token "pause".* An Hedera key for "minting" and "burning" tokens.* A new symbol to use for the token.com.google.protobuf.ByteString* A new symbol to use for the token.getToken()* A token identifier.* A new treasury account identifier.* An Hedera key for wiping tokens from accounts.boolean* An Hedera key for token administration.boolean* An identifier for the account to be charged renewal fees at the token's expiry to extend the lifetime of the token.boolean* A duration between token automatic renewals.<br/> All entities in state may be charged "rent" occasionally (typically every 90 days) to prevent unnecessary growth of the ledger.boolean* An expiration timestamp.boolean* An Hedera key for managing the token custom fee schedule.boolean* An Hedera key for managing asset "freeze".boolean* An Hedera key for managing account KYC.booleanhasMemo()* A short description for this token.boolean* Token "Metadata".boolean* An Hedera key for managing the token `metadata`.boolean* An Hedera key for managing token "pause".boolean* An Hedera key for "minting" and "burning" tokens.booleanhasToken()* A token identifier.boolean* A new treasury account identifier.boolean* An Hedera key for wiping tokens from accounts.newBuilder(TokenUpdateTransactionBody prototype) static TokenUpdateTransactionBodyparseDelimitedFrom(InputStream input) static TokenUpdateTransactionBodyparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TokenUpdateTransactionBodyparseFrom(byte[] data) static TokenUpdateTransactionBodyparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TokenUpdateTransactionBodyparseFrom(com.google.protobuf.ByteString data) static TokenUpdateTransactionBodyparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TokenUpdateTransactionBodyparseFrom(com.google.protobuf.CodedInputStream input) static TokenUpdateTransactionBodyparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TokenUpdateTransactionBodyparseFrom(InputStream input) static TokenUpdateTransactionBodyparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TokenUpdateTransactionBodyparseFrom(ByteBuffer data) static TokenUpdateTransactionBodyparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<TokenUpdateTransactionBody> parser()Methods inherited from class com.google.protobuf.GeneratedMessageLite
createBuilder, createBuilder, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeToMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType, isInitialized
-
Field Details
-
TOKEN_FIELD_NUMBER
public static final int TOKEN_FIELD_NUMBER- See Also:
-
SYMBOL_FIELD_NUMBER
public static final int SYMBOL_FIELD_NUMBER- See Also:
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
TREASURY_FIELD_NUMBER
public static final int TREASURY_FIELD_NUMBER- See Also:
-
ADMINKEY_FIELD_NUMBER
public static final int ADMINKEY_FIELD_NUMBER- See Also:
-
KYCKEY_FIELD_NUMBER
public static final int KYCKEY_FIELD_NUMBER- See Also:
-
FREEZEKEY_FIELD_NUMBER
public static final int FREEZEKEY_FIELD_NUMBER- See Also:
-
WIPEKEY_FIELD_NUMBER
public static final int WIPEKEY_FIELD_NUMBER- See Also:
-
SUPPLYKEY_FIELD_NUMBER
public static final int SUPPLYKEY_FIELD_NUMBER- See Also:
-
AUTORENEWACCOUNT_FIELD_NUMBER
public static final int AUTORENEWACCOUNT_FIELD_NUMBER- See Also:
-
AUTORENEWPERIOD_FIELD_NUMBER
public static final int AUTORENEWPERIOD_FIELD_NUMBER- See Also:
-
EXPIRY_FIELD_NUMBER
public static final int EXPIRY_FIELD_NUMBER- See Also:
-
MEMO_FIELD_NUMBER
public static final int MEMO_FIELD_NUMBER- See Also:
-
FEE_SCHEDULE_KEY_FIELD_NUMBER
public static final int FEE_SCHEDULE_KEY_FIELD_NUMBER- See Also:
-
PAUSE_KEY_FIELD_NUMBER
public static final int PAUSE_KEY_FIELD_NUMBER- See Also:
-
METADATA_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER- See Also:
-
METADATA_KEY_FIELD_NUMBER
public static final int METADATA_KEY_FIELD_NUMBER- See Also:
-
KEY_VERIFICATION_MODE_FIELD_NUMBER
public static final int KEY_VERIFICATION_MODE_FIELD_NUMBER- See Also:
-
-
Method Details
-
hasToken
public boolean hasToken()* A token identifier. <p> This SHALL identify the token type to delete.<br/> The identified token MUST exist, and MUST NOT be deleted.<br/> If any field other than `expiry` is set, the identified token MUST have a valid `admin_key`.
.proto.TokenID token = 1;- Specified by:
hasTokenin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- Whether the token field is set.
-
getToken
* A token identifier. <p> This SHALL identify the token type to delete.<br/> The identified token MUST exist, and MUST NOT be deleted.<br/> If any field other than `expiry` is set, the identified token MUST have a valid `admin_key`.
.proto.TokenID token = 1;- Specified by:
getTokenin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- The token.
-
getSymbol
* A new symbol to use for the token. <p> This value, if set, MUST NOT exceed 100 bytes when encoded as UTF-8.<br/> This value, if set, MUST NOT contain the Unicode NUL codepoint.
string symbol = 2;- Specified by:
getSymbolin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- The symbol.
-
getSymbolBytes
public com.google.protobuf.ByteString getSymbolBytes()* A new symbol to use for the token. <p> This value, if set, MUST NOT exceed 100 bytes when encoded as UTF-8.<br/> This value, if set, MUST NOT contain the Unicode NUL codepoint.
string symbol = 2;- Specified by:
getSymbolBytesin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- The bytes for symbol.
-
getName
* A new name for the token.<br/> This is generally the "full name" displayed in wallet software. <p> This value, if set, MUST NOT exceed 100 bytes when encoded as UTF-8.<br/> This value, if set, MUST NOT contain the Unicode NUL codepoint.
string name = 3;- Specified by:
getNamein interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()* A new name for the token.<br/> This is generally the "full name" displayed in wallet software. <p> This value, if set, MUST NOT exceed 100 bytes when encoded as UTF-8.<br/> This value, if set, MUST NOT contain the Unicode NUL codepoint.
string name = 3;- Specified by:
getNameBytesin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- The bytes for name.
-
hasTreasury
public boolean hasTreasury()* A new treasury account identifier. <p> If set, - The identified account SHALL be designated the "treasury" for the token, and all tokens "minted" SHALL be delivered to that account following this transaction.<br/> - The identified account MUST exist, MUST NOT be expired, MUST NOT be deleted, and SHOULD have a non-zero HBAR balance.<br/> - The identified account SHALL be associated to this token. - The full balance of this token held by the prior treasury account SHALL be transferred to the new treasury account, if the token type is fungible/common. - If the token type is non-fungible/unique, the previous treasury account MUST NOT hold any tokens of this type. - The new treasury account key MUST sign this transaction.
.proto.AccountID treasury = 4;- Specified by:
hasTreasuryin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- Whether the treasury field is set.
-
getTreasury
* A new treasury account identifier. <p> If set, - The identified account SHALL be designated the "treasury" for the token, and all tokens "minted" SHALL be delivered to that account following this transaction.<br/> - The identified account MUST exist, MUST NOT be expired, MUST NOT be deleted, and SHOULD have a non-zero HBAR balance.<br/> - The identified account SHALL be associated to this token. - The full balance of this token held by the prior treasury account SHALL be transferred to the new treasury account, if the token type is fungible/common. - If the token type is non-fungible/unique, the previous treasury account MUST NOT hold any tokens of this type. - The new treasury account key MUST sign this transaction.
.proto.AccountID treasury = 4;- Specified by:
getTreasuryin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- The treasury.
-
hasAdminKey
public boolean hasAdminKey()* An Hedera key for token administration. <p> This key, if set, SHALL have administrative authority for this token and MAY authorize token update and/or token delete transactions.<br/> If this key is set to an empty `KeyList`, this token SHALL be immutable thereafter, except for expiration and renewal.<br/> If set, this key MUST be a valid key or an empty `KeyList`.<br/> If set to a valid key, the previous key and new key MUST both sign this transaction.
.proto.Key adminKey = 5;- Specified by:
hasAdminKeyin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- Whether the adminKey field is set.
-
getAdminKey
* An Hedera key for token administration. <p> This key, if set, SHALL have administrative authority for this token and MAY authorize token update and/or token delete transactions.<br/> If this key is set to an empty `KeyList`, this token SHALL be immutable thereafter, except for expiration and renewal.<br/> If set, this key MUST be a valid key or an empty `KeyList`.<br/> If set to a valid key, the previous key and new key MUST both sign this transaction.
.proto.Key adminKey = 5;- Specified by:
getAdminKeyin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- The adminKey.
-
hasKycKey
public boolean hasKycKey()* An Hedera key for managing account KYC. <p> This key, if set, SHALL have KYC authority for this token and MAY authorize transactions to grant or revoke KYC for accounts.<br/> If this key is not set, or is an empty `KeyList`, KYC status for this token SHALL NOT be granted or revoked for any account.<br/> If this key is removed after granting KYC, those grants SHALL remain and cannot be revoked.<br/> If set, this key MUST be a valid key or an empty `KeyList`.<br/> If set to a valid key, the previous key and new key MUST both sign this transaction.
.proto.Key kycKey = 6;- Specified by:
hasKycKeyin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- Whether the kycKey field is set.
-
getKycKey
* An Hedera key for managing account KYC. <p> This key, if set, SHALL have KYC authority for this token and MAY authorize transactions to grant or revoke KYC for accounts.<br/> If this key is not set, or is an empty `KeyList`, KYC status for this token SHALL NOT be granted or revoked for any account.<br/> If this key is removed after granting KYC, those grants SHALL remain and cannot be revoked.<br/> If set, this key MUST be a valid key or an empty `KeyList`.<br/> If set to a valid key, the previous key and new key MUST both sign this transaction.
.proto.Key kycKey = 6;- Specified by:
getKycKeyin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- The kycKey.
-
hasFreezeKey
public boolean hasFreezeKey()* An Hedera key for managing asset "freeze". <p> This key, if set, SHALL have "freeze" authority for this token and MAY authorize transactions to freeze or unfreeze accounts with respect to this token.<br/> If this key is set to an empty `KeyList`, this token SHALL NOT be frozen or unfrozen for any account.<br/> If this key is removed after freezing accounts, those accounts SHALL remain frozen and cannot be unfrozen.<br/> If set, this key MUST be a valid key or an empty `KeyList`.<br/> If set to a valid key, the previous key and new key MUST both sign this transaction.
.proto.Key freezeKey = 7;- Specified by:
hasFreezeKeyin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- Whether the freezeKey field is set.
-
getFreezeKey
* An Hedera key for managing asset "freeze". <p> This key, if set, SHALL have "freeze" authority for this token and MAY authorize transactions to freeze or unfreeze accounts with respect to this token.<br/> If this key is set to an empty `KeyList`, this token SHALL NOT be frozen or unfrozen for any account.<br/> If this key is removed after freezing accounts, those accounts SHALL remain frozen and cannot be unfrozen.<br/> If set, this key MUST be a valid key or an empty `KeyList`.<br/> If set to a valid key, the previous key and new key MUST both sign this transaction.
.proto.Key freezeKey = 7;- Specified by:
getFreezeKeyin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- The freezeKey.
-
hasWipeKey
public boolean hasWipeKey()* An Hedera key for wiping tokens from accounts. <p> This key, if set, SHALL have "wipe" authority for this token and MAY authorize transactions to "wipe" any amount of this token from any account, effectively burning the tokens "wiped".<br/> If this key is set to an empty `KeyList`, it SHALL NOT be possible to "wipe" this token from an account.<br/> If set, this key MUST be a valid key or an empty `KeyList`.<br/> If set to a valid key, the previous key and new key MUST both sign this transaction.
.proto.Key wipeKey = 8;- Specified by:
hasWipeKeyin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- Whether the wipeKey field is set.
-
getWipeKey
* An Hedera key for wiping tokens from accounts. <p> This key, if set, SHALL have "wipe" authority for this token and MAY authorize transactions to "wipe" any amount of this token from any account, effectively burning the tokens "wiped".<br/> If this key is set to an empty `KeyList`, it SHALL NOT be possible to "wipe" this token from an account.<br/> If set, this key MUST be a valid key or an empty `KeyList`.<br/> If set to a valid key, the previous key and new key MUST both sign this transaction.
.proto.Key wipeKey = 8;- Specified by:
getWipeKeyin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- The wipeKey.
-
hasSupplyKey
public boolean hasSupplyKey()* An Hedera key for "minting" and "burning" tokens. <p> This key, if set, MAY authorize transactions to "mint" new tokens to be delivered to the token treasury or "burn" tokens held by the token treasury.<br/> If this key is set to an empty `KeyList`, it SHALL NOT be possible to change the supply of tokens and neither "mint" nor "burn" transactions SHALL be permitted.<br/> If set, this key MUST be a valid key or an empty `KeyList`.<br/> If set to a valid key, the previous key and new key MUST both sign this transaction.
.proto.Key supplyKey = 9;- Specified by:
hasSupplyKeyin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- Whether the supplyKey field is set.
-
getSupplyKey
* An Hedera key for "minting" and "burning" tokens. <p> This key, if set, MAY authorize transactions to "mint" new tokens to be delivered to the token treasury or "burn" tokens held by the token treasury.<br/> If this key is set to an empty `KeyList`, it SHALL NOT be possible to change the supply of tokens and neither "mint" nor "burn" transactions SHALL be permitted.<br/> If set, this key MUST be a valid key or an empty `KeyList`.<br/> If set to a valid key, the previous key and new key MUST both sign this transaction.
.proto.Key supplyKey = 9;- Specified by:
getSupplyKeyin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- The supplyKey.
-
hasAutoRenewAccount
public boolean hasAutoRenewAccount()* An identifier for the account to be charged renewal fees at the token's expiry to extend the lifetime of the token. <p> If this value is set for the identified token, the token lifetime SHALL be extended by the _smallest_ of the following at expiration: <ul> <li>The current `autoRenewPeriod` duration.</li> <li>The maximum duration that this account has funds to purchase.</li> <li>The configured MAX_AUTORENEW_PERIOD at the time of automatic renewal.</li> </ul> If this account's HBAR balance is `0` when the token must be renewed, then the token SHALL be expired, and MAY be subsequently removed from state.<br/> If this value is set, the referenced account MUST sign this transaction. <p> <blockquote>Note<blockquote> It is not currently possible to remove an automatic renewal account. Once set, it can only be replaced by a valid account. </blockquote></blockquote>
.proto.AccountID autoRenewAccount = 10;- Specified by:
hasAutoRenewAccountin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- Whether the autoRenewAccount field is set.
-
getAutoRenewAccount
* An identifier for the account to be charged renewal fees at the token's expiry to extend the lifetime of the token. <p> If this value is set for the identified token, the token lifetime SHALL be extended by the _smallest_ of the following at expiration: <ul> <li>The current `autoRenewPeriod` duration.</li> <li>The maximum duration that this account has funds to purchase.</li> <li>The configured MAX_AUTORENEW_PERIOD at the time of automatic renewal.</li> </ul> If this account's HBAR balance is `0` when the token must be renewed, then the token SHALL be expired, and MAY be subsequently removed from state.<br/> If this value is set, the referenced account MUST sign this transaction. <p> <blockquote>Note<blockquote> It is not currently possible to remove an automatic renewal account. Once set, it can only be replaced by a valid account. </blockquote></blockquote>
.proto.AccountID autoRenewAccount = 10;- Specified by:
getAutoRenewAccountin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- The autoRenewAccount.
-
hasAutoRenewPeriod
public boolean hasAutoRenewPeriod()* A duration between token automatic renewals.<br/> All entities in state may be charged "rent" occasionally (typically every 90 days) to prevent unnecessary growth of the ledger. This value sets the interval between such events for this token. <p> If set, this value MUST be greater than the configured `MIN_AUTORENEW_PERIOD`.<br/> If set, this value MUST be less than the configured `MAX_AUTORENEW_PERIOD`.
.proto.Duration autoRenewPeriod = 11;- Specified by:
hasAutoRenewPeriodin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- Whether the autoRenewPeriod field is set.
-
getAutoRenewPeriod
* A duration between token automatic renewals.<br/> All entities in state may be charged "rent" occasionally (typically every 90 days) to prevent unnecessary growth of the ledger. This value sets the interval between such events for this token. <p> If set, this value MUST be greater than the configured `MIN_AUTORENEW_PERIOD`.<br/> If set, this value MUST be less than the configured `MAX_AUTORENEW_PERIOD`.
.proto.Duration autoRenewPeriod = 11;- Specified by:
getAutoRenewPeriodin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- The autoRenewPeriod.
-
hasExpiry
public boolean hasExpiry()* An expiration timestamp. <p> If this value is set, the automatic renewal account is not set for the identified token, and token expiration is enabled in network configuration, this token SHALL expire when the consensus time exceeds this value, and MAY be subsequently removed from the network state.<br/> If `autoRenewAccount` is set or the `auto_renew_account_id` is set for the identified token, the token SHALL be subject to automatic renewal when the consensus time exceeds this value.
.proto.Timestamp expiry = 12;- Specified by:
hasExpiryin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- Whether the expiry field is set.
-
getExpiry
* An expiration timestamp. <p> If this value is set, the automatic renewal account is not set for the identified token, and token expiration is enabled in network configuration, this token SHALL expire when the consensus time exceeds this value, and MAY be subsequently removed from the network state.<br/> If `autoRenewAccount` is set or the `auto_renew_account_id` is set for the identified token, the token SHALL be subject to automatic renewal when the consensus time exceeds this value.
.proto.Timestamp expiry = 12;- Specified by:
getExpiryin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- The expiry.
-
hasMemo
public boolean hasMemo()* A short description for this token. <p> This value, if set, MUST NOT exceed `transaction.maxMemoUtf8Bytes` (default 100) bytes when encoded as UTF-8.
.google.protobuf.StringValue memo = 13;- Specified by:
hasMemoin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- Whether the memo field is set.
-
getMemo
public com.google.protobuf.StringValue getMemo()* A short description for this token. <p> This value, if set, MUST NOT exceed `transaction.maxMemoUtf8Bytes` (default 100) bytes when encoded as UTF-8.
.google.protobuf.StringValue memo = 13;- Specified by:
getMemoin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- The memo.
-
hasFeeScheduleKey
public boolean hasFeeScheduleKey()* An Hedera key for managing the token custom fee schedule. <p> This key, if set, MAY authorize transactions to modify the `custom_fees` for this token.<br/> If this key is set to an empty `KeyList`, the `custom_fees` for this token SHALL NOT be modified.<br/> If set, this key MUST be a valid key or an empty `KeyList`.<br/> If set to a valid key, the previous key and new key MUST both sign this transaction.
.proto.Key fee_schedule_key = 14;- Specified by:
hasFeeScheduleKeyin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- Whether the feeScheduleKey field is set.
-
getFeeScheduleKey
* An Hedera key for managing the token custom fee schedule. <p> This key, if set, MAY authorize transactions to modify the `custom_fees` for this token.<br/> If this key is set to an empty `KeyList`, the `custom_fees` for this token SHALL NOT be modified.<br/> If set, this key MUST be a valid key or an empty `KeyList`.<br/> If set to a valid key, the previous key and new key MUST both sign this transaction.
.proto.Key fee_schedule_key = 14;- Specified by:
getFeeScheduleKeyin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- The feeScheduleKey.
-
hasPauseKey
public boolean hasPauseKey()* An Hedera key for managing token "pause". <p> This key, if set, SHALL have "pause" authority for this token and MAY authorize transactions to pause or unpause this token.<br/> If this key is set to an empty `KeyList`, this token SHALL NOT be paused or unpaused.<br/> If this key is removed while the token is paused, the token cannot be unpaused and SHALL remain paused.<br/> If set, this key MUST be a valid key or an empty `KeyList`.<br/> If set to a valid key, the previous key and new key MUST both sign this transaction.
.proto.Key pause_key = 15;- Specified by:
hasPauseKeyin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- Whether the pauseKey field is set.
-
getPauseKey
* An Hedera key for managing token "pause". <p> This key, if set, SHALL have "pause" authority for this token and MAY authorize transactions to pause or unpause this token.<br/> If this key is set to an empty `KeyList`, this token SHALL NOT be paused or unpaused.<br/> If this key is removed while the token is paused, the token cannot be unpaused and SHALL remain paused.<br/> If set, this key MUST be a valid key or an empty `KeyList`.<br/> If set to a valid key, the previous key and new key MUST both sign this transaction.
.proto.Key pause_key = 15;- Specified by:
getPauseKeyin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- The pauseKey.
-
hasMetadata
public boolean hasMetadata()* Token "Metadata". <p> The value, if set, MUST NOT exceed 100 bytes.<br/> <dl><dt>Examples</dt> <dd>hcs://1/0.0.4896575</dd> <dd>ipfs://bafkreifd7tcjjuwxxf4qkaibkj62pj4mhfuud7plwrc3pfoygt55al6syi</dd> </dl>
.google.protobuf.BytesValue metadata = 16;- Specified by:
hasMetadatain interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- Whether the metadata field is set.
-
getMetadata
public com.google.protobuf.BytesValue getMetadata()* Token "Metadata". <p> The value, if set, MUST NOT exceed 100 bytes.<br/> <dl><dt>Examples</dt> <dd>hcs://1/0.0.4896575</dd> <dd>ipfs://bafkreifd7tcjjuwxxf4qkaibkj62pj4mhfuud7plwrc3pfoygt55al6syi</dd> </dl>
.google.protobuf.BytesValue metadata = 16;- Specified by:
getMetadatain interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- The metadata.
-
hasMetadataKey
public boolean hasMetadataKey()* An Hedera key for managing the token `metadata`. <p> This key, if set, MAY authorize transactions to modify the `metadata` for this token.<br/> If this key is set to an empty `KeyList`, the `metadata` for this token SHALL NOT be modified.<br/> If set, this key MUST be a valid key or an empty `KeyList`.<br/> If set to a valid key, the previous key and new key MUST both sign this transaction.
.proto.Key metadata_key = 17;- Specified by:
hasMetadataKeyin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- Whether the metadataKey field is set.
-
getMetadataKey
* An Hedera key for managing the token `metadata`. <p> This key, if set, MAY authorize transactions to modify the `metadata` for this token.<br/> If this key is set to an empty `KeyList`, the `metadata` for this token SHALL NOT be modified.<br/> If set, this key MUST be a valid key or an empty `KeyList`.<br/> If set to a valid key, the previous key and new key MUST both sign this transaction.
.proto.Key metadata_key = 17;- Specified by:
getMetadataKeyin interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- The metadataKey.
-
getKeyVerificationModeValue
public int getKeyVerificationModeValue()* Set a key validation mode.<br/> Any key may be updated by a transaction signed by the token `admin_key`. Each role key may _also_ sign a transaction to update that key. If a role key signs an update to change that role key both old and new key must sign the transaction, _unless_ this field is set to `NO_VALIDATION`, in which case the _new_ key is not required to sign the transaction (the existing key is still required).<br/> The primary intent for this field is to allow a role key (e.g. a `pause_key`) holder to "remove" that key from the token by signing a transaction to set that role key to an empty `KeyList`. <p> If set to `FULL_VALIDATION`, either the `admin_key` or _both_ current and new key MUST sign this transaction to update a "key" field for the identified token.<br/> If set to `NO_VALIDATION`, either the `admin_key` or the current key MUST sign this transaction to update a "key" field for the identified token.<br/> This field SHALL be treated as `FULL_VALIDATION` if not set.
.proto.TokenKeyValidation key_verification_mode = 18;- Specified by:
getKeyVerificationModeValuein interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- The enum numeric value on the wire for keyVerificationMode.
-
getKeyVerificationMode
* Set a key validation mode.<br/> Any key may be updated by a transaction signed by the token `admin_key`. Each role key may _also_ sign a transaction to update that key. If a role key signs an update to change that role key both old and new key must sign the transaction, _unless_ this field is set to `NO_VALIDATION`, in which case the _new_ key is not required to sign the transaction (the existing key is still required).<br/> The primary intent for this field is to allow a role key (e.g. a `pause_key`) holder to "remove" that key from the token by signing a transaction to set that role key to an empty `KeyList`. <p> If set to `FULL_VALIDATION`, either the `admin_key` or _both_ current and new key MUST sign this transaction to update a "key" field for the identified token.<br/> If set to `NO_VALIDATION`, either the `admin_key` or the current key MUST sign this transaction to update a "key" field for the identified token.<br/> This field SHALL be treated as `FULL_VALIDATION` if not set.
.proto.TokenKeyValidation key_verification_mode = 18;- Specified by:
getKeyVerificationModein interfaceTokenUpdateTransactionBodyOrBuilder- Returns:
- The keyVerificationMode.
-
parseFrom
public static TokenUpdateTransactionBody parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TokenUpdateTransactionBody parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TokenUpdateTransactionBody parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TokenUpdateTransactionBody parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TokenUpdateTransactionBody parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TokenUpdateTransactionBody parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static TokenUpdateTransactionBody parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static TokenUpdateTransactionBody parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static TokenUpdateTransactionBody parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static TokenUpdateTransactionBody parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilder
-
newBuilder
-
dynamicMethod
protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1) - Specified by:
dynamicMethodin classcom.google.protobuf.GeneratedMessageLite<TokenUpdateTransactionBody,TokenUpdateTransactionBody.Builder>
-
getDefaultInstance
-
parser
-