Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::GRPCTLSHealthCheck.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#grpc_service_name
def grpc_service_name() -> ::String-
(::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.
#grpc_service_name=
def grpc_service_name=(value) -> ::String-
value (::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.
-
(::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.
#port
def port() -> ::Integer- (::Integer) — The TCP port number to which the health check prober sends packets. Valid values are 1 through 65535.
#port=
def port=(value) -> ::Integer- value (::Integer) — The TCP port number to which the health check prober sends packets. Valid values are 1 through 65535.
- (::Integer) — The TCP port number to which the health check prober sends packets. Valid values are 1 through 65535.
#port_specification
def port_specification() -> ::String-
(::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 theport 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. Check the PortSpecification enum for the list of possible values.
#port_specification=
def port_specification=(value) -> ::String-
value (::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 theport 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. Check the PortSpecification enum for the list of possible values.
-
(::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 theport 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. Check the PortSpecification enum for the list of possible values.