BackendService.Builder (Google Cloud 0.89.0-alpha API)

java.lang.Object
- com.google.cloud.compute.v1.BackendService.Builder

Enclosing class:: BackendService

public static class BackendService.Builder
extends Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BackendService.Builder`	`addAllBackends(List<Backend> backends)` The list of backends that serve this BackendService.
`BackendService.Builder`	`addAllCustomRequestHeaders(List<String> customRequestHeaders)` Headers that the HTTP/S load balancer should add to proxied requests.
`BackendService.Builder`	`addAllHealthChecks(List<String> healthChecks)` The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService.
`BackendService.Builder`	`addBackends(Backend backends)` The list of backends that serve this BackendService.
`BackendService.Builder`	`addCustomRequestHeaders(String customRequestHeaders)` Headers that the HTTP/S load balancer should add to proxied requests.
`BackendService.Builder`	`addHealthChecks(String healthChecks)` The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService.
`BackendService`	`build()`
`BackendService.Builder`	`clone()`
`Integer`	`getAffinityCookieTtlSec()` Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE.
`List<Backend>`	`getBackendsList()` 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.
`List<String>`	`getCustomRequestHeadersList()` Headers that the HTTP/S load balancer should add to proxied requests.
`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>`	`getHealthChecksList()` The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService.
`BackendServiceIAP`	`getIap()`
`String`	`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.Builder`	`mergeFrom(BackendService other)`
`BackendService.Builder`	`setAffinityCookieTtlSec(Integer affinityCookieTtlSec)` Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE.
`BackendService.Builder`	`setCdnPolicy(BackendServiceCdnPolicy cdnPolicy)` Cloud CDN configuration for this BackendService.
`BackendService.Builder`	`setConnectionDraining(ConnectionDraining connectionDraining)`
`BackendService.Builder`	`setCreationTimestamp(String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`BackendService.Builder`	`setDescription(String description)` An optional description of this resource.
`BackendService.Builder`	`setEnableCDN(Boolean enableCDN)` If true, enable Cloud CDN for this BackendService.
`BackendService.Builder`	`setFingerprint(String fingerprint)` Fingerprint of this resource.
`BackendService.Builder`	`setIap(BackendServiceIAP iap)`
`BackendService.Builder`	`setId(String id)` [Output Only] The unique identifier for the resource.
`BackendService.Builder`	`setKind(String kind)` [Output Only] Type of resource.
`BackendService.Builder`	`setLoadBalancingScheme(String loadBalancingScheme)` Indicates whether the backend service will be used with internal or external load balancing.
`BackendService.Builder`	`setName(String name)` Name of the resource.
`BackendService.Builder`	`setPort(Integer port)` Deprecated in favor of portName.
`BackendService.Builder`	`setPortName(String portName)` Name of backend port.
`BackendService.Builder`	`setProtocol(String protocol)` The protocol this BackendService uses to communicate with backends.
`BackendService.Builder`	`setRegion(String region)` [Output Only] URL of the region where the regional backend service resides.
`BackendService.Builder`	`setSecurityPolicy(String securityPolicy)` [Output Only] The resource URL for the security policy associated with this backend service.
`BackendService.Builder`	`setSelfLink(String selfLink)` [Output Only] Server-defined URL for the resource.
`BackendService.Builder`	`setSessionAffinity(String sessionAffinity)` Type of session affinity to use.
`BackendService.Builder`	`setTimeoutSec(Integer timeoutSec)` How many seconds to wait for the backend before considering it a failed request.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - mergeFrom
```
public BackendService.Builder mergeFrom(BackendService other)
```
  - 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.
  - setAffinityCookieTtlSec
```
public BackendService.Builder 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.
  - getBackendsList
```
public List<Backend> getBackendsList()
```
    The list of backends that serve this BackendService.
  - addAllBackends
```
public BackendService.Builder addAllBackends(List<Backend> backends)
```
    The list of backends that serve this BackendService.
  - addBackends
```
public BackendService.Builder addBackends(Backend backends)
```
    The list of backends that serve this BackendService.
  - getCdnPolicy
```
public BackendServiceCdnPolicy getCdnPolicy()
```
    Cloud CDN configuration for this BackendService.
  - setCdnPolicy
```
public BackendService.Builder setCdnPolicy(BackendServiceCdnPolicy cdnPolicy)
```
    Cloud CDN configuration for this BackendService.
  - getConnectionDraining
```
public ConnectionDraining getConnectionDraining()
```
  - setConnectionDraining
```
public BackendService.Builder setConnectionDraining(ConnectionDraining connectionDraining)
```
  - getCreationTimestamp
```
public String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
  - setCreationTimestamp
```
public BackendService.Builder setCreationTimestamp(String creationTimestamp)
```
    [Output Only] Creation timestamp in RFC3339 text format.
  - getCustomRequestHeadersList
```
public List<String> getCustomRequestHeadersList()
```
    Headers that the HTTP/S load balancer should add to proxied requests.
  - addAllCustomRequestHeaders
```
public BackendService.Builder addAllCustomRequestHeaders(List<String> customRequestHeaders)
```
    Headers that the HTTP/S load balancer should add to proxied requests.
  - addCustomRequestHeaders
```
public BackendService.Builder addCustomRequestHeaders(String customRequestHeaders)
```
    Headers that the HTTP/S load balancer should add to proxied requests.
  - getDescription
```
public String getDescription()
```
    An optional description of this resource. Provide this property when you create the resource.
  - setDescription
```
public BackendService.Builder setDescription(String description)
```
    An optional description of this resource. Provide this property when you create the resource.
  - getEnableCDN
```
public Boolean getEnableCDN()
```
    If true, enable Cloud CDN for this BackendService.
    When the load balancing scheme is INTERNAL, this field is not used.
  - setEnableCDN
```
public BackendService.Builder setEnableCDN(Boolean enableCDN)
```
    If true, enable Cloud CDN for this BackendService.
    When the load balancing scheme is INTERNAL, this field is not used.
  - 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.
  - setFingerprint
```
public BackendService.Builder 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.
  - getHealthChecksList
```
public List<String> getHealthChecksList()
```
    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.
  - addAllHealthChecks
```
public BackendService.Builder addAllHealthChecks(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.
  - addHealthChecks
```
public BackendService.Builder addHealthChecks(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.
  - getIap
```
public BackendServiceIAP getIap()
```
  - setIap
```
public BackendService.Builder setIap(BackendServiceIAP iap)
```
  - getId
```
public String getId()
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
  - setId
```
public BackendService.Builder setId(String id)
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
  - getKind
```
public String getKind()
```
    [Output Only] Type of resource. Always compute#backendService for backend services.
  - setKind
```
public BackendService.Builder setKind(String kind)
```
    [Output Only] Type of resource. Always compute#backendService for backend services.
  - 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.
  - setLoadBalancingScheme
```
public BackendService.Builder 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.
  - 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.
  - setName
```
public BackendService.Builder 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.
  - 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.
  - setPort
```
public BackendService.Builder 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.
  - 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.
  - setPortName
```
public BackendService.Builder 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.
  - 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.
  - setProtocol
```
public BackendService.Builder 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.
  - 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.
  - setRegion
```
public BackendService.Builder 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.
  - getSecurityPolicy
```
public String getSecurityPolicy()
```
    [Output Only] The resource URL for the security policy associated with this backend service.
  - setSecurityPolicy
```
public BackendService.Builder setSecurityPolicy(String securityPolicy)
```
    [Output Only] The resource URL for the security policy associated with this backend service.
  - getSelfLink
```
public String getSelfLink()
```
    [Output Only] Server-defined URL for the resource.
  - setSelfLink
```
public BackendService.Builder setSelfLink(String selfLink)
```
    [Output Only] Server-defined URL for the resource.
  - 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.
  - setSessionAffinity
```
public BackendService.Builder 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.
  - getTimeoutSec
```
public Integer getTimeoutSec()
```
    How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
  - setTimeoutSec
```
public BackendService.Builder setTimeoutSec(Integer timeoutSec)
```
    How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
  - build
```
public BackendService build()
```
  - clone
```
public BackendService.Builder clone()
```
    Overrides:
    
    clone in class Object

Class BackendService.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

mergeFrom

getAffinityCookieTtlSec

setAffinityCookieTtlSec

getBackendsList

addAllBackends

addBackends

getCdnPolicy

setCdnPolicy

getConnectionDraining

setConnectionDraining

getCreationTimestamp

setCreationTimestamp

getCustomRequestHeadersList

addAllCustomRequestHeaders

addCustomRequestHeaders

getDescription

setDescription

getEnableCDN

setEnableCDN

getFingerprint

setFingerprint

getHealthChecksList

addAllHealthChecks

addHealthChecks

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

build

clone