All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.hederahashgraph.api.proto.java.NodeOrBuilder Maven / Gradle / Ivy

There is a newer version: 0.54.0
Show newest version
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: state/addressbook/node.proto

package com.hederahashgraph.api.proto.java;

public interface NodeOrBuilder extends
    // @@protoc_insertion_point(interface_extends:com.hedera.hapi.node.state.addressbook.Node)
    com.google.protobuf.MessageOrBuilder {

  /**
   * 
   **
   * A consensus node identifier.
   * <p>
   * Node identifiers SHALL be unique _within_ a shard and realm,
   * but a node SHALL NOT, ever, serve multiple shards or realms,
   * therefore the node identifier MAY be repeated _between_ shards and realms.
   * 
* * uint64 node_id = 1; * @return The nodeId. */ long getNodeId(); /** *
   **
   * 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.
   * 
* * .proto.AccountID account_id = 2; * @return Whether the accountId field is set. */ 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.
   * 
* * .proto.AccountID account_id = 2; * @return The accountId. */ com.hederahashgraph.api.proto.java.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.
   * 
* * .proto.AccountID account_id = 2; */ com.hederahashgraph.api.proto.java.AccountIDOrBuilder getAccountIdOrBuilder(); /** *
   **
   * A short description of the node.
   * <p>
   * This value, if set, SHALL NOT exceed 100 bytes when encoded as UTF-8.
   * 
* * string description = 3; * @return The description. */ java.lang.String getDescription(); /** *
   **
   * A short description of the node.
   * <p>
   * This value, if set, SHALL NOT exceed 100 bytes when encoded as UTF-8.
   * 
* * string description = 3; * @return The bytes for description. */ com.google.protobuf.ByteString getDescriptionBytes(); /** *
   **
   * 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; */ java.util.List 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; */ com.hederahashgraph.api.proto.java.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; */ 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; */ java.util.List getGossipEndpointOrBuilderList(); /** *
   **
   * 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; */ com.hederahashgraph.api.proto.java.ServiceEndpointOrBuilder getGossipEndpointOrBuilder( int index); /** *
   **
   * A list of service endpoints for gRPC 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; */ java.util.List getServiceEndpointList(); /** *
   **
   * A list of service endpoints for gRPC 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; */ com.hederahashgraph.api.proto.java.ServiceEndpoint getServiceEndpoint(int index); /** *
   **
   * A list of service endpoints for gRPC 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; */ int getServiceEndpointCount(); /** *
   **
   * A list of service endpoints for gRPC 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; */ java.util.List getServiceEndpointOrBuilderList(); /** *
   **
   * A list of service endpoints for gRPC 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; */ com.hederahashgraph.api.proto.java.ServiceEndpointOrBuilder getServiceEndpointOrBuilder( int index); /** *
   **
   * 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; * @return The gossipCaCertificate. */ com.google.protobuf.ByteString getGossipCaCertificate(); /** *
   **
   * 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; * @return The grpcCertificateHash. */ com.google.protobuf.ByteString getGrpcCertificateHash(); /** *
   **
   * 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.
   * 
* * uint64 weight = 8; * @return The weight. */ long getWeight(); /** *
   **
   * 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; * @return The deleted. */ boolean getDeleted(); /** *
   **
   * 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; * @return Whether the adminKey field is set. */ 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; * @return The adminKey. */ com.hederahashgraph.api.proto.java.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; */ com.hederahashgraph.api.proto.java.KeyOrBuilder getAdminKeyOrBuilder(); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy