• Home
• com.google.apis
• google-api-services-compute
• alpha-rev20200526-1.30.9
• source code
• BackendService.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.compute.model.BackendService.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute.model
Class BackendService



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.BackendService













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class BackendService
extends GenericJson
Represents a Backend Service resource.

 A backend service defines how Google Cloud load balancers distribute traffic. The backend service
 configuration contains a set of values, such as the protocol used to connect to backends, various
 distribution and session settings, health checks, and timeouts. These settings provide fine-
 grained control over how your load balancer behaves. Most of the settings have default values
 that allow for easy configuration if you need to get started quickly.

 Backend services in Google Compute Engine can be either regionally or globally scoped.

 * [Global](/compute/docs/reference/rest/{$api_version}/backendServices) *
 [Regional](/compute/docs/reference/rest/{$api_version}/regionBackendServices)

 For more information, read Backend Services.

 (== resource_for {$api_version}.backendService ==)

 
 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
GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


BackendService() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


BackendService
clone() 


byte[]
decodeFingerprint()
Fingerprint of this resource.



BackendService
encodeFingerprint(byte[] fingerprint)
Fingerprint of this resource.



Integer
getAffinityCookieTtlSec()
If set to 0, the cookie is non-persistent and lasts only until the end of the browser session
 (or equivalent).



List<Backend>
getBackends()
The list of backends that serve this BackendService.



BackendServiceCdnPolicy
getCdnPolicy()
Cloud CDN configuration for this BackendService.



CircuitBreakers
getCircuitBreakers()
Settings controlling the volume of connections to a backend service.



ConnectionDraining
getConnectionDraining() 


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.



String
getDescription()
An optional description of this resource.



Boolean
getEnableCDN()
If true, enables Cloud CDN for the backend service.



BackendServiceFailoverPolicy
getFailoverPolicy()
Applicable only to Failover for Internal TCP/UDP 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() 


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.



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.



Integer
getTimeoutSec()
The backend service timeout has a different meaning depending on the type of load balancer.



BackendService
set(String fieldName,
   Object value) 


BackendService
setAffinityCookieTtlSec(Integer affinityCookieTtlSec)
If set to 0, the cookie is non-persistent and lasts only until the end of the browser session
 (or equivalent).



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)
Settings controlling the volume of connections to a backend service.



BackendService
setConnectionDraining(ConnectionDraining connectionDraining) 


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
setDescription(String description)
An optional description of this resource.



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.



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) 


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
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
setTimeoutSec(Integer timeoutSec)
The backend service timeout has a different meaning depending on the type of load balancer.







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














Constructor Detail





BackendService
public BackendService()









Method Detail





getAffinityCookieTtlSec
public Integer getAffinityCookieTtlSec()
If set to 0, the cookie is non-persistent and lasts only until the end of the browser session
 (or equivalent). The maximum allowed value is one day (86,400).

Returns:
value or null for none








setAffinityCookieTtlSec
public BackendService setAffinityCookieTtlSec(Integer affinityCookieTtlSec)
If set to 0, the cookie is non-persistent and lasts only until the end of the browser session
 (or equivalent). The maximum allowed value is one day (86,400).

Parameters:
affinityCookieTtlSec - affinityCookieTtlSec or null for none








getBackends
public List<Backend> getBackends()
The list of backends that serve this BackendService.

Returns:
value or null for none








setBackends
public BackendService setBackends(List<Backend> backends)
The list of backends that serve this BackendService.

Parameters:
backends - backends or null for none








getCdnPolicy
public BackendServiceCdnPolicy getCdnPolicy()
Cloud CDN configuration for this BackendService.

Returns:
value or null for none








setCdnPolicy
public BackendService setCdnPolicy(BackendServiceCdnPolicy cdnPolicy)
Cloud CDN configuration for this BackendService.

Parameters:
cdnPolicy - cdnPolicy or null for none








getCircuitBreakers
public CircuitBreakers getCircuitBreakers()
Settings controlling the volume of connections to a backend service. If not set, this feature
 is considered disabled.

 This field is applicable to either:   - A regional backend service with the service_protocol
 set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.  - A global
 backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

Returns:
value or null for none








