Class: Google::Apis::ComputeAlpha::TcpHealthCheck

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TcpHealthCheck

Returns a new instance of TcpHealthCheck.



40260
40261
40262
# File 'lib/google/apis/compute_alpha/classes.rb', line 40260

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#portFixnum

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)


40218
40219
40220
# File 'lib/google/apis/compute_alpha/classes.rb', line 40218

def port
  @port
end

#port_nameString

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)


40224
40225
40226
# File 'lib/google/apis/compute_alpha/classes.rb', line 40224

def port_name
  @port_name
end

#port_specificationString

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)


40237
40238
40239
# File 'lib/google/apis/compute_alpha/classes.rb', line 40237

def port_specification
  @port_specification
end

#proxy_headerString

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)


40243
40244
40245
# File 'lib/google/apis/compute_alpha/classes.rb', line 40243

def proxy_header
  @proxy_header
end

#requestString

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)


40251
40252
40253
# File 'lib/google/apis/compute_alpha/classes.rb', line 40251

def request
  @request
end

#responseString

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)


40258
40259
40260
# File 'lib/google/apis/compute_alpha/classes.rb', line 40258

def response
  @response
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



40265
40266
40267
40268
40269
40270
40271
40272
# File 'lib/google/apis/compute_alpha/classes.rb', line 40265

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