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

A BackendService resource. This resource defines a group of backend VMs together with their serving capacity.

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: http://code.google.com/p/google-http-java-client/wiki/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

Methods

Modifier and Type	Method and Description
BackendService	clone()
byte[]	decodeFingerprint() Fingerprint of this resource.
BackendService	encodeFingerprint(byte[] fingerprint) Fingerprint of this resource.
List<Backend>	getBackends() The list of backends that serve this BackendService.
String	getCreationTimestamp() Creation timestamp in RFC3339 text format (output only).
String	getDescription() An optional textual description of the resource; provided by the client when the resource is created.
String	getFingerprint() Fingerprint of this resource.
List<String>	getHealthChecks() The list of URLs to the HttpHealthCheck resource for health checking this BackendService.
BigInteger	getId() Unique identifier for the resource; defined by the server (output only).
String	getKind() Type of the resource.
String	getName() Name of the resource; provided by the client when the resource is created.
Integer	getPort() The TCP port to connect on the backend.
String	getProtocol()
String	getSelfLink() Server defined URL for the resource (output only).
Integer	getTimeoutSec() How many seconds to wait for the backend before considering it a failed request.
BackendService	set(String fieldName, Object value)
BackendService	setBackends(List<Backend> backends) The list of backends that serve this BackendService.
BackendService	setCreationTimestamp(String creationTimestamp) Creation timestamp in RFC3339 text format (output only).
BackendService	setDescription(String description) An optional textual description of the resource; provided by the client when the resource is created.
BackendService	setFingerprint(String fingerprint) Fingerprint of this resource.
BackendService	setHealthChecks(List<String> healthChecks) The list of URLs to the HttpHealthCheck resource for health checking this BackendService.
BackendService	setId(BigInteger id) Unique identifier for the resource; defined by the server (output only).
BackendService	setKind(String kind) Type of the resource.
BackendService	setName(String name) Name of the resource; provided by the client when the resource is created.
BackendService	setPort(Integer port) The TCP port to connect on the backend.
BackendService	setProtocol(String protocol)
BackendService	setSelfLink(String selfLink) Server defined URL for the resource (output only).
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

Constructor Detail

BackendService

public BackendService()

Method Detail

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

getCreationTimestamp

public String getCreationTimestamp()

Creation timestamp in RFC3339 text format (output only).

Returns:

value or null for none

setCreationTimestamp

public BackendService setCreationTimestamp(String creationTimestamp)

Creation timestamp in RFC3339 text format (output only).

Parameters:

creationTimestamp - creationTimestamp or null for none

getDescription

public String getDescription()

An optional textual description of the resource; provided by the client when the resource is created.

Returns:

value or null for none

setDescription

public BackendService setDescription(String description)

An optional textual description of the resource; provided by the client when the resource is created.

Parameters:

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

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.

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.

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.

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 resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.

Returns:

value or null for none

setHealthChecks

public BackendService setHealthChecks(List<String> healthChecks)

The list of URLs to the HttpHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.

Parameters:

healthChecks - healthChecks or null for none

getId

public BigInteger getId()

Unique identifier for the resource; defined by the server (output only).

Returns:

value or null for none

setId

public BackendService setId(BigInteger id)

Unique identifier for the resource; defined by the server (output only).

Parameters:

id - id or null for none

getKind

public String getKind()

Type of the resource.

Returns:

value or null for none

setKind

public BackendService setKind(String kind)

Type of the resource.

Parameters:

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

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.

Parameters:

name - name or null for none

getPort

public Integer getPort()

The TCP port to connect on the backend. The default value is 80.

Returns:

value or null for none

setPort

public BackendService setPort(Integer port)

The TCP port to connect on the backend. The default value is 80.

Parameters:

port - port or null for none

getProtocol

public String getProtocol()

Returns:

value or null for none

setProtocol

public BackendService setProtocol(String protocol)

Parameters:

protocol - protocol or null for none

getSelfLink

public String getSelfLink()

Server defined URL for the resource (output only).

Returns:

value or null for none

setSelfLink

public BackendService setSelfLink(String selfLink)

Server defined URL for the resource (output only).

Parameters:

selfLink - selfLink 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 GenericJson

clone

public BackendService clone()

Overrides:

clone in class GenericJson