Package io.envoyproxy.envoy.service.health.v3

Class ClusterHealthCheck

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.service.health.v3.ClusterHealthCheck
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ClusterHealthCheckOrBuilder, Serializable
public final class ClusterHealthCheck extends com.google.protobuf.GeneratedMessageV3 implements ClusterHealthCheckOrBuilder
 The cluster name and locality is provided to Envoy for the endpoints that it
 health checks to support statistics reporting, logging and debugging by the
 Envoy instance (outside of HDS). For maximum usefulness, it should match the
 same cluster structure as that provided by EDS.
 [#next-free-field: 6]
Protobuf type envoy.service.health.v3.ClusterHealthCheck
See Also:

  • Field Details

    • CLUSTER_NAME_FIELD_NUMBER

      public static final int CLUSTER_NAME_FIELD_NUMBER
      See Also:

    • HEALTH_CHECKS_FIELD_NUMBER

      public static final int HEALTH_CHECKS_FIELD_NUMBER
      See Also:

    • LOCALITY_ENDPOINTS_FIELD_NUMBER

      public static final int LOCALITY_ENDPOINTS_FIELD_NUMBER
      See Also:

    • TRANSPORT_SOCKET_MATCHES_FIELD_NUMBER

      public static final int TRANSPORT_SOCKET_MATCHES_FIELD_NUMBER
      See Also:

    • UPSTREAM_BIND_CONFIG_FIELD_NUMBER

      public static final int UPSTREAM_BIND_CONFIG_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getClusterName

      public String getClusterName()
      string cluster_name = 1;
      Specified by:
      getClusterName in interface ClusterHealthCheckOrBuilder
      Returns:
      The clusterName.

    • getClusterNameBytes

      public com.google.protobuf.ByteString getClusterNameBytes()
      string cluster_name = 1;
      Specified by:
      getClusterNameBytes in interface ClusterHealthCheckOrBuilder
      Returns:
      The bytes for clusterName.

    • getHealthChecksList

      public List<HealthCheck> getHealthChecksList()
      repeated .envoy.config.core.v3.HealthCheck health_checks = 2;
      Specified by:
      getHealthChecksList in interface ClusterHealthCheckOrBuilder

    • getHealthChecksOrBuilderList

      public List<? extends HealthCheckOrBuilder> getHealthChecksOrBuilderList()
      repeated .envoy.config.core.v3.HealthCheck health_checks = 2;
      Specified by:
      getHealthChecksOrBuilderList in interface ClusterHealthCheckOrBuilder

    • getHealthChecksCount

      public int getHealthChecksCount()
      repeated .envoy.config.core.v3.HealthCheck health_checks = 2;
      Specified by:
      getHealthChecksCount in interface ClusterHealthCheckOrBuilder

    • getHealthChecks

      public HealthCheck getHealthChecks(int index)
      repeated .envoy.config.core.v3.HealthCheck health_checks = 2;
      Specified by:
      getHealthChecks in interface ClusterHealthCheckOrBuilder

    • getHealthChecksOrBuilder

      public HealthCheckOrBuilder getHealthChecksOrBuilder(int index)
      repeated .envoy.config.core.v3.HealthCheck health_checks = 2;
      Specified by:
      getHealthChecksOrBuilder in interface ClusterHealthCheckOrBuilder

    • getLocalityEndpointsList

      public List<LocalityEndpoints> getLocalityEndpointsList()
      repeated .envoy.service.health.v3.LocalityEndpoints locality_endpoints = 3;
      Specified by:
      getLocalityEndpointsList in interface ClusterHealthCheckOrBuilder

    • getLocalityEndpointsOrBuilderList

      public List<? extends LocalityEndpointsOrBuilder> getLocalityEndpointsOrBuilderList()
      repeated .envoy.service.health.v3.LocalityEndpoints locality_endpoints = 3;
      Specified by:
      getLocalityEndpointsOrBuilderList in interface ClusterHealthCheckOrBuilder

    • getLocalityEndpointsCount

      public int getLocalityEndpointsCount()
      repeated .envoy.service.health.v3.LocalityEndpoints locality_endpoints = 3;
      Specified by:
      getLocalityEndpointsCount in interface ClusterHealthCheckOrBuilder

    • getLocalityEndpoints

      public LocalityEndpoints getLocalityEndpoints(int index)
      repeated .envoy.service.health.v3.LocalityEndpoints locality_endpoints = 3;
      Specified by:
      getLocalityEndpoints in interface ClusterHealthCheckOrBuilder

    • getLocalityEndpointsOrBuilder

      public LocalityEndpointsOrBuilder getLocalityEndpointsOrBuilder(int index)
      repeated .envoy.service.health.v3.LocalityEndpoints locality_endpoints = 3;
      Specified by:
      getLocalityEndpointsOrBuilder in interface ClusterHealthCheckOrBuilder

    • getTransportSocketMatchesList

      public List<Cluster.TransportSocketMatch> getTransportSocketMatchesList()
       Optional map that gets filtered by :ref:`health_checks.transport_socket_match_criteria <envoy_v3_api_field_config.core.v3.HealthCheck.transport_socket_match_criteria>`
 on connection when health checking. For more details, see
 :ref:`config.cluster.v3.Cluster.transport_socket_matches <envoy_v3_api_field_config.cluster.v3.Cluster.transport_socket_matches>`.
      repeated .envoy.config.cluster.v3.Cluster.TransportSocketMatch transport_socket_matches = 4;
      Specified by:
      getTransportSocketMatchesList in interface ClusterHealthCheckOrBuilder

    • getTransportSocketMatchesOrBuilderList

      public List<? extends Cluster.TransportSocketMatchOrBuilder> getTransportSocketMatchesOrBuilderList()
       Optional map that gets filtered by :ref:`health_checks.transport_socket_match_criteria <envoy_v3_api_field_config.core.v3.HealthCheck.transport_socket_match_criteria>`
 on connection when health checking. For more details, see
 :ref:`config.cluster.v3.Cluster.transport_socket_matches <envoy_v3_api_field_config.cluster.v3.Cluster.transport_socket_matches>`.
      repeated .envoy.config.cluster.v3.Cluster.TransportSocketMatch transport_socket_matches = 4;
      Specified by:
      getTransportSocketMatchesOrBuilderList in interface ClusterHealthCheckOrBuilder

    • getTransportSocketMatchesCount

      public int getTransportSocketMatchesCount()
       Optional map that gets filtered by :ref:`health_checks.transport_socket_match_criteria <envoy_v3_api_field_config.core.v3.HealthCheck.transport_socket_match_criteria>`
 on connection when health checking. For more details, see
 :ref:`config.cluster.v3.Cluster.transport_socket_matches <envoy_v3_api_field_config.cluster.v3.Cluster.transport_socket_matches>`.
      repeated .envoy.config.cluster.v3.Cluster.TransportSocketMatch transport_socket_matches = 4;
      Specified by:
      getTransportSocketMatchesCount in interface ClusterHealthCheckOrBuilder

    • getTransportSocketMatches

      public Cluster.TransportSocketMatch getTransportSocketMatches(int index)
       Optional map that gets filtered by :ref:`health_checks.transport_socket_match_criteria <envoy_v3_api_field_config.core.v3.HealthCheck.transport_socket_match_criteria>`
 on connection when health checking. For more details, see
 :ref:`config.cluster.v3.Cluster.transport_socket_matches <envoy_v3_api_field_config.cluster.v3.Cluster.transport_socket_matches>`.
      repeated .envoy.config.cluster.v3.Cluster.TransportSocketMatch transport_socket_matches = 4;
      Specified by:
      getTransportSocketMatches in interface ClusterHealthCheckOrBuilder

    • getTransportSocketMatchesOrBuilder

      public Cluster.TransportSocketMatchOrBuilder getTransportSocketMatchesOrBuilder(int index)
       Optional map that gets filtered by :ref:`health_checks.transport_socket_match_criteria <envoy_v3_api_field_config.core.v3.HealthCheck.transport_socket_match_criteria>`
 on connection when health checking. For more details, see
 :ref:`config.cluster.v3.Cluster.transport_socket_matches <envoy_v3_api_field_config.cluster.v3.Cluster.transport_socket_matches>`.
      repeated .envoy.config.cluster.v3.Cluster.TransportSocketMatch transport_socket_matches = 4;
      Specified by:
      getTransportSocketMatchesOrBuilder in interface ClusterHealthCheckOrBuilder

    • hasUpstreamBindConfig

      public boolean hasUpstreamBindConfig()
       Optional configuration used to bind newly established upstream connections.
 If the address and port are empty, no bind will be performed.
      .envoy.config.core.v3.BindConfig upstream_bind_config = 5;
      Specified by:
      hasUpstreamBindConfig in interface ClusterHealthCheckOrBuilder
      Returns:
      Whether the upstreamBindConfig field is set.

    • getUpstreamBindConfig

      public BindConfig getUpstreamBindConfig()
       Optional configuration used to bind newly established upstream connections.
 If the address and port are empty, no bind will be performed.
      .envoy.config.core.v3.BindConfig upstream_bind_config = 5;
      Specified by:
      getUpstreamBindConfig in interface ClusterHealthCheckOrBuilder
      Returns:
      The upstreamBindConfig.

    • getUpstreamBindConfigOrBuilder

      public BindConfigOrBuilder getUpstreamBindConfigOrBuilder()
       Optional configuration used to bind newly established upstream connections.
 If the address and port are empty, no bind will be performed.
      .envoy.config.core.v3.BindConfig upstream_bind_config = 5;
      Specified by:
      getUpstreamBindConfigOrBuilder in interface ClusterHealthCheckOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ClusterHealthCheck parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ClusterHealthCheck parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ClusterHealthCheck parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ClusterHealthCheck parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ClusterHealthCheck parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ClusterHealthCheck parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ClusterHealthCheck parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ClusterHealthCheck parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ClusterHealthCheck parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ClusterHealthCheck parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ClusterHealthCheck parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ClusterHealthCheck parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ClusterHealthCheck.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ClusterHealthCheck.Builder newBuilder()

    • newBuilder

      public static ClusterHealthCheck.Builder newBuilder(ClusterHealthCheck prototype)

    • toBuilder

      public ClusterHealthCheck.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ClusterHealthCheck.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static ClusterHealthCheck getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ClusterHealthCheck> parser()

    • getParserForType

      public com.google.protobuf.Parser<ClusterHealthCheck> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public ClusterHealthCheck getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder