Package com.google.cloud.compute.v1

Interface HTTPSHealthCheckOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
HTTPSHealthCheck, HTTPSHealthCheck.Builder
@Generated public interface HTTPSHealthCheckOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getHost()
    The value of the host header in the HTTPS health check request.
    com.google.protobuf.ByteString
    getHostBytes()
    The value of the host header in the HTTPS health check request.
    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
    getRequestPath()
    The request path of the HTTPS health check request.
    com.google.protobuf.ByteString
    getRequestPathBytes()
    The request path of the HTTPS health check request.
    String
    getResponse()
    Creates a content-based HTTPS health check.
    com.google.protobuf.ByteString
    getResponseBytes()
    Creates a content-based HTTPS health check.
    boolean
    hasHost()
    The value of the host header in the HTTPS health check request.
    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
    hasRequestPath()
    The request path of the HTTPS health check request.
    boolean
    hasResponse()
    Creates a content-based HTTPS 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 Details

    • hasHost

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

    • getHost

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

    • getHostBytes

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

    • hasPort

      boolean hasPort()
       The TCP port number to which the health check prober sends packets. The
 default value is 443. Valid values are 1 through65535.
      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 443. Valid values are 1 through65535.
      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 theport field  in the health check. Supported by backend services
 for passthrough 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 passthrough 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 theport field  in the health check. Supported by backend services
 for passthrough 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 passthrough 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 theport field  in the health check. Supported by backend services
 for passthrough 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 passthrough 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.

    • hasRequestPath

      boolean hasRequestPath()
       The request path of the HTTPS health check request. The default value is/. Must comply withRFC3986.
      optional string request_path = 229403605;
      Returns:
      Whether the requestPath field is set.

    • getRequestPath

      String getRequestPath()
       The request path of the HTTPS health check request. The default value is/. Must comply withRFC3986.
      optional string request_path = 229403605;
      Returns:
      The requestPath.

    • getRequestPathBytes

      com.google.protobuf.ByteString getRequestPathBytes()
       The request path of the HTTPS health check request. The default value is/. Must comply withRFC3986.
      optional string request_path = 229403605;
      Returns:
      The bytes for requestPath.

    • hasResponse

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

    • getResponse

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

    • getResponseBytes

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