public final class BackendService extends GenericJson
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
GenericData.Flags
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
Constructor and Description |
---|
BackendService() |
Modifier and Type | Method and Description |
---|---|
BackendService |
clone() |
byte[] |
decodeFingerprint()
Fingerprint of this resource.
|
BackendService |
encodeFingerprint(byte[] fingerprint)
Fingerprint of this resource.
|
Integer |
getAffinityCookieTtlSec()
Lifetime of cookies in seconds.
|
List<Backend> |
getBackends()
The list of backends that serve this BackendService.
|
BackendServiceCdnPolicy |
getCdnPolicy()
Cloud CDN configuration for this BackendService.
|
CircuitBreakers |
getCircuitBreakers() |
String |
getCompressionMode()
Compress text responses using Brotli or gzip compression, based on the client?s Accept-Encoding
header.
|
ConnectionDraining |
getConnectionDraining() |
BackendServiceConnectionTrackingPolicy |
getConnectionTrackingPolicy() |
ConsistentHashLoadBalancerSettings |
getConsistentHash()
Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP
headers, cookies or other properties.
|
String |
getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
|
List<String> |
getCustomRequestHeaders()
Headers that the HTTP/S load balancer should add to proxied requests.
|
List<String> |
getCustomResponseHeaders()
Headers that the HTTP/S load balancer should add to proxied responses.
|
String |
getDescription()
An optional description of this resource.
|
String |
getEdgeSecurityPolicy()
[Output Only] The resource URL for the edge security policy associated with this backend
service.
|
Boolean |
getEnableCDN()
If true, enables Cloud CDN for the backend service.
|
BackendServiceFailoverPolicy |
getFailoverPolicy()
Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing.
|
String |
getFingerprint()
Fingerprint of this resource.
|
List<String> |
getHealthChecks()
The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy)
resource for health checking this backend service.
|
BackendServiceIAP |
getIap()
The configurations for Identity-Aware Proxy on this resource.
|
BigInteger |
getId()
[Output Only] The unique identifier for the resource.
|
String |
getKind()
[Output Only] Type of resource.
|
String |
getLoadBalancingScheme()
Specifies the load balancer type.
|
String |
getLocalityLbPolicy()
The load balancing algorithm used within the scope of the locality.
|
BackendServiceLogConfig |
getLogConfig()
This field denotes the logging options for the load balancer traffic served by this backend
service.
|
Duration |
getMaxStreamDuration()
Specifies the default maximum duration (timeout) for streams to this service.
|
String |
getName()
Name of the resource.
|
String |
getNetwork()
The URL of the network to which this backend service belongs.
|
OutlierDetection |
getOutlierDetection()
Settings controlling the eviction of unhealthy hosts from the load balancing pool for the
backend service.
|
Integer |
getPort()
Deprecated in favor of portName.
|
String |
getPortName()
A named port on a backend instance group representing the port for communication to the backend
VMs in that group.
|
String |
getProtocol()
The protocol this BackendService uses to communicate with backends.
|
String |
getRegion()
[Output Only] URL of the region where the regional backend service resides.
|
String |
getSecurityPolicy()
[Output Only] The resource URL for the security policy associated with this backend service.
|
SecuritySettings |
getSecuritySettings()
This field specifies the security policy that applies to this backend service.
|
String |
getSelfLink()
[Output Only] Server-defined URL for the resource.
|
String |
getSelfLinkWithId()
[Output Only] Server-defined URL for this resource with the resource id.
|
String |
getSessionAffinity()
Type of session affinity to use.
|
Subsetting |
getSubsetting() |
Integer |
getTimeoutSec()
Not supported when the backend service is referenced by a URL map that is bound to target gRPC
proxy that has validateForProxyless field set to true.
|
BackendService |
set(String fieldName,
Object value) |
BackendService |
setAffinityCookieTtlSec(Integer affinityCookieTtlSec)
Lifetime of cookies in seconds.
|
BackendService |
setBackends(List<Backend> backends)
The list of backends that serve this BackendService.
|
BackendService |
setCdnPolicy(BackendServiceCdnPolicy cdnPolicy)
Cloud CDN configuration for this BackendService.
|
BackendService |
setCircuitBreakers(CircuitBreakers circuitBreakers) |
BackendService |
setCompressionMode(String compressionMode)
Compress text responses using Brotli or gzip compression, based on the client?s Accept-Encoding
header.
|
BackendService |
setConnectionDraining(ConnectionDraining connectionDraining) |
BackendService |
setConnectionTrackingPolicy(BackendServiceConnectionTrackingPolicy connectionTrackingPolicy) |
BackendService |
setConsistentHash(ConsistentHashLoadBalancerSettings consistentHash)
Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP
headers, cookies or other properties.
|
BackendService |
setCreationTimestamp(String creationTimestamp)
[Output Only] Creation timestamp in RFC3339 text format.
|
BackendService |
setCustomRequestHeaders(List<String> customRequestHeaders)
Headers that the HTTP/S load balancer should add to proxied requests.
|
BackendService |
setCustomResponseHeaders(List<String> customResponseHeaders)
Headers that the HTTP/S load balancer should add to proxied responses.
|
BackendService |
setDescription(String description)
An optional description of this resource.
|
BackendService |
setEdgeSecurityPolicy(String edgeSecurityPolicy)
[Output Only] The resource URL for the edge security policy associated with this backend
service.
|
BackendService |
setEnableCDN(Boolean enableCDN)
If true, enables Cloud CDN for the backend service.
|
BackendService |
setFailoverPolicy(BackendServiceFailoverPolicy failoverPolicy)
Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing.
|
BackendService |
setFingerprint(String fingerprint)
Fingerprint of this resource.
|
BackendService |
setHealthChecks(List<String> healthChecks)
The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy)
resource for health checking this backend service.
|
BackendService |
setIap(BackendServiceIAP iap)
The configurations for Identity-Aware Proxy on this resource.
|
BackendService |
setId(BigInteger id)
[Output Only] The unique identifier for the resource.
|
BackendService |
setKind(String kind)
[Output Only] Type of resource.
|
BackendService |
setLoadBalancingScheme(String loadBalancingScheme)
Specifies the load balancer type.
|
BackendService |
setLocalityLbPolicy(String localityLbPolicy)
The load balancing algorithm used within the scope of the locality.
|
BackendService |
setLogConfig(BackendServiceLogConfig logConfig)
This field denotes the logging options for the load balancer traffic served by this backend
service.
|
BackendService |
setMaxStreamDuration(Duration maxStreamDuration)
Specifies the default maximum duration (timeout) for streams to this service.
|
BackendService |
setName(String name)
Name of the resource.
|
BackendService |
setNetwork(String network)
The URL of the network to which this backend service belongs.
|
BackendService |
setOutlierDetection(OutlierDetection outlierDetection)
Settings controlling the eviction of unhealthy hosts from the load balancing pool for the
backend service.
|
BackendService |
setPort(Integer port)
Deprecated in favor of portName.
|
BackendService |
setPortName(String portName)
A named port on a backend instance group representing the port for communication to the backend
VMs in that group.
|
BackendService |
setProtocol(String protocol)
The protocol this BackendService uses to communicate with backends.
|
BackendService |
setRegion(String region)
[Output Only] URL of the region where the regional backend service resides.
|
BackendService |
setSecurityPolicy(String securityPolicy)
[Output Only] The resource URL for the security policy associated with this backend service.
|
BackendService |
setSecuritySettings(SecuritySettings securitySettings)
This field specifies the security policy that applies to this backend service.
|
BackendService |
setSelfLink(String selfLink)
[Output Only] Server-defined URL for the resource.
|
BackendService |
setSelfLinkWithId(String selfLinkWithId)
[Output Only] Server-defined URL for this resource with the resource id.
|
BackendService |
setSessionAffinity(String sessionAffinity)
Type of session affinity to use.
|
BackendService |
setSubsetting(Subsetting subsetting) |
BackendService |
setTimeoutSec(Integer timeoutSec)
Not supported when the backend service is referenced by a URL map that is bound to target gRPC
proxy that has validateForProxyless field set to true.
|
getFactory, setFactory, toPrettyString, toString
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
clear, containsKey, containsValue, isEmpty, keySet, size, values
finalize, getClass, notify, notifyAll, wait, wait, wait
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
public Integer getAffinityCookieTtlSec()
null
for nonepublic BackendService setAffinityCookieTtlSec(Integer affinityCookieTtlSec)
affinityCookieTtlSec
- affinityCookieTtlSec or null
for nonepublic List<Backend> getBackends()
null
for nonepublic BackendService setBackends(List<Backend> backends)
backends
- backends or null
for nonepublic BackendServiceCdnPolicy getCdnPolicy()
null
for nonepublic BackendService setCdnPolicy(BackendServiceCdnPolicy cdnPolicy)
cdnPolicy
- cdnPolicy or null
for nonepublic CircuitBreakers getCircuitBreakers()
null
for nonepublic BackendService setCircuitBreakers(CircuitBreakers circuitBreakers)
circuitBreakers
- circuitBreakers or null
for nonepublic String getCompressionMode()
null
for nonepublic BackendService setCompressionMode(String compressionMode)
compressionMode
- compressionMode or null
for nonepublic ConnectionDraining getConnectionDraining()
null
for nonepublic BackendService setConnectionDraining(ConnectionDraining connectionDraining)
connectionDraining
- connectionDraining or null
for nonepublic BackendServiceConnectionTrackingPolicy getConnectionTrackingPolicy()
null
for nonepublic BackendService setConnectionTrackingPolicy(BackendServiceConnectionTrackingPolicy connectionTrackingPolicy)
connectionTrackingPolicy
- connectionTrackingPolicy or null
for nonepublic ConsistentHashLoadBalancerSettings getConsistentHash()
null
for nonepublic BackendService setConsistentHash(ConsistentHashLoadBalancerSettings consistentHash)
consistentHash
- consistentHash or null
for nonepublic String getCreationTimestamp()
null
for nonepublic BackendService setCreationTimestamp(String creationTimestamp)
creationTimestamp
- creationTimestamp or null
for nonepublic List<String> getCustomRequestHeaders()
null
for nonepublic BackendService setCustomRequestHeaders(List<String> customRequestHeaders)
customRequestHeaders
- customRequestHeaders or null
for nonepublic List<String> getCustomResponseHeaders()
null
for nonepublic BackendService setCustomResponseHeaders(List<String> customResponseHeaders)
customResponseHeaders
- customResponseHeaders or null
for nonepublic String getDescription()
null
for nonepublic BackendService setDescription(String description)
description
- description or null
for nonepublic String getEdgeSecurityPolicy()
null
for nonepublic BackendService setEdgeSecurityPolicy(String edgeSecurityPolicy)
edgeSecurityPolicy
- edgeSecurityPolicy or null
for nonepublic Boolean getEnableCDN()
null
for nonepublic BackendService setEnableCDN(Boolean enableCDN)
enableCDN
- enableCDN or null
for nonepublic BackendServiceFailoverPolicy getFailoverPolicy()
null
for nonepublic BackendService setFailoverPolicy(BackendServiceFailoverPolicy failoverPolicy)
failoverPolicy
- failoverPolicy or null
for nonepublic String getFingerprint()
null
for nonedecodeFingerprint()
public byte[] decodeFingerprint()
null
for nonegetFingerprint()
public BackendService setFingerprint(String fingerprint)
fingerprint
- fingerprint or null
for none#encodeFingerprint()
public BackendService encodeFingerprint(byte[] fingerprint)
The value is encoded Base64 or {@code null} for none.
public List<String> getHealthChecks()
null
for nonepublic BackendService setHealthChecks(List<String> healthChecks)
healthChecks
- healthChecks or null
for nonepublic BackendServiceIAP getIap()
null
for nonepublic BackendService setIap(BackendServiceIAP iap)
iap
- iap or null
for nonepublic BigInteger getId()
null
for nonepublic BackendService setId(BigInteger id)
id
- id or null
for nonepublic String getKind()
null
for nonepublic BackendService setKind(String kind)
kind
- kind or null
for nonepublic String getLoadBalancingScheme()
null
for nonepublic BackendService setLoadBalancingScheme(String loadBalancingScheme)
loadBalancingScheme
- loadBalancingScheme or null
for nonepublic String getLocalityLbPolicy()
null
for nonepublic BackendService setLocalityLbPolicy(String localityLbPolicy)
localityLbPolicy
- localityLbPolicy or null
for nonepublic BackendServiceLogConfig getLogConfig()
null
for nonepublic BackendService setLogConfig(BackendServiceLogConfig logConfig)
logConfig
- logConfig or null
for nonepublic Duration getMaxStreamDuration()
null
for nonepublic BackendService setMaxStreamDuration(Duration maxStreamDuration)
maxStreamDuration
- maxStreamDuration or null
for nonepublic String getName()
null
for nonepublic BackendService setName(String name)
name
- name or null
for nonepublic String getNetwork()
null
for nonepublic BackendService setNetwork(String network)
network
- network or null
for nonepublic OutlierDetection getOutlierDetection()
null
for nonepublic BackendService setOutlierDetection(OutlierDetection outlierDetection)
outlierDetection
- outlierDetection or null
for nonepublic Integer getPort()
null
for nonepublic BackendService setPort(Integer port)
port
- port or null
for nonepublic String getPortName()
null
for nonepublic BackendService setPortName(String portName)
portName
- portName or null
for nonepublic String getProtocol()
null
for nonepublic BackendService setProtocol(String protocol)
protocol
- protocol or null
for nonepublic String getRegion()
null
for nonepublic BackendService setRegion(String region)
region
- region or null
for nonepublic String getSecurityPolicy()
null
for nonepublic BackendService setSecurityPolicy(String securityPolicy)
securityPolicy
- securityPolicy or null
for nonepublic SecuritySettings getSecuritySettings()
null
for nonepublic BackendService setSecuritySettings(SecuritySettings securitySettings)
securitySettings
- securitySettings or null
for nonepublic String getSelfLink()
null
for nonepublic BackendService setSelfLink(String selfLink)
selfLink
- selfLink or null
for nonepublic String getSelfLinkWithId()
null
for nonepublic BackendService setSelfLinkWithId(String selfLinkWithId)
selfLinkWithId
- selfLinkWithId or null
for nonepublic String getSessionAffinity()
null
for nonepublic BackendService setSessionAffinity(String sessionAffinity)
sessionAffinity
- sessionAffinity or null
for nonepublic Subsetting getSubsetting()
null
for nonepublic BackendService setSubsetting(Subsetting subsetting)
subsetting
- subsetting or null
for nonepublic Integer getTimeoutSec()
null
for nonepublic BackendService setTimeoutSec(Integer timeoutSec)
timeoutSec
- timeoutSec or null
for nonepublic BackendService set(String fieldName, Object value)
set
in class GenericJson
public BackendService clone()
clone
in class GenericJson
Copyright © 2011–2021 Google. All rights reserved.