setCircuitBreakers
public BackendService setCircuitBreakers(CircuitBreakers circuitBreakers)
Settings controlling the volume of connections to a backend service. If not set, this feature
 is considered disabled.

 This field is applicable to either:   - A regional backend service with the service_protocol
 set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.  - A global
 backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

Parameters:
circuitBreakers - circuitBreakers or null for none








getConnectionDraining
public ConnectionDraining getConnectionDraining()

Returns:
value or null for none








setConnectionDraining
public BackendService setConnectionDraining(ConnectionDraining connectionDraining)

Parameters:
connectionDraining - connectionDraining or null for none








getConsistentHash
public ConsistentHashLoadBalancerSettings getConsistentHash()
Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP
 headers, cookies or other properties. This load balancing policy is applicable only for HTTP
 connections. The affinity to a particular destination host will be lost when one or more hosts
 are added/removed from the destination service. This field specifies parameters that control
 consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or
 RING_HASH.

 This field is applicable to either:   - A regional backend service with the service_protocol
 set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.  - A global
 backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

Returns:
value or null for none








setConsistentHash
public 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. This load balancing policy is applicable only for HTTP
 connections. The affinity to a particular destination host will be lost when one or more hosts
 are added/removed from the destination service. This field specifies parameters that control
 consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or
 RING_HASH.

 This field is applicable to either:   - A regional backend service with the service_protocol
 set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.  - A global
 backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

Parameters:
consistentHash - consistentHash or null for none








getCreationTimestamp
public String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.

Returns:
value or null for none








setCreationTimestamp
public BackendService setCreationTimestamp(String creationTimestamp)
[Output Only] Creation timestamp in RFC3339 text format.

Parameters:
creationTimestamp - creationTimestamp or null for none








getCustomRequestHeaders
public List<String> getCustomRequestHeaders()
Headers that the HTTP/S load balancer should add to proxied requests.

Returns:
value or null for none








setCustomRequestHeaders
public BackendService setCustomRequestHeaders(List<String> customRequestHeaders)
Headers that the HTTP/S load balancer should add to proxied requests.

Parameters:
customRequestHeaders - customRequestHeaders or null for none








getDescription
public String getDescription()
An optional description of this resource. Provide this property when you create the resource.

Returns:
value or null for none








setDescription
public BackendService setDescription(String description)
An optional description of this resource. Provide this property when you create the resource.

Parameters:
description - description or null for none








getEnableCDN
public Boolean getEnableCDN()
If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme
 is EXTERNAL and the protocol is HTTP or HTTPS.

Returns:
value or null for none








setEnableCDN
public BackendService setEnableCDN(Boolean enableCDN)
If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme
 is EXTERNAL and the protocol is HTTP or HTTPS.

Parameters:
enableCDN - enableCDN or null for none








getFailoverPolicy
public BackendServiceFailoverPolicy getFailoverPolicy()
Applicable only to Failover for Internal TCP/UDP Load Balancing. Requires at least one backend
 instance group to be defined as a backup (failover) backend.

Returns:
value or null for none








setFailoverPolicy
public BackendService setFailoverPolicy(BackendServiceFailoverPolicy failoverPolicy)
Applicable only to Failover for Internal TCP/UDP Load Balancing. Requires at least one backend
 instance group to be defined as a backup (failover) backend.

Parameters:
failoverPolicy - failoverPolicy or null for none








getFingerprint
public String getFingerprint()
Fingerprint of this resource. A hash of the contents stored in this object. This field is used
 in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-
 date fingerprint must be provided in order to update the BackendService, otherwise the request
 will fail with error 412 conditionNotMet.

 To see the latest fingerprint, make a get() request to retrieve a BackendService.

Returns:
value or null for none
See Also:
decodeFingerprint()








decodeFingerprint
public byte[] decodeFingerprint()
Fingerprint of this resource. A hash of the contents stored in this object. This field is used
 in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-
 date fingerprint must be provided in order to update the BackendService, otherwise the request
 will fail with error 412 conditionNotMet.

 To see the latest fingerprint, make a get() request to retrieve a BackendService.

Returns:
Base64 decoded value or null for none
Since:
1.14
See Also:
getFingerprint()








setFingerprint
public BackendService setFingerprint(String fingerprint)
Fingerprint of this resource. A hash of the contents stored in this object. This field is used
 in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-
 date fingerprint must be provided in order to update the BackendService, otherwise the request
 will fail with error 412 conditionNotMet.

 To see the latest fingerprint, make a get() request to retrieve a BackendService.

Parameters:
fingerprint - fingerprint or null for none
See Also:
#encodeFingerprint()








encodeFingerprint
public BackendService encodeFingerprint(byte[] fingerprint)
Fingerprint of this resource. A hash of the contents stored in this object. This field is used
 in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-
 date fingerprint must be provided in order to update the BackendService, otherwise the request
 will fail with error 412 conditionNotMet.

 To see the latest fingerprint, make a get() request to retrieve a BackendService.

Since:
1.14
See Also:

 The value is encoded Base64 or {@code null} for none.
 








getHealthChecks
public List<String> getHealthChecks()
The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy)
 resource for health checking this backend service. Not all backend services support legacy
 health checks. See  Load balancer guide. Currently at most one health check can be specified.
 Backend services with instance group or zonal NEG backends must have a health check. Backend
 services with internet NEG backends must not have a health check. A health check must

Returns:
value or null for none








setHealthChecks
public BackendService setHealthChecks(List<String> healthChecks)
The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy)
 resource for health checking this backend service. Not all backend services support legacy
 health checks. See  Load balancer guide. Currently at most one health check can be specified.
 Backend services with instance group or zonal NEG backends must have a health check. Backend
 services with internet NEG backends must not have a health check. A health check must

Parameters:
healthChecks - healthChecks or null for none








getIap
public BackendServiceIAP getIap()

Returns:
value or null for none








setIap
public BackendService setIap(BackendServiceIAP iap)

Parameters:
iap - iap or null for none








getId
public BigInteger getId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns:
value or null for none








