Package com.google.cloud.compute.v1

Interface TCPHealthCheckOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    TCPHealthCheck, TCPHealthCheck.Builder
    public interface TCPHealthCheckOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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.
      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.

      • 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

      • hasPort

        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;
        Returns:
        Whether the port field is set.

      • getPort

        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;
        Returns:
        The port.

      • hasPortName

        boolean hasPortName()
         Not supported.
        optional string port_name = 41534345;
        Returns:
        Whether the portName field is set.

      • getPortName

        String getPortName()
         Not supported.
        optional string port_name = 41534345;
        Returns:
        The portName.

      • getPortNameBytes

        com.google.protobuf.ByteString getPortNameBytes()
         Not supported.
        optional string port_name = 41534345;
        Returns:
        The bytes for portName.

      • hasPortSpecification

        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;
        Returns:
        Whether the portSpecification field is set.

      • getPortSpecification

        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;
        Returns:
        The portSpecification.

      • getPortSpecificationBytes

        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;
        Returns:
        The bytes for portSpecification.

      • hasProxyHeader

        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;
        Returns:
        Whether the proxyHeader field is set.

      • getProxyHeader

        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;
        Returns:
        The proxyHeader.

      • getProxyHeaderBytes

        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;
        Returns:
        The bytes for proxyHeader.

      • hasRequest

        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;
        Returns:
        Whether the request field is set.

      • getRequest

        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;
        Returns:
        The request.

      • getRequestBytes

        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;
        Returns:
        The bytes for request.

      • hasResponse

        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;
        Returns:
        Whether the response field is set.

      • getResponse

        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;
        Returns:
        The response.

      • getResponseBytes

        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;
        Returns:
        The bytes for response.