Interface GRPCHealthCheckOrBuilder (1.11.0)

public interface GRPCHealthCheckOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getGrpcServiceName()

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

optional string grpc_service_name = 136533078;

Returns
TypeDescription
String

The grpcServiceName.

getGrpcServiceNameBytes()

public abstract ByteString getGrpcServiceNameBytes()

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.

optional string grpc_service_name = 136533078;

Returns
TypeDescription
ByteString

The bytes for grpcServiceName.

getPort()

public abstract int 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.

optional int32 port = 3446913;

Returns
TypeDescription
int

The port.

getPortName()

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

optional string port_name = 41534345;

Returns
TypeDescription
String

The portName.

getPortNameBytes()

public abstract ByteString getPortNameBytes()

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.

optional string port_name = 41534345;

Returns
TypeDescription
ByteString

The bytes for portName.

getPortSpecification()

public abstract 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. Check the PortSpecification enum for the list of possible values.

optional string port_specification = 51590597;

Returns
TypeDescription
String

The portSpecification.

getPortSpecificationBytes()

public abstract ByteString getPortSpecificationBytes()

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. Check the PortSpecification enum for the list of possible values.

optional string port_specification = 51590597;

Returns
TypeDescription
ByteString

The bytes for portSpecification.

hasGrpcServiceName()

public abstract boolean hasGrpcServiceName()

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.

optional string grpc_service_name = 136533078;

Returns
TypeDescription
boolean

Whether the grpcServiceName field is set.

hasPort()

public abstract boolean hasPort()

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.

optional int32 port = 3446913;

Returns
TypeDescription
boolean

Whether the port field is set.

hasPortName()

public abstract boolean hasPortName()

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.

optional string port_name = 41534345;

Returns
TypeDescription
boolean

Whether the portName field is set.

hasPortSpecification()

public abstract boolean hasPortSpecification()

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. Check the PortSpecification enum for the list of possible values.

optional string port_specification = 51590597;

Returns
TypeDescription
boolean

Whether the portSpecification field is set.