Class GRPCHealthCheck.Builder (1.61.0)

public static final class GRPCHealthCheck.Builder extends GeneratedMessageV3.Builder<GRPCHealthCheck.Builder> implements GRPCHealthCheckOrBuilder

Protobuf type google.cloud.compute.v1.GRPCHealthCheck

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GRPCHealthCheck.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GRPCHealthCheck.Builder
Overrides

build()

public GRPCHealthCheck build()
Returns
Type Description
GRPCHealthCheck

buildPartial()

public GRPCHealthCheck buildPartial()
Returns
Type Description
GRPCHealthCheck

clear()

public GRPCHealthCheck.Builder clear()
Returns
Type Description
GRPCHealthCheck.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public GRPCHealthCheck.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
GRPCHealthCheck.Builder
Overrides

clearGrpcServiceName()

public GRPCHealthCheck.Builder clearGrpcServiceName()

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
Type Description
GRPCHealthCheck.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public GRPCHealthCheck.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
GRPCHealthCheck.Builder
Overrides

clearPort()

public GRPCHealthCheck.Builder clearPort()

The TCP port number to which the health check prober sends packets. Valid values are 1 through 65535.

optional int32 port = 3446913;

Returns
Type Description
GRPCHealthCheck.Builder

This builder for chaining.

clearPortName()

public GRPCHealthCheck.Builder clearPortName()

Not supported.

optional string port_name = 41534345;

Returns
Type Description
GRPCHealthCheck.Builder

This builder for chaining.

clearPortSpecification()

public GRPCHealthCheck.Builder clearPortSpecification()

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

optional string port_specification = 51590597;

Returns
Type Description
GRPCHealthCheck.Builder

This builder for chaining.

clone()

public GRPCHealthCheck.Builder clone()
Returns
Type Description
GRPCHealthCheck.Builder
Overrides

getDefaultInstanceForType()

public GRPCHealthCheck getDefaultInstanceForType()
Returns
Type Description
GRPCHealthCheck

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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
Type Description
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
Type Description
ByteString

The bytes for grpcServiceName.

getPort()

public int getPort()

The TCP port number to which the health check prober sends packets. Valid values are 1 through 65535.

optional int32 port = 3446913;

Returns
Type Description
int

The port.

getPortName()

public String getPortName()

Not supported.

optional string port_name = 41534345;

Returns
Type Description
String

The portName.

getPortNameBytes()

public ByteString getPortNameBytes()

Not supported.

optional string port_name = 41534345;

Returns
Type Description
ByteString

The bytes for portName.

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

optional string port_specification = 51590597;

Returns
Type Description
String

The portSpecification.

getPortSpecificationBytes()

public ByteString getPortSpecificationBytes()

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

optional string port_specification = 51590597;

Returns
Type Description
ByteString

The bytes for portSpecification.

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
Type Description
boolean

Whether the grpcServiceName field is set.

hasPort()

public boolean hasPort()

The TCP port number to which the health check prober sends packets. Valid values are 1 through 65535.

optional int32 port = 3446913;

Returns
Type Description
boolean

Whether the port field is set.

hasPortName()

public boolean hasPortName()

Not supported.

optional string port_name = 41534345;

Returns
Type Description
boolean

Whether the portName field is set.

hasPortSpecification()

public boolean hasPortSpecification()

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

optional string port_specification = 51590597;

Returns
Type Description
boolean

Whether the portSpecification field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(GRPCHealthCheck other)

public GRPCHealthCheck.Builder mergeFrom(GRPCHealthCheck other)
Parameter
Name Description
other GRPCHealthCheck
Returns
Type Description
GRPCHealthCheck.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GRPCHealthCheck.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GRPCHealthCheck.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public GRPCHealthCheck.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
GRPCHealthCheck.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GRPCHealthCheck.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GRPCHealthCheck.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public GRPCHealthCheck.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GRPCHealthCheck.Builder
Overrides

setGrpcServiceName(String value)

public GRPCHealthCheck.Builder setGrpcServiceName(String value)

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;

Parameter
Name Description
value String

The grpcServiceName to set.

Returns
Type Description
GRPCHealthCheck.Builder

This builder for chaining.

setGrpcServiceNameBytes(ByteString value)

public GRPCHealthCheck.Builder setGrpcServiceNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for grpcServiceName to set.

Returns
Type Description
GRPCHealthCheck.Builder

This builder for chaining.

setPort(int value)

public GRPCHealthCheck.Builder setPort(int value)

The TCP port number to which the health check prober sends packets. Valid values are 1 through 65535.

optional int32 port = 3446913;

Parameter
Name Description
value int

The port to set.

Returns
Type Description
GRPCHealthCheck.Builder

This builder for chaining.

setPortName(String value)

public GRPCHealthCheck.Builder setPortName(String value)

Not supported.

optional string port_name = 41534345;

Parameter
Name Description
value String

The portName to set.

Returns
Type Description
GRPCHealthCheck.Builder

This builder for chaining.

setPortNameBytes(ByteString value)

public GRPCHealthCheck.Builder setPortNameBytes(ByteString value)

Not supported.

optional string port_name = 41534345;

Parameter
Name Description
value ByteString

The bytes for portName to set.

Returns
Type Description
GRPCHealthCheck.Builder

This builder for chaining.

setPortSpecification(String value)

public GRPCHealthCheck.Builder setPortSpecification(String value)

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

optional string port_specification = 51590597;

Parameter
Name Description
value String

The portSpecification to set.

Returns
Type Description
GRPCHealthCheck.Builder

This builder for chaining.

setPortSpecificationBytes(ByteString value)

public GRPCHealthCheck.Builder setPortSpecificationBytes(ByteString value)

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

optional string port_specification = 51590597;

Parameter
Name Description
value ByteString

The bytes for portSpecification to set.

Returns
Type Description
GRPCHealthCheck.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public GRPCHealthCheck.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
GRPCHealthCheck.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final GRPCHealthCheck.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GRPCHealthCheck.Builder
Overrides