ClusterHealthCheck (api 0.1.28 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - io.envoyproxy.envoy.service.health.v4alpha.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.

Protobuf type envoy.service.health.v4alpha.ClusterHealthCheck

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ClusterHealthCheck.Builder` 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).

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CLUSTER_NAME_FIELD_NUMBER`
`static int`	`HEALTH_CHECKS_FIELD_NUMBER`
`static int`	`LOCALITY_ENDPOINTS_FIELD_NUMBER`
`static int`	`TRANSPORT_SOCKET_MATCHES_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getClusterName()` `string cluster_name = 1;`
`com.google.protobuf.ByteString`	`getClusterNameBytes()` `string cluster_name = 1;`
`static ClusterHealthCheck`	`getDefaultInstance()`
`ClusterHealthCheck`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`HealthCheck`	`getHealthChecks(int index)` `repeated .envoy.config.core.v4alpha.HealthCheck health_checks = 2;`
`int`	`getHealthChecksCount()` `repeated .envoy.config.core.v4alpha.HealthCheck health_checks = 2;`
`List<HealthCheck>`	`getHealthChecksList()` `repeated .envoy.config.core.v4alpha.HealthCheck health_checks = 2;`
`HealthCheckOrBuilder`	`getHealthChecksOrBuilder(int index)` `repeated .envoy.config.core.v4alpha.HealthCheck health_checks = 2;`
`List<? extends HealthCheckOrBuilder>`	`getHealthChecksOrBuilderList()` `repeated .envoy.config.core.v4alpha.HealthCheck health_checks = 2;`
`LocalityEndpoints`	`getLocalityEndpoints(int index)` `repeated .envoy.service.health.v4alpha.LocalityEndpoints locality_endpoints = 3;`
`int`	`getLocalityEndpointsCount()` `repeated .envoy.service.health.v4alpha.LocalityEndpoints locality_endpoints = 3;`
`List<LocalityEndpoints>`	`getLocalityEndpointsList()` `repeated .envoy.service.health.v4alpha.LocalityEndpoints locality_endpoints = 3;`
`LocalityEndpointsOrBuilder`	`getLocalityEndpointsOrBuilder(int index)` `repeated .envoy.service.health.v4alpha.LocalityEndpoints locality_endpoints = 3;`
`List<? extends LocalityEndpointsOrBuilder>`	`getLocalityEndpointsOrBuilderList()` `repeated .envoy.service.health.v4alpha.LocalityEndpoints locality_endpoints = 3;`
`com.google.protobuf.Parser<ClusterHealthCheck>`	`getParserForType()`
`int`	`getSerializedSize()`
`Cluster.TransportSocketMatch`	`getTransportSocketMatches(int index)` Optional map that gets filtered by :ref:`health_checks.transport_socket_match_criteria <envoy_api_field_config.core.v4alpha.HealthCheck.transport_socket_match_criteria>` on connection when health checking.
`int`	`getTransportSocketMatchesCount()` Optional map that gets filtered by :ref:`health_checks.transport_socket_match_criteria <envoy_api_field_config.core.v4alpha.HealthCheck.transport_socket_match_criteria>` on connection when health checking.
`List<Cluster.TransportSocketMatch>`	`getTransportSocketMatchesList()` Optional map that gets filtered by :ref:`health_checks.transport_socket_match_criteria <envoy_api_field_config.core.v4alpha.HealthCheck.transport_socket_match_criteria>` on connection when health checking.
`Cluster.TransportSocketMatchOrBuilder`	`getTransportSocketMatchesOrBuilder(int index)` Optional map that gets filtered by :ref:`health_checks.transport_socket_match_criteria <envoy_api_field_config.core.v4alpha.HealthCheck.transport_socket_match_criteria>` on connection when health checking.
`List<? extends Cluster.TransportSocketMatchOrBuilder>`	`getTransportSocketMatchesOrBuilderList()` Optional map that gets filtered by :ref:`health_checks.transport_socket_match_criteria <envoy_api_field_config.core.v4alpha.HealthCheck.transport_socket_match_criteria>` on connection when health checking.
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`int`	`hashCode()`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static ClusterHealthCheck.Builder`	`newBuilder()`
`static ClusterHealthCheck.Builder`	`newBuilder(ClusterHealthCheck prototype)`
`ClusterHealthCheck.Builder`	`newBuilderForType()`
`protected ClusterHealthCheck.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static ClusterHealthCheck`	`parseDelimitedFrom(InputStream input)`
`static ClusterHealthCheck`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ClusterHealthCheck`	`parseFrom(byte[] data)`
`static ClusterHealthCheck`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ClusterHealthCheck`	`parseFrom(ByteBuffer data)`
`static ClusterHealthCheck`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ClusterHealthCheck`	`parseFrom(com.google.protobuf.ByteString data)`
`static ClusterHealthCheck`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ClusterHealthCheck`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static ClusterHealthCheck`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ClusterHealthCheck`	`parseFrom(InputStream input)`
`static ClusterHealthCheck`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<ClusterHealthCheck>`	`parser()`
`ClusterHealthCheck.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- CLUSTER_NAME_FIELD_NUMBER
```
public static final int CLUSTER_NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- HEALTH_CHECKS_FIELD_NUMBER
```
public static final int HEALTH_CHECKS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LOCALITY_ENDPOINTS_FIELD_NUMBER
```
public static final int LOCALITY_ENDPOINTS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TRANSPORT_SOCKET_MATCHES_FIELD_NUMBER
```
public static final int TRANSPORT_SOCKET_MATCHES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields 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

getClusterNameBytes
```
public com.google.protobuf.ByteString getClusterNameBytes()
```
string cluster_name = 1;

Specified by:

getClusterNameBytes in interface ClusterHealthCheckOrBuilder

getHealthChecksList
```
public List<HealthCheck> getHealthChecksList()
```
repeated .envoy.config.core.v4alpha.HealthCheck health_checks = 2;

Specified by:

getHealthChecksList in interface ClusterHealthCheckOrBuilder

getHealthChecksOrBuilderList
```
public List<? extends HealthCheckOrBuilder> getHealthChecksOrBuilderList()
```
repeated .envoy.config.core.v4alpha.HealthCheck health_checks = 2;

Specified by:

getHealthChecksOrBuilderList in interface ClusterHealthCheckOrBuilder

getHealthChecksCount
```
public int getHealthChecksCount()
```
repeated .envoy.config.core.v4alpha.HealthCheck health_checks = 2;

Specified by:

getHealthChecksCount in interface ClusterHealthCheckOrBuilder

getHealthChecks
```
public HealthCheck getHealthChecks(int index)
```
repeated .envoy.config.core.v4alpha.HealthCheck health_checks = 2;

Specified by:

getHealthChecks in interface ClusterHealthCheckOrBuilder

getHealthChecksOrBuilder
```
public HealthCheckOrBuilder getHealthChecksOrBuilder(int index)
```
repeated .envoy.config.core.v4alpha.HealthCheck health_checks = 2;

Specified by:

getHealthChecksOrBuilder in interface ClusterHealthCheckOrBuilder

getLocalityEndpointsList
```
public List<LocalityEndpoints> getLocalityEndpointsList()
```
repeated .envoy.service.health.v4alpha.LocalityEndpoints locality_endpoints = 3;

Specified by:

getLocalityEndpointsList in interface ClusterHealthCheckOrBuilder

getLocalityEndpointsOrBuilderList
```
public List<? extends LocalityEndpointsOrBuilder> getLocalityEndpointsOrBuilderList()
```
repeated .envoy.service.health.v4alpha.LocalityEndpoints locality_endpoints = 3;

Specified by:

getLocalityEndpointsOrBuilderList in interface ClusterHealthCheckOrBuilder

getLocalityEndpointsCount
```
public int getLocalityEndpointsCount()
```
repeated .envoy.service.health.v4alpha.LocalityEndpoints locality_endpoints = 3;

Specified by:

getLocalityEndpointsCount in interface ClusterHealthCheckOrBuilder

getLocalityEndpoints
```
public LocalityEndpoints getLocalityEndpoints(int index)
```
repeated .envoy.service.health.v4alpha.LocalityEndpoints locality_endpoints = 3;

Specified by:

getLocalityEndpoints in interface ClusterHealthCheckOrBuilder

getLocalityEndpointsOrBuilder
```
public LocalityEndpointsOrBuilder getLocalityEndpointsOrBuilder(int index)
```
repeated .envoy.service.health.v4alpha.LocalityEndpoints locality_endpoints = 3;

Specified by:

getLocalityEndpointsOrBuilder in interface ClusterHealthCheckOrBuilder