Class HTTPHealthCheck.Builder (1.11.0)

public static final class HTTPHealthCheck.Builder extends GeneratedMessageV3.Builder<HTTPHealthCheck.Builder> implements HTTPHealthCheckOrBuilder

Protobuf type google.cloud.compute.v1.HTTPHealthCheck

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public HTTPHealthCheck build()
Returns
TypeDescription
HTTPHealthCheck

buildPartial()

public HTTPHealthCheck buildPartial()
Returns
TypeDescription
HTTPHealthCheck

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearHost()

public HTTPHealthCheck.Builder clearHost()

The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

optional string host = 3208616;

Returns
TypeDescription
HTTPHealthCheck.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPort()

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

This builder for chaining.

clearPortName()

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

This builder for chaining.

clearPortSpecification()

public HTTPHealthCheck.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, HTTP 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
HTTPHealthCheck.Builder

This builder for chaining.

clearProxyHeader()

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

This builder for chaining.

clearRequestPath()

public HTTPHealthCheck.Builder clearRequestPath()

The request path of the HTTP health check request. The default value is /.

optional string request_path = 229403605;

Returns
TypeDescription
HTTPHealthCheck.Builder

This builder for chaining.

clearResponse()

public HTTPHealthCheck.Builder clearResponse()

The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

optional string response = 196547649;

Returns
TypeDescription
HTTPHealthCheck.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public HTTPHealthCheck getDefaultInstanceForType()
Returns
TypeDescription
HTTPHealthCheck

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getHost()

public String getHost()

The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

optional string host = 3208616;

Returns
TypeDescription
String

The host.

getHostBytes()

public ByteString getHostBytes()

The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

optional string host = 3208616;

Returns
TypeDescription
ByteString

The bytes for host.

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

getRequestPath()

public String getRequestPath()

The request path of the HTTP health check request. The default value is /.

optional string request_path = 229403605;

Returns
TypeDescription
String

The requestPath.

getRequestPathBytes()

public ByteString getRequestPathBytes()

The request path of the HTTP health check request. The default value is /.

optional string request_path = 229403605;

Returns
TypeDescription
ByteString

The bytes for requestPath.

getResponse()

public String getResponse()

The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

optional string response = 196547649;

Returns
TypeDescription
String

The response.

getResponseBytes()

public ByteString getResponseBytes()

The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

optional string response = 196547649;

Returns
TypeDescription
ByteString

The bytes for response.

hasHost()

public boolean hasHost()

The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

optional string host = 3208616;

Returns
TypeDescription
boolean

Whether the host field is set.

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

hasRequestPath()

public boolean hasRequestPath()

The request path of the HTTP health check request. The default value is /.

optional string request_path = 229403605;

Returns
TypeDescription
boolean

Whether the requestPath field is set.

hasResponse()

public boolean hasResponse()

The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines 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(HTTPHealthCheck other)

public HTTPHealthCheck.Builder mergeFrom(HTTPHealthCheck other)
Parameter
NameDescription
otherHTTPHealthCheck
Returns
TypeDescription
HTTPHealthCheck.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setHost(String value)

public HTTPHealthCheck.Builder setHost(String value)

The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

optional string host = 3208616;

Parameter
NameDescription
valueString

The host to set.

Returns
TypeDescription
HTTPHealthCheck.Builder

This builder for chaining.

setHostBytes(ByteString value)

public HTTPHealthCheck.Builder setHostBytes(ByteString value)

The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

optional string host = 3208616;

Parameter
NameDescription
valueByteString

The bytes for host to set.

Returns
TypeDescription
HTTPHealthCheck.Builder

This builder for chaining.

setPort(int value)

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

This builder for chaining.

setPortName(String value)

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

This builder for chaining.

setPortNameBytes(ByteString value)

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

This builder for chaining.

setPortSpecification(String value)

public HTTPHealthCheck.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, HTTP 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
HTTPHealthCheck.Builder

This builder for chaining.

setPortSpecificationBytes(ByteString value)

public HTTPHealthCheck.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, HTTP 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
HTTPHealthCheck.Builder

This builder for chaining.

setProxyHeader(String value)

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

This builder for chaining.

setProxyHeaderBytes(ByteString value)

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

This builder for chaining.

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

public HTTPHealthCheck.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
HTTPHealthCheck.Builder
Overrides

setRequestPath(String value)

public HTTPHealthCheck.Builder setRequestPath(String value)

The request path of the HTTP health check request. The default value is /.

optional string request_path = 229403605;

Parameter
NameDescription
valueString

The requestPath to set.

Returns
TypeDescription
HTTPHealthCheck.Builder

This builder for chaining.

setRequestPathBytes(ByteString value)

public HTTPHealthCheck.Builder setRequestPathBytes(ByteString value)

The request path of the HTTP health check request. The default value is /.

optional string request_path = 229403605;

Parameter
NameDescription
valueByteString

The bytes for requestPath to set.

Returns
TypeDescription
HTTPHealthCheck.Builder

This builder for chaining.

setResponse(String value)

public HTTPHealthCheck.Builder setResponse(String value)

The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

optional string response = 196547649;

Parameter
NameDescription
valueString

The response to set.

Returns
TypeDescription
HTTPHealthCheck.Builder

This builder for chaining.

setResponseBytes(ByteString value)

public HTTPHealthCheck.Builder setResponseBytes(ByteString value)

The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.

optional string response = 196547649;

Parameter
NameDescription
valueByteString

The bytes for response to set.

Returns
TypeDescription
HTTPHealthCheck.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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