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.



51838
51839
51840
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 51838

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) 


51788
51789
51790
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 51788

def port
  @port
end

#port_name ⇒ String

Not supported. Corresponds to the JSON property portName

Returns:

  • (String) 


51793
51794
51795
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 51793

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 passthrough 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 passthrough 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) 


51815
51816
51817
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 51815

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) 


51821
51822
51823
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 51821

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) 


51827
51828
51829
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 51827

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) 


51836
51837
51838
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 51836

def response
  @response
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



51843
51844
51845
51846
51847
51848
51849
51850
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 51843

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