Class: Google::Cloud::Compute::V1::HTTPHealthCheck

Inherits:

Object

Object
Google::Cloud::Compute::V1::HTTPHealthCheck

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/compute/v1/compute.rb

Defined Under Namespace

Modules: PortSpecification, ProxyHeader

Instance Attribute Summary collapse

#host ⇒ ::String
The value of the host header in the HTTP health check request.
#port ⇒ ::Integer
The TCP port number for the health check request.
#port_name ⇒ ::String
Port name as defined in InstanceGroup#NamedPort#name.
#port_specification ⇒ ::Google::Cloud::Compute::V1::HTTPHealthCheck::PortSpecification
Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking.
#proxy_header ⇒ ::Google::Cloud::Compute::V1::HTTPHealthCheck::ProxyHeader
Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1.
#request_path ⇒ ::String
The request path of the HTTP health check request.
#response ⇒ ::String
The string to match anywhere in the first 1024 bytes of the response body.

Instance Attribute Details

#host ⇒ `::String`

Returns The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

Returns:

(::String) —
The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4145

class HTTPHealthCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how port is selected for health checking, can be one of following values:
  # USE_FIXED_PORT: The port number in port is used for health checking.
  # USE_NAMED_PORT: The portName is used for health checking.
  # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
  #
  #
  # If not specified, HTTP health check follows behavior specified in port and portName fields.
  module PortSpecification
    # A value indicating that the enum field is not set.
    UNDEFINED_PORT_SPECIFICATION = 0

    USE_FIXED_PORT = 190235748

    USE_NAMED_PORT = 349300671

    USE_SERVING_PORT = 362637516
  end

  # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
  module ProxyHeader
    # A value indicating that the enum field is not set.
    UNDEFINED_PROXY_HEADER = 0

    NONE = 2402104

    PROXY_V1 = 334352940
  end
end

#port ⇒ `::Integer`

Returns The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.

Returns:

(::Integer) —
The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4145

class HTTPHealthCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how port is selected for health checking, can be one of following values:
  # USE_FIXED_PORT: The port number in port is used for health checking.
  # USE_NAMED_PORT: The portName is used for health checking.
  # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
  #
  #
  # If not specified, HTTP health check follows behavior specified in port and portName fields.
  module PortSpecification
    # A value indicating that the enum field is not set.
    UNDEFINED_PORT_SPECIFICATION = 0

    USE_FIXED_PORT = 190235748

    USE_NAMED_PORT = 349300671

    USE_SERVING_PORT = 362637516
  end

  # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
  module ProxyHeader
    # A value indicating that the enum field is not set.
    UNDEFINED_PROXY_HEADER = 0

    NONE = 2402104

    PROXY_V1 = 334352940
  end
end

#port_name ⇒ `::String`

Returns Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

Returns:

(::String) —
Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4145

class HTTPHealthCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how port is selected for health checking, can be one of following values:
  # USE_FIXED_PORT: The port number in port is used for health checking.
  # USE_NAMED_PORT: The portName is used for health checking.
  # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
  #
  #
  # If not specified, HTTP health check follows behavior specified in port and portName fields.
  module PortSpecification
    # A value indicating that the enum field is not set.
    UNDEFINED_PORT_SPECIFICATION = 0

    USE_FIXED_PORT = 190235748

    USE_NAMED_PORT = 349300671

    USE_SERVING_PORT = 362637516
  end

  # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
  module ProxyHeader
    # A value indicating that the enum field is not set.
    UNDEFINED_PROXY_HEADER = 0

    NONE = 2402104

    PROXY_V1 = 334352940
  end
end

#port_specification ⇒ `::Google::Cloud::Compute::V1::HTTPHealthCheck::PortSpecification`

Returns Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

If not specified, HTTP health check follows behavior specified in port and portName fields.

Returns:

(::Google::Cloud::Compute::V1::HTTPHealthCheck::PortSpecification) —
Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.

If not specified, HTTP health check follows behavior specified in port and portName fields.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4145

class HTTPHealthCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how port is selected for health checking, can be one of following values:
  # USE_FIXED_PORT: The port number in port is used for health checking.
  # USE_NAMED_PORT: The portName is used for health checking.
  # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
  #
  #
  # If not specified, HTTP health check follows behavior specified in port and portName fields.
  module PortSpecification
    # A value indicating that the enum field is not set.
    UNDEFINED_PORT_SPECIFICATION = 0

    USE_FIXED_PORT = 190235748

    USE_NAMED_PORT = 349300671

    USE_SERVING_PORT = 362637516
  end

  # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
  module ProxyHeader
    # A value indicating that the enum field is not set.
    UNDEFINED_PROXY_HEADER = 0

    NONE = 2402104

    PROXY_V1 = 334352940
  end
end

#proxy_header ⇒ `::Google::Cloud::Compute::V1::HTTPHealthCheck::ProxyHeader`

Returns Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

Returns:

(::Google::Cloud::Compute::V1::HTTPHealthCheck::ProxyHeader) —
Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4145

class HTTPHealthCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how port is selected for health checking, can be one of following values:
  # USE_FIXED_PORT: The port number in port is used for health checking.
  # USE_NAMED_PORT: The portName is used for health checking.
  # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
  #
  #
  # If not specified, HTTP health check follows behavior specified in port and portName fields.
  module PortSpecification
    # A value indicating that the enum field is not set.
    UNDEFINED_PORT_SPECIFICATION = 0

    USE_FIXED_PORT = 190235748

    USE_NAMED_PORT = 349300671

    USE_SERVING_PORT = 362637516
  end

  # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
  module ProxyHeader
    # A value indicating that the enum field is not set.
    UNDEFINED_PROXY_HEADER = 0

    NONE = 2402104

    PROXY_V1 = 334352940
  end
end

#request_path ⇒ `::String`

Returns The request path of the HTTP health check request. The default value is /.

Returns:

(::String) —
The request path of the HTTP health check request. The default value is /.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4145

class HTTPHealthCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how port is selected for health checking, can be one of following values:
  # USE_FIXED_PORT: The port number in port is used for health checking.
  # USE_NAMED_PORT: The portName is used for health checking.
  # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
  #
  #
  # If not specified, HTTP health check follows behavior specified in port and portName fields.
  module PortSpecification
    # A value indicating that the enum field is not set.
    UNDEFINED_PORT_SPECIFICATION = 0

    USE_FIXED_PORT = 190235748

    USE_NAMED_PORT = 349300671

    USE_SERVING_PORT = 362637516
  end

  # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
  module ProxyHeader
    # A value indicating that the enum field is not set.
    UNDEFINED_PROXY_HEADER = 0

    NONE = 2402104

    PROXY_V1 = 334352940
  end
end

#response ⇒ `::String`

Returns The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

Returns:

(::String) —
The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 4145

class HTTPHealthCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how port is selected for health checking, can be one of following values:
  # USE_FIXED_PORT: The port number in port is used for health checking.
  # USE_NAMED_PORT: The portName is used for health checking.
  # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.
  #
  #
  # If not specified, HTTP health check follows behavior specified in port and portName fields.
  module PortSpecification
    # A value indicating that the enum field is not set.
    UNDEFINED_PORT_SPECIFICATION = 0

    USE_FIXED_PORT = 190235748

    USE_NAMED_PORT = 349300671

    USE_SERVING_PORT = 362637516
  end

  # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
  module ProxyHeader
    # A value indicating that the enum field is not set.
    UNDEFINED_PROXY_HEADER = 0

    NONE = 2402104

    PROXY_V1 = 334352940
  end
end

Class: Google::Cloud::Compute::V1::HTTPHealthCheck

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#host ⇒ ::String

#port ⇒ ::Integer

#port_name ⇒ ::String

#port_specification ⇒ ::Google::Cloud::Compute::V1::HTTPHealthCheck::PortSpecification

#proxy_header ⇒ ::Google::Cloud::Compute::V1::HTTPHealthCheck::ProxyHeader

#request_path ⇒ ::String

#response ⇒ ::String

#host ⇒ `::String`

#port ⇒ `::Integer`

#port_name ⇒ `::String`

#port_specification ⇒ `::Google::Cloud::Compute::V1::HTTPHealthCheck::PortSpecification`

#proxy_header ⇒ `::Google::Cloud::Compute::V1::HTTPHealthCheck::ProxyHeader`

#request_path ⇒ `::String`

#response ⇒ `::String`