Class HealthCheck.GrpcHealthCheck

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HealthCheck.GrpcHealthCheckOrBuilder, java.io.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:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  HealthCheck.GrpcHealthCheck.Builder
      `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 extends java.lang.Object>, 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
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private GrpcHealthCheck()  
      private GrpcHealthCheck​(com.google.protobuf.GeneratedMessage.Builder<?> builder)  
    • Field Detail

      • SERVICE_NAME_FIELD_NUMBER

        public static final int SERVICE_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values
      • serviceName_

        private volatile java.lang.Object serviceName_
      • authority_

        private volatile java.lang.Object authority_
      • INITIAL_METADATA_FIELD_NUMBER

        public static final int INITIAL_METADATA_FIELD_NUMBER
        See Also:
        Constant Field Values
      • memoizedIsInitialized

        private byte memoizedIsInitialized
    • Constructor Detail

      • GrpcHealthCheck

        private GrpcHealthCheck​(com.google.protobuf.GeneratedMessage.Builder<?> builder)
      • GrpcHealthCheck

        private GrpcHealthCheck()
    • Method Detail

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

        public java.lang.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.
      • getAuthority

        public java.lang.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.
      • getInitialMetadataList

        public java.util.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
      • getInitialMetadataOrBuilderList

        public java.util.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
      • 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
      • 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
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage
      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static HealthCheck.GrpcHealthCheck parseFrom​(java.nio.ByteBuffer data)
                                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static HealthCheck.GrpcHealthCheck parseFrom​(java.nio.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

        public static HealthCheck.GrpcHealthCheck parseFrom​(java.io.InputStream input)
                                                     throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static HealthCheck.GrpcHealthCheck parseFrom​(java.io.InputStream input,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static HealthCheck.GrpcHealthCheck parseDelimitedFrom​(java.io.InputStream input)
                                                              throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static HealthCheck.GrpcHealthCheck parseDelimitedFrom​(java.io.InputStream input,
                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                              throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static HealthCheck.GrpcHealthCheck parseFrom​(com.google.protobuf.CodedInputStream input)
                                                     throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static HealthCheck.GrpcHealthCheck parseFrom​(com.google.protobuf.CodedInputStream input,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws java.io.IOException
        Throws:
        java.io.IOException
      • newBuilderForType

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

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

        protected HealthCheck.GrpcHealthCheck.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage
      • getParserForType

        public com.google.protobuf.Parser<HealthCheck.GrpcHealthCheck> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessage
      • getDefaultInstanceForType

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