Package io.envoyproxy.envoy.api.v2.core

Interface HealthCheck.GrpcHealthCheckOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getAuthority()
      The value of the :authority header in the gRPC health check request.
      com.google.protobuf.ByteString getAuthorityBytes()
      The value of the :authority header in the gRPC health check request.
      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>`_.
      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>`_.

      • 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 Detail

      • 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_api_field_endpoint.Endpoint.HealthCheckConfig.hostname>` field.
        string authority = 2;
        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_api_field_endpoint.Endpoint.HealthCheckConfig.hostname>` field.
        string authority = 2;
        Returns:
        The bytes for authority.