Package com.google.cloud.compute.v1

Class TCPHealthCheck

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

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  TCPHealthCheck.Builder
      static class  TCPHealthCheck.PortSpecification
      Specifies how a port is selected for health checking.
      static class  TCPHealthCheck.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 Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      static TCPHealthCheck getDefaultInstance()  
      TCPHealthCheck getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Parser<TCPHealthCheck> getParserForType()  
      int getPort()
      The TCP port number to which the health check prober sends packets.
      String getPortName()
      Not supported.
      com.google.protobuf.ByteString getPortNameBytes()
      Not supported.
      String getPortSpecification()
      Specifies how a port is selected for health checking.
      com.google.protobuf.ByteString getPortSpecificationBytes()
      Specifies how a port is selected for health checking.
      String getProxyHeader()
      Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1.
      com.google.protobuf.ByteString getProxyHeaderBytes()
      Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1.
      String getRequest()
      Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection.
      com.google.protobuf.ByteString getRequestBytes()
      Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection.
      String getResponse()
      Creates a content-based TCP health check.
      com.google.protobuf.ByteString getResponseBytes()
      Creates a content-based TCP health check.
      int getSerializedSize()  
      int hashCode()  
      boolean hasPort()
      The TCP port number to which the health check prober sends packets.
      boolean hasPortName()
      Not supported.
      boolean hasPortSpecification()
      Specifies how a port is selected for health checking.
      boolean hasProxyHeader()
      Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1.
      boolean hasRequest()
      Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection.
      boolean hasResponse()
      Creates a content-based TCP health check.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static TCPHealthCheck.Builder newBuilder()  
      static TCPHealthCheck.Builder newBuilder​(TCPHealthCheck prototype)  
      TCPHealthCheck.Builder newBuilderForType()  
      protected TCPHealthCheck.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static TCPHealthCheck parseDelimitedFrom​(InputStream input)  
      static TCPHealthCheck parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static TCPHealthCheck parseFrom​(byte[] data)  
      static TCPHealthCheck parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static TCPHealthCheck parseFrom​(com.google.protobuf.ByteString data)  
      static TCPHealthCheck parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static TCPHealthCheck parseFrom​(com.google.protobuf.CodedInputStream input)  
      static TCPHealthCheck parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static TCPHealthCheck parseFrom​(InputStream input)  
      static TCPHealthCheck parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static TCPHealthCheck parseFrom​(ByteBuffer data)  
      static TCPHealthCheck parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<TCPHealthCheck> parser()  
      TCPHealthCheck.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • 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

      • hasPort

        public boolean hasPort()
         The TCP port number to which the health check prober sends packets. The default value is 80. Valid values are 1 through 65535.
        optional int32 port = 3446913;
        Specified by:
        hasPort in interface TCPHealthCheckOrBuilder
        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 80. Valid values are 1 through 65535.
        optional int32 port = 3446913;
        Specified by:
        getPort in interface TCPHealthCheckOrBuilder
        Returns:
        The port.

      • hasPortName

        public boolean hasPortName()
         Not supported.
        optional string port_name = 41534345;
        Specified by:
        hasPortName in interface TCPHealthCheckOrBuilder
        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 TCPHealthCheckOrBuilder
        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 TCPHealthCheckOrBuilder
        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 TCPHealthCheckOrBuilder
        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 TCPHealthCheckOrBuilder
        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 TCPHealthCheckOrBuilder
        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 TCPHealthCheckOrBuilder
        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 TCPHealthCheckOrBuilder
        Returns:
        The bytes for proxyHeader.

      • hasRequest

        public boolean hasRequest()
         Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection.
        optional string request = 21951119;
        Specified by:
        hasRequest in interface TCPHealthCheckOrBuilder
        Returns:
        Whether the request field is set.

      • getRequest

        public String getRequest()
         Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection.
        optional string request = 21951119;
        Specified by:
        getRequest in interface TCPHealthCheckOrBuilder
        Returns:
        The request.

      • getRequestBytes

        public com.google.protobuf.ByteString getRequestBytes()
         Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection.
        optional string request = 21951119;
        Specified by:
        getRequestBytes in interface TCPHealthCheckOrBuilder
        Returns:
        The bytes for request.

      • hasResponse

        public boolean hasResponse()
         Creates a content-based TCP health check. In addition to establishing a TCP connection, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp
        optional string response = 196547649;
        Specified by:
        hasResponse in interface TCPHealthCheckOrBuilder
        Returns:
        Whether the response field is set.

      • getResponse

        public String getResponse()
         Creates a content-based TCP health check. In addition to establishing a TCP connection, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp
        optional string response = 196547649;
        Specified by:
        getResponse in interface TCPHealthCheckOrBuilder
        Returns:
        The response.

      • getResponseBytes

        public com.google.protobuf.ByteString getResponseBytes()
         Creates a content-based TCP health check. In addition to establishing a TCP connection, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp
        optional string response = 196547649;
        Specified by:
        getResponseBytes in interface TCPHealthCheckOrBuilder
        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 TCPHealthCheck parseFrom​(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static TCPHealthCheck getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<TCPHealthCheck> parser()

      • getParserForType

        public com.google.protobuf.Parser<TCPHealthCheck> 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 TCPHealthCheck getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder