BackendService (Google Cloud 0.119.0-alpha API)

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

All Implemented Interfaces:: com.google.api.gax.httpjson.ApiMessage

@Generated(value="by GAPIC")
 @BetaApi
public final class BackendService
extends Object
implements com.google.api.gax.httpjson.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()` If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent).
`com.google.api.gax.httpjson.ApiMessage`	`getApiMessageRequestBody()`
`List<Backend>`	`getBackendsList()` 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>`	`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, enables Cloud CDN for the backend service.
`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`	`getLocalityLbPolicy()` The load balancing algorithm used within the scope of the locality.
`String`	`getName()` Name of the resource.
`OutlierDetection`	`getOutlierDetection()` Settings controlling eviction of unhealthy hosts from the load balancing pool.
`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.
`String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`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.
`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 com.google.api.gax.httpjson.ApiMessage
  - getApiMessageRequestBody
```
@Nullable
public com.google.api.gax.httpjson.ApiMessage getApiMessageRequestBody()
```
    Specified by:
    
    getApiMessageRequestBody in interface com.google.api.gax.httpjson.ApiMessage
  - getFieldMask
```
@Nullable
public List<String> getFieldMask()
```
    Specified by:
    
    getFieldMask in interface com.google.api.gax.httpjson.ApiMessage
  - 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).
  - getBackendsList
```
public List<Backend> getBackendsList()
```
    The list of backends that serve this BackendService.
  - getCdnPolicy
```
public BackendServiceCdnPolicy getCdnPolicy()
```
    Cloud CDN configuration for this BackendService.
  - getCircuitBreakers
```
public CircuitBreakers getCircuitBreakers()
```
    Settings controlling the volume of connections to a 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.
  - getConnectionDraining
```
public ConnectionDraining getConnectionDraining()
```
  - 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.
  - 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, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS.
  - 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.
  - 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.
  - 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.
  - getOutlierDetection
```
public OutlierDetection getOutlierDetection()
```
    Settings controlling eviction of unhealthy hosts from the load balancing pool. 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.
  - 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).
  - 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 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 Blaancing).
  - getProtocol
```
public String getProtocol()
```
    The protocol this BackendService uses to communicate with backends.
    Possible values are HTTP, HTTPS, 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.
  - 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. 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, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.
  - 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.
  - 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

getCircuitBreakers

getConnectionDraining

getConsistentHash

getCreationTimestamp

getCustomRequestHeadersList

getDescription

getEnableCDN

getFingerprint

getHealthChecksList

getIap

getId

getKind

getLoadBalancingScheme

getLocalityLbPolicy

getName

getOutlierDetection

getPort

getPortName

getProtocol

getRegion

getSecurityPolicy

getSelfLink

getSessionAffinity

getTimeoutSec

newBuilder

newBuilder

toBuilder

getDefaultInstance

toString

equals

hashCode