com.hedera.hapi.platform.state.legacy.AddressOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hedera-protobuf-java-api Show documentation
Hedera Protobuf Java API
There is a newer version: 0.57.1
Show newest version
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: state/platform_state.proto

package com.hedera.hapi.platform.state.legacy;

public interface AddressOrBuilder extends
    // @@protoc_insertion_point(interface_extends:com.hedera.hapi.platform.state.Address)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    **
   * The ID of this member.
   * <p>
   * This identifier SHALL be agreed upon by all consensus nodes.
   * 
   *
   * .com.hedera.hapi.platform.state.NodeId id = 1;
   * @return Whether the id field is set.
   */
  boolean hasId();
  /**
   *    **
   * The ID of this member.
   * <p>
   * This identifier SHALL be agreed upon by all consensus nodes.
   * 
   *
   * .com.hedera.hapi.platform.state.NodeId id = 1;
   * @return The id.
   */
  com.hedera.hapi.platform.state.legacy.NodeId getId();
  /**
   *    **
   * The ID of this member.
   * <p>
   * This identifier SHALL be agreed upon by all consensus nodes.
   * 
   *
   * .com.hedera.hapi.platform.state.NodeId id = 1;
   */
  com.hedera.hapi.platform.state.legacy.NodeIdOrBuilder getIdOrBuilder();

  /**
   *    **
   * The nickname other consensus nodes will use to refer to this consensus node.
   * 
   *
   * string nickname = 2;
   * @return The nickname.
   */
  java.lang.String getNickname();
  /**
   *    **
   * The nickname other consensus nodes will use to refer to this consensus node.
   * 
   *
   * string nickname = 2;
   * @return The bytes for nickname.
   */
  com.google.protobuf.ByteString
      getNicknameBytes();

  /**
   *    **
   * The name that a consensus node uses to refer to themselves.
   * 
   *
   * string self_name = 3;
   * @return The selfName.
   */
  java.lang.String getSelfName();
  /**
   *    **
   * The name that a consensus node uses to refer to themselves.
   * 
   *
   * string self_name = 3;
   * @return The bytes for selfName.
   */
  com.google.protobuf.ByteString
      getSelfNameBytes();

  /**
   *    **
   * A consensus weight.<br/>
   * This value is the relative weight for this consensus node in the
   * consensus voting algorithm.
   * 
   *
   * uint64 weight = 4;
   * @return The weight.
   */
  long getWeight();

  /**
   *    **
   * A string network address.<br/>
   * This value is the hostname assigned on the "internal" network
   * interface behind any network firewalls, protocol gateways, or
   * DNS translations.
   * <p>
   * This value SHALL be either a FQDN host name or an IPv4 address.
   * 
   *
   * string hostname_internal = 5;
   * @return The hostnameInternal.
   */
  java.lang.String getHostnameInternal();
  /**
   *    **
   * A string network address.<br/>
   * This value is the hostname assigned on the "internal" network
   * interface behind any network firewalls, protocol gateways, or
   * DNS translations.
   * <p>
   * This value SHALL be either a FQDN host name or an IPv4 address.
   * 
   *
   * string hostname_internal = 5;
   * @return The bytes for hostnameInternal.
   */
  com.google.protobuf.ByteString
      getHostnameInternalBytes();

  /**
   *    **
   * Network port number.<br/>
   * This value is the "translated" port number assigned on the "internal"
   * network behind any network firewalls or other address translations.
   * <p>
   * This value SHALL be between 1 and 65535.
   * 
   *
   * uint32 port_internal = 6;
   * @return The portInternal.
   */
  int getPortInternal();

  /**
   *    **
   * A string network address.<br/>
   * This value is the hostname assigned on the "public" network
   * interface visible to the general internet.
   * <p>
   * This value SHALL be either a FQDN host name or an IPv4 address.
   * 
   *
   * string hostname_external = 7;
   * @return The hostnameExternal.
   */
  java.lang.String getHostnameExternal();
  /**
   *    **
   * A string network address.<br/>
   * This value is the hostname assigned on the "public" network
   * interface visible to the general internet.
   * <p>
   * This value SHALL be either a FQDN host name or an IPv4 address.
   * 
   *
   * string hostname_external = 7;
   * @return The bytes for hostnameExternal.
   */
  com.google.protobuf.ByteString
      getHostnameExternalBytes();

  /**
   *    **
   * Network port number.<br/>
   * This value is the port number visible to the general internet.
   * <p>
   * This value SHALL be between 1 and 65535.
   * 
   *
   * uint32 port_external = 8;
   * @return The portExternal.
   */
  int getPortExternal();

  /**
   *    **
   * The signing x509 certificate of the consensus node.
   * <p>
   * This SHALL provide the public key used for signing.
   * 
   *
   * bytes signing_certificate = 9;
   * @return The signingCertificate.
   */
  com.google.protobuf.ByteString getSigningCertificate();

  /**
   *    **
   * The agreement x509 certificate of the consensus node.
   * <p>
   * This SHALL be used for establishing TLS connections.
   * 
   *
   * bytes agreement_certificate = 10;
   * @return The agreementCertificate.
   */
  com.google.protobuf.ByteString getAgreementCertificate();

  /**
   *    **
   * A string that provides additional information about this consensus node.
   * 
   *
   * string memo = 11;
   * @return The memo.
   */
  java.lang.String getMemo();
  /**
   *    **
   * A string that provides additional information about this consensus node.
   * 
   *
   * string memo = 11;
   * @return The bytes for memo.
   */
  com.google.protobuf.ByteString
      getMemoBytes();
}