- 1.63.0 (latest)
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public static final class GRPCHealthCheck.Builder extends GeneratedMessageV3.Builder<GRPCHealthCheck.Builder> implements GRPCHealthCheckOrBuilder Protobuf type google.cloud.compute.v1.GRPCHealthCheck
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > GRPCHealthCheck.BuilderImplements
GRPCHealthCheckOrBuilderStatic 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 |
|
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 |
|
clearField(Descriptors.FieldDescriptor field)
public GRPCHealthCheck.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
GRPCHealthCheck.Builder |
|
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 |
|
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 |
|
getDefaultInstanceForType()
public GRPCHealthCheck getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
GRPCHealthCheck |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public GRPCHealthCheck.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
GRPCHealthCheck.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final GRPCHealthCheck.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
GRPCHealthCheck.Builder |
|
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 |
|
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 |
StringThe 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 |
ByteStringThe 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 |
intThe 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 |
StringThe 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 |
ByteStringThe 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 |
StringThe 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 |
ByteStringThe 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 |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final GRPCHealthCheck.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
GRPCHealthCheck.Builder |
|