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



21178
21179
21180
 
# File 'generated/google/apis/compute_v1/classes.rb', line 21178

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) 


21129
21130
21131
 
# File 'generated/google/apis/compute_v1/classes.rb', line 21129

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) 


21135
21136
21137
 
# File 'generated/google/apis/compute_v1/classes.rb', line 21135

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) 


21155
21156
21157
 
# File 'generated/google/apis/compute_v1/classes.rb', line 21155

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) 


21161
21162
21163
 
# File 'generated/google/apis/compute_v1/classes.rb', line 21161

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) 


21169
21170
21171
 
# File 'generated/google/apis/compute_v1/classes.rb', line 21169

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) 


21176
21177
21178
 
# File 'generated/google/apis/compute_v1/classes.rb', line 21176

def response
  @response
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



21183
21184
21185
21186
21187
21188
21189
21190
 
# File 'generated/google/apis/compute_v1/classes.rb', line 21183

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