Module com.hedera.hashgraph.sdk

Package com.hedera.hashgraph.sdk

Class RegisteredNodeUpdateTransaction

java.lang.Object

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

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

com.hedera.hashgraph.sdk.RegisteredNodeUpdateTransaction

public class RegisteredNodeUpdateTransaction
extends Transaction<RegisteredNodeUpdateTransaction>

A transaction to update an existing registered node in the network address book.

This transaction, once complete, SHALL modify the identified registered node state as requested.

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
RegisteredNodeUpdateTransaction()	Constructor.
RegisteredNodeUpdateTransaction(TransactionBody txBody)	Constructor.
RegisteredNodeUpdateTransaction(LinkedHashMap<TransactionId,LinkedHashMap<AccountId,Transaction>> txs)	Constructor.

Method Summary

Modifier and Type	Method	Description
RegisteredNodeUpdateTransaction	addServiceEndpoint(RegisteredServiceEndpoint serviceEndpoint)	Add a service endpoint for the client calls.
(package private) RegisteredNodeUpdateTransactionBody.Builder	build()	Build the transaction body.
Key	getAdminKey()	Get administrative key controlled by the node operator.
String	getDescription()	Get short description of the node.
(package private) io.grpc.MethodDescriptor<Transaction,TransactionResponse>	getMethodDescriptor()	Called to direct the invocation of the query to the appropriate gRPC service.
long	getRegisteredNodeId()	Get registered node identifier in the network state.
List<RegisteredServiceEndpoint>	getServiceEndpoints()	Get list of service endpoints for client calls.
(package private) void	initFromTransactionBody()	Initialize from the transaction body.
(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.
RegisteredNodeUpdateTransaction	setAdminKey(Key adminKey)	Set administrative key controlled by the node operator.
RegisteredNodeUpdateTransaction	setDescription(String description)	A short description of the node.
RegisteredNodeUpdateTransaction	setRegisteredNodeId(long registeredNodeId)	Set registered node identifier in the network state.
RegisteredNodeUpdateTransaction	setServiceEndpoints(List<RegisteredServiceEndpoint> serviceEndpoints)	A list of service endpoints for client calls.
(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

RegisteredNodeUpdateTransaction

public RegisteredNodeUpdateTransaction()

Constructor.

RegisteredNodeUpdateTransaction

RegisteredNodeUpdateTransaction(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

RegisteredNodeUpdateTransaction

RegisteredNodeUpdateTransaction(TransactionBody txBody)

Constructor.

Parameters:

txBody - protobuf TransactionBody

Method Details

getRegisteredNodeId

public long getRegisteredNodeId()

Get registered node identifier in the network state.

Returns:

the registered node id

Throws:

IllegalStateException - when register node id is not being set

setRegisteredNodeId

public RegisteredNodeUpdateTransaction setRegisteredNodeId(long registeredNodeId)

Set registered node identifier in the network state.

The node identified MUST exist in the registered address book.
The node identified MUST NOT be deleted.
This value is REQUIRED.

Parameters:

registeredNodeId - the registered node identifier.

Returns:

this

getAdminKey

@Nullable
public Key getAdminKey()

Get administrative key controlled by the node operator.

Returns:

Key the admin key

setAdminKey

public RegisteredNodeUpdateTransaction setAdminKey(@Nullable
 Key adminKey)

Set administrative key controlled by the node operator.

This key MUST sign this transaction.
This key MUST sign each transaction to update this node.
This field MUST contain a valid `Key` value.

Parameters:

adminKey - the admin key for the registered node.

Returns:

this

getDescription

@Nullable
public String getDescription()

Get short description of the node.

Returns:

String the node's description

setDescription

public RegisteredNodeUpdateTransaction setDescription(String description)

A short description of the node.

This value, if set, MUST NOT exceed 100 bytes when encoded as UTF-8.
This field is OPTIONAL.

Parameters:

description - The string to be set as description for the node.

Returns:

this

getServiceEndpoints

public List<RegisteredServiceEndpoint> getServiceEndpoints()

Get list of service endpoints for client calls.

Returns:

List<RegisterServiceEndpoint> list of service endpoints

setServiceEndpoints

public RegisteredNodeUpdateTransaction setServiceEndpoints(List<RegisteredServiceEndpoint> serviceEndpoints)

A list of service endpoints for client calls.

These endpoints SHALL represent the published endpoints to which clients may submit requests.
Endpoints in this list MAY supply either IP address or FQDN, but MUST NOT supply both values for the same endpoint.
Multiple endpoints in this list MAY resolve to the same interface.
One Registered Node MAY expose endpoints for multiple service types.
This list MUST NOT be empty.
This list MUST NOT contain more than `50` entries.

Parameters:

serviceEndpoints - the list of service endpoints for the client calls.

Returns:

this

addServiceEndpoint

public RegisteredNodeUpdateTransaction addServiceEndpoint(RegisteredServiceEndpoint serviceEndpoint)

Add a service endpoint for the client calls.

Parameters:

serviceEndpoint - the service endpoint

Returns:

this

build

RegisteredNodeUpdateTransactionBody.Builder build()

Build the transaction body.

Returns:

RegisteredNodeUpdateTransactionBody

initFromTransactionBody

void initFromTransactionBody()

Initialize from the transaction body.

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<RegisteredNodeUpdateTransaction>

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<RegisteredNodeUpdateTransaction>

validateChecksums

void validateChecksums(Client client)
                throws BadEntityIdException

Specified by:

validateChecksums in class Transaction<RegisteredNodeUpdateTransaction>

Throws:

BadEntityIdException

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<RegisteredNodeUpdateTransaction,Transaction,TransactionResponse,TransactionResponse>