Class: Google::Apis::ComputeV1::TcpHealthCheck
- Inherits:
-
Object
- Object
- Google::Apis::ComputeV1::TcpHealthCheck
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/representations.rb,
lib/google/apis/compute_v1/representations.rb
Instance Attribute Summary collapse
-
#port ⇒ Fixnum
The TCP port number for the health check request.
-
#port_name ⇒ String
Port name as defined in InstanceGroup#NamedPort#name.
-
#port_specification ⇒ String
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 ⇒ String
Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1.
-
#request ⇒ String
The application data to send once the TCP connection has been established ( default value is empty).
-
#response ⇒ String
The bytes to match against the beginning of the response data.
Instance Method Summary collapse
-
#initialize(**args) ⇒ TcpHealthCheck
constructor
A new instance of TcpHealthCheck.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ TcpHealthCheck
Returns a new instance of TcpHealthCheck.
31983 31984 31985 |
# File 'lib/google/apis/compute_v1/classes.rb', line 31983 def initialize(**args) update!(**args) end |
Instance Attribute Details
#port ⇒ Fixnum
The TCP port number for the health check request. The default value is 80.
Valid values are 1 through 65535.
Corresponds to the JSON property port
31941 31942 31943 |
# File 'lib/google/apis/compute_v1/classes.rb', line 31941 def port @port end |
#port_name ⇒ String
Port name as defined in InstanceGroup#NamedPort#name. If both port and
port_name are defined, port takes precedence.
Corresponds to the JSON property portName
31947 31948 31949 |
# File 'lib/google/apis/compute_v1/classes.rb', line 31947 def port_name @port_name end |
#port_specification ⇒ String
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, TCP health check follows behavior specified in port and
portName fields.
Corresponds to the JSON property portSpecification
31960 31961 31962 |
# File 'lib/google/apis/compute_v1/classes.rb', line 31960 def port_specification @port_specification end |
#proxy_header ⇒ String
Specifies the type of proxy header to append before sending data to the
backend, either NONE or PROXY_V1. The default is NONE.
Corresponds to the JSON property proxyHeader
31966 31967 31968 |
# File 'lib/google/apis/compute_v1/classes.rb', line 31966 def proxy_header @proxy_header end |
#request ⇒ String
The application data to send once the TCP connection has been established (
default value is empty). If both request and response are empty, the
connection establishment alone will indicate health. The request data can only
be ASCII.
Corresponds to the JSON property request
31974 31975 31976 |
# File 'lib/google/apis/compute_v1/classes.rb', line 31974 def request @request end |
#response ⇒ String
The bytes to match against the beginning of the response data. If left empty (
the default value), any response will indicate health. The response data can
only be ASCII.
Corresponds to the JSON property response
31981 31982 31983 |
# File 'lib/google/apis/compute_v1/classes.rb', line 31981 def response @response end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
31988 31989 31990 31991 31992 31993 31994 31995 |
# File 'lib/google/apis/compute_v1/classes.rb', line 31988 def update!(**args) @port = args[:port] if args.key?(:port) @port_name = args[:port_name] if args.key?(:port_name) @port_specification = args[:port_specification] if args.key?(:port_specification) @proxy_header = args[:proxy_header] if args.key?(:proxy_header) @request = args[:request] if args.key?(:request) @response = args[:response] if args.key?(:response) end |