BackendService (Google Cloud 0.89.0-alpha API)

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

All Implemented Interfaces:: ApiMessage

@Generated(value="by GAPIC")
 @BetaApi
public final class BackendService
extends Object
implements ApiMessage

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BackendService.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`BackendService.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`Integer`	`getAffinityCookieTtlSec()` Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE.
`ApiMessage`	`getApiMessageRequestBody()`
`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.
`static BackendService`	`getDefaultInstance()`
`String`	`getDescription()` An optional description of this resource.
`Boolean`	`getEnableCDN()` If true, enable Cloud CDN for this BackendService.
`List<String>`	`getFieldMask()`
`Object`	`getFieldValue(String fieldName)`
`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.
`int`	`hashCode()`
`static BackendService.Builder`	`newBuilder()`
`static BackendService.Builder`	`newBuilder(BackendService prototype)`
`BackendService.Builder`	`toBuilder()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - getFieldValue
```
public Object getFieldValue(String fieldName)
```
    Specified by:
    
    getFieldValue in interface ApiMessage
  - getApiMessageRequestBody
```
@Nullable
public ApiMessage getApiMessageRequestBody()
```
    Specified by:
    
    getApiMessageRequestBody in interface ApiMessage
  - getFieldMask
```
@Nullable
public List<String> getFieldMask()
```
    Specified by:
    
    getFieldMask in interface ApiMessage
  - 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.
  - getBackendsList
```
public List<Backend> getBackendsList()
```
    The list of backends that serve this BackendService.
  - getCdnPolicy
```
public BackendServiceCdnPolicy getCdnPolicy()
```
    Cloud CDN configuration for this BackendService.
  - getConnectionDraining
```
public ConnectionDraining getConnectionDraining()
```
  - getCreationTimestamp
```
public String getCreationTimestamp()
```
    [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.
  - getDescription
```
public String getDescription()
```
    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.
  - 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.
  - 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.
  - getIap
```
public BackendServiceIAP getIap()
```
  - getId
```
public String getId()
```
    [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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - getSecurityPolicy
```
public String getSecurityPolicy()
```
    [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.
  - 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.
  - getTimeoutSec
```
public Integer getTimeoutSec()
```
    How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
  - newBuilder
```
public static BackendService.Builder newBuilder()
```
  - newBuilder
```
public static BackendService.Builder newBuilder(BackendService prototype)
```
  - toBuilder
```
public BackendService.Builder toBuilder()
```
  - getDefaultInstance
```
public static BackendService getDefaultInstance()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class BackendService

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getFieldValue

getApiMessageRequestBody

getFieldMask

getAffinityCookieTtlSec

getBackendsList

getCdnPolicy

getConnectionDraining

getCreationTimestamp

getCustomRequestHeadersList

getDescription

getEnableCDN

getFingerprint

getHealthChecksList

getIap

getId

getKind

getLoadBalancingScheme

getName

getPort

getPortName

getProtocol

getRegion

getSecurityPolicy

getSelfLink

getSessionAffinity

getTimeoutSec

newBuilder

newBuilder

toBuilder

getDefaultInstance

toString

equals

hashCode