com.hedera.hashgraph.sdk.proto.TokenUpdateTransactionBodyOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk-full Show documentation
Show all versions of sdk-full Show documentation
Hedera™ Hashgraph SDK for Java
The newest version!
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: token_update.proto
// Protobuf Java Version: 3.25.3
package com.hedera.hashgraph.sdk.proto;
public interface TokenUpdateTransactionBodyOrBuilder extends
// @@protoc_insertion_point(interface_extends:proto.TokenUpdateTransactionBody)
com.google.protobuf.MessageOrBuilder {
/**
*
**
* The Token to be updated
*
*
* .proto.TokenID token = 1;
* @return Whether the token field is set.
*/
boolean hasToken();
/**
*
**
* The Token to be updated
*
*
* .proto.TokenID token = 1;
* @return The token.
*/
com.hedera.hashgraph.sdk.proto.TokenID getToken();
/**
*
**
* The Token to be updated
*
*
* .proto.TokenID token = 1;
*/
com.hedera.hashgraph.sdk.proto.TokenIDOrBuilder getTokenOrBuilder();
/**
*
**
* The new publicly visible token symbol. The token symbol is specified as a Unicode string.
* Its UTF-8 encoding cannot exceed 100 bytes, and cannot contain the 0 byte (NUL).
*
*
* string symbol = 2;
* @return The symbol.
*/
java.lang.String getSymbol();
/**
*
**
* The new publicly visible token symbol. The token symbol is specified as a Unicode string.
* Its UTF-8 encoding cannot exceed 100 bytes, and cannot contain the 0 byte (NUL).
*
*
* string symbol = 2;
* @return The bytes for symbol.
*/
com.google.protobuf.ByteString
getSymbolBytes();
/**
*
**
* The new publicly visible name of the token. The token name is specified as a Unicode string.
* Its UTF-8 encoding cannot exceed 100 bytes, and cannot contain the 0 byte (NUL).
*
*
* string name = 3;
* @return The name.
*/
java.lang.String getName();
/**
*
**
* The new publicly visible name of the token. The token name is specified as a Unicode string.
* Its UTF-8 encoding cannot exceed 100 bytes, and cannot contain the 0 byte (NUL).
*
*
* string name = 3;
* @return The bytes for name.
*/
com.google.protobuf.ByteString
getNameBytes();
/**
*
**
* The new Treasury account of the Token. If the provided treasury account is not existing or
* deleted, the response will be INVALID_TREASURY_ACCOUNT_FOR_TOKEN. If successful, the Token
* balance held in the previous Treasury Account is transferred to the new one.
*
*
* .proto.AccountID treasury = 4;
* @return Whether the treasury field is set.
*/
boolean hasTreasury();
/**
*
**
* The new Treasury account of the Token. If the provided treasury account is not existing or
* deleted, the response will be INVALID_TREASURY_ACCOUNT_FOR_TOKEN. If successful, the Token
* balance held in the previous Treasury Account is transferred to the new one.
*
*
* .proto.AccountID treasury = 4;
* @return The treasury.
*/
com.hedera.hashgraph.sdk.proto.AccountID getTreasury();
/**
*
**
* The new Treasury account of the Token. If the provided treasury account is not existing or
* deleted, the response will be INVALID_TREASURY_ACCOUNT_FOR_TOKEN. If successful, the Token
* balance held in the previous Treasury Account is transferred to the new one.
*
*
* .proto.AccountID treasury = 4;
*/
com.hedera.hashgraph.sdk.proto.AccountIDOrBuilder getTreasuryOrBuilder();
/**
*
**
* The new admin key of the Token. If Token is immutable, transaction will resolve to
* TOKEN_IS_IMMUTABlE.
*
*
* .proto.Key adminKey = 5;
* @return Whether the adminKey field is set.
*/
boolean hasAdminKey();
/**
*
**
* The new admin key of the Token. If Token is immutable, transaction will resolve to
* TOKEN_IS_IMMUTABlE.
*
*
* .proto.Key adminKey = 5;
* @return The adminKey.
*/
com.hedera.hashgraph.sdk.proto.Key getAdminKey();
/**
*
**
* The new admin key of the Token. If Token is immutable, transaction will resolve to
* TOKEN_IS_IMMUTABlE.
*
*
* .proto.Key adminKey = 5;
*/
com.hedera.hashgraph.sdk.proto.KeyOrBuilder getAdminKeyOrBuilder();
/**
*
**
* The new KYC key of the Token. If Token does not have currently a KYC key, transaction will
* resolve to TOKEN_HAS_NO_KYC_KEY.
*
*
* .proto.Key kycKey = 6;
* @return Whether the kycKey field is set.
*/
boolean hasKycKey();
/**
*
**
* The new KYC key of the Token. If Token does not have currently a KYC key, transaction will
* resolve to TOKEN_HAS_NO_KYC_KEY.
*
*
* .proto.Key kycKey = 6;
* @return The kycKey.
*/
com.hedera.hashgraph.sdk.proto.Key getKycKey();
/**
*
**
* The new KYC key of the Token. If Token does not have currently a KYC key, transaction will
* resolve to TOKEN_HAS_NO_KYC_KEY.
*
*
* .proto.Key kycKey = 6;
*/
com.hedera.hashgraph.sdk.proto.KeyOrBuilder getKycKeyOrBuilder();
/**
*
**
* The new Freeze key of the Token. If the Token does not have currently a Freeze key,
* transaction will resolve to TOKEN_HAS_NO_FREEZE_KEY.
*
*
* .proto.Key freezeKey = 7;
* @return Whether the freezeKey field is set.
*/
boolean hasFreezeKey();
/**
*
**
* The new Freeze key of the Token. If the Token does not have currently a Freeze key,
* transaction will resolve to TOKEN_HAS_NO_FREEZE_KEY.
*
*
* .proto.Key freezeKey = 7;
* @return The freezeKey.
*/
com.hedera.hashgraph.sdk.proto.Key getFreezeKey();
/**
*
**
* The new Freeze key of the Token. If the Token does not have currently a Freeze key,
* transaction will resolve to TOKEN_HAS_NO_FREEZE_KEY.
*
*
* .proto.Key freezeKey = 7;
*/
com.hedera.hashgraph.sdk.proto.KeyOrBuilder getFreezeKeyOrBuilder();
/**
*
**
* The new Wipe key of the Token. If the Token does not have currently a Wipe key, transaction
* will resolve to TOKEN_HAS_NO_WIPE_KEY.
*
*
* .proto.Key wipeKey = 8;
* @return Whether the wipeKey field is set.
*/
boolean hasWipeKey();
/**
*
**
* The new Wipe key of the Token. If the Token does not have currently a Wipe key, transaction
* will resolve to TOKEN_HAS_NO_WIPE_KEY.
*
*
* .proto.Key wipeKey = 8;
* @return The wipeKey.
*/
com.hedera.hashgraph.sdk.proto.Key getWipeKey();
/**
*
**
* The new Wipe key of the Token. If the Token does not have currently a Wipe key, transaction
* will resolve to TOKEN_HAS_NO_WIPE_KEY.
*
*
* .proto.Key wipeKey = 8;
*/
com.hedera.hashgraph.sdk.proto.KeyOrBuilder getWipeKeyOrBuilder();
/**
*
**
* The new Supply key of the Token. If the Token does not have currently a Supply key,
* transaction will resolve to TOKEN_HAS_NO_SUPPLY_KEY.
*
*
* .proto.Key supplyKey = 9;
* @return Whether the supplyKey field is set.
*/
boolean hasSupplyKey();
/**
*
**
* The new Supply key of the Token. If the Token does not have currently a Supply key,
* transaction will resolve to TOKEN_HAS_NO_SUPPLY_KEY.
*
*
* .proto.Key supplyKey = 9;
* @return The supplyKey.
*/
com.hedera.hashgraph.sdk.proto.Key getSupplyKey();
/**
*
**
* The new Supply key of the Token. If the Token does not have currently a Supply key,
* transaction will resolve to TOKEN_HAS_NO_SUPPLY_KEY.
*
*
* .proto.Key supplyKey = 9;
*/
com.hedera.hashgraph.sdk.proto.KeyOrBuilder getSupplyKeyOrBuilder();
/**
*
**
* The new account which will be automatically charged to renew the token's expiration, at
* autoRenewPeriod interval.
*
*
* .proto.AccountID autoRenewAccount = 10;
* @return Whether the autoRenewAccount field is set.
*/
boolean hasAutoRenewAccount();
/**
*
**
* The new account which will be automatically charged to renew the token's expiration, at
* autoRenewPeriod interval.
*
*
* .proto.AccountID autoRenewAccount = 10;
* @return The autoRenewAccount.
*/
com.hedera.hashgraph.sdk.proto.AccountID getAutoRenewAccount();
/**
*
**
* The new account which will be automatically charged to renew the token's expiration, at
* autoRenewPeriod interval.
*
*
* .proto.AccountID autoRenewAccount = 10;
*/
com.hedera.hashgraph.sdk.proto.AccountIDOrBuilder getAutoRenewAccountOrBuilder();
/**
*
**
* The new interval at which the auto-renew account will be charged to extend the token's
* expiry.
*
*
* .proto.Duration autoRenewPeriod = 11;
* @return Whether the autoRenewPeriod field is set.
*/
boolean hasAutoRenewPeriod();
/**
*
**
* The new interval at which the auto-renew account will be charged to extend the token's
* expiry.
*
*
* .proto.Duration autoRenewPeriod = 11;
* @return The autoRenewPeriod.
*/
com.hedera.hashgraph.sdk.proto.Duration getAutoRenewPeriod();
/**
*
**
* The new interval at which the auto-renew account will be charged to extend the token's
* expiry.
*
*
* .proto.Duration autoRenewPeriod = 11;
*/
com.hedera.hashgraph.sdk.proto.DurationOrBuilder getAutoRenewPeriodOrBuilder();
/**
*
**
* The new expiry time of the token. Expiry can be updated even if admin key is not set. If the
* provided expiry is earlier than the current token expiry, transaction wil resolve to
* INVALID_EXPIRATION_TIME
*
*
* .proto.Timestamp expiry = 12;
* @return Whether the expiry field is set.
*/
boolean hasExpiry();
/**
*
**
* The new expiry time of the token. Expiry can be updated even if admin key is not set. If the
* provided expiry is earlier than the current token expiry, transaction wil resolve to
* INVALID_EXPIRATION_TIME
*
*
* .proto.Timestamp expiry = 12;
* @return The expiry.
*/
com.hedera.hashgraph.sdk.proto.Timestamp getExpiry();
/**
*
**
* The new expiry time of the token. Expiry can be updated even if admin key is not set. If the
* provided expiry is earlier than the current token expiry, transaction wil resolve to
* INVALID_EXPIRATION_TIME
*
*
* .proto.Timestamp expiry = 12;
*/
com.hedera.hashgraph.sdk.proto.TimestampOrBuilder getExpiryOrBuilder();
/**
*
**
* If set, the new memo to be associated with the token (UTF-8 encoding max 100 bytes)
*
*
* .google.protobuf.StringValue memo = 13;
* @return Whether the memo field is set.
*/
boolean hasMemo();
/**
*
**
* If set, the new memo to be associated with the token (UTF-8 encoding max 100 bytes)
*
*
* .google.protobuf.StringValue memo = 13;
* @return The memo.
*/
com.google.protobuf.StringValue getMemo();
/**
*
**
* If set, the new memo to be associated with the token (UTF-8 encoding max 100 bytes)
*
*
* .google.protobuf.StringValue memo = 13;
*/
com.google.protobuf.StringValueOrBuilder getMemoOrBuilder();
/**
*
**
* If set, the new key to use to update the token's custom fee schedule; if the token does not
* currently have this key, transaction will resolve to TOKEN_HAS_NO_FEE_SCHEDULE_KEY
*
*
* .proto.Key fee_schedule_key = 14;
* @return Whether the feeScheduleKey field is set.
*/
boolean hasFeeScheduleKey();
/**
*
**
* If set, the new key to use to update the token's custom fee schedule; if the token does not
* currently have this key, transaction will resolve to TOKEN_HAS_NO_FEE_SCHEDULE_KEY
*
*
* .proto.Key fee_schedule_key = 14;
* @return The feeScheduleKey.
*/
com.hedera.hashgraph.sdk.proto.Key getFeeScheduleKey();
/**
*
**
* If set, the new key to use to update the token's custom fee schedule; if the token does not
* currently have this key, transaction will resolve to TOKEN_HAS_NO_FEE_SCHEDULE_KEY
*
*
* .proto.Key fee_schedule_key = 14;
*/
com.hedera.hashgraph.sdk.proto.KeyOrBuilder getFeeScheduleKeyOrBuilder();
/**
*
**
* The Key which can pause and unpause the Token. If the Token does not currently have a pause key,
* transaction will resolve to TOKEN_HAS_NO_PAUSE_KEY
*
*
* .proto.Key pause_key = 15;
* @return Whether the pauseKey field is set.
*/
boolean hasPauseKey();
/**
*
**
* The Key which can pause and unpause the Token. If the Token does not currently have a pause key,
* transaction will resolve to TOKEN_HAS_NO_PAUSE_KEY
*
*
* .proto.Key pause_key = 15;
* @return The pauseKey.
*/
com.hedera.hashgraph.sdk.proto.Key getPauseKey();
/**
*
**
* The Key which can pause and unpause the Token. If the Token does not currently have a pause key,
* transaction will resolve to TOKEN_HAS_NO_PAUSE_KEY
*
*
* .proto.Key pause_key = 15;
*/
com.hedera.hashgraph.sdk.proto.KeyOrBuilder getPauseKeyOrBuilder();
/**
*
**
* Metadata of the created token definition
*
*
* .google.protobuf.BytesValue metadata = 16;
* @return Whether the metadata field is set.
*/
boolean hasMetadata();
/**
*
**
* Metadata of the created token definition
*
*
* .google.protobuf.BytesValue metadata = 16;
* @return The metadata.
*/
com.google.protobuf.BytesValue getMetadata();
/**
*
**
* Metadata of the created token definition
*
*
* .google.protobuf.BytesValue metadata = 16;
*/
com.google.protobuf.BytesValueOrBuilder getMetadataOrBuilder();
/**
*
**
* The key which can change the metadata of a token
* (token definition, partition definition, and individual NFTs).
* If the Token does not have currently a Metadata key,
* transaction will resolve to TOKEN_HAS_NO_METADATA_KEY
*
*
* .proto.Key metadata_key = 17;
* @return Whether the metadataKey field is set.
*/
boolean hasMetadataKey();
/**
*
**
* The key which can change the metadata of a token
* (token definition, partition definition, and individual NFTs).
* If the Token does not have currently a Metadata key,
* transaction will resolve to TOKEN_HAS_NO_METADATA_KEY
*
*
* .proto.Key metadata_key = 17;
* @return The metadataKey.
*/
com.hedera.hashgraph.sdk.proto.Key getMetadataKey();
/**
*
**
* The key which can change the metadata of a token
* (token definition, partition definition, and individual NFTs).
* If the Token does not have currently a Metadata key,
* transaction will resolve to TOKEN_HAS_NO_METADATA_KEY
*
*
* .proto.Key metadata_key = 17;
*/
com.hedera.hashgraph.sdk.proto.KeyOrBuilder getMetadataKeyOrBuilder();
/**
*
**
* Determines whether the system should check the validity of the passed keys for update.
*
*
* .proto.TokenKeyValidation key_verification_mode = 18;
* @return The enum numeric value on the wire for keyVerificationMode.
*/
int getKeyVerificationModeValue();
/**
*
**
* Determines whether the system should check the validity of the passed keys for update.
*
*
* .proto.TokenKeyValidation key_verification_mode = 18;
* @return The keyVerificationMode.
*/
com.hedera.hashgraph.sdk.proto.TokenKeyValidation getKeyVerificationMode();
}