com.google.api.services.compute.model

Class TargetInstance

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class TargetInstance
extends GenericJson

Represents a Target Instance resource. You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances.

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

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
TargetInstance()

Method Summary

Modifier and Type	Method and Description
TargetInstance	clone()
String	getCreationTimestamp() [Output Only] Creation timestamp in RFC3339 text format.
String	getDescription() An optional description of this resource.
BigInteger	getId() [Output Only] The unique identifier for the resource.
String	getInstance() A URL to the virtual machine instance that handles traffic for this target instance.
String	getKind() [Output Only] The type of the resource.
String	getName() Name of the resource.
String	getNatPolicy() Must have a value of NO_NAT.
String	getNetwork() The URL of the network this target instance uses to forward traffic.
String	getSelfLink() [Output Only] Server-defined URL for the resource.
String	getZone() [Output Only] URL of the zone where the target instance resides.
TargetInstance	set(String fieldName, Object value)
TargetInstance	setCreationTimestamp(String creationTimestamp) [Output Only] Creation timestamp in RFC3339 text format.
TargetInstance	setDescription(String description) An optional description of this resource.
TargetInstance	setId(BigInteger id) [Output Only] The unique identifier for the resource.
TargetInstance	setInstance(String instance) A URL to the virtual machine instance that handles traffic for this target instance.
TargetInstance	setKind(String kind) [Output Only] The type of the resource.
TargetInstance	setName(String name) Name of the resource.
TargetInstance	setNatPolicy(String natPolicy) Must have a value of NO_NAT.
TargetInstance	setNetwork(String network) The URL of the network this target instance uses to forward traffic.
TargetInstance	setSelfLink(String selfLink) [Output Only] Server-defined URL for the resource.
TargetInstance	setZone(String zone) [Output Only] URL of the zone where the target instance resides.

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

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, 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

TargetInstance

public TargetInstance()

Method Detail

getCreationTimestamp

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

Returns:

value or null for none

setCreationTimestamp

public TargetInstance 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 TargetInstance setDescription(String description)

An optional description of this resource. Provide this property when you create the resource.

Parameters:

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

getInstance

public String getInstance()

A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance

Returns:

value or null for none

setInstance

public TargetInstance setInstance(String instance)

A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance

Parameters:

instance - instance or null for none

getKind

public String getKind()

[Output Only] The type of the resource. Always compute#targetInstance for target instances.

Returns:

value or null for none

setKind

public TargetInstance setKind(String kind)

[Output Only] The type of the resource. Always compute#targetInstance for target instances.

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

getNatPolicy

public String getNatPolicy()

Must have a value of NO_NAT. Protocol forwarding delivers packets while preserving the destination IP address of the forwarding rule referencing the target instance.

Returns:

value or null for none

setNatPolicy

public TargetInstance setNatPolicy(String natPolicy)

Must have a value of NO_NAT. Protocol forwarding delivers packets while preserving the destination IP address of the forwarding rule referencing the target instance.

Parameters:

natPolicy - natPolicy or null for none

getNetwork

public String getNetwork()

The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to.

Returns:

value or null for none

setNetwork

public TargetInstance setNetwork(String network)

The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to.

Parameters:

network - network or null for none

getSelfLink

public String getSelfLink()

[Output Only] Server-defined URL for the resource.

Returns:

value or null for none

setSelfLink

public TargetInstance setSelfLink(String selfLink)

[Output Only] Server-defined URL for the resource.

Parameters:

selfLink - selfLink or null for none

getZone

public String getZone()

[Output Only] URL of the zone where the target instance resides. 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

setZone

public TargetInstance setZone(String zone)

[Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Parameters:

zone - zone or null for none

set

public TargetInstance set(String fieldName,
                          Object value)

Overrides:

set in class GenericJson

clone

public TargetInstance clone()

Overrides:

clone in class GenericJson