target.apidocs.com.google.api.services.compute.model.SSLHealthCheck.html Maven / Gradle / Ivy
The newest version!
SSLHealthCheck (Compute Engine API v1-rev20250320-2.0.0)
com.google.api.services.compute.model
Class SSLHealthCheck
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.compute.model.SSLHealthCheck
-
public final class SSLHealthCheck
extends com.google.api.client.json.GenericJson
Model definition for SSLHealthCheck.
This is the Java data model class that specifies how to parse/serialize into the JSON that is
transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see:
https://developers.google.com/api-client-library/java/google-http-java-client/json
- Author:
- Google, Inc.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
SSLHealthCheck()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
SSLHealthCheck
clone()
Integer
getPort()
The TCP port number to which the health check prober sends packets.
String
getPortName()
Not supported.
String
getPortSpecification()
Specifies how a port is selected for health checking.
String
getProxyHeader()
Specifies the type of proxy header to append before sending data to the backend, either NONE or
PROXY_V1.
String
getRequest()
Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length,
after establishing the TCP connection and SSL handshake.
String
getResponse()
Creates a content-based SSL health check.
SSLHealthCheck
set(String fieldName,
Object value)
SSLHealthCheck
setPort(Integer port)
The TCP port number to which the health check prober sends packets.
SSLHealthCheck
setPortName(String portName)
Not supported.
SSLHealthCheck
setPortSpecification(String portSpecification)
Specifies how a port is selected for health checking.
SSLHealthCheck
setProxyHeader(String proxyHeader)
Specifies the type of proxy header to append before sending data to the backend, either NONE or
PROXY_V1.
SSLHealthCheck
setRequest(String request)
Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length,
after establishing the TCP connection and SSL handshake.
SSLHealthCheck
setResponse(String response)
Creates a content-based SSL health check.
-
Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString
-
Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Method Detail
-
getPort
public Integer getPort()
The TCP port number to which the health check prober sends packets. The default value is 443.
Valid values are 1 through 65535.
- Returns:
- value or
null for none
-
setPort
public SSLHealthCheck setPort(Integer port)
The TCP port number to which the health check prober sends packets. The default value is 443.
Valid values are 1 through 65535.
- Parameters:
port - port or null for none
-
getPortName
public String getPortName()
Not supported.
- Returns:
- value or
null for none
-
setPortName
public SSLHealthCheck setPortName(String portName)
Not supported.
- Parameters:
portName - portName or null for none
-
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.
- Returns:
- value or
null for none
-
setPortSpecification
public SSLHealthCheck setPortSpecification(String portSpecification)
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.
- Parameters:
portSpecification - portSpecification or null for none
-
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.
- Returns:
- value or
null for none
-
setProxyHeader
public SSLHealthCheck setProxyHeader(String proxyHeader)
Specifies the type of proxy header to append before sending data to the backend, either NONE or
PROXY_V1. The default is NONE.
- Parameters:
proxyHeader - proxyHeader or null for none
-
getRequest
public String getRequest()
Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length,
after establishing the TCP connection and SSL handshake.
- Returns:
- value or
null for none
-
setRequest
public SSLHealthCheck setRequest(String request)
Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length,
after establishing the TCP connection and SSL handshake.
- Parameters:
request - request or null for none
-
getResponse
public String getResponse()
Creates a content-based SSL health check. In addition to establishing a TCP connection and the
TLS handshake, you can configure the health check to pass only when the backend sends this
exact response ASCII string, up to 1024 bytes in length. For details, see:
https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp
- Returns:
- value or
null for none
-
setResponse
public SSLHealthCheck setResponse(String response)
Creates a content-based SSL health check. In addition to establishing a TCP connection and the
TLS handshake, you can configure the health check to pass only when the backend sends this
exact response ASCII string, up to 1024 bytes in length. For details, see:
https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp
- Parameters:
response - response or null for none
-
set
public SSLHealthCheck set(String fieldName,
Object value)
- Overrides:
set in class com.google.api.client.json.GenericJson
-
clone
public SSLHealthCheck clone()
- Overrides:
clone in class com.google.api.client.json.GenericJson
Copyright © 2011–2025 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy