Class SSLHealthCheck (1.6.0-beta)

public final class SSLHealthCheck extends GeneratedMessageV3 implements SSLHealthCheckOrBuilder

Protobuf type google.cloud.compute.v1.SSLHealthCheck

Fields

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_FIELD_NUMBER

public static final int REQUEST_FIELD_NUMBER
Field Value
Type Description
int

RESPONSE_FIELD_NUMBER

public static final int RESPONSE_FIELD_NUMBER
Field Value
Type Description
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstance()

public static SSLHealthCheck getDefaultInstance()
Returns
Type Description
SSLHealthCheck

getDefaultInstanceForType()

public SSLHealthCheck getDefaultInstanceForType()
Returns
Type Description
SSLHealthCheck

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

getParserForType()

public Parser<SSLHealthCheck> getParserForType()
Returns
Type Description
Parser<SSLHealthCheck>
Overrides

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
Type Description
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
Type Description
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
Type Description
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, SSL 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
Type Description
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, SSL 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
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.

getRequest()

public String getRequest()

The application data to send once the SSL 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
Type Description
String

The request.

getRequestBytes()

public ByteString getRequestBytes()

The application data to send once the SSL 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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for response.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

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
Type Description
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
Type Description
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, SSL 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
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.

hasRequest()

public boolean hasRequest()

The application data to send once the SSL 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
Type Description
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
Type Description
boolean

Whether the response field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilder()

public static SSLHealthCheck.Builder newBuilder()
Returns
Type Description
SSLHealthCheck.Builder

newBuilder(SSLHealthCheck prototype)

public static SSLHealthCheck.Builder newBuilder(SSLHealthCheck prototype)
Parameter
Name Description
prototype SSLHealthCheck
Returns
Type Description
SSLHealthCheck.Builder

newBuilderForType()

public SSLHealthCheck.Builder newBuilderForType()
Returns
Type Description
SSLHealthCheck.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SSLHealthCheck.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SSLHealthCheck.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

parseDelimitedFrom(InputStream input)

public static SSLHealthCheck parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SSLHealthCheck
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SSLHealthCheck parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SSLHealthCheck
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SSLHealthCheck parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SSLHealthCheck
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SSLHealthCheck parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SSLHealthCheck
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SSLHealthCheck parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SSLHealthCheck
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SSLHealthCheck parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SSLHealthCheck
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SSLHealthCheck parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SSLHealthCheck
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SSLHealthCheck parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SSLHealthCheck
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SSLHealthCheck parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SSLHealthCheck
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SSLHealthCheck parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SSLHealthCheck
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SSLHealthCheck parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SSLHealthCheck
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SSLHealthCheck parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SSLHealthCheck
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SSLHealthCheck> parser()
Returns
Type Description
Parser<SSLHealthCheck>

toBuilder()

public SSLHealthCheck.Builder toBuilder()
Returns
Type Description
SSLHealthCheck.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException