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

Interface NodeOrBuilder

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

  • Method Details

    • getNodeId

      long getNodeId()
       *
 A consensus node identifier.
 <p>
 Node identifiers SHALL be globally unique for a given ledger.
      uint64 node_id = 1;
      Returns:
      The nodeId.

    • hasAccountId

      boolean hasAccountId()
       *
 An account identifier.
 <p>
 This account SHALL be owned by the entity responsible for the node.<br/>
 This account SHALL be charged transaction fees for any transactions
 that are submitted to the network by this node and
 fail due diligence checks.<br/>
 This account SHALL be paid the node portion of transaction fees
 for transactions submitted by this node.
      .proto.AccountID account_id = 2;
      Returns:
      Whether the accountId field is set.

    • getAccountId

      AccountID getAccountId()
       *
 An account identifier.
 <p>
 This account SHALL be owned by the entity responsible for the node.<br/>
 This account SHALL be charged transaction fees for any transactions
 that are submitted to the network by this node and
 fail due diligence checks.<br/>
 This account SHALL be paid the node portion of transaction fees
 for transactions submitted by this node.
      .proto.AccountID account_id = 2;
      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.
      string description = 3;
      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.
      string description = 3;
      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/>
 If the network configuration value `gossipFqdnRestricted` is set, then
 all endpoints in this list SHALL 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
 SHALL NOT supply both values for the same endpoint.<br/>
 This list SHALL NOT be empty.<br/>
 This list SHALL 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.
      repeated .proto.ServiceEndpoint gossip_endpoint = 4;

    • 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/>
 If the network configuration value `gossipFqdnRestricted` is set, then
 all endpoints in this list SHALL 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
 SHALL NOT supply both values for the same endpoint.<br/>
 This list SHALL NOT be empty.<br/>
 This list SHALL 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.
      repeated .proto.ServiceEndpoint gossip_endpoint = 4;

    • 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/>
 If the network configuration value `gossipFqdnRestricted` is set, then
 all endpoints in this list SHALL 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
 SHALL NOT supply both values for the same endpoint.<br/>
 This list SHALL NOT be empty.<br/>
 This list SHALL 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.
      repeated .proto.ServiceEndpoint gossip_endpoint = 4;

    • getServiceEndpointList

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

    • getServiceEndpoint

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

    • getServiceEndpointCount

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

    • getGossipCaCertificate

      com.google.protobuf.ByteString getGossipCaCertificate()
       *
 A certificate used to sign gossip events.
 <p>
 This value SHALL be a certificate of a type permitted for gossip
 signatures.<br/>
 This value SHALL be the DER encoding of the certificate presented.<br/>
 This field is REQUIRED and MUST NOT be empty.
      bytes gossip_ca_certificate = 6;
      Returns:
      The gossipCaCertificate.

    • getGrpcCertificateHash

      com.google.protobuf.ByteString getGrpcCertificateHash()
       *
 A hash of the node gRPC certificate.
 <p>
 This value MAY be used to verify the certificate presented by the node
 during TLS negotiation for gRPC.<br/>
 This value SHALL be a SHA-384 hash.<br/>
 The TLS certificate to be hashed SHALL first be in PEM format and SHALL
 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 = 7;
      Returns:
      The grpcCertificateHash.

    • getWeight

      @Deprecated long getWeight()
      Deprecated.
      com.hedera.hapi.node.state.addressbook.Node.weight is deprecated. See node.proto;l=116
       *
 A consensus weight.
 <p>
 Each node SHALL have a weight in consensus calculations.<br/>
 The consensus weight of a node SHALL be calculated based on the amount
 of HBAR staked to that node.<br/>
 Consensus SHALL be calculated based on agreement of greater than `2/3`
 of the total `weight` value of all nodes on the network.
 <p>
 This field is deprecated and SHALL NOT be used when RosterLifecycle
 is enabled.
      uint64 weight = 8 [deprecated = true];
      Returns:
      The weight.

    • getDeleted

      boolean getDeleted()
       *
 A flag indicating this node is deleted.
 <p>
 If this field is set, then this node SHALL NOT be included in the next
 update of the network address book.<br/>
 If this field is set, then this node SHALL be immutable and SHALL NOT
 be modified.<br/>
 If this field is set, then any `nodeUpdate` transaction to modify this
 node SHALL fail.
      bool deleted = 9;
      Returns:
      The deleted.

    • hasAdminKey

      boolean hasAdminKey()
       *
 An administrative key controlled by the node operator.
 <p>
 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 = 10;
      Returns:
      Whether the adminKey field is set.

    • getAdminKey

      Key getAdminKey()
       *
 An administrative key controlled by the node operator.
 <p>
 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 = 10;
      Returns:
      The adminKey.

    • getDeclineReward

      boolean getDeclineReward()
       *
 A flag indicating this node declines node rewards distributed at
 the end of staking period.
 <p>
 If this field is set, then this node SHALL NOT receive any node rewards
 distributed at the end of the staking period.
      bool decline_reward = 11;
      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 = 12;
      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 = 12;
      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 = 13;
      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 = 13;
      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 = 13;
      Parameters:
      index - The index of the element to return.
      Returns:
      The associatedRegisteredNode at the given index.