Class HealthCheck.GrpcHealthCheck.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<HealthCheck.GrpcHealthCheck.Builder>
com.google.protobuf.GeneratedMessage.Builder<HealthCheck.GrpcHealthCheck.Builder>
io.envoyproxy.envoy.config.core.v3.HealthCheck.GrpcHealthCheck.Builder
- All Implemented Interfaces:
com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,HealthCheck.GrpcHealthCheckOrBuilder
,Cloneable
- Enclosing class:
HealthCheck.GrpcHealthCheck
public static final class HealthCheck.GrpcHealthCheck.Builder
extends com.google.protobuf.GeneratedMessage.Builder<HealthCheck.GrpcHealthCheck.Builder>
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
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Object
private int
private List
<HeaderValueOption> private com.google.protobuf.RepeatedFieldBuilder
<HeaderValueOption, HeaderValueOption.Builder, HeaderValueOptionOrBuilder> private Object
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAllInitialMetadata
(Iterable<? extends HeaderValueOption> values) 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.addInitialMetadata
(int index, HeaderValueOption value) 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.addInitialMetadata
(int index, HeaderValueOption.Builder builderForValue) 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.addInitialMetadata
(HeaderValueOption.Builder builderForValue) 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.addInitialMetadataBuilder
(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.build()
private void
private void
clear()
The value of the :authority header in the gRPC health check request.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.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>`_.private void
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 final com.google.protobuf.Descriptors.Descriptor
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.getInitialMetadataBuilder
(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.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.private com.google.protobuf.RepeatedFieldBuilder
<HeaderValueOption, HeaderValueOption.Builder, 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.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.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>`_.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
mergeFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.Message other) removeInitialMetadata
(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.setAuthority
(String value) The value of the :authority header in the gRPC health check request.setAuthorityBytes
(com.google.protobuf.ByteString value) The value of the :authority header in the gRPC health check request.setInitialMetadata
(int index, HeaderValueOption value) 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.setInitialMetadata
(int index, HeaderValueOption.Builder builderForValue) 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.setServiceName
(String value) 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>`_.setServiceNameBytes
(com.google.protobuf.ByteString value) 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>`_.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
bitField0_
private int bitField0_ -
serviceName_
-
authority_
-
initialMetadata_
-
initialMetadataBuilder_
private com.google.protobuf.RepeatedFieldBuilder<HeaderValueOption,HeaderValueOption.Builder, initialMetadataBuilder_HeaderValueOptionOrBuilder>
-
-
Constructor Details
-
Builder
private Builder() -
Builder
private Builder(com.google.protobuf.AbstractMessage.BuilderParent parent)
-
-
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.Builder<HealthCheck.GrpcHealthCheck.Builder>
-
clear
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessage.Builder<HealthCheck.GrpcHealthCheck.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessage.Builder<HealthCheck.GrpcHealthCheck.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartialRepeatedFields
-
buildPartial0
-
mergeFrom
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<HealthCheck.GrpcHealthCheck.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage.Builder<HealthCheck.GrpcHealthCheck.Builder>
-
mergeFrom
public HealthCheck.GrpcHealthCheck.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<HealthCheck.GrpcHealthCheck.Builder>
- Throws:
IOException
-
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.
-
setServiceName
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;
- Parameters:
value
- The serviceName to set.- Returns:
- This builder for chaining.
-
clearServiceName
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;
- Returns:
- This builder for chaining.
-
setServiceNameBytes
public HealthCheck.GrpcHealthCheck.Builder setServiceNameBytes(com.google.protobuf.ByteString value) 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;
- Parameters:
value
- The bytes for serviceName to set.- Returns:
- This builder for chaining.
-
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.
-
setAuthority
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) = { ... }
- Parameters:
value
- The authority to set.- Returns:
- This builder for chaining.
-
clearAuthority
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) = { ... }
- Returns:
- This builder for chaining.
-
setAuthorityBytes
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) = { ... }
- Parameters:
value
- The bytes for authority to set.- Returns:
- This builder for chaining.
-
ensureInitialMetadataIsMutable
private void ensureInitialMetadataIsMutable() -
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
-
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
-
setInitialMetadata
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) = { ... }
-
setInitialMetadata
public HealthCheck.GrpcHealthCheck.Builder setInitialMetadata(int index, HeaderValueOption.Builder builderForValue) 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) = { ... }
-
addInitialMetadata
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) = { ... }
-
addInitialMetadata
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) = { ... }
-
addInitialMetadata
public HealthCheck.GrpcHealthCheck.Builder addInitialMetadata(HeaderValueOption.Builder builderForValue) 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) = { ... }
-
addInitialMetadata
public HealthCheck.GrpcHealthCheck.Builder addInitialMetadata(int index, HeaderValueOption.Builder builderForValue) 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) = { ... }
-
addAllInitialMetadata
public HealthCheck.GrpcHealthCheck.Builder addAllInitialMetadata(Iterable<? extends HeaderValueOption> values) 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) = { ... }
-
clearInitialMetadata
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) = { ... }
-
removeInitialMetadata
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) = { ... }
-
getInitialMetadataBuilder
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) = { ... }
-
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
-
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
-
addInitialMetadataBuilder
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) = { ... }
-
addInitialMetadataBuilder
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) = { ... }
-
getInitialMetadataBuilderList
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) = { ... }
-
getInitialMetadataFieldBuilder
private com.google.protobuf.RepeatedFieldBuilder<HeaderValueOption,HeaderValueOption.Builder, getInitialMetadataFieldBuilder()HeaderValueOptionOrBuilder>
-