Class HTTPSHealthCheck (1.65.0)

Version latest

• 1.65.0 (latest)
• 1.64.0
• 1.63.0
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public final class HTTPSHealthCheck extends GeneratedMessageV3 implements HTTPSHealthCheckOrBuilder

Protobuf type google.cloud.compute.v1.HTTPSHealthCheck

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > HTTPSHealthCheck

Implements

HTTPSHealthCheckOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

HOST_FIELD_NUMBER

public static final int HOST_FIELD_NUMBER

Field Value
Type	Description
int

PORT_FIELD_NUMBER

public static final int PORT_FIELD_NUMBER

Field Value
Type	Description
int

PORT_NAME_FIELD_NUMBER

public static final int PORT_NAME_FIELD_NUMBER

Field Value
Type	Description
int

PORT_SPECIFICATION_FIELD_NUMBER

public static final int PORT_SPECIFICATION_FIELD_NUMBER

Field Value
Type	Description
int

PROXY_HEADER_FIELD_NUMBER

public static final int PROXY_HEADER_FIELD_NUMBER

Field Value
Type	Description
int

REQUEST_PATH_FIELD_NUMBER

public static final int REQUEST_PATH_FIELD_NUMBER

Field Value
Type	Description
int

RESPONSE_FIELD_NUMBER

public static final int RESPONSE_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static HTTPSHealthCheck getDefaultInstance()

Returns
Type	Description
HTTPSHealthCheck

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static HTTPSHealthCheck.Builder newBuilder()

Returns
Type	Description
HTTPSHealthCheck.Builder

newBuilder(HTTPSHealthCheck prototype)

public static HTTPSHealthCheck.Builder newBuilder(HTTPSHealthCheck prototype)

Parameter
Name	Description
prototype	HTTPSHealthCheck

Returns
Type	Description
HTTPSHealthCheck.Builder

parseDelimitedFrom(InputStream input)

public static HTTPSHealthCheck parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
HTTPSHealthCheck

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HTTPSHealthCheck parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
HTTPSHealthCheck

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static HTTPSHealthCheck parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
HTTPSHealthCheck

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static HTTPSHealthCheck parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
HTTPSHealthCheck

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static HTTPSHealthCheck parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
HTTPSHealthCheck

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static HTTPSHealthCheck parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
HTTPSHealthCheck

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static HTTPSHealthCheck parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
HTTPSHealthCheck

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static HTTPSHealthCheck parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
HTTPSHealthCheck

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static HTTPSHealthCheck parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
HTTPSHealthCheck

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HTTPSHealthCheck parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
HTTPSHealthCheck

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static HTTPSHealthCheck parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
HTTPSHealthCheck

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static HTTPSHealthCheck parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
HTTPSHealthCheck

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<HTTPSHealthCheck> parser()

Returns
Type	Description
Parser<HTTPSHealthCheck>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public HTTPSHealthCheck getDefaultInstanceForType()

Returns
Type	Description
HTTPSHealthCheck

getHost()

public String getHost()

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

getParserForType()

public Parser<HTTPSHealthCheck> getParserForType()

Returns
Type	Description
Parser<HTTPSHealthCheck>

Overrides

GeneratedMessageV3.getParserForType()

getPort()

public int getPort()

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

getRequestPath()

public String getRequestPath()

The request path of the HTTPS health check request. The default value is /. Must comply with RFC3986.

optional string request_path = 229403605;

Returns
Type	Description
String	The requestPath.

getRequestPathBytes()

public ByteString getRequestPathBytes()

The request path of the HTTPS health check request. The default value is /. Must comply with RFC3986.

optional string request_path = 229403605;

Returns
Type	Description
ByteString	The bytes for requestPath.

getResponse()

public String getResponse()

Creates a content-based HTTPS 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 HTTPS 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.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

hasHost()

public boolean hasHost()

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

hasRequestPath()

public boolean hasRequestPath()

The request path of the HTTPS health check request. The default value is /. Must comply with RFC3986.

optional string request_path = 229403605;

Returns
Type	Description
boolean	Whether the requestPath field is set.

hasResponse()

public boolean hasResponse()

Creates a content-based HTTPS 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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public HTTPSHealthCheck.Builder newBuilderForType()

Returns
Type	Description
HTTPSHealthCheck.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected HTTPSHealthCheck.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
HTTPSHealthCheck.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public HTTPSHealthCheck.Builder toBuilder()

Returns
Type	Description
HTTPSHealthCheck.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException