Class HTTPSHealthCheck.Builder (1.13.0)

public static final class HTTPSHealthCheck.Builder extends GeneratedMessageV3.Builder<HTTPSHealthCheck.Builder> implements HTTPSHealthCheckOrBuilder

Protobuf type google.cloud.compute.v1.HTTPSHealthCheck

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public HTTPSHealthCheck build()
Returns
TypeDescription
HTTPSHealthCheck

buildPartial()

public HTTPSHealthCheck buildPartial()
Returns
TypeDescription
HTTPSHealthCheck

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearHost()

public HTTPSHealthCheck.Builder clearHost()

The value of the host header in the HTTPS 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
HTTPSHealthCheck.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPort()

public HTTPSHealthCheck.Builder clearPort()

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

optional int32 port = 3446913;

Returns
TypeDescription
HTTPSHealthCheck.Builder

This builder for chaining.

clearPortName()

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

This builder for chaining.

clearPortSpecification()

public HTTPSHealthCheck.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, HTTPS 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
HTTPSHealthCheck.Builder

This builder for chaining.

clearProxyHeader()

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

This builder for chaining.

clearRequestPath()

public HTTPSHealthCheck.Builder clearRequestPath()

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

optional string request_path = 229403605;

Returns
TypeDescription
HTTPSHealthCheck.Builder

This builder for chaining.

clearResponse()

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

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public HTTPSHealthCheck getDefaultInstanceForType()
Returns
TypeDescription
HTTPSHealthCheck

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getHost()

public String getHost()

The value of the host header in the HTTPS 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 HTTPS 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 443. 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, HTTPS 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, HTTPS 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 HTTPS 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 HTTPS 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 HTTPS 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 443. 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, HTTPS 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 HTTPS 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(HTTPSHealthCheck other)

public HTTPSHealthCheck.Builder mergeFrom(HTTPSHealthCheck other)
Parameter
NameDescription
otherHTTPSHealthCheck
Returns
TypeDescription
HTTPSHealthCheck.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setHost(String value)

public HTTPSHealthCheck.Builder setHost(String value)

The value of the host header in the HTTPS 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
HTTPSHealthCheck.Builder

This builder for chaining.

setHostBytes(ByteString value)

public HTTPSHealthCheck.Builder setHostBytes(ByteString value)

The value of the host header in the HTTPS 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
HTTPSHealthCheck.Builder

This builder for chaining.

setPort(int value)

public HTTPSHealthCheck.Builder setPort(int value)

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

optional int32 port = 3446913;

Parameter
NameDescription
valueint

The port to set.

Returns
TypeDescription
HTTPSHealthCheck.Builder

This builder for chaining.

setPortName(String value)

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

This builder for chaining.

setPortNameBytes(ByteString value)

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

This builder for chaining.

setPortSpecification(String value)

public HTTPSHealthCheck.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, HTTPS 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
HTTPSHealthCheck.Builder

This builder for chaining.

setPortSpecificationBytes(ByteString value)

public HTTPSHealthCheck.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, HTTPS 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
HTTPSHealthCheck.Builder

This builder for chaining.

setProxyHeader(String value)

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

This builder for chaining.

setProxyHeaderBytes(ByteString value)

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

This builder for chaining.

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

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

setRequestPath(String value)

public HTTPSHealthCheck.Builder setRequestPath(String value)

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

optional string request_path = 229403605;

Parameter
NameDescription
valueString

The requestPath to set.

Returns
TypeDescription
HTTPSHealthCheck.Builder

This builder for chaining.

setRequestPathBytes(ByteString value)

public HTTPSHealthCheck.Builder setRequestPathBytes(ByteString value)

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

optional string request_path = 229403605;

Parameter
NameDescription
valueByteString

The bytes for requestPath to set.

Returns
TypeDescription
HTTPSHealthCheck.Builder

This builder for chaining.

setResponse(String value)

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

This builder for chaining.

setResponseBytes(ByteString value)

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

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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