com.hedera.hashgraph.sdk.proto.TokenInfoOrBuilder 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_get_info.proto
// Protobuf Java Version: 3.25.3
package com.hedera.hashgraph.sdk.proto;
public interface TokenInfoOrBuilder extends
// @@protoc_insertion_point(interface_extends:proto.TokenInfo)
com.google.protobuf.MessageOrBuilder {
/**
*
**
* ID of the token instance
*
*
* .proto.TokenID tokenId = 1;
* @return Whether the tokenId field is set.
*/
boolean hasTokenId();
/**
*
**
* ID of the token instance
*
*
* .proto.TokenID tokenId = 1;
* @return The tokenId.
*/
com.hedera.hashgraph.sdk.proto.TokenID getTokenId();
/**
*
**
* ID of the token instance
*
*
* .proto.TokenID tokenId = 1;
*/
com.hedera.hashgraph.sdk.proto.TokenIDOrBuilder getTokenIdOrBuilder();
/**
*
**
* The name of the token. It is a string of ASCII only characters
*
*
* string name = 2;
* @return The name.
*/
java.lang.String getName();
/**
*
**
* The name of the token. It is a string of ASCII only characters
*
*
* string name = 2;
* @return The bytes for name.
*/
com.google.protobuf.ByteString
getNameBytes();
/**
*
**
* The symbol of the token. It is a UTF-8 capitalized alphabetical string
*
*
* string symbol = 3;
* @return The symbol.
*/
java.lang.String getSymbol();
/**
*
**
* The symbol of the token. It is a UTF-8 capitalized alphabetical string
*
*
* string symbol = 3;
* @return The bytes for symbol.
*/
com.google.protobuf.ByteString
getSymbolBytes();
/**
*
**
* The number of decimal places a token is divisible by. Always 0 for tokens of type
* NON_FUNGIBLE_UNIQUE
*
*
* uint32 decimals = 4;
* @return The decimals.
*/
int getDecimals();
/**
*
**
* For tokens of type FUNGIBLE_COMMON - the total supply of tokens that are currently in
* circulation. For tokens of type NON_FUNGIBLE_UNIQUE - the number of NFTs created of this
* token instance
*
*
* uint64 totalSupply = 5;
* @return The totalSupply.
*/
long getTotalSupply();
/**
*
**
* The ID of the account which is set as Treasury
*
*
* .proto.AccountID treasury = 6;
* @return Whether the treasury field is set.
*/
boolean hasTreasury();
/**
*
**
* The ID of the account which is set as Treasury
*
*
* .proto.AccountID treasury = 6;
* @return The treasury.
*/
com.hedera.hashgraph.sdk.proto.AccountID getTreasury();
/**
*
**
* The ID of the account which is set as Treasury
*
*
* .proto.AccountID treasury = 6;
*/
com.hedera.hashgraph.sdk.proto.AccountIDOrBuilder getTreasuryOrBuilder();
/**
*
**
* The key which can perform update/delete operations on the token. If empty, the token can be
* perceived as immutable (not being able to be updated/deleted)
*
*
* .proto.Key adminKey = 7;
* @return Whether the adminKey field is set.
*/
boolean hasAdminKey();
/**
*
**
* The key which can perform update/delete operations on the token. If empty, the token can be
* perceived as immutable (not being able to be updated/deleted)
*
*
* .proto.Key adminKey = 7;
* @return The adminKey.
*/
com.hedera.hashgraph.sdk.proto.Key getAdminKey();
/**
*
**
* The key which can perform update/delete operations on the token. If empty, the token can be
* perceived as immutable (not being able to be updated/deleted)
*
*
* .proto.Key adminKey = 7;
*/
com.hedera.hashgraph.sdk.proto.KeyOrBuilder getAdminKeyOrBuilder();
/**
*
**
* The key which can grant or revoke KYC of an account for the token's transactions. If empty,
* KYC is not required, and KYC grant or revoke operations are not possible.
*
*
* .proto.Key kycKey = 8;
* @return Whether the kycKey field is set.
*/
boolean hasKycKey();
/**
*
**
* The key which can grant or revoke KYC of an account for the token's transactions. If empty,
* KYC is not required, and KYC grant or revoke operations are not possible.
*
*
* .proto.Key kycKey = 8;
* @return The kycKey.
*/
com.hedera.hashgraph.sdk.proto.Key getKycKey();
/**
*
**
* The key which can grant or revoke KYC of an account for the token's transactions. If empty,
* KYC is not required, and KYC grant or revoke operations are not possible.
*
*
* .proto.Key kycKey = 8;
*/
com.hedera.hashgraph.sdk.proto.KeyOrBuilder getKycKeyOrBuilder();
/**
*
**
* The key which can freeze or unfreeze an account for token transactions. If empty, freezing is
* not possible
*
*
* .proto.Key freezeKey = 9;
* @return Whether the freezeKey field is set.
*/
boolean hasFreezeKey();
/**
*
**
* The key which can freeze or unfreeze an account for token transactions. If empty, freezing is
* not possible
*
*
* .proto.Key freezeKey = 9;
* @return The freezeKey.
*/
com.hedera.hashgraph.sdk.proto.Key getFreezeKey();
/**
*
**
* The key which can freeze or unfreeze an account for token transactions. If empty, freezing is
* not possible
*
*
* .proto.Key freezeKey = 9;
*/
com.hedera.hashgraph.sdk.proto.KeyOrBuilder getFreezeKeyOrBuilder();
/**
*
**
* The key which can wipe token balance of an account. If empty, wipe is not possible
*
*
* .proto.Key wipeKey = 10;
* @return Whether the wipeKey field is set.
*/
boolean hasWipeKey();
/**
*
**
* The key which can wipe token balance of an account. If empty, wipe is not possible
*
*
* .proto.Key wipeKey = 10;
* @return The wipeKey.
*/
com.hedera.hashgraph.sdk.proto.Key getWipeKey();
/**
*
**
* The key which can wipe token balance of an account. If empty, wipe is not possible
*
*
* .proto.Key wipeKey = 10;
*/
com.hedera.hashgraph.sdk.proto.KeyOrBuilder getWipeKeyOrBuilder();
/**
*
**
* The key which can change the supply of a token. The key is used to sign Token Mint/Burn
* operations
*
*
* .proto.Key supplyKey = 11;
* @return Whether the supplyKey field is set.
*/
boolean hasSupplyKey();
/**
*
**
* The key which can change the supply of a token. The key is used to sign Token Mint/Burn
* operations
*
*
* .proto.Key supplyKey = 11;
* @return The supplyKey.
*/
com.hedera.hashgraph.sdk.proto.Key getSupplyKey();
/**
*
**
* The key which can change the supply of a token. The key is used to sign Token Mint/Burn
* operations
*
*
* .proto.Key supplyKey = 11;
*/
com.hedera.hashgraph.sdk.proto.KeyOrBuilder getSupplyKeyOrBuilder();
/**
*
**
* The default Freeze status (not applicable, frozen or unfrozen) of Hedera accounts relative to
* this token. FreezeNotApplicable is returned if Token Freeze Key is empty. Frozen is returned
* if Token Freeze Key is set and defaultFreeze is set to true. Unfrozen is returned if Token
* Freeze Key is set and defaultFreeze is set to false
*
*
* .proto.TokenFreezeStatus defaultFreezeStatus = 12;
* @return The enum numeric value on the wire for defaultFreezeStatus.
*/
int getDefaultFreezeStatusValue();
/**
*
**
* The default Freeze status (not applicable, frozen or unfrozen) of Hedera accounts relative to
* this token. FreezeNotApplicable is returned if Token Freeze Key is empty. Frozen is returned
* if Token Freeze Key is set and defaultFreeze is set to true. Unfrozen is returned if Token
* Freeze Key is set and defaultFreeze is set to false
*
*
* .proto.TokenFreezeStatus defaultFreezeStatus = 12;
* @return The defaultFreezeStatus.
*/
com.hedera.hashgraph.sdk.proto.TokenFreezeStatus getDefaultFreezeStatus();
/**
*
**
* The default KYC status (KycNotApplicable or Revoked) of Hedera accounts relative to this
* token. KycNotApplicable is returned if KYC key is not set, otherwise Revoked
*
*
* .proto.TokenKycStatus defaultKycStatus = 13;
* @return The enum numeric value on the wire for defaultKycStatus.
*/
int getDefaultKycStatusValue();
/**
*
**
* The default KYC status (KycNotApplicable or Revoked) of Hedera accounts relative to this
* token. KycNotApplicable is returned if KYC key is not set, otherwise Revoked
*
*
* .proto.TokenKycStatus defaultKycStatus = 13;
* @return The defaultKycStatus.
*/
com.hedera.hashgraph.sdk.proto.TokenKycStatus getDefaultKycStatus();
/**
*
**
* Specifies whether the token was deleted or not
*
*
* bool deleted = 14;
* @return The deleted.
*/
boolean getDeleted();
/**
*
**
* An account which will be automatically charged to renew the token's expiration, at
* autoRenewPeriod interval
*
*
* .proto.AccountID autoRenewAccount = 15;
* @return Whether the autoRenewAccount field is set.
*/
boolean hasAutoRenewAccount();
/**
*
**
* An account which will be automatically charged to renew the token's expiration, at
* autoRenewPeriod interval
*
*
* .proto.AccountID autoRenewAccount = 15;
* @return The autoRenewAccount.
*/
com.hedera.hashgraph.sdk.proto.AccountID getAutoRenewAccount();
/**
*
**
* An account which will be automatically charged to renew the token's expiration, at
* autoRenewPeriod interval
*
*
* .proto.AccountID autoRenewAccount = 15;
*/
com.hedera.hashgraph.sdk.proto.AccountIDOrBuilder getAutoRenewAccountOrBuilder();
/**
*
**
* The interval at which the auto-renew account will be charged to extend the token's expiry
*
*
* .proto.Duration autoRenewPeriod = 16;
* @return Whether the autoRenewPeriod field is set.
*/
boolean hasAutoRenewPeriod();
/**
*
**
* The interval at which the auto-renew account will be charged to extend the token's expiry
*
*
* .proto.Duration autoRenewPeriod = 16;
* @return The autoRenewPeriod.
*/
com.hedera.hashgraph.sdk.proto.Duration getAutoRenewPeriod();
/**
*
**
* The interval at which the auto-renew account will be charged to extend the token's expiry
*
*
* .proto.Duration autoRenewPeriod = 16;
*/
com.hedera.hashgraph.sdk.proto.DurationOrBuilder getAutoRenewPeriodOrBuilder();
/**
*
**
* The epoch second at which the token will expire
*
*
* .proto.Timestamp expiry = 17;
* @return Whether the expiry field is set.
*/
boolean hasExpiry();
/**
*
**
* The epoch second at which the token will expire
*
*
* .proto.Timestamp expiry = 17;
* @return The expiry.
*/
com.hedera.hashgraph.sdk.proto.Timestamp getExpiry();
/**
*
**
* The epoch second at which the token will expire
*
*
* .proto.Timestamp expiry = 17;
*/
com.hedera.hashgraph.sdk.proto.TimestampOrBuilder getExpiryOrBuilder();
/**
*
**
* The memo associated with the token
*
*
* string memo = 18;
* @return The memo.
*/
java.lang.String getMemo();
/**
*
**
* The memo associated with the token
*
*
* string memo = 18;
* @return The bytes for memo.
*/
com.google.protobuf.ByteString
getMemoBytes();
/**
*
**
* The token type
*
*
* .proto.TokenType tokenType = 19;
* @return The enum numeric value on the wire for tokenType.
*/
int getTokenTypeValue();
/**
*
**
* The token type
*
*
* .proto.TokenType tokenType = 19;
* @return The tokenType.
*/
com.hedera.hashgraph.sdk.proto.TokenType getTokenType();
/**
*
**
* The token supply type
*
*
* .proto.TokenSupplyType supplyType = 20;
* @return The enum numeric value on the wire for supplyType.
*/
int getSupplyTypeValue();
/**
*
**
* The token supply type
*
*
* .proto.TokenSupplyType supplyType = 20;
* @return The supplyType.
*/
com.hedera.hashgraph.sdk.proto.TokenSupplyType getSupplyType();
/**
*
**
* For tokens of type FUNGIBLE_COMMON - The Maximum number of fungible tokens that can be in
* circulation. For tokens of type NON_FUNGIBLE_UNIQUE - the maximum number of NFTs (serial
* numbers) that can be in circulation
*
*
* int64 maxSupply = 21;
* @return The maxSupply.
*/
long getMaxSupply();
/**
*
**
* The key which can change the custom fee schedule of the token; if not set, the fee schedule
* is immutable
*
*
* .proto.Key fee_schedule_key = 22;
* @return Whether the feeScheduleKey field is set.
*/
boolean hasFeeScheduleKey();
/**
*
**
* The key which can change the custom fee schedule of the token; if not set, the fee schedule
* is immutable
*
*
* .proto.Key fee_schedule_key = 22;
* @return The feeScheduleKey.
*/
com.hedera.hashgraph.sdk.proto.Key getFeeScheduleKey();
/**
*
**
* The key which can change the custom fee schedule of the token; if not set, the fee schedule
* is immutable
*
*
* .proto.Key fee_schedule_key = 22;
*/
com.hedera.hashgraph.sdk.proto.KeyOrBuilder getFeeScheduleKeyOrBuilder();
/**
*
**
* The custom fees to be assessed during a CryptoTransfer that transfers units of this token
*
*
* repeated .proto.CustomFee custom_fees = 23;
*/
java.util.List
getCustomFeesList();
/**
*
**
* The custom fees to be assessed during a CryptoTransfer that transfers units of this token
*
*
* repeated .proto.CustomFee custom_fees = 23;
*/
com.hedera.hashgraph.sdk.proto.CustomFee getCustomFees(int index);
/**
*
**
* The custom fees to be assessed during a CryptoTransfer that transfers units of this token
*
*
* repeated .proto.CustomFee custom_fees = 23;
*/
int getCustomFeesCount();
/**
*
**
* The custom fees to be assessed during a CryptoTransfer that transfers units of this token
*
*
* repeated .proto.CustomFee custom_fees = 23;
*/
java.util.List
getCustomFeesOrBuilderList();
/**
*
**
* The custom fees to be assessed during a CryptoTransfer that transfers units of this token
*
*
* repeated .proto.CustomFee custom_fees = 23;
*/
com.hedera.hashgraph.sdk.proto.CustomFeeOrBuilder getCustomFeesOrBuilder(
int index);
/**
*
**
* The Key which can pause and unpause the Token.
*
*
* .proto.Key pause_key = 24;
* @return Whether the pauseKey field is set.
*/
boolean hasPauseKey();
/**
*
**
* The Key which can pause and unpause the Token.
*
*
* .proto.Key pause_key = 24;
* @return The pauseKey.
*/
com.hedera.hashgraph.sdk.proto.Key getPauseKey();
/**
*
**
* The Key which can pause and unpause the Token.
*
*
* .proto.Key pause_key = 24;
*/
com.hedera.hashgraph.sdk.proto.KeyOrBuilder getPauseKeyOrBuilder();
/**
*
**
* Specifies whether the token is paused or not. PauseNotApplicable is returned if pauseKey is not set.
*
*
* .proto.TokenPauseStatus pause_status = 25;
* @return The enum numeric value on the wire for pauseStatus.
*/
int getPauseStatusValue();
/**
*
**
* Specifies whether the token is paused or not. PauseNotApplicable is returned if pauseKey is not set.
*
*
* .proto.TokenPauseStatus pause_status = 25;
* @return The pauseStatus.
*/
com.hedera.hashgraph.sdk.proto.TokenPauseStatus getPauseStatus();
/**
*
**
* The ledger ID the response was returned from; please see <a href="https://github.com/hashgraph/hedera-improvement-proposal/blob/master/HIP/hip-198.md">HIP-198</a> for the network-specific IDs.
*
*
* bytes ledger_id = 26;
* @return The ledgerId.
*/
com.google.protobuf.ByteString getLedgerId();
/**
*
**
* Represents the metadata of the token definition.
*
*
* bytes metadata = 27;
* @return The metadata.
*/
com.google.protobuf.ByteString getMetadata();
/**
*
**
* The key which can change the metadata of a token
* (token definition and individual NFTs).
*
*
* .proto.Key metadata_key = 28;
* @return Whether the metadataKey field is set.
*/
boolean hasMetadataKey();
/**
*
**
* The key which can change the metadata of a token
* (token definition and individual NFTs).
*
*
* .proto.Key metadata_key = 28;
* @return The metadataKey.
*/
com.hedera.hashgraph.sdk.proto.Key getMetadataKey();
/**
*
**
* The key which can change the metadata of a token
* (token definition and individual NFTs).
*
*
* .proto.Key metadata_key = 28;
*/
com.hedera.hashgraph.sdk.proto.KeyOrBuilder getMetadataKeyOrBuilder();
}