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.



26377
26378
26379
 
# File 'generated/google/apis/compute_v1/classes.rb', line 26377

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) 


26335
26336
26337
 
# File 'generated/google/apis/compute_v1/classes.rb', line 26335

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) 


26341
26342
26343
 
# File 'generated/google/apis/compute_v1/classes.rb', line 26341

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) 


26354
26355
26356
 
# File 'generated/google/apis/compute_v1/classes.rb', line 26354

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) 


26360
26361
26362
 
# File 'generated/google/apis/compute_v1/classes.rb', line 26360

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) 


26368
26369
26370
 
# File 'generated/google/apis/compute_v1/classes.rb', line 26368

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) 


26375
26376
26377
 
# File 'generated/google/apis/compute_v1/classes.rb', line 26375

def response
  @response
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



26382
26383
26384
26385
26386
26387
26388
26389
 
# File 'generated/google/apis/compute_v1/classes.rb', line 26382

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