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

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

Modifier and Type	Method and Description
GRPCHealthCheck	clone()
String	getGrpcServiceName() The gRPC service name for the health check.
Integer	getPort() The port number for the health check request.
String	getPortName() Port name as defined in InstanceGroup#NamedPort#name.
String	getPortSpecification() 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.
GRPCHealthCheck	set(String fieldName, Object value)
GRPCHealthCheck	setGrpcServiceName(String grpcServiceName) The gRPC service name for the health check.
GRPCHealthCheck	setPort(Integer port) The port number for the health check request.
GRPCHealthCheck	setPortName(String portName) Port name as defined in InstanceGroup#NamedPort#name.
GRPCHealthCheck	setPortSpecification(String portSpecification) 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.

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 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.

Returns:

value or null for none

setPort

public GRPCHealthCheck setPort(Integer port)

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.

Parameters:

port - port or null for none

getPortName

public String getPortName()

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.

Returns:

value or null for none

setPortName

public GRPCHealthCheck setPortName(String portName)

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.

Parameters:

portName - portName or null for none

getPortSpecification

public String getPortSpecification()

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.

Returns:

value or null for none

setPortSpecification

public GRPCHealthCheck setPortSpecification(String portSpecification)

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.

Parameters:

portSpecification - portSpecification or null for none

set

public GRPCHealthCheck set(String fieldName,
                           Object value)

Overrides:

set in class GenericJson

clone

public GRPCHealthCheck clone()

Overrides:

clone in class GenericJson