BackendService (Compute Engine API v1-rev20190107-1.26.0)

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 com.google.api.client.json.GenericJson
```
A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity. (== resource_for v1.backendService ==) (== resource_for beta.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
  com.google.api.client.util.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()

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()` Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE.
`List<Backend>`	`getBackends()` The list of backends that serve this BackendService.
`BackendServiceCdnPolicy`	`getCdnPolicy()` Cloud CDN configuration for this BackendService.
`ConnectionDraining`	`getConnectionDraining()`
`String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`String`	`getDescription()` An optional description of this resource.
`Boolean`	`getEnableCDN()` If true, enable Cloud CDN for this BackendService.
`String`	`getFingerprint()` Fingerprint of this resource.
`List<String>`	`getHealthChecks()` The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService.
`BackendServiceIAP`	`getIap()`
`BigInteger`	`getId()` [Output Only] The unique identifier for the resource.
`String`	`getKind()` [Output Only] Type of resource.
`String`	`getLoadBalancingScheme()` Indicates whether the backend service will be used with internal or external load balancing.
`String`	`getName()` Name of the resource.
`Integer`	`getPort()` Deprecated in favor of portName.
`String`	`getPortName()` Name of backend port.
`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.
`String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`String`	`getSessionAffinity()` Type of session affinity to use.
`Integer`	`getTimeoutSec()` How many seconds to wait for the backend before considering it a failed request.
`BackendService`	`set(String fieldName, Object value)`
`BackendService`	`setAffinityCookieTtlSec(Integer affinityCookieTtlSec)` Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE.
`BackendService`	`setBackends(List<Backend> backends)` The list of backends that serve this BackendService.
`BackendService`	`setCdnPolicy(BackendServiceCdnPolicy cdnPolicy)` Cloud CDN configuration for this BackendService.
`BackendService`	`setConnectionDraining(ConnectionDraining connectionDraining)`
`BackendService`	`setCreationTimestamp(String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`BackendService`	`setDescription(String description)` An optional description of this resource.
`BackendService`	`setEnableCDN(Boolean enableCDN)` If true, enable Cloud CDN for this BackendService.
`BackendService`	`setFingerprint(String fingerprint)` Fingerprint of this resource.
`BackendService`	`setHealthChecks(List<String> healthChecks)` The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService.
`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)` Indicates whether the backend service will be used with internal or external load balancing.
`BackendService`	`setName(String name)` Name of the resource.
`BackendService`	`setPort(Integer port)` Deprecated in favor of portName.
`BackendService`	`setPortName(String portName)` Name of backend port.
`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`	`setSelfLink(String selfLink)` [Output Only] Server-defined URL for the resource.
`BackendService`	`setSessionAffinity(String sessionAffinity)` Type of session affinity to use.
`BackendService`	`setTimeoutSec(Integer timeoutSec)` How many seconds to wait for the backend before considering it a failed request.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, 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()
```
    Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. 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 for TTL is one day. When the load balancing scheme is INTERNAL, this field is not used.
    
    Returns:
    
    value or null for none
  - setAffinityCookieTtlSec
```
public BackendService setAffinityCookieTtlSec(Integer affinityCookieTtlSec)
```
    Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. 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 for TTL is one day. When the load balancing scheme is INTERNAL, this field is not used.
    
    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
  - getConnectionDraining
```
public ConnectionDraining getConnectionDraining()
```
    Returns:
    
    value or null for none
  - setConnectionDraining
```
public BackendService setConnectionDraining(ConnectionDraining connectionDraining)
```
    Parameters:
    
    connectionDraining - connectionDraining 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
  - 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, enable Cloud CDN for this BackendService. When the load balancing scheme is INTERNAL, this field is not used.
    
    Returns:
    
    value or null for none
  - setEnableCDN
```
public BackendService setEnableCDN(Boolean enableCDN)
```
    If true, enable Cloud CDN for this BackendService. When the load balancing scheme is INTERNAL, this field is not used.
    
    Parameters:
    
    enableCDN - enableCDN 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 HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required for Compute Engine backend services. A health check must not be specified for App Engine backend and Cloud Function backend. For internal load balancing, a URL to a HealthCheck resource must be specified instead.
    
    Returns:
    
    value or null for none
  - setHealthChecks
```
public BackendService setHealthChecks(List<String> healthChecks)
```
    The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required for Compute Engine backend services. A health check must not be specified for App Engine backend and Cloud Function backend. For internal load balancing, a URL to a HealthCheck resource must be specified instead.
    
    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()
```
    Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. Possible values are INTERNAL and EXTERNAL.
    
    Returns:
    
    value or null for none
  - setLoadBalancingScheme
```
public BackendService setLoadBalancingScheme(String loadBalancingScheme)
```
    Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. Possible values are INTERNAL and EXTERNAL.
    
    Parameters:
    
    loadBalancingScheme - loadBalancingScheme 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
  - 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 for internal 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 for internal load balancing.
    
    Parameters:
    
    port - port or null for none
  - getPortName
```
public String getPortName()
```
    Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL. When the load balancing scheme is INTERNAL, this field is not used.
    
    Returns:
    
    value or null for none
  - setPortName
```
public BackendService setPortName(String portName)
```
    Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL. When the load balancing scheme is INTERNAL, this field is not used.
    
    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, TCP, and SSL. The default is HTTP. For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
    
    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, TCP, and SSL. The default is HTTP. For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
    
    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
  - 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
  - getSessionAffinity
```
public String getSessionAffinity()
```
    Type of session affinity to use. The default is NONE. When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE. When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. When the protocol is UDP, this field is not used.
    
    Returns:
    
    value or null for none
  - setSessionAffinity
```
public BackendService setSessionAffinity(String sessionAffinity)
```
    Type of session affinity to use. The default is NONE. When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE. When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. When the protocol is UDP, this field is not used.
    
    Parameters:
    
    sessionAffinity - sessionAffinity or null for none
  - getTimeoutSec
```
public Integer getTimeoutSec()
```
    How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
    
    Returns:
    
    value or null for none
  - setTimeoutSec
```
public BackendService setTimeoutSec(Integer timeoutSec)
```
    How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
    
    Parameters:
    
    timeoutSec - timeoutSec or null for none
  - set
```
public BackendService set(String fieldName,
                          Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public BackendService clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class BackendService

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

BackendService

Method Detail

getAffinityCookieTtlSec

setAffinityCookieTtlSec

getBackends

setBackends

getCdnPolicy

setCdnPolicy

getConnectionDraining

setConnectionDraining

getCreationTimestamp

setCreationTimestamp

getDescription

setDescription

getEnableCDN

setEnableCDN

getFingerprint

decodeFingerprint

setFingerprint

encodeFingerprint

getHealthChecks

setHealthChecks

getIap

setIap

getId

setId

getKind

setKind

getLoadBalancingScheme

setLoadBalancingScheme

getName

setName

getPort

setPort

getPortName

setPortName

getProtocol

setProtocol

getRegion

setRegion

getSecurityPolicy

setSecurityPolicy

getSelfLink

setSelfLink

getSessionAffinity

setSessionAffinity

getTimeoutSec

setTimeoutSec

set

clone