Class TCPHealthCheck.Builder

  • All Implemented Interfaces:
    TCPHealthCheckOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    TCPHealthCheck

    public static final class TCPHealthCheck.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<TCPHealthCheck.Builder>
    implements TCPHealthCheckOrBuilder
     
    Protobuf type google.cloud.compute.v1.TCPHealthCheck
    • Method Detail

      • 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.Builder<TCPHealthCheck.Builder>
      • clear

        public TCPHealthCheck.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.GeneratedMessageV3.Builder<TCPHealthCheck.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.GeneratedMessageV3.Builder<TCPHealthCheck.Builder>
      • getDefaultInstanceForType

        public TCPHealthCheck getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

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

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

        public TCPHealthCheck.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<TCPHealthCheck.Builder>
      • setField

        public TCPHealthCheck.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<TCPHealthCheck.Builder>
      • clearField

        public TCPHealthCheck.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<TCPHealthCheck.Builder>
      • clearOneof

        public TCPHealthCheck.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<TCPHealthCheck.Builder>
      • setRepeatedField

        public TCPHealthCheck.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       int index,
                                                       Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TCPHealthCheck.Builder>
      • addRepeatedField

        public TCPHealthCheck.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TCPHealthCheck.Builder>
      • mergeFrom

        public TCPHealthCheck.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<TCPHealthCheck.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<TCPHealthCheck.Builder>
      • mergeFrom

        public TCPHealthCheck.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<TCPHealthCheck.Builder>
        Throws:
        IOException
      • 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.
      • setPort

        public TCPHealthCheck.Builder setPort​(int value)
         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;
        Parameters:
        value - The port to set.
        Returns:
        This builder for chaining.
      • clearPort

        public TCPHealthCheck.Builder clearPort()
         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;
        Returns:
        This builder for chaining.
      • 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.
      • setPortName

        public TCPHealthCheck.Builder setPortName​(String value)
         Not supported.
         
        optional string port_name = 41534345;
        Parameters:
        value - The portName to set.
        Returns:
        This builder for chaining.
      • clearPortName

        public TCPHealthCheck.Builder clearPortName()
         Not supported.
         
        optional string port_name = 41534345;
        Returns:
        This builder for chaining.
      • setPortNameBytes

        public TCPHealthCheck.Builder setPortNameBytes​(com.google.protobuf.ByteString value)
         Not supported.
         
        optional string port_name = 41534345;
        Parameters:
        value - The bytes for portName to set.
        Returns:
        This builder for chaining.
      • 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.
      • setPortSpecification

        public TCPHealthCheck.Builder setPortSpecification​(String value)
         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;
        Parameters:
        value - The portSpecification to set.
        Returns:
        This builder for chaining.
      • clearPortSpecification

        public TCPHealthCheck.Builder clearPortSpecification()
         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;
        Returns:
        This builder for chaining.
      • setPortSpecificationBytes

        public TCPHealthCheck.Builder setPortSpecificationBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for portSpecification to set.
        Returns:
        This builder for chaining.
      • 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.
      • setProxyHeader

        public TCPHealthCheck.Builder setProxyHeader​(String value)
         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;
        Parameters:
        value - The proxyHeader to set.
        Returns:
        This builder for chaining.
      • clearProxyHeader

        public TCPHealthCheck.Builder clearProxyHeader()
         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;
        Returns:
        This builder for chaining.
      • setProxyHeaderBytes

        public TCPHealthCheck.Builder setProxyHeaderBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for proxyHeader to set.
        Returns:
        This builder for chaining.
      • 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.
      • setRequest

        public TCPHealthCheck.Builder setRequest​(String value)
         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;
        Parameters:
        value - The request to set.
        Returns:
        This builder for chaining.
      • clearRequest

        public TCPHealthCheck.Builder clearRequest()
         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;
        Returns:
        This builder for chaining.
      • setRequestBytes

        public TCPHealthCheck.Builder setRequestBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for request to set.
        Returns:
        This builder for chaining.
      • 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.
      • setResponse

        public TCPHealthCheck.Builder setResponse​(String value)
         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;
        Parameters:
        value - The response to set.
        Returns:
        This builder for chaining.
      • clearResponse

        public TCPHealthCheck.Builder clearResponse()
         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;
        Returns:
        This builder for chaining.
      • setResponseBytes

        public TCPHealthCheck.Builder setResponseBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for response to set.
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final TCPHealthCheck.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TCPHealthCheck.Builder>
      • mergeUnknownFields

        public final TCPHealthCheck.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TCPHealthCheck.Builder>