Interface HealthCheck.GrpcHealthCheckOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
HealthCheck.GrpcHealthCheck
,HealthCheck.GrpcHealthCheck.Builder
- Enclosing class:
HealthCheck
public static interface HealthCheck.GrpcHealthCheckOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionThe 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.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.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>`_.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getServiceName
String 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;
- Returns:
- The serviceName.
-
getServiceNameBytes
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;
- Returns:
- The bytes for serviceName.
-
getAuthority
String 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) = { ... }
- Returns:
- The authority.
-
getAuthorityBytes
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) = { ... }
- Returns:
- The bytes for authority.
-
getInitialMetadataList
List<HeaderValueOption> 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) = { ... }
-
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) = { ... }
-
getInitialMetadataCount
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) = { ... }
-
getInitialMetadataOrBuilderList
List<? extends HeaderValueOptionOrBuilder> 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) = { ... }
-
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) = { ... }
-