Class TCPHealthCheck.Builder (1.12.1)

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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TCPHealthCheck.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
TCPHealthCheck.Builder
Overrides

build()

public TCPHealthCheck build()
Returns
TypeDescription
TCPHealthCheck

buildPartial()

public TCPHealthCheck buildPartial()
Returns
TypeDescription
TCPHealthCheck

clear()

public TCPHealthCheck.Builder clear()
Returns
TypeDescription
TCPHealthCheck.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public TCPHealthCheck.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
TCPHealthCheck.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public TCPHealthCheck.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
TCPHealthCheck.Builder
Overrides

clearPort()

public TCPHealthCheck.Builder clearPort()

The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.

optional int32 port = 3446913;

Returns
TypeDescription
TCPHealthCheck.Builder

This builder for chaining.

clearPortName()

public TCPHealthCheck.Builder clearPortName()

Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

optional string port_name = 41534345;

Returns
TypeDescription
TCPHealthCheck.Builder

This builder for chaining.

clearPortSpecification()

public TCPHealthCheck.Builder clearPortSpecification()

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, TCP 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
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
TypeDescription
TCPHealthCheck.Builder

This builder for chaining.

clearRequest()

public TCPHealthCheck.Builder clearRequest()

The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

optional string request = 21951119;

Returns
TypeDescription
TCPHealthCheck.Builder

This builder for chaining.

clearResponse()

public TCPHealthCheck.Builder clearResponse()

The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

optional string response = 196547649;

Returns
TypeDescription
TCPHealthCheck.Builder

This builder for chaining.

clone()

public TCPHealthCheck.Builder clone()
Returns
TypeDescription
TCPHealthCheck.Builder
Overrides

getDefaultInstanceForType()

public TCPHealthCheck getDefaultInstanceForType()
Returns
TypeDescription
TCPHealthCheck

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getPort()

public int getPort()

The TCP port number for the health check request. The default value is 80. 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.

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.

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, TCP 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, TCP 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.

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
TypeDescription
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
TypeDescription
ByteString

The bytes for proxyHeader.

getRequest()

public String getRequest()

The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

optional string request = 21951119;

Returns
TypeDescription
String

The request.

getRequestBytes()

public ByteString getRequestBytes()

The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

optional string request = 21951119;

Returns
TypeDescription
ByteString

The bytes for request.

getResponse()

public String getResponse()

The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

optional string response = 196547649;

Returns
TypeDescription
String

The response.

getResponseBytes()

public ByteString getResponseBytes()

The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

optional string response = 196547649;

Returns
TypeDescription
ByteString

The bytes for response.

hasPort()

public boolean hasPort()

The TCP port number for the health check request. The default value is 80. 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.

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, TCP 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.

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
TypeDescription
boolean

Whether the proxyHeader field is set.

hasRequest()

public boolean hasRequest()

The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

optional string request = 21951119;

Returns
TypeDescription
boolean

Whether the request field is set.

hasResponse()

public boolean hasResponse()

The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

optional string response = 196547649;

Returns
TypeDescription
boolean

Whether the response field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(TCPHealthCheck other)

public TCPHealthCheck.Builder mergeFrom(TCPHealthCheck other)
Parameter
NameDescription
otherTCPHealthCheck
Returns
TypeDescription
TCPHealthCheck.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TCPHealthCheck.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TCPHealthCheck.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public TCPHealthCheck.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
TCPHealthCheck.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TCPHealthCheck.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
TCPHealthCheck.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public TCPHealthCheck.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
TCPHealthCheck.Builder
Overrides

setPort(int value)

public TCPHealthCheck.Builder setPort(int value)

The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.

optional int32 port = 3446913;

Parameter
NameDescription
valueint

The port to set.

Returns
TypeDescription
TCPHealthCheck.Builder

This builder for chaining.

setPortName(String value)

public TCPHealthCheck.Builder setPortName(String value)

Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

optional string port_name = 41534345;

Parameter
NameDescription
valueString

The portName to set.

Returns
TypeDescription
TCPHealthCheck.Builder

This builder for chaining.

setPortNameBytes(ByteString value)

public TCPHealthCheck.Builder setPortNameBytes(ByteString value)

Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

optional string port_name = 41534345;

Parameter
NameDescription
valueByteString

The bytes for portName to set.

Returns
TypeDescription
TCPHealthCheck.Builder

This builder for chaining.

setPortSpecification(String value)

public TCPHealthCheck.Builder setPortSpecification(String value)

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, TCP 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;

Parameter
NameDescription
valueString

The portSpecification to set.

Returns
TypeDescription
TCPHealthCheck.Builder

This builder for chaining.

setPortSpecificationBytes(ByteString value)

public TCPHealthCheck.Builder setPortSpecificationBytes(ByteString value)

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, TCP 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;

Parameter
NameDescription
valueByteString

The bytes for portSpecification to set.

Returns
TypeDescription
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
NameDescription
valueString

The proxyHeader to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for proxyHeader to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
TCPHealthCheck.Builder
Overrides

setRequest(String value)

public TCPHealthCheck.Builder setRequest(String value)

The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

optional string request = 21951119;

Parameter
NameDescription
valueString

The request to set.

Returns
TypeDescription
TCPHealthCheck.Builder

This builder for chaining.

setRequestBytes(ByteString value)

public TCPHealthCheck.Builder setRequestBytes(ByteString value)

The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

optional string request = 21951119;

Parameter
NameDescription
valueByteString

The bytes for request to set.

Returns
TypeDescription
TCPHealthCheck.Builder

This builder for chaining.

setResponse(String value)

public TCPHealthCheck.Builder setResponse(String value)

The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

optional string response = 196547649;

Parameter
NameDescription
valueString

The response to set.

Returns
TypeDescription
TCPHealthCheck.Builder

This builder for chaining.

setResponseBytes(ByteString value)

public TCPHealthCheck.Builder setResponseBytes(ByteString value)

The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

optional string response = 196547649;

Parameter
NameDescription
valueByteString

The bytes for response to set.

Returns
TypeDescription
TCPHealthCheck.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final TCPHealthCheck.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
TCPHealthCheck.Builder
Overrides