Class GRPCHealthCheck (1.7.2)

public final class GRPCHealthCheck extends GeneratedMessageV3 implements GRPCHealthCheckOrBuilder

Protobuf type google.cloud.compute.v1.GRPCHealthCheck

Static Fields

GRPC_SERVICE_NAME_FIELD_NUMBER

public static final int GRPC_SERVICE_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PORT_FIELD_NUMBER

public static final int PORT_FIELD_NUMBER
Field Value
TypeDescription
int

PORT_NAME_FIELD_NUMBER

public static final int PORT_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PORT_SPECIFICATION_FIELD_NUMBER

public static final int PORT_SPECIFICATION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static GRPCHealthCheck getDefaultInstance()
Returns
TypeDescription
GRPCHealthCheck

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static GRPCHealthCheck.Builder newBuilder()
Returns
TypeDescription
GRPCHealthCheck.Builder

newBuilder(GRPCHealthCheck prototype)

public static GRPCHealthCheck.Builder newBuilder(GRPCHealthCheck prototype)
Parameter
NameDescription
prototypeGRPCHealthCheck
Returns
TypeDescription
GRPCHealthCheck.Builder

parseDelimitedFrom(InputStream input)

public static GRPCHealthCheck parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
GRPCHealthCheck
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GRPCHealthCheck parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GRPCHealthCheck
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static GRPCHealthCheck parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
GRPCHealthCheck
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GRPCHealthCheck parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GRPCHealthCheck
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GRPCHealthCheck parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
GRPCHealthCheck
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GRPCHealthCheck parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GRPCHealthCheck
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GRPCHealthCheck parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
GRPCHealthCheck
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GRPCHealthCheck parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GRPCHealthCheck
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static GRPCHealthCheck parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
GRPCHealthCheck
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GRPCHealthCheck parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GRPCHealthCheck
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static GRPCHealthCheck parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
GRPCHealthCheck
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GRPCHealthCheck parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GRPCHealthCheck
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<GRPCHealthCheck> parser()
Returns
TypeDescription
Parser<GRPCHealthCheck>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public GRPCHealthCheck getDefaultInstanceForType()
Returns
TypeDescription
GRPCHealthCheck

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.

optional string grpc_service_name = 136533078;

Returns
TypeDescription
String

The grpcServiceName.

getGrpcServiceNameBytes()

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

getParserForType()

public Parser<GRPCHealthCheck> getParserForType()
Returns
TypeDescription
Parser<GRPCHealthCheck>
Overrides

getPort()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasGrpcServiceName()

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

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public GRPCHealthCheck.Builder newBuilderForType()
Returns
TypeDescription
GRPCHealthCheck.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GRPCHealthCheck.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
GRPCHealthCheck.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public GRPCHealthCheck.Builder toBuilder()
Returns
TypeDescription
GRPCHealthCheck.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException