target.apidocs.com.google.api.services.compute.model.GRPCHealthCheck.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-compute Show documentation

There is a newer version: v1-rev20250320-2.0.0

Show newest version







GRPCHealthCheck (Compute Engine API v1-rev20250107-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute.model
Class GRPCHealthCheck



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.compute.model.GRPCHealthCheck













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class GRPCHealthCheck
extends com.google.api.client.json.GenericJson
Model definition for GRPCHealthCheck.

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


GRPCHealthCheck() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


GRPCHealthCheck
clone() 


String
getGrpcServiceName()
The gRPC service name for the health check.



Integer
getPort()
The TCP port number to which the health check prober sends packets.



String
getPortName()
Not supported.



String
getPortSpecification()
Specifies how a port is selected for health checking.



GRPCHealthCheck
set(String fieldName,
   Object value) 


GRPCHealthCheck
setGrpcServiceName(String grpcServiceName)
The gRPC service name for the health check.



GRPCHealthCheck
setPort(Integer port)
The TCP port number to which the health check prober sends packets.



GRPCHealthCheck
setPortName(String portName)
Not supported.



GRPCHealthCheck
setPortSpecification(String portSpecification)
Specifies how a port is selected for health checking.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





GRPCHealthCheck
public GRPCHealthCheck()









Method Detail





getGrpcServiceName
public String getGrpcServiceName()
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.

Returns:
value or null for none








setGrpcServiceName
public GRPCHealthCheck setGrpcServiceName(String grpcServiceName)
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.

Parameters:
grpcServiceName - grpcServiceName or null for none








getPort
public Integer getPort()
The TCP port number to which the health check prober sends packets. Valid values are 1 through
 65535.

Returns:
value or null for none








setPort
public GRPCHealthCheck setPort(Integer port)
The TCP port number to which the health check prober sends packets. Valid values are 1 through
 65535.

Parameters:
port - port or null for none








getPortName
public String getPortName()
Not supported.

Returns:
value or null for none








setPortName
public GRPCHealthCheck setPortName(String portName)
Not supported.

Parameters:
portName - portName or null for none








getPortSpecification
public String getPortSpecification()
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.

Returns:
value or null for none








setPortSpecification
public GRPCHealthCheck setPortSpecification(String portSpecification)
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.

Parameters:
portSpecification - portSpecification or null for none








set
public GRPCHealthCheck set(String fieldName,
                           Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public GRPCHealthCheck clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2025 Google. All rights reserved.

Modifier and Type	Method and Description
`GRPCHealthCheck`	`clone()`
`String`	`getGrpcServiceName()` The gRPC service name for the health check.
`Integer`	`getPort()` The TCP port number to which the health check prober sends packets.
`String`	`getPortName()` Not supported.
`String`	`getPortSpecification()` Specifies how a port is selected for health checking.
`GRPCHealthCheck`	`set(String fieldName, Object value)`
`GRPCHealthCheck`	`setGrpcServiceName(String grpcServiceName)` The gRPC service name for the health check.
`GRPCHealthCheck`	`setPort(Integer port)` The TCP port number to which the health check prober sends packets.
`GRPCHealthCheck`	`setPortName(String portName)` Not supported.
`GRPCHealthCheck`	`setPortSpecification(String portSpecification)` Specifies how a port is selected for health checking.