setId
public BackendService setId(BigInteger id)
[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Parameters:
id - id or null for none








getKind
public String getKind()
[Output Only] Type of resource. Always compute#backendService for backend services.

Returns:
value or null for none








setKind
public BackendService setKind(String kind)
[Output Only] Type of resource. Always compute#backendService for backend services.

Parameters:
kind - kind or null for none








getLoadBalancingScheme
public String getLoadBalancingScheme()
Specifies the load balancer type. Choose EXTERNAL for load balancers that receive traffic from
 external clients. Choose INTERNAL for Internal TCP/UDP Load Balancing. Choose INTERNAL_MANAGED
 for Internal HTTP(S) Load Balancing. Choose INTERNAL_SELF_MANAGED for Traffic Director. A
 backend service created for one type of load balancing cannot be used with another. For more
 information, refer to Choosing a load balancer.

Returns:
value or null for none








setLoadBalancingScheme
public BackendService setLoadBalancingScheme(String loadBalancingScheme)
Specifies the load balancer type. Choose EXTERNAL for load balancers that receive traffic from
 external clients. Choose INTERNAL for Internal TCP/UDP Load Balancing. Choose INTERNAL_MANAGED
 for Internal HTTP(S) Load Balancing. Choose INTERNAL_SELF_MANAGED for Traffic Director. A
 backend service created for one type of load balancing cannot be used with another. For more
 information, refer to Choosing a load balancer.

Parameters:
loadBalancingScheme - loadBalancingScheme or null for none








getLocalityLbPolicy
public String getLocalityLbPolicy()
The load balancing algorithm used within the scope of the locality. The possible values are: -
 ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin
 order. This is the default.  - LEAST_REQUEST: An O(1) algorithm which selects two random
 healthy hosts and picks the host which has fewer active requests.  - RING_HASH: The ring/modulo
 hash load balancer implements consistent hashing to backends. The algorithm has the property
 that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.  -
 RANDOM: The load balancer selects a random healthy host.  - ORIGINAL_DESTINATION: Backend host
 is selected based on the client connection metadata, i.e., connections are opened to the same
 address as the destination address of the incoming connection before the connection was
 redirected to the load balancer.  - MAGLEV: used as a drop in replacement for the ring hash
 load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and
 host selection times. For more information about Maglev, refer to
 https://ai.google/research/pubs/pub44824

 This field is applicable to either:   - A regional backend service with the service_protocol
 set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.  - A global
 backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

 If sessionAffinity is not NONE, and this field is not set to >MAGLEV or RING_HASH, session
 affinity settings will not take effect.

Returns:
value or null for none








setLocalityLbPolicy
public BackendService setLocalityLbPolicy(String localityLbPolicy)
The load balancing algorithm used within the scope of the locality. The possible values are: -
 ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin
 order. This is the default.  - LEAST_REQUEST: An O(1) algorithm which selects two random
 healthy hosts and picks the host which has fewer active requests.  - RING_HASH: The ring/modulo
 hash load balancer implements consistent hashing to backends. The algorithm has the property
 that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.  -
 RANDOM: The load balancer selects a random healthy host.  - ORIGINAL_DESTINATION: Backend host
 is selected based on the client connection metadata, i.e., connections are opened to the same
 address as the destination address of the incoming connection before the connection was
 redirected to the load balancer.  - MAGLEV: used as a drop in replacement for the ring hash
 load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and
 host selection times. For more information about Maglev, refer to
 https://ai.google/research/pubs/pub44824

 This field is applicable to either:   - A regional backend service with the service_protocol
 set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.  - A global
 backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

 If sessionAffinity is not NONE, and this field is not set to >MAGLEV or RING_HASH, session
 affinity settings will not take effect.

Parameters:
localityLbPolicy - localityLbPolicy or null for none








getLogConfig
public BackendServiceLogConfig getLogConfig()
This field denotes the logging options for the load balancer traffic served by this backend
 service. If logging is enabled, logs will be exported to Stackdriver.

Returns:
value or null for none








setLogConfig
public BackendService setLogConfig(BackendServiceLogConfig logConfig)
This field denotes the logging options for the load balancer traffic served by this backend
 service. If logging is enabled, logs will be exported to Stackdriver.

Parameters:
logConfig - logConfig or null for none








getName
public String getName()
Name of the resource. Provided by the client when the resource is created. The name must be
 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters
 long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
 character must be a lowercase letter, and all following characters must be a dash, lowercase
 letter, or digit, except the last character, which cannot be a dash.

Returns:
value or null for none








setName
public BackendService setName(String name)
Name of the resource. Provided by the client when the resource is created. The name must be
 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters
 long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
 character must be a lowercase letter, and all following characters must be a dash, lowercase
 letter, or digit, except the last character, which cannot be a dash.

Parameters:
name - name or null for none








getNetwork
public String getNetwork()
The URL of the network to which this backend service belongs. This field can only be spcified
 when the load balancing scheme is set to INTERNAL.

Returns:
value or null for none








setNetwork
public BackendService setNetwork(String network)
The URL of the network to which this backend service belongs. This field can only be spcified
 when the load balancing scheme is set to INTERNAL.

Parameters:
network - network or null for none








getOutlierDetection
public OutlierDetection getOutlierDetection()
Settings controlling the eviction of unhealthy hosts from the load balancing pool for the
 backend service. If not set, this feature is considered disabled.

 This field is applicable to either:   - A regional backend service with the service_protocol
 set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.  - A global
 backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

Returns:
value or null for none








setOutlierDetection
public BackendService setOutlierDetection(OutlierDetection outlierDetection)
Settings controlling the eviction of unhealthy hosts from the load balancing pool for the
 backend service. If not set, this feature is considered disabled.

 This field is applicable to either:   - A regional backend service with the service_protocol
 set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.  - A global
 backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

Parameters:
outlierDetection - outlierDetection or null for none








getPort
public Integer getPort()
Deprecated in favor of portName. The TCP port to connect on the backend. The default value is
 80.

 This cannot be used if the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).

Returns:
value or null for none








setPort
public BackendService setPort(Integer port)
Deprecated in favor of portName. The TCP port to connect on the backend. The default value is
 80.

 This cannot be used if the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).

Parameters:
port - port or null for none








getPortName
public String getPortName()
A named port on a backend instance group representing the port for communication to the backend
 VMs in that group. Required when the loadBalancingScheme is EXTERNAL, INTERNAL_MANAGED, or
 INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on
 each backend instance group. This parameter has no meaning if the backends are NEGs.

 Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).

Returns:
value or null for none








setPortName
public BackendService setPortName(String portName)
A named port on a backend instance group representing the port for communication to the backend
 VMs in that group. Required when the loadBalancingScheme is EXTERNAL, INTERNAL_MANAGED, or
 INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on
 each backend instance group. This parameter has no meaning if the backends are NEGs.

 Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).

Parameters:
portName - portName or null for none








