Package io.envoyproxy.envoy.config.core.v3

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 Details

  • 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 class com.google.protobuf.GeneratedMessage.Builder<HealthCheck.GrpcHealthCheck.Builder>

    • clear

      public HealthCheck.GrpcHealthCheck.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<HealthCheck.GrpcHealthCheck.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<HealthCheck.GrpcHealthCheck.Builder>

    • getDefaultInstanceForType

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

    • build

      public HealthCheck.GrpcHealthCheck build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public HealthCheck.GrpcHealthCheck buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • buildPartialRepeatedFields

      private void buildPartialRepeatedFields(HealthCheck.GrpcHealthCheck result)

    • buildPartial0

      private void buildPartial0(HealthCheck.GrpcHealthCheck result)

    • mergeFrom

      public HealthCheck.GrpcHealthCheck.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HealthCheck.GrpcHealthCheck.Builder>

    • mergeFrom

      public HealthCheck.GrpcHealthCheck.Builder mergeFrom(HealthCheck.GrpcHealthCheck other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.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 interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HealthCheck.GrpcHealthCheck.Builder>
      Throws:
      IOException

    • getServiceName

      public 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;
      Specified by:
      getServiceName in interface HealthCheck.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 interface HealthCheck.GrpcHealthCheckOrBuilder
      Returns:
      The bytes for serviceName.

    • setServiceName

      public HealthCheck.GrpcHealthCheck.Builder 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>`_.
 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

      public HealthCheck.GrpcHealthCheck.Builder 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

      public 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) = { ... }
      Specified by:
      getAuthority in interface HealthCheck.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 interface HealthCheck.GrpcHealthCheckOrBuilder
      Returns:
      The bytes for authority.

    • setAuthority

      public HealthCheck.GrpcHealthCheck.Builder setAuthority(String value)
       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

      public HealthCheck.GrpcHealthCheck.Builder 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

      public HealthCheck.GrpcHealthCheck.Builder setAuthorityBytes(com.google.protobuf.ByteString value)
       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

      public 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) = { ... }
      Specified by:
      getInitialMetadataList in interface HealthCheck.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 interface HealthCheck.GrpcHealthCheckOrBuilder

    • getInitialMetadata

      public HeaderValueOption 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. 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 interface HealthCheck.GrpcHealthCheckOrBuilder

    • setInitialMetadata

      public HealthCheck.GrpcHealthCheck.Builder 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. 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

      public HealthCheck.GrpcHealthCheck.Builder addInitialMetadata(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. 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 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. 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

      public HealthCheck.GrpcHealthCheck.Builder 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

      public HealthCheck.GrpcHealthCheck.Builder 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. 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

      public HeaderValueOption.Builder 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. 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

      public HeaderValueOptionOrBuilder 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. 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 interface HealthCheck.GrpcHealthCheckOrBuilder

    • getInitialMetadataOrBuilderList

      public 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) = { ... }
      Specified by:
      getInitialMetadataOrBuilderList in interface HealthCheck.GrpcHealthCheckOrBuilder

    • addInitialMetadataBuilder

      public HeaderValueOption.Builder 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

      public HeaderValueOption.Builder 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. 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

      public List<HeaderValueOption.Builder> 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,HeaderValueOptionOrBuilder> getInitialMetadataFieldBuilder()