Class: Google::Apis::ComputeV1::GrpcHealthCheck

Inherits:

Object

• Object
• Google::Apis::ComputeV1::GrpcHealthCheck

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

• #grpc_service_name ⇒ String

  The gRPC service name for the health check.

• #port ⇒ Fixnum

  The TCP port number to which the health check prober sends packets.

• #port_name ⇒ String

  Not supported.

• #port_specification ⇒ String

  Specifies how a port is selected for health checking.

Instance Method Summary

• #initialize(**args) ⇒ GrpcHealthCheck constructor

  A new instance of GrpcHealthCheck.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ GrpcHealthCheck

Returns a new instance of GrpcHealthCheck.

# File 'lib/google/apis/compute_v1/classes.rb', line 10450

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

Instance Attribute Details

#grpc_service_name ⇒ String

The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention: - Empty service_name means the overall status of all services at the backend. - Non- empty service_name means the health of that gRPC service, as defined by the owner of the service. The grpc_service_name can only be ASCII. Corresponds to the JSON property grpcServiceName

Returns:

• (String)

# File 'lib/google/apis/compute_v1/classes.rb', line 10415

def grpc_service_name
  @grpc_service_name
end

#port ⇒ Fixnum

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

Returns:

• (Fixnum)

# File 'lib/google/apis/compute_v1/classes.rb', line 10421

def port
  @port
end

#port_name ⇒ String

Not supported. Corresponds to the JSON property portName

Returns:

• (String)

# File 'lib/google/apis/compute_v1/classes.rb', line 10426

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)

# File 'lib/google/apis/compute_v1/classes.rb', line 10448

def port_specification
  @port_specification
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/compute_v1/classes.rb', line 10455

def update!(**args)
  @grpc_service_name = args[:grpc_service_name] if args.key?(:grpc_service_name)
  @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)
end