Module com.hedera.hashgraph.sdk
Package com.hedera.hashgraph.sdk.proto
Interface NodeUpdateTransactionBodyOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
- All Known Implementing Classes:
NodeUpdateTransactionBody,NodeUpdateTransactionBody.Builder
@Generated
public interface NodeUpdateTransactionBodyOrBuilder
extends com.google.protobuf.MessageLiteOrBuilder
-
Method Summary
Modifier and TypeMethodDescription* An account identifier.* An administrative key controlled by the node operator.* A list of registered nodes operated by the same entity as this node.<br/> This value may contain a list of "registered nodes" (as described in HIP-1137) that are operated by the same entity that operates this consensus node.com.google.protobuf.BoolValue* A boolean indicating that this node has chosen to decline node rewards distributed at the end of staking period.com.google.protobuf.StringValue* A short description of the node.com.google.protobuf.BytesValue* A certificate used to sign gossip events.getGossipEndpoint(int index) * A list of service endpoints for gossip.int* A list of service endpoints for gossip.* A list of service endpoints for gossip.com.google.protobuf.BytesValue* A hash of the node gRPC TLS certificate.* A web proxy for gRPC from non-gRPC clients.long* A consensus node identifier in the network state.getServiceEndpoint(int index) * A list of service endpoints for gRPC calls.int* A list of service endpoints for gRPC calls.* A list of service endpoints for gRPC calls.boolean* An account identifier.boolean* An administrative key controlled by the node operator.boolean* A list of registered nodes operated by the same entity as this node.<br/> This value may contain a list of "registered nodes" (as described in HIP-1137) that are operated by the same entity that operates this consensus node.boolean* A boolean indicating that this node has chosen to decline node rewards distributed at the end of staking period.boolean* A short description of the node.boolean* A certificate used to sign gossip events.boolean* A hash of the node gRPC TLS certificate.boolean* A web proxy for gRPC from non-gRPC clients.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType, isInitialized
-
Method Details
-
getNodeId
long getNodeId()* A consensus node identifier in the network state. <p> The node identified MUST exist in the network address book.<br/> The node identified MUST NOT be deleted.<br/> This value is REQUIRED.
uint64 node_id = 1;- Returns:
- The nodeId.
-
hasAccountId
boolean hasAccountId()* An account identifier. <p> If set, this SHALL replace the node account identifier.<br/> If set, this transaction MUST be signed by the active `key` for _both_ the current node account _and_ the identified new node account.
.proto.AccountID account_id = 2;- Returns:
- Whether the accountId field is set.
-
getAccountId
AccountID getAccountId()* An account identifier. <p> If set, this SHALL replace the node account identifier.<br/> If set, this transaction MUST be signed by the active `key` for _both_ the current node account _and_ the identified new node account.
.proto.AccountID account_id = 2;- Returns:
- The accountId.
-
hasDescription
boolean hasDescription()* A short description of the node. <p> This value, if set, MUST NOT exceed `transaction.maxMemoUtf8Bytes` (default 100) bytes when encoded as UTF-8.<br/> If set, this value SHALL replace the previous value.
.google.protobuf.StringValue description = 3;- Returns:
- Whether the description field is set.
-
getDescription
com.google.protobuf.StringValue getDescription()* A short description of the node. <p> This value, if set, MUST NOT exceed `transaction.maxMemoUtf8Bytes` (default 100) bytes when encoded as UTF-8.<br/> If set, this value SHALL replace the previous value.
.google.protobuf.StringValue description = 3;- Returns:
- The description.
-
getGossipEndpointList
List<ServiceEndpoint> getGossipEndpointList()* A list of service endpoints for gossip. <p> If set, this list MUST meet the following requirements. <hr/> These endpoints SHALL represent the published endpoints to which other consensus nodes may _gossip_ transactions.<br/> These endpoints SHOULD NOT specify both address and DNS name.<br/> This list MUST NOT be empty.<br/> This list MUST NOT contain more than `10` entries.<br/> The first two entries in this list SHALL be the endpoints published to all consensus nodes.<br/> All other entries SHALL be reserved for future use. <p> Each network may have additional requirements for these endpoints. A client MUST check network-specific documentation for those details.<br/> <blockquote>Example<blockquote> Hedera Mainnet _requires_ that address be specified, and does not permit DNS name (FQDN) to be specified. </blockquote> <blockquote> Solo, however, _requires_ DNS name (FQDN) but also permits address. </blockquote></blockquote> <p> If set, the new list SHALL replace the existing list.
repeated .proto.ServiceEndpoint gossip_endpoint = 4; -
getGossipEndpoint
* A list of service endpoints for gossip. <p> If set, this list MUST meet the following requirements. <hr/> These endpoints SHALL represent the published endpoints to which other consensus nodes may _gossip_ transactions.<br/> These endpoints SHOULD NOT specify both address and DNS name.<br/> This list MUST NOT be empty.<br/> This list MUST NOT contain more than `10` entries.<br/> The first two entries in this list SHALL be the endpoints published to all consensus nodes.<br/> All other entries SHALL be reserved for future use. <p> Each network may have additional requirements for these endpoints. A client MUST check network-specific documentation for those details.<br/> <blockquote>Example<blockquote> Hedera Mainnet _requires_ that address be specified, and does not permit DNS name (FQDN) to be specified. </blockquote> <blockquote> Solo, however, _requires_ DNS name (FQDN) but also permits address. </blockquote></blockquote> <p> If set, the new list SHALL replace the existing list.
repeated .proto.ServiceEndpoint gossip_endpoint = 4; -
getGossipEndpointCount
int getGossipEndpointCount()* A list of service endpoints for gossip. <p> If set, this list MUST meet the following requirements. <hr/> These endpoints SHALL represent the published endpoints to which other consensus nodes may _gossip_ transactions.<br/> These endpoints SHOULD NOT specify both address and DNS name.<br/> This list MUST NOT be empty.<br/> This list MUST NOT contain more than `10` entries.<br/> The first two entries in this list SHALL be the endpoints published to all consensus nodes.<br/> All other entries SHALL be reserved for future use. <p> Each network may have additional requirements for these endpoints. A client MUST check network-specific documentation for those details.<br/> <blockquote>Example<blockquote> Hedera Mainnet _requires_ that address be specified, and does not permit DNS name (FQDN) to be specified. </blockquote> <blockquote> Solo, however, _requires_ DNS name (FQDN) but also permits address. </blockquote></blockquote> <p> If set, the new list SHALL replace the existing list.
repeated .proto.ServiceEndpoint gossip_endpoint = 4; -
getServiceEndpointList
List<ServiceEndpoint> getServiceEndpointList()* A list of service endpoints for gRPC calls. <p> If set, this list MUST meet the following requirements. <hr/> These endpoints SHALL represent the published endpoints to which clients may submit transactions.<br/> These endpoints SHOULD specify address and port.<br/> These endpoints MAY specify a DNS name.<br/> These endpoints SHOULD NOT specify both address and DNS name.<br/> This list MUST NOT be empty.<br/> This list MUST NOT contain more than `8` entries. <p> Each network may have additional requirements for these endpoints. A client MUST check network-specific documentation for those details. <p> If set, the new list SHALL replace the existing list.
repeated .proto.ServiceEndpoint service_endpoint = 5; -
getServiceEndpoint
* A list of service endpoints for gRPC calls. <p> If set, this list MUST meet the following requirements. <hr/> These endpoints SHALL represent the published endpoints to which clients may submit transactions.<br/> These endpoints SHOULD specify address and port.<br/> These endpoints MAY specify a DNS name.<br/> These endpoints SHOULD NOT specify both address and DNS name.<br/> This list MUST NOT be empty.<br/> This list MUST NOT contain more than `8` entries. <p> Each network may have additional requirements for these endpoints. A client MUST check network-specific documentation for those details. <p> If set, the new list SHALL replace the existing list.
repeated .proto.ServiceEndpoint service_endpoint = 5; -
getServiceEndpointCount
int getServiceEndpointCount()* A list of service endpoints for gRPC calls. <p> If set, this list MUST meet the following requirements. <hr/> These endpoints SHALL represent the published endpoints to which clients may submit transactions.<br/> These endpoints SHOULD specify address and port.<br/> These endpoints MAY specify a DNS name.<br/> These endpoints SHOULD NOT specify both address and DNS name.<br/> This list MUST NOT be empty.<br/> This list MUST NOT contain more than `8` entries. <p> Each network may have additional requirements for these endpoints. A client MUST check network-specific documentation for those details. <p> If set, the new list SHALL replace the existing list.
repeated .proto.ServiceEndpoint service_endpoint = 5; -
hasGossipCaCertificate
boolean hasGossipCaCertificate()* A certificate used to sign gossip events. <p> This value MUST be a certificate of a type permitted for gossip signatures.<br/> This value MUST be the DER encoding of the certificate presented. <p> If set, the new value SHALL replace the existing bytes value.
.google.protobuf.BytesValue gossip_ca_certificate = 6;- Returns:
- Whether the gossipCaCertificate field is set.
-
getGossipCaCertificate
com.google.protobuf.BytesValue getGossipCaCertificate()* A certificate used to sign gossip events. <p> This value MUST be a certificate of a type permitted for gossip signatures.<br/> This value MUST be the DER encoding of the certificate presented. <p> If set, the new value SHALL replace the existing bytes value.
.google.protobuf.BytesValue gossip_ca_certificate = 6;- Returns:
- The gossipCaCertificate.
-
hasGrpcCertificateHash
boolean hasGrpcCertificateHash()* A hash of the node gRPC TLS certificate. <p> This value MAY be used to verify the certificate presented by the node during TLS negotiation for gRPC.<br/> This value MUST be a SHA-384 hash.<br/> The TLS certificate to be hashed MUST first be in PEM format and MUST be encoded with UTF-8 NFKD encoding to a stream of bytes provided to the hash algorithm.<br/> <p> If set, the new value SHALL replace the existing hash value.
.google.protobuf.BytesValue grpc_certificate_hash = 7;- Returns:
- Whether the grpcCertificateHash field is set.
-
getGrpcCertificateHash
com.google.protobuf.BytesValue getGrpcCertificateHash()* A hash of the node gRPC TLS certificate. <p> This value MAY be used to verify the certificate presented by the node during TLS negotiation for gRPC.<br/> This value MUST be a SHA-384 hash.<br/> The TLS certificate to be hashed MUST first be in PEM format and MUST be encoded with UTF-8 NFKD encoding to a stream of bytes provided to the hash algorithm.<br/> <p> If set, the new value SHALL replace the existing hash value.
.google.protobuf.BytesValue grpc_certificate_hash = 7;- Returns:
- The grpcCertificateHash.
-
hasAdminKey
boolean hasAdminKey()* An administrative key controlled by the node operator. <p> This field is OPTIONAL.<br/> If set, this key MUST sign this transaction.<br/> If set, this key MUST sign each subsequent transaction to update this node.<br/> If set, this field MUST contain a valid `Key` value.<br/> If set, this field MUST NOT be set to an empty `KeyList`.
.proto.Key admin_key = 8;- Returns:
- Whether the adminKey field is set.
-
getAdminKey
Key getAdminKey()* An administrative key controlled by the node operator. <p> This field is OPTIONAL.<br/> If set, this key MUST sign this transaction.<br/> If set, this key MUST sign each subsequent transaction to update this node.<br/> If set, this field MUST contain a valid `Key` value.<br/> If set, this field MUST NOT be set to an empty `KeyList`.
.proto.Key admin_key = 8;- Returns:
- The adminKey.
-
hasDeclineReward
boolean hasDeclineReward()* A boolean indicating that this node has chosen to decline node rewards distributed at the end of staking period. <p> This node SHALL NOT receive reward if this value is set, and `true`.
.google.protobuf.BoolValue decline_reward = 9;- Returns:
- Whether the declineReward field is set.
-
getDeclineReward
com.google.protobuf.BoolValue getDeclineReward()* A boolean indicating that this node has chosen to decline node rewards distributed at the end of staking period. <p> This node SHALL NOT receive reward if this value is set, and `true`.
.google.protobuf.BoolValue decline_reward = 9;- Returns:
- The declineReward.
-
hasGrpcProxyEndpoint
boolean hasGrpcProxyEndpoint()* A web proxy for gRPC from non-gRPC clients. <p> This endpoint SHALL be a Fully Qualified Domain Name (FQDN) using the HTTPS protocol, and SHALL support gRPC-Web for use by browser-based clients.<br/> This endpoint MUST be signed by a trusted certificate authority.<br/> This endpoint MUST use a valid port and SHALL be reachable over TLS.<br/> This field MAY be omitted if the node does not support gRPC-Web access.<br/> This field MUST be updated if the gRPC-Web endpoint changes.<br/> This field SHALL enable frontend clients to avoid hard-coded proxy endpoints.<br/> This field MAY be set to `ServiceEndpoint.DEFAULT` to remove a previously-valid web proxy.
.proto.ServiceEndpoint grpc_proxy_endpoint = 10;- Returns:
- Whether the grpcProxyEndpoint field is set.
-
getGrpcProxyEndpoint
ServiceEndpoint getGrpcProxyEndpoint()* A web proxy for gRPC from non-gRPC clients. <p> This endpoint SHALL be a Fully Qualified Domain Name (FQDN) using the HTTPS protocol, and SHALL support gRPC-Web for use by browser-based clients.<br/> This endpoint MUST be signed by a trusted certificate authority.<br/> This endpoint MUST use a valid port and SHALL be reachable over TLS.<br/> This field MAY be omitted if the node does not support gRPC-Web access.<br/> This field MUST be updated if the gRPC-Web endpoint changes.<br/> This field SHALL enable frontend clients to avoid hard-coded proxy endpoints.<br/> This field MAY be set to `ServiceEndpoint.DEFAULT` to remove a previously-valid web proxy.
.proto.ServiceEndpoint grpc_proxy_endpoint = 10;- Returns:
- The grpcProxyEndpoint.
-
hasAssociatedRegisteredNodeList
boolean hasAssociatedRegisteredNodeList()* A list of registered nodes operated by the same entity as this node.<br/> This value may contain a list of "registered nodes" (as described in HIP-1137) that are operated by the same entity that operates this consensus node. <p> This field is OPTIONAL.<br/> If this field is not set, the current list SHALL NOT change.<br/> If this field is set, but contains an empty list, any existing associated registered nodes SHALL be removed.<br/> This field MUST NOT contain more than twenty(20) entries.<br/> Every entry in this list MUST be a valid `registered_node_id` for a current registered node.
.com.hedera.hapi.node.addressbook.AssociatedRegisteredNodeList associated_registered_node_list = 11;- Returns:
- Whether the associatedRegisteredNodeList field is set.
-
getAssociatedRegisteredNodeList
AssociatedRegisteredNodeList getAssociatedRegisteredNodeList()* A list of registered nodes operated by the same entity as this node.<br/> This value may contain a list of "registered nodes" (as described in HIP-1137) that are operated by the same entity that operates this consensus node. <p> This field is OPTIONAL.<br/> If this field is not set, the current list SHALL NOT change.<br/> If this field is set, but contains an empty list, any existing associated registered nodes SHALL be removed.<br/> This field MUST NOT contain more than twenty(20) entries.<br/> Every entry in this list MUST be a valid `registered_node_id` for a current registered node.
.com.hedera.hapi.node.addressbook.AssociatedRegisteredNodeList associated_registered_node_list = 11;- Returns:
- The associatedRegisteredNodeList.
-