com.google.api.services.compute.model

Class SourceInstanceProperties

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class SourceInstanceProperties
extends GenericJson

Model definition for SourceInstanceProperties.

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

Method Summary

Modifier and Type	Method and Description
SourceInstanceProperties	clone()
Boolean	getCanIpForward() Enables instances created based on this machine image to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own.
Boolean	getDeletionProtection() Whether the instance created from this machine image should be protected against deletion.
String	getDescription() An optional text description for the instances that are created from this machine image.
List<SavedAttachedDisk>	getDisks() An array of disks that are associated with the instances that are created from this machine image.
List<AcceleratorConfig>	getGuestAccelerators() A list of guest accelerator cards' type and count to use for instances created from this machine image.
Map<String,String>	getLabels() Labels to apply to instances that are created from this machine image.
String	getMachineType() The machine type to use for instances that are created from this machine image.
Metadata	getMetadata() The metadata key/value pairs to assign to instances that are created from this machine image.
String	getMinCpuPlatform() Minimum cpu/platform to be used by instances created from this machine image.
List<NetworkInterface>	getNetworkInterfaces() An array of network access configurations for this interface.
String	getPostKeyRevocationActionType() PostKeyRevocationActionType of the instance.
Scheduling	getScheduling() Specifies the scheduling options for the instances that are created from this machine image.
List<ServiceAccount>	getServiceAccounts() A list of service accounts with specified scopes.
Tags	getTags() A list of tags to apply to the instances that are created from this machine image.
SourceInstanceProperties	set(String fieldName, Object value)
SourceInstanceProperties	setCanIpForward(Boolean canIpForward) Enables instances created based on this machine image to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own.
SourceInstanceProperties	setDeletionProtection(Boolean deletionProtection) Whether the instance created from this machine image should be protected against deletion.
SourceInstanceProperties	setDescription(String description) An optional text description for the instances that are created from this machine image.
SourceInstanceProperties	setDisks(List<SavedAttachedDisk> disks) An array of disks that are associated with the instances that are created from this machine image.
SourceInstanceProperties	setGuestAccelerators(List<AcceleratorConfig> guestAccelerators) A list of guest accelerator cards' type and count to use for instances created from this machine image.
SourceInstanceProperties	setLabels(Map<String,String> labels) Labels to apply to instances that are created from this machine image.
SourceInstanceProperties	setMachineType(String machineType) The machine type to use for instances that are created from this machine image.
SourceInstanceProperties	setMetadata(Metadata metadata) The metadata key/value pairs to assign to instances that are created from this machine image.
SourceInstanceProperties	setMinCpuPlatform(String minCpuPlatform) Minimum cpu/platform to be used by instances created from this machine image.
SourceInstanceProperties	setNetworkInterfaces(List<NetworkInterface> networkInterfaces) An array of network access configurations for this interface.
SourceInstanceProperties	setPostKeyRevocationActionType(String postKeyRevocationActionType) PostKeyRevocationActionType of the instance.
SourceInstanceProperties	setScheduling(Scheduling scheduling) Specifies the scheduling options for the instances that are created from this machine image.
SourceInstanceProperties	setServiceAccounts(List<ServiceAccount> serviceAccounts) A list of service accounts with specified scopes.
SourceInstanceProperties	setTags(Tags tags) A list of tags to apply to the instances that are created from this machine image.

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

SourceInstanceProperties

public SourceInstanceProperties()

Method Detail

getCanIpForward

public Boolean getCanIpForward()

Enables instances created based on this machine image to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.

Returns:

value or null for none

setCanIpForward

public SourceInstanceProperties setCanIpForward(Boolean canIpForward)

Enables instances created based on this machine image to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.

Parameters:

canIpForward - canIpForward or null for none

getDeletionProtection

public Boolean getDeletionProtection()

Whether the instance created from this machine image should be protected against deletion.

Returns:

value or null for none

setDeletionProtection

public SourceInstanceProperties setDeletionProtection(Boolean deletionProtection)

Whether the instance created from this machine image should be protected against deletion.

Parameters:

deletionProtection - deletionProtection or null for none

getDescription

public String getDescription()

An optional text description for the instances that are created from this machine image.

Returns:

value or null for none

setDescription

public SourceInstanceProperties setDescription(String description)

