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

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TcpHealthCheck

Returns a new instance of TcpHealthCheck.



36160
36161
36162
 
# File 'lib/google/apis/compute_v1/classes.rb', line 36160

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

Instance Attribute Details

#port ⇒ Fixnum

The TCP port number to which the health check prober sends packets. The default value is 80. Valid values are 1 through 65535. Corresponds to the JSON property port

Returns:

  • (Fixnum) 


36110
36111
36112
 
# File 'lib/google/apis/compute_v1/classes.rb', line 36110

def port
  @port
end

#port_name ⇒ String

Not supported. Corresponds to the JSON property portName

Returns:

  • (String) 


36115
36116
36117
 
# File 'lib/google/apis/compute_v1/classes.rb', line 36115

def port_name
  @port_name
end

#port_specification ⇒ String

Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass- through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports. Corresponds to the JSON property portSpecification

Returns:

  • (String) 


36137
36138
36139
 
# File 'lib/google/apis/compute_v1/classes.rb', line 36137

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) 


36143
36144
36145
 
# File 'lib/google/apis/compute_v1/classes.rb', line 36143

def proxy_header
  @proxy_header
end

#request ⇒ String

Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection. Corresponds to the JSON property request

Returns:

  • (String) 


36149
36150
36151
 
# File 'lib/google/apis/compute_v1/classes.rb', line 36149

def request
  @request
end

#response ⇒ String

Creates a content-based TCP health check. In addition to establishing a TCP connection, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check- concepts#criteria-protocol-ssl-tcp Corresponds to the JSON property response

Returns:

  • (String) 


36158
36159
36160
 
# File 'lib/google/apis/compute_v1/classes.rb', line 36158

def response
  @response
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



36165
36166
36167
36168
36169
36170
36171
36172
 
# File 'lib/google/apis/compute_v1/classes.rb', line 36165

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