Package com.google.cloud.compute.v1

Class HTTPSHealthCheck

  • All Implemented Interfaces:
    HTTPSHealthCheckOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class HTTPSHealthCheck
extends com.google.protobuf.GeneratedMessageV3
implements HTTPSHealthCheckOrBuilder
    Protobuf type google.cloud.compute.v1.HTTPSHealthCheck
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  HTTPSHealthCheck.Builder
      static class  HTTPSHealthCheck.PortSpecification
      Specifies how a port is selected for health checking.
      static class  HTTPSHealthCheck.ProxyHeader
      Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasHost

        public boolean hasHost()
         The value of the host header in the HTTPS health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest
        optional string host = 3208616;
        Specified by:
        hasHost in interface HTTPSHealthCheckOrBuilder
        Returns:
        Whether the host field is set.

      • getHost

        public String getHost()
         The value of the host header in the HTTPS health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest
        optional string host = 3208616;
        Specified by:
        getHost in interface HTTPSHealthCheckOrBuilder
        Returns:
        The host.

      • getHostBytes

        public com.google.protobuf.ByteString getHostBytes()
         The value of the host header in the HTTPS health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest
        optional string host = 3208616;
        Specified by:
        getHostBytes in interface HTTPSHealthCheckOrBuilder
        Returns:
        The bytes for host.

      • hasPort

        public boolean hasPort()
         The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535.
        optional int32 port = 3446913;
        Specified by:
        hasPort in interface HTTPSHealthCheckOrBuilder
        Returns:
        Whether the port field is set.

      • getPort

        public int getPort()
         The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535.
        optional int32 port = 3446913;
        Specified by:
        getPort in interface HTTPSHealthCheckOrBuilder
        Returns:
        The port.

      • hasPortName

        public boolean hasPortName()
         Not supported.
        optional string port_name = 41534345;
        Specified by:
        hasPortName in interface HTTPSHealthCheckOrBuilder
        Returns:
        Whether the portName field is set.

      • getPortNameBytes

        public com.google.protobuf.ByteString getPortNameBytes()
         Not supported.
        optional string port_name = 41534345;
        Specified by:
        getPortNameBytes in interface HTTPSHealthCheckOrBuilder
        Returns:
        The bytes for portName.

      • hasPortSpecification

        public boolean hasPortSpecification()
         Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.
 Check the PortSpecification enum for the list of possible values.
        optional string port_specification = 51590597;
        Specified by:
        hasPortSpecification in interface HTTPSHealthCheckOrBuilder
        Returns:
        Whether the portSpecification field is set.

      • getPortSpecification

        public String getPortSpecification()
         Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.
 Check the PortSpecification enum for the list of possible values.
        optional string port_specification = 51590597;
        Specified by:
        getPortSpecification in interface HTTPSHealthCheckOrBuilder
        Returns:
        The portSpecification.

      • getPortSpecificationBytes

        public com.google.protobuf.ByteString getPortSpecificationBytes()
         Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.
 Check the PortSpecification enum for the list of possible values.
        optional string port_specification = 51590597;
        Specified by:
        getPortSpecificationBytes in interface HTTPSHealthCheckOrBuilder
        Returns:
        The bytes for portSpecification.

      • hasProxyHeader

        public boolean hasProxyHeader()
         Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
 Check the ProxyHeader enum for the list of possible values.
        optional string proxy_header = 160374142;
        Specified by:
        hasProxyHeader in interface HTTPSHealthCheckOrBuilder
        Returns:
        Whether the proxyHeader field is set.

      • getProxyHeader

        public String getProxyHeader()
         Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
 Check the ProxyHeader enum for the list of possible values.
        optional string proxy_header = 160374142;
        Specified by:
        getProxyHeader in interface HTTPSHealthCheckOrBuilder
        Returns:
        The proxyHeader.

      • getProxyHeaderBytes

        public com.google.protobuf.ByteString getProxyHeaderBytes()
         Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
 Check the ProxyHeader enum for the list of possible values.
        optional string proxy_header = 160374142;
        Specified by:
        getProxyHeaderBytes in interface HTTPSHealthCheckOrBuilder
        Returns:
        The bytes for proxyHeader.

      • hasRequestPath

        public boolean hasRequestPath()
         The request path of the HTTPS health check request. The default value is /.
        optional string request_path = 229403605;
        Specified by:
        hasRequestPath in interface HTTPSHealthCheckOrBuilder
        Returns:
        Whether the requestPath field is set.

      • getRequestPath

        public String getRequestPath()
         The request path of the HTTPS health check request. The default value is /.
        optional string request_path = 229403605;
        Specified by:
        getRequestPath in interface HTTPSHealthCheckOrBuilder
        Returns:
        The requestPath.

      • getRequestPathBytes

        public com.google.protobuf.ByteString getRequestPathBytes()
         The request path of the HTTPS health check request. The default value is /.
        optional string request_path = 229403605;
        Specified by:
        getRequestPathBytes in interface HTTPSHealthCheckOrBuilder
        Returns:
        The bytes for requestPath.

      • hasResponse

        public boolean hasResponse()
         Creates a content-based HTTPS health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http
        optional string response = 196547649;
        Specified by:
        hasResponse in interface HTTPSHealthCheckOrBuilder
        Returns:
        Whether the response field is set.

      • getResponse

        public String getResponse()
         Creates a content-based HTTPS health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http
        optional string response = 196547649;
        Specified by:
        getResponse in interface HTTPSHealthCheckOrBuilder
        Returns:
        The response.

      • getResponseBytes

        public com.google.protobuf.ByteString getResponseBytes()
         Creates a content-based HTTPS health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http
        optional string response = 196547649;
        Specified by:
        getResponseBytes in interface HTTPSHealthCheckOrBuilder
        Returns:
        The bytes for response.

      • isInitialized

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

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • equals

        public boolean equals​(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 HTTPSHealthCheck parseFrom​(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HTTPSHealthCheck parseFrom​(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HTTPSHealthCheck parseFrom​(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HTTPSHealthCheck parseFrom​(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HTTPSHealthCheck parseFrom​(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HTTPSHealthCheck parseFrom​(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HTTPSHealthCheck parseFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException
        Throws:
        IOException

      • newBuilderForType

        public HTTPSHealthCheck.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public HTTPSHealthCheck.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected HTTPSHealthCheck.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<HTTPSHealthCheck> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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