Module com.hedera.hashgraph.sdk
Package com.hedera.hashgraph.sdk.proto

Interface NodeCreateTransactionBodyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
NodeCreateTransactionBody, NodeCreateTransactionBody.Builder
@Generated public interface NodeCreateTransactionBodyOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Details

    • hasAccountId

      boolean hasAccountId()
       *
 A Node account identifier.
 <p>
 This account identifier MUST be in the "account number" form.<br/>
 This account identifier MUST NOT use the alias field.<br/>
 If the identified account does not exist, this transaction SHALL fail.<br/>
 Multiple nodes MAY share the same node account.<br/>
 This field is REQUIRED.
      .proto.AccountID account_id = 1;
      Returns:
      Whether the accountId field is set.

    • getAccountId

      AccountID getAccountId()
       *
 A Node account identifier.
 <p>
 This account identifier MUST be in the "account number" form.<br/>
 This account identifier MUST NOT use the alias field.<br/>
 If the identified account does not exist, this transaction SHALL fail.<br/>
 Multiple nodes MAY share the same node account.<br/>
 This field is REQUIRED.
      .proto.AccountID account_id = 1;
      Returns:
      The accountId.

    • getDescription

      String 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/>
 This field is OPTIONAL.
      string description = 2;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       *
 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/>
 This field is OPTIONAL.
      string description = 2;
      Returns:
      The bytes for description.

    • getGossipEndpointList

      List<ServiceEndpoint> getGossipEndpointList()
       *
 A list of service endpoints for gossip.
 <p>
 These endpoints SHALL represent the published endpoints to which other
 consensus nodes may _gossip_ transactions.<br/>
 These endpoints MUST specify a port.<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/>
 If the network configuration value `gossipFqdnRestricted` is set, then
 all endpoints in this list MUST supply only IP address.<br/>
 If the network configuration value `gossipFqdnRestricted` is _not_ set,
 then endpoints in this list MAY supply either IP address or FQDN, but
 MUST NOT supply both values for the same endpoint.
      repeated .proto.ServiceEndpoint gossip_endpoint = 3;

    • getGossipEndpoint

      ServiceEndpoint getGossipEndpoint(int index)
       *
 A list of service endpoints for gossip.
 <p>
 These endpoints SHALL represent the published endpoints to which other
 consensus nodes may _gossip_ transactions.<br/>
 These endpoints MUST specify a port.<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/>
 If the network configuration value `gossipFqdnRestricted` is set, then
 all endpoints in this list MUST supply only IP address.<br/>
 If the network configuration value `gossipFqdnRestricted` is _not_ set,
 then endpoints in this list MAY supply either IP address or FQDN, but
 MUST NOT supply both values for the same endpoint.
      repeated .proto.ServiceEndpoint gossip_endpoint = 3;

    • getGossipEndpointCount

      int getGossipEndpointCount()
       *
 A list of service endpoints for gossip.
 <p>
 These endpoints SHALL represent the published endpoints to which other
 consensus nodes may _gossip_ transactions.<br/>
 These endpoints MUST specify a port.<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/>
 If the network configuration value `gossipFqdnRestricted` is set, then
 all endpoints in this list MUST supply only IP address.<br/>
 If the network configuration value `gossipFqdnRestricted` is _not_ set,
 then endpoints in this list MAY supply either IP address or FQDN, but
 MUST NOT supply both values for the same endpoint.
      repeated .proto.ServiceEndpoint gossip_endpoint = 3;

    • getServiceEndpointList

      List<ServiceEndpoint> getServiceEndpointList()
       *
 A list of service endpoints for gRPC calls.
 <p>
 These endpoints SHALL represent the published gRPC endpoints to which
 clients may submit transactions.<br/>
 These endpoints MUST specify a port.<br/>
 Endpoints in this list MAY supply either IP address or FQDN, but MUST
 NOT supply both values for the same endpoint.<br/>
 This list MUST NOT be empty.<br/>
 This list MUST NOT contain more than `8` entries.
      repeated .proto.ServiceEndpoint service_endpoint = 4;

    • getServiceEndpoint

      ServiceEndpoint getServiceEndpoint(int index)
       *
 A list of service endpoints for gRPC calls.
 <p>
 These endpoints SHALL represent the published gRPC endpoints to which
 clients may submit transactions.<br/>
 These endpoints MUST specify a port.<br/>
 Endpoints in this list MAY supply either IP address or FQDN, but MUST
 NOT supply both values for the same endpoint.<br/>
 This list MUST NOT be empty.<br/>
 This list MUST NOT contain more than `8` entries.
      repeated .proto.ServiceEndpoint service_endpoint = 4;

    • getServiceEndpointCount

      int getServiceEndpointCount()
       *
 A list of service endpoints for gRPC calls.
 <p>
 These endpoints SHALL represent the published gRPC endpoints to which
 clients may submit transactions.<br/>
 These endpoints MUST specify a port.<br/>
 Endpoints in this list MAY supply either IP address or FQDN, but MUST
 NOT supply both values for the same endpoint.<br/>
 This list MUST NOT be empty.<br/>
 This list MUST NOT contain more than `8` entries.
      repeated .proto.ServiceEndpoint service_endpoint = 4;

    • getGossipCaCertificate

      com.google.protobuf.ByteString 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.<br/>
 This field is REQUIRED and MUST NOT be empty.
      bytes gossip_ca_certificate = 5;
      Returns:
      The gossipCaCertificate.

    • getGrpcCertificateHash

      com.google.protobuf.ByteString 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/>
 This field is OPTIONAL.
      bytes grpc_certificate_hash = 6;
      Returns:
      The grpcCertificateHash.

    • hasAdminKey

      boolean hasAdminKey()
       *
 An administrative key controlled by the node operator.
 <p>
 This key MUST sign this transaction.<br/>
 This key MUST sign each transaction to update this node.<br/>
 This field MUST contain a valid `Key` value.<br/>
 This field is REQUIRED and MUST NOT be set to an empty `KeyList`.
      .proto.Key admin_key = 7;
      Returns:
      Whether the adminKey field is set.

    • getAdminKey

      Key getAdminKey()
       *
 An administrative key controlled by the node operator.
 <p>
 This key MUST sign this transaction.<br/>
 This key MUST sign each transaction to update this node.<br/>
 This field MUST contain a valid `Key` value.<br/>
 This field is REQUIRED and MUST NOT be set to an empty `KeyList`.
      .proto.Key admin_key = 7;
      Returns:
      The adminKey.

    • getDeclineReward

      boolean getDeclineReward()
       *
 A boolean flag indicating whether the node operator declines to receive
 node rewards.
 <p>
 If this flag is set to `true`, the node operator declines to receive
 node rewards.<br/>
      bool decline_reward = 8;
      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.
      .proto.ServiceEndpoint grpc_proxy_endpoint = 9;
      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.
      .proto.ServiceEndpoint grpc_proxy_endpoint = 9;
      Returns:
      The grpcProxyEndpoint.

    • getAssociatedRegisteredNodeList

      List<Long> 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 and MAY be empty.<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.
      repeated uint64 associated_registered_node = 10;
      Returns:
      A list containing the associatedRegisteredNode.

    • getAssociatedRegisteredNodeCount

      int getAssociatedRegisteredNodeCount()
       *
 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 and MAY be empty.<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.
      repeated uint64 associated_registered_node = 10;
      Returns:
      The count of associatedRegisteredNode.

    • getAssociatedRegisteredNode

      long getAssociatedRegisteredNode(int index)
       *
 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 and MAY be empty.<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.
      repeated uint64 associated_registered_node = 10;
      Parameters:
      index - The index of the element to return.
      Returns:
      The associatedRegisteredNode at the given index.