GoogleApi.Compute.V1.Model.GRPCHealthCheck (google_api_compute v0.37.0) View Source


  • grpcServiceName (type: String.t, default: nil) - 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 (type: integer(), default: nil) - The port number for the health check request. Must be specified if port_name and port_specification are not set or if port_specification is USE_FIXED_PORT. Valid values are 1 through 65535.

  • portName (type: String.t, default: nil) - Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. The port_name should conform to RFC1035.

  • portSpecification (type: String.t, default: nil) - 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, gRPC health check follows behavior specified in port and portName fields.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.Compute.V1.Model.GRPCHealthCheck{
  grpcServiceName: String.t() | nil,
  port: integer() | nil,
  portName: String.t() | nil,
  portSpecification: String.t() | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.