Class: Google::Apis::ComputeV1::TcpHealthCheck

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/compute_v1/classes.rb,
generated/google/apis/compute_v1/representations.rb,
generated/google/apis/compute_v1/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ TcpHealthCheck

Returns a new instance of TcpHealthCheck



21031
21032
21033
 
# File 'generated/google/apis/compute_v1/classes.rb', line 21031

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

Returns:

  • (Fixnum) 


20982
20983
20984
 
# File 'generated/google/apis/compute_v1/classes.rb', line 20982

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

Returns:

  • (String) 


20988
20989
20990
 
# File 'generated/google/apis/compute_v1/classes.rb', line 20988

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

Returns:

  • (String) 


21008
21009
21010
 
# File 'generated/google/apis/compute_v1/classes.rb', line 21008

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

Returns:

  • (String) 


21014
21015
21016
 
# File 'generated/google/apis/compute_v1/classes.rb', line 21014

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

Returns:

  • (String) 


21022
21023
21024
 
# File 'generated/google/apis/compute_v1/classes.rb', line 21022

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

Returns:

  • (String) 


21029
21030
21031
 
# File 'generated/google/apis/compute_v1/classes.rb', line 21029

def response
  @response
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



21036
21037
21038
21039
21040
21041
21042
21043
 
# File 'generated/google/apis/compute_v1/classes.rb', line 21036

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