getProtocol
public String getProtocol()
The protocol this BackendService uses to communicate with backends.

 Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, or UDP. depending on the chosen load balancer
 or Traffic Director configuration. Refer to the documentation for the load balancer or for
 Traffic Director for more information.

Returns:
value or null for none








setProtocol
public BackendService setProtocol(String protocol)
The protocol this BackendService uses to communicate with backends.

 Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, or UDP. depending on the chosen load balancer
 or Traffic Director configuration. Refer to the documentation for the load balancer or for
 Traffic Director for more information.

Parameters:
protocol - protocol or null for none








getRegion
public String getRegion()
[Output Only] URL of the region where the regional backend service resides. This field is not
 applicable to global backend services. You must specify this field as part of the HTTP request
 URL. It is not settable as a field in the request body.

Returns:
value or null for none








setRegion
public BackendService setRegion(String region)
[Output Only] URL of the region where the regional backend service resides. This field is not
 applicable to global backend services. You must specify this field as part of the HTTP request
 URL. It is not settable as a field in the request body.

Parameters:
region - region or null for none








getSecurityPolicy
public String getSecurityPolicy()
[Output Only] The resource URL for the security policy associated with this backend service.

Returns:
value or null for none








setSecurityPolicy
public BackendService setSecurityPolicy(String securityPolicy)
[Output Only] The resource URL for the security policy associated with this backend service.

Parameters:
securityPolicy - securityPolicy or null for none








getSecuritySettings
public SecuritySettings getSecuritySettings()
This field specifies the security policy that applies to this backend service. This field is
 applicable to either: - A regional backend service with the service_protocol set to HTTP,
 HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.  - A global backend service
 with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

Returns:
value or null for none








setSecuritySettings
public BackendService setSecuritySettings(SecuritySettings securitySettings)
This field specifies the security policy that applies to this backend service. This field is
 applicable to either: - A regional backend service with the service_protocol set to HTTP,
 HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.  - A global backend service
 with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

Parameters:
securitySettings - securitySettings or null for none








getSelfLink
public String getSelfLink()
[Output Only] Server-defined URL for the resource.

Returns:
value or null for none








setSelfLink
public BackendService setSelfLink(String selfLink)
[Output Only] Server-defined URL for the resource.

Parameters:
selfLink - selfLink or null for none








getSelfLinkWithId
public String getSelfLinkWithId()
[Output Only] Server-defined URL for this resource with the resource id.

Returns:
value or null for none








setSelfLinkWithId
public BackendService setSelfLinkWithId(String selfLinkWithId)
[Output Only] Server-defined URL for this resource with the resource id.

Parameters:
selfLinkWithId - selfLinkWithId or null for none








getSessionAffinity
public String getSessionAffinity()
Type of session affinity to use. The default is NONE. Session affinity is not applicable if the
 --protocol is UDP.

 When the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or
 GENERATED_COOKIE. You can use GENERATED_COOKIE if the protocol is HTTP or HTTPS.

 When the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO,
 or CLIENT_IP_PORT_PROTO.

 When the loadBalancingScheme is INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, possible values are
 NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.

Returns:
value or null for none








setSessionAffinity
public BackendService setSessionAffinity(String sessionAffinity)
Type of session affinity to use. The default is NONE. Session affinity is not applicable if the
 --protocol is UDP.

 When the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or
 GENERATED_COOKIE. You can use GENERATED_COOKIE if the protocol is HTTP or HTTPS.

 When the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO,
 or CLIENT_IP_PORT_PROTO.

 When the loadBalancingScheme is INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, possible values are
 NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.

Parameters:
sessionAffinity - sessionAffinity or null for none








getTimeoutSec
public Integer getTimeoutSec()
The backend service timeout has a different meaning depending on the type of load balancer. For
 more information read,  Backend service settings The default is 30 seconds.

Returns:
value or null for none








setTimeoutSec
public BackendService setTimeoutSec(Integer timeoutSec)
The backend service timeout has a different meaning depending on the type of load balancer. For
 more information read,  Backend service settings The default is 30 seconds.

Parameters:
timeoutSec - timeoutSec or null for none








set
public BackendService set(String fieldName,
                          Object value)

Overrides:
set in class GenericJson








clone
public BackendService clone()

Overrides:
clone in class GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2020 Google. All rights reserved.