Module com.hedera.hashgraph.sdk

Package com.hedera.hashgraph.sdk

Class TokenPauseTransaction

java.lang.Object

com.hedera.hashgraph.sdk.Executable<TokenPauseTransaction,Transaction,TransactionResponse,TransactionResponse>

com.hedera.hashgraph.sdk.Transaction<TokenPauseTransaction>

com.hedera.hashgraph.sdk.TokenPauseTransaction

public class TokenPauseTransaction
extends Transaction<TokenPauseTransaction>

Pause transaction activity for a token. This transaction MUST be signed by the Token `pause_key`.
The `token` identified MUST exist, and MUST NOT be deleted.
The `token` identified MAY be paused; if the token is already paused, this transaction SHALL have no effect. The `token` identified MUST have a `pause_key` set, the `pause_key` MUST be a valid `Key`, and the `pause_key` MUST NOT be an empty `KeyList`.
A `paused` token SHALL NOT be transferred or otherwise modified except to "up-pause" the token with `unpauseToken` or in a `rejectToken` transaction. ### Block Stream Effects None

Nested Class Summary

Nested classes/interfaces inherited from class com.hedera.hashgraph.sdk.Transaction

Transaction.SignableNodeTransactionBodyBytes

Nested classes/interfaces inherited from class com.hedera.hashgraph.sdk.Executable

Executable.GrpcRequest

Field Summary

Fields inherited from class com.hedera.hashgraph.sdk.Transaction

customFeeLimits, DEFAULT_AUTO_RENEW_PERIOD, defaultMaxTransactionFee, DUMMY_ACCOUNT_ID, DUMMY_TRANSACTION_ID, frozenBodyBuilder, innerSignedTransactions, outerTransactions, publicKeys, regenerateTransactionId, signers, sigPairLists, sourceTransactionBody, transactionIds

Fields inherited from class com.hedera.hashgraph.sdk.Executable

attemptedAllNodes, blockingUnaryCall, grpcDeadline, logger, maxAttempts, maxBackoff, minBackoff, nodeAccountIds, nodes, random, RST_STREAM

Constructor Summary

Constructors

Constructor	Description
TokenPauseTransaction()	Constructor.
TokenPauseTransaction(TransactionBody txBody)	Constructor.
TokenPauseTransaction(LinkedHashMap<TransactionId,LinkedHashMap<AccountId,Transaction>> txs)	Constructor.

Method Summary

Modifier and Type	Method	Description
(package private) TokenPauseTransactionBody.Builder	build()	Build the transaction body.
(package private) io.grpc.MethodDescriptor<Transaction,TransactionResponse>	getMethodDescriptor()	Called to direct the invocation of the query to the appropriate gRPC service.
TokenId	getTokenId()	Extract the token id.
(package private) void	initFromTransactionBody()
(package private) void	onFreeze(TransactionBody.Builder bodyBuilder)	Called in Transaction.freezeWith(Client) just before the transaction body is built.
(package private) void	onScheduled(SchedulableTransactionBody.Builder scheduled)	Called in Transaction.schedule() when converting transaction into a scheduled version.
TokenPauseTransaction	setTokenId(TokenId tokenId)	A token identifier.
(package private) void	validateChecksums(Client client)

Methods inherited from class com.hedera.hashgraph.sdk.Transaction

addSignature, addSignature, batchify, buildAllTransactions, buildTransaction, doSchedule, estimateFee, freeze, freezeWith, fromBytes, fromScheduledTransaction, generateTransactionIds, getBatchKey, getDefaultMaxTransactionFee, getExecutionState, getHighVolume, getMaxTransactionFee, getRegenerateTransactionId, getRequiredChunks, getSignableNodeBodyBytesList, getSignatures, getSignaturesAtOffset, getTransactionBodySize, getTransactionHash, getTransactionHashPerNode, getTransactionId, getTransactionIdInternal, getTransactionMemo, getTransactionSize, getTransactionValidDuration, hash, isBatchedAndNotBatchTransaction, isFrozen, keyAlreadySigned, makeRequest, mapResponse, mapResponseStatus, onExecute, onExecuteAsync, regenerateTransactionId, requireNotFrozen, requireOneNodeAccountId, schedule, setBatchKey, setHighVolume, setMaxTransactionFee, setNodeAccountIds, setRegenerateTransactionId, setTransactionId, setTransactionMemo, setTransactionValidDuration, sign, signTransaction, signWith, signWithOperator, spawnBodyBuilder, toBytes, toString, wipeTransactionLists

Methods inherited from class com.hedera.hashgraph.sdk.Executable

advanceRequest, checkNodeAccountIds, execute, execute, executeAsync, executeAsync, executeAsync, executeAsync, executeAsync, executeAsync, getGrpcRequest, getMaxAttempts, getMaxBackoff, getMaxRetry, getMinBackoff, getNodeAccountIds, getNodeForExecute, grpcDeadline, logTransaction, mergeFromClient, setGrpcDeadline, setLogger, setMaxAttempts, setMaxBackoff, setMaxRetry, setMinBackoff, setNodesFromNodeAccountIds, setRequestListener, setResponseListener, shouldRetryExceptionally

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

TokenPauseTransaction

public TokenPauseTransaction()

Constructor.

TokenPauseTransaction

TokenPauseTransaction(LinkedHashMap<TransactionId,LinkedHashMap<AccountId,Transaction>> txs)
               throws com.google.protobuf.InvalidProtocolBufferException

Constructor.

Parameters:

txs - Compound list of transaction id's list of (AccountId, Transaction) records

Throws:

com.google.protobuf.InvalidProtocolBufferException - when there is an issue with the protobuf

TokenPauseTransaction

TokenPauseTransaction(TransactionBody txBody)

Constructor.

Parameters:

txBody - protobuf TransactionBody

Method Details

getTokenId

@Nullable
public TokenId getTokenId()

Extract the token id.

Returns:

the token id

setTokenId

public TokenPauseTransaction setTokenId(TokenId tokenId)

A token identifier.

The identified token SHALL be paused. Subsequent transactions involving that token SHALL fail until the token is "unpaused".

Parameters:

tokenId - the token id

Returns:

this

initFromTransactionBody

void initFromTransactionBody()

build

TokenPauseTransactionBody.Builder build()

Build the transaction body.

Returns:

TokenPauseTransactionBody

getMethodDescriptor

io.grpc.MethodDescriptor<Transaction,TransactionResponse> getMethodDescriptor()

Description copied from class: Executable

Called to direct the invocation of the query to the appropriate gRPC service.

Specified by:

getMethodDescriptor in class Executable<TokenPauseTransaction,Transaction,TransactionResponse,TransactionResponse>

onFreeze

void onFreeze(TransactionBody.Builder bodyBuilder)

Description copied from class: Transaction

Called in Transaction.freezeWith(Client) just before the transaction body is built. The intent is for the derived class to assign their data variant to the transaction body.

Specified by:

onFreeze in class Transaction<TokenPauseTransaction>

onScheduled

void onScheduled(SchedulableTransactionBody.Builder scheduled)

Description copied from class: Transaction

Called in Transaction.schedule() when converting transaction into a scheduled version.

Specified by:

onScheduled in class Transaction<TokenPauseTransaction>

validateChecksums

void validateChecksums(Client client)
                throws BadEntityIdException

Specified by:

validateChecksums in class Transaction<TokenPauseTransaction>

Throws:

BadEntityIdException