An optional text description for the instances that are created from this machine image.

Parameters:

description - description or null for none

getDisks

public List<SavedAttachedDisk> getDisks()

An array of disks that are associated with the instances that are created from this machine image.

Returns:

value or null for none

setDisks

public SourceInstanceProperties setDisks(List<SavedAttachedDisk> disks)

An array of disks that are associated with the instances that are created from this machine image.

Parameters:

disks - disks or null for none

getGuestAccelerators

public List<AcceleratorConfig> getGuestAccelerators()

A list of guest accelerator cards' type and count to use for instances created from this machine image.

Returns:

value or null for none

setGuestAccelerators

public SourceInstanceProperties setGuestAccelerators(List<AcceleratorConfig> guestAccelerators)

A list of guest accelerator cards' type and count to use for instances created from this machine image.

Parameters:

guestAccelerators - guestAccelerators or null for none

getLabels

public Map<String,String> getLabels()

Labels to apply to instances that are created from this machine image.

Returns:

value or null for none

setLabels

public SourceInstanceProperties setLabels(Map<String,String> labels)

Labels to apply to instances that are created from this machine image.

Parameters:

labels - labels or null for none

getMachineType

public String getMachineType()

The machine type to use for instances that are created from this machine image.

Returns:

value or null for none

setMachineType

public SourceInstanceProperties setMachineType(String machineType)

The machine type to use for instances that are created from this machine image.

Parameters:

machineType - machineType or null for none

getMetadata

public Metadata getMetadata()

The metadata key/value pairs to assign to instances that are created from this machine image. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.

Returns:

value or null for none

setMetadata

public SourceInstanceProperties setMetadata(Metadata metadata)

The metadata key/value pairs to assign to instances that are created from this machine image. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.

Parameters:

metadata - metadata or null for none

getMinCpuPlatform

public String getMinCpuPlatform()

Minimum cpu/platform to be used by instances created from this machine image. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform.

Returns:

value or null for none

setMinCpuPlatform

public SourceInstanceProperties setMinCpuPlatform(String minCpuPlatform)

Minimum cpu/platform to be used by instances created from this machine image. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform.

Parameters:

minCpuPlatform - minCpuPlatform or null for none

getNetworkInterfaces

public List<NetworkInterface> getNetworkInterfaces()

An array of network access configurations for this interface.

Returns:

value or null for none

setNetworkInterfaces

public SourceInstanceProperties setNetworkInterfaces(List<NetworkInterface> networkInterfaces)

An array of network access configurations for this interface.

Parameters:

networkInterfaces - networkInterfaces or null for none

getPostKeyRevocationActionType

public String getPostKeyRevocationActionType()

PostKeyRevocationActionType of the instance.

Returns:

value or null for none

setPostKeyRevocationActionType

public SourceInstanceProperties setPostKeyRevocationActionType(String postKeyRevocationActionType)

PostKeyRevocationActionType of the instance.

Parameters:

postKeyRevocationActionType - postKeyRevocationActionType or null for none

getScheduling

public Scheduling getScheduling()

Specifies the scheduling options for the instances that are created from this machine image.

Returns:

value or null for none

setScheduling

public SourceInstanceProperties setScheduling(Scheduling scheduling)

Specifies the scheduling options for the instances that are created from this machine image.

Parameters:

scheduling - scheduling or null for none

getServiceAccounts

public List<ServiceAccount> getServiceAccounts()

A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this machine image. Use metadata queries to obtain the access tokens for these instances.

Returns:

value or null for none

setServiceAccounts

public SourceInstanceProperties setServiceAccounts(List<ServiceAccount> serviceAccounts)

A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this machine image. Use metadata queries to obtain the access tokens for these instances.

Parameters:

serviceAccounts - serviceAccounts or null for none

getTags

public Tags getTags()

A list of tags to apply to the instances that are created from this machine image. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.

Returns:

value or null for none

setTags

public SourceInstanceProperties setTags(Tags tags)

A list of tags to apply to the instances that are created from this machine image. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.

Parameters:

tags - tags or null for none

set

public SourceInstanceProperties set(String fieldName,
                                    Object value)

Overrides:

set in class GenericJson

clone

public SourceInstanceProperties clone()

Overrides:

clone in class GenericJson