Class HTTPHealthCheck.Builder (1.53.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
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public HTTPHealthCheck build()
Returns
Type Description
HTTPHealthCheck

buildPartial()

public HTTPHealthCheck buildPartial()
Returns
Type Description
HTTPHealthCheck

clear()

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

clearField(Descriptors.FieldDescriptor field)

public HTTPHealthCheck.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
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 host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest

optional string host = 3208616;

Returns
Type Description
HTTPHealthCheck.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPort()

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

This builder for chaining.

clearPortName()

public HTTPHealthCheck.Builder clearPortName()

Not supported.

optional string port_name = 41534345;

Returns
Type Description
HTTPHealthCheck.Builder

This builder for chaining.

clearPortSpecification()

public HTTPHealthCheck.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. Also supported in legacy HTTP health checks for 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 pass-through 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
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
Type Description
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
Type Description
HTTPHealthCheck.Builder

This builder for chaining.

clearResponse()

public HTTPHealthCheck.Builder clearResponse()

Creates a content-based HTTP health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http

optional string response = 196547649;

Returns
Type Description
HTTPHealthCheck.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public HTTPHealthCheck getDefaultInstanceForType()
Returns
Type Description
HTTPHealthCheck

getDescriptorForType()

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

getHost()

public String getHost()

The value of the host header in the HTTP health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest

optional string host = 3208616;

Returns
Type Description
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 host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest

optional string host = 3208616;

Returns
Type Description
ByteString

The bytes for host.

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. Also supported in legacy HTTP health checks for 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 pass-through 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. Also supported in legacy HTTP health checks for 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 pass-through 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.

getRequestPath()

public String getRequestPath()

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

optional string request_path = 229403605;

Returns
Type Description
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
Type Description
ByteString

The bytes for requestPath.

getResponse()

public String getResponse()

Creates a content-based HTTP health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http

optional string response = 196547649;

Returns
Type Description
String

The response.

getResponseBytes()

public ByteString getResponseBytes()

Creates a content-based HTTP health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http

optional string response = 196547649;

Returns
Type Description
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 host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest

optional string host = 3208616;

Returns
Type Description
boolean

Whether the host field is set.

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. Also supported in legacy HTTP health checks for 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 pass-through 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.

hasRequestPath()

public boolean hasRequestPath()

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

optional string request_path = 229403605;

Returns
Type Description
boolean

Whether the requestPath field is set.

hasResponse()

public boolean hasResponse()

Creates a content-based HTTP health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http

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(HTTPHealthCheck other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

public HTTPHealthCheck.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
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 host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest

optional string host = 3208616;

Parameter
Name Description
value String

The host to set.

Returns
Type Description
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 host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest

optional string host = 3208616;

Parameter
Name Description
value ByteString

The bytes for host to set.

Returns
Type Description
HTTPHealthCheck.Builder

This builder for chaining.

setPort(int value)

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

This builder for chaining.

setPortName(String value)

public HTTPHealthCheck.Builder setPortName(String value)

Not supported.

optional string port_name = 41534345;

Parameter
Name Description
value String

The portName to set.

Returns
Type Description
HTTPHealthCheck.Builder

This builder for chaining.

setPortNameBytes(ByteString value)

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

This builder for chaining.

setPortSpecification(String value)

public HTTPHealthCheck.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. Also supported in legacy HTTP health checks for 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 pass-through 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
HTTPHealthCheck.Builder

This builder for chaining.

setPortSpecificationBytes(ByteString value)

public HTTPHealthCheck.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. Also supported in legacy HTTP health checks for 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 pass-through 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
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
Name Description
value String

The proxyHeader to set.

Returns
Type Description
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
Name Description
value ByteString

The bytes for proxyHeader to set.

Returns
Type Description
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
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
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
Name Description
value String

The requestPath to set.

Returns
Type Description
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
Name Description
value ByteString

The bytes for requestPath to set.

Returns
Type Description
HTTPHealthCheck.Builder

This builder for chaining.

setResponse(String value)

public HTTPHealthCheck.Builder setResponse(String value)

Creates a content-based HTTP health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http

optional string response = 196547649;

Parameter
Name Description
value String

The response to set.

Returns
Type Description
HTTPHealthCheck.Builder

This builder for chaining.

setResponseBytes(ByteString value)

public HTTPHealthCheck.Builder setResponseBytes(ByteString value)

Creates a content-based HTTP health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http

optional string response = 196547649;

Parameter
Name Description
value ByteString

The bytes for response to set.

Returns
Type Description
HTTPHealthCheck.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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