Class HealthCheck.GrpcHealthCheck
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.core.v3.HealthCheck.GrpcHealthCheck
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,HealthCheck.GrpcHealthCheckOrBuilder
,Serializable
- Enclosing class:
HealthCheck
public static final class HealthCheck.GrpcHealthCheck
extends com.google.protobuf.GeneratedMessage
implements HealthCheck.GrpcHealthCheckOrBuilder
`grpc.health.v1.Health <https://github.com/grpc/grpc/blob/master/src/proto/grpc/health/v1/health.proto>`_-based healthcheck. See `gRPC doc <https://github.com/grpc/grpc/blob/master/doc/health-checking.md>`_ for details.Protobuf type
envoy.config.core.v3.HealthCheck.GrpcHealthCheck
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
`grpc.health.v1.Health <https://github.com/grpc/grpc/blob/master/src/proto/grpc/health/v1/health.proto>`_-based healthcheck.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Object
static final int
private static final HealthCheck.GrpcHealthCheck
static final int
private List
<HeaderValueOption> private byte
private static final com.google.protobuf.Parser
<HealthCheck.GrpcHealthCheck> private static final long
static final int
private Object
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
GrpcHealthCheck
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
The value of the :authority header in the gRPC health check request.com.google.protobuf.ByteString
The value of the :authority header in the gRPC health check request.static HealthCheck.GrpcHealthCheck
static final com.google.protobuf.Descriptors.Descriptor
getInitialMetadata
(int index) Specifies a list of key-value pairs that should be added to the metadata of each GRPC call that is sent to the health checked cluster.int
Specifies a list of key-value pairs that should be added to the metadata of each GRPC call that is sent to the health checked cluster.Specifies a list of key-value pairs that should be added to the metadata of each GRPC call that is sent to the health checked cluster.getInitialMetadataOrBuilder
(int index) Specifies a list of key-value pairs that should be added to the metadata of each GRPC call that is sent to the health checked cluster.List
<? extends HeaderValueOptionOrBuilder> Specifies a list of key-value pairs that should be added to the metadata of each GRPC call that is sent to the health checked cluster.com.google.protobuf.Parser
<HealthCheck.GrpcHealthCheck> int
An optional service name parameter which will be sent to gRPC service in `grpc.health.v1.HealthCheckRequest <https://github.com/grpc/grpc/blob/master/src/proto/grpc/health/v1/health.proto#L20>`_.com.google.protobuf.ByteString
An optional service name parameter which will be sent to gRPC service in `grpc.health.v1.HealthCheckRequest <https://github.com/grpc/grpc/blob/master/src/proto/grpc/health/v1/health.proto#L20>`_.int
hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
newBuilder
(HealthCheck.GrpcHealthCheck prototype) protected HealthCheck.GrpcHealthCheck.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) static HealthCheck.GrpcHealthCheck
parseDelimitedFrom
(InputStream input) static HealthCheck.GrpcHealthCheck
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static HealthCheck.GrpcHealthCheck
parseFrom
(byte[] data) static HealthCheck.GrpcHealthCheck
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static HealthCheck.GrpcHealthCheck
parseFrom
(com.google.protobuf.ByteString data) static HealthCheck.GrpcHealthCheck
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static HealthCheck.GrpcHealthCheck
parseFrom
(com.google.protobuf.CodedInputStream input) static HealthCheck.GrpcHealthCheck
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static HealthCheck.GrpcHealthCheck
parseFrom
(InputStream input) static HealthCheck.GrpcHealthCheck
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static HealthCheck.GrpcHealthCheck
parseFrom
(ByteBuffer data) static HealthCheck.GrpcHealthCheck
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<HealthCheck.GrpcHealthCheck> parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
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.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
SERVICE_NAME_FIELD_NUMBER
public static final int SERVICE_NAME_FIELD_NUMBER- See Also:
-
serviceName_
-
AUTHORITY_FIELD_NUMBER
public static final int AUTHORITY_FIELD_NUMBER- See Also:
-
authority_
-
INITIAL_METADATA_FIELD_NUMBER
public static final int INITIAL_METADATA_FIELD_NUMBER- See Also:
-
initialMetadata_
-
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
GrpcHealthCheck
private GrpcHealthCheck(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
GrpcHealthCheck
private GrpcHealthCheck()
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
getServiceName
An optional service name parameter which will be sent to gRPC service in `grpc.health.v1.HealthCheckRequest <https://github.com/grpc/grpc/blob/master/src/proto/grpc/health/v1/health.proto#L20>`_. message. See `gRPC health-checking overview <https://github.com/grpc/grpc/blob/master/doc/health-checking.md>`_ for more information.
string service_name = 1;
- Specified by:
getServiceName
in interfaceHealthCheck.GrpcHealthCheckOrBuilder
- Returns:
- The serviceName.
-
getServiceNameBytes
public com.google.protobuf.ByteString getServiceNameBytes()An optional service name parameter which will be sent to gRPC service in `grpc.health.v1.HealthCheckRequest <https://github.com/grpc/grpc/blob/master/src/proto/grpc/health/v1/health.proto#L20>`_. message. See `gRPC health-checking overview <https://github.com/grpc/grpc/blob/master/doc/health-checking.md>`_ for more information.
string service_name = 1;
- Specified by:
getServiceNameBytes
in interfaceHealthCheck.GrpcHealthCheckOrBuilder
- Returns:
- The bytes for serviceName.
-
getAuthority
The value of the :authority header in the gRPC health check request. If left empty (default value), the name of the cluster this health check is associated with will be used. The authority header can be customized for a specific endpoint by setting the :ref:`hostname <envoy_v3_api_field_config.endpoint.v3.Endpoint.HealthCheckConfig.hostname>` field.
string authority = 2 [(.validate.rules) = { ... }
- Specified by:
getAuthority
in interfaceHealthCheck.GrpcHealthCheckOrBuilder
- Returns:
- The authority.
-
getAuthorityBytes
public com.google.protobuf.ByteString getAuthorityBytes()The value of the :authority header in the gRPC health check request. If left empty (default value), the name of the cluster this health check is associated with will be used. The authority header can be customized for a specific endpoint by setting the :ref:`hostname <envoy_v3_api_field_config.endpoint.v3.Endpoint.HealthCheckConfig.hostname>` field.
string authority = 2 [(.validate.rules) = { ... }
- Specified by:
getAuthorityBytes
in interfaceHealthCheck.GrpcHealthCheckOrBuilder
- Returns:
- The bytes for authority.
-
getInitialMetadataList
Specifies a list of key-value pairs that should be added to the metadata of each GRPC call that is sent to the health checked cluster. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.core.v3.HeaderValueOption initial_metadata = 3 [(.validate.rules) = { ... }
- Specified by:
getInitialMetadataList
in interfaceHealthCheck.GrpcHealthCheckOrBuilder
-
getInitialMetadataOrBuilderList
Specifies a list of key-value pairs that should be added to the metadata of each GRPC call that is sent to the health checked cluster. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.core.v3.HeaderValueOption initial_metadata = 3 [(.validate.rules) = { ... }
- Specified by:
getInitialMetadataOrBuilderList
in interfaceHealthCheck.GrpcHealthCheckOrBuilder
-
getInitialMetadataCount
public int getInitialMetadataCount()Specifies a list of key-value pairs that should be added to the metadata of each GRPC call that is sent to the health checked cluster. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.core.v3.HeaderValueOption initial_metadata = 3 [(.validate.rules) = { ... }
- Specified by:
getInitialMetadataCount
in interfaceHealthCheck.GrpcHealthCheckOrBuilder
-
getInitialMetadata
Specifies a list of key-value pairs that should be added to the metadata of each GRPC call that is sent to the health checked cluster. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.core.v3.HeaderValueOption initial_metadata = 3 [(.validate.rules) = { ... }
- Specified by:
getInitialMetadata
in interfaceHealthCheck.GrpcHealthCheckOrBuilder
-
getInitialMetadataOrBuilder
Specifies a list of key-value pairs that should be added to the metadata of each GRPC call that is sent to the health checked cluster. For more information, including details on header value syntax, see the documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
repeated .envoy.config.core.v3.HeaderValueOption initial_metadata = 3 [(.validate.rules) = { ... }
- Specified by:
getInitialMetadataOrBuilder
in interfaceHealthCheck.GrpcHealthCheckOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static HealthCheck.GrpcHealthCheck parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static HealthCheck.GrpcHealthCheck parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static HealthCheck.GrpcHealthCheck parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static HealthCheck.GrpcHealthCheck parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static HealthCheck.GrpcHealthCheck parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static HealthCheck.GrpcHealthCheck parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static HealthCheck.GrpcHealthCheck parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static HealthCheck.GrpcHealthCheck parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static HealthCheck.GrpcHealthCheck parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static HealthCheck.GrpcHealthCheck parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected HealthCheck.GrpcHealthCheck.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-