Class TCPHealthCheck.Builder (1.55.0)

public static final class TCPHealthCheck.Builder extends GeneratedMessageV3.Builder<TCPHealthCheck.Builder> implements TCPHealthCheckOrBuilder

Protobuf type google.cloud.compute.v1.TCPHealthCheck

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public TCPHealthCheck build()
Returns
Type Description
TCPHealthCheck

buildPartial()

public TCPHealthCheck buildPartial()
Returns
Type Description
TCPHealthCheck

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPort()

public TCPHealthCheck.Builder clearPort()

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

optional int32 port = 3446913;

Returns
Type Description
TCPHealthCheck.Builder

This builder for chaining.

clearPortName()

public TCPHealthCheck.Builder clearPortName()

Not supported.

optional string port_name = 41534345;

Returns
Type Description
TCPHealthCheck.Builder

This builder for chaining.

clearPortSpecification()

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

This builder for chaining.

clearProxyHeader()

public TCPHealthCheck.Builder clearProxyHeader()

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. Check the ProxyHeader enum for the list of possible values.

optional string proxy_header = 160374142;

Returns
Type Description
TCPHealthCheck.Builder

This builder for chaining.

clearRequest()

public TCPHealthCheck.Builder clearRequest()

Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection.

optional string request = 21951119;

Returns
Type Description
TCPHealthCheck.Builder

This builder for chaining.

clearResponse()

public TCPHealthCheck.Builder clearResponse()

Creates a content-based TCP health check. In addition to establishing a TCP connection, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp

optional string response = 196547649;

Returns
Type Description
TCPHealthCheck.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public TCPHealthCheck getDefaultInstanceForType()
Returns
Type Description
TCPHealthCheck

getDescriptorForType()

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

getPort()

public int getPort()

The TCP port number to which the health check prober sends packets. The default value is 80. 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.

getProxyHeader()

public String getProxyHeader()

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. Check the ProxyHeader enum for the list of possible values.

optional string proxy_header = 160374142;

Returns
Type Description
String

The proxyHeader.

getProxyHeaderBytes()

public ByteString getProxyHeaderBytes()

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. Check the ProxyHeader enum for the list of possible values.

optional string proxy_header = 160374142;

Returns
Type Description
ByteString

The bytes for proxyHeader.

getRequest()

public String getRequest()

Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection.

optional string request = 21951119;

Returns
Type Description
String

The request.

getRequestBytes()

public ByteString getRequestBytes()

Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection.

optional string request = 21951119;

Returns
Type Description
ByteString

The bytes for request.

getResponse()

public String getResponse()

Creates a content-based TCP health check. In addition to establishing a TCP connection, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp

optional string response = 196547649;

Returns
Type Description
String

The response.

getResponseBytes()

public ByteString getResponseBytes()

Creates a content-based TCP health check. In addition to establishing a TCP connection, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp

optional string response = 196547649;

Returns
Type Description
ByteString

The bytes for response.

hasPort()

public boolean hasPort()

The TCP port number to which the health check prober sends packets. The default value is 80. 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.

hasProxyHeader()

public boolean hasProxyHeader()

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. Check the ProxyHeader enum for the list of possible values.

optional string proxy_header = 160374142;

Returns
Type Description
boolean

Whether the proxyHeader field is set.

hasRequest()

public boolean hasRequest()

Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection.

optional string request = 21951119;

Returns
Type Description
boolean

Whether the request field is set.

hasResponse()

public boolean hasResponse()

Creates a content-based TCP health check. In addition to establishing a TCP connection, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp

optional string response = 196547649;

Returns
Type Description
boolean

Whether the response field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(TCPHealthCheck other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setPort(int value)

public TCPHealthCheck.Builder setPort(int value)

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

optional int32 port = 3446913;

Parameter
Name Description
value int

The port to set.

Returns
Type Description
TCPHealthCheck.Builder

This builder for chaining.

setPortName(String value)

public TCPHealthCheck.Builder setPortName(String value)

Not supported.

optional string port_name = 41534345;

Parameter
Name Description
value String

The portName to set.

Returns
Type Description
TCPHealthCheck.Builder

This builder for chaining.

setPortNameBytes(ByteString value)

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

This builder for chaining.

setPortSpecification(String value)

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

This builder for chaining.

setPortSpecificationBytes(ByteString value)

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

This builder for chaining.

setProxyHeader(String value)

public TCPHealthCheck.Builder setProxyHeader(String value)

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. Check the ProxyHeader enum for the list of possible values.

optional string proxy_header = 160374142;

Parameter
Name Description
value String

The proxyHeader to set.

Returns
Type Description
TCPHealthCheck.Builder

This builder for chaining.

setProxyHeaderBytes(ByteString value)

public TCPHealthCheck.Builder setProxyHeaderBytes(ByteString value)

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. Check the ProxyHeader enum for the list of possible values.

optional string proxy_header = 160374142;

Parameter
Name Description
value ByteString

The bytes for proxyHeader to set.

Returns
Type Description
TCPHealthCheck.Builder

This builder for chaining.

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

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

setRequest(String value)

public TCPHealthCheck.Builder setRequest(String value)

Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection.

optional string request = 21951119;

Parameter
Name Description
value String

The request to set.

Returns
Type Description
TCPHealthCheck.Builder

This builder for chaining.

setRequestBytes(ByteString value)

public TCPHealthCheck.Builder setRequestBytes(ByteString value)

Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection.

optional string request = 21951119;

Parameter
Name Description
value ByteString

The bytes for request to set.

Returns
Type Description
TCPHealthCheck.Builder

This builder for chaining.

setResponse(String value)

public TCPHealthCheck.Builder setResponse(String value)

Creates a content-based TCP health check. In addition to establishing a TCP connection, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp

optional string response = 196547649;

Parameter
Name Description
value String

The response to set.

Returns
Type Description
TCPHealthCheck.Builder

This builder for chaining.

setResponseBytes(ByteString value)

public TCPHealthCheck.Builder setResponseBytes(ByteString value)

Creates a content-based TCP health check. In addition to establishing a TCP connection, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp

optional string response = 196547649;

Parameter
Name Description
value ByteString

The bytes for response to set.

Returns
Type Description
TCPHealthCheck.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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