com.hedera.hashgraph.sdk.proto.NodeCreateTransactionBodyOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk-full Show documentation
Hedera™ Hashgraph SDK for Java
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: node_create.proto

// Protobuf Java Version: 3.25.3
package com.hedera.hashgraph.sdk.proto;

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

  /**
   *    **
   * 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;
   * @return Whether the accountId field is set.
   */
  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;
   * @return The accountId.
   */
  com.hedera.hashgraph.sdk.proto.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;
   */
  com.hedera.hashgraph.sdk.proto.AccountIDOrBuilder getAccountIdOrBuilder();

  /**
   *    **
   * A short description of the node.
   * <p>
   * This value, if set, MUST NOT exceed 100 bytes when encoded as UTF-8.<br/>
   * This field is OPTIONAL.
   * 
   *
   * string description = 2;
   * @return The description.
   */
  java.lang.String getDescription();
  /**
   *    **
   * A short description of the node.
   * <p>
   * This value, if set, MUST NOT exceed 100 bytes when encoded as UTF-8.<br/>
   * This field is OPTIONAL.
   * 
   *
   * string description = 2;
   * @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/>
   * 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;
   */
  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/>
   * 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;
   */
  com.hedera.hashgraph.sdk.proto.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;
   */
  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;
   */
  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/>
   * 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;
   */
  com.hedera.hashgraph.sdk.proto.ServiceEndpointOrBuilder getGossipEndpointOrBuilder(
      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;
   */
  java.util.List 
      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;
   */
  com.hedera.hashgraph.sdk.proto.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;
   */
  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;
   */
  java.util.List 
      getServiceEndpointOrBuilderList();
  /**
   *    **
   * 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;
   */
  com.hedera.hashgraph.sdk.proto.ServiceEndpointOrBuilder getServiceEndpointOrBuilder(
      int index);

  /**
   *    **
   * 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;
   * @return The gossipCaCertificate.
   */
  com.google.protobuf.ByteString getGossipCaCertificate();

  /**
   *    **
   * 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;
   * @return The grpcCertificateHash.
   */
  com.google.protobuf.ByteString getGrpcCertificateHash();

  /**
   *    **
   * 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;
   * @return Whether the adminKey field is set.
   */
  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;
   * @return The adminKey.
   */
  com.hedera.hashgraph.sdk.proto.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;
   */
  com.hedera.hashgraph.sdk.proto.KeyOrBuilder getAdminKeyOrBuilder();
}