• Home
• com.google.apis
• google-api-services-compute
• v1-rev20200104-1.30.8
• source code
• InstanceProperties.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.compute.model.InstanceProperties.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute.model
Class InstanceProperties



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













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class InstanceProperties
extends GenericJson
Model definition for InstanceProperties.

 
 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


InstanceProperties() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


InstanceProperties
clone() 


Boolean
getCanIpForward()
Enables instances created based on this template to send packets with source IP addresses other
 than their own and receive packets with destination IP addresses other than their own.



String
getDescription()
An optional text description for the instances that are created from this instance template.



List<AttachedDisk>
getDisks()
An array of disks that are associated with the instances that are created from this template.



List<AcceleratorConfig>
getGuestAccelerators()
A list of guest accelerator cards' type and count to use for instances created from the
 instance template.



Map<String,String>
getLabels()
Labels to apply to instances that are created from this template.



String
getMachineType()
The machine type to use for instances that are created from this template.



Metadata
getMetadata()
The metadata key/value pairs to assign to instances that are created from this template.



String
getMinCpuPlatform()
Minimum cpu/platform to be used by this instance.



List<NetworkInterface>
getNetworkInterfaces()
An array of network access configurations for this interface.



ReservationAffinity
getReservationAffinity()
Specifies the reservations that this instance can consume from.



Scheduling
getScheduling()
Specifies the scheduling options for the instances that are created from this template.



List<ServiceAccount>
getServiceAccounts()
A list of service accounts with specified scopes.



ShieldedInstanceConfig
getShieldedInstanceConfig() 


Tags
getTags()
A list of tags to apply to the instances that are created from this template.



InstanceProperties
set(String fieldName,
   Object value) 


InstanceProperties
setCanIpForward(Boolean canIpForward)
Enables instances created based on this template to send packets with source IP addresses other
 than their own and receive packets with destination IP addresses other than their own.



InstanceProperties
setDescription(String description)
An optional text description for the instances that are created from this instance template.



InstanceProperties
setDisks(List<AttachedDisk> disks)
An array of disks that are associated with the instances that are created from this template.



InstanceProperties
setGuestAccelerators(List<AcceleratorConfig> guestAccelerators)
A list of guest accelerator cards' type and count to use for instances created from the
 instance template.



InstanceProperties
setLabels(Map<String,String> labels)
Labels to apply to instances that are created from this template.



InstanceProperties
setMachineType(String machineType)
The machine type to use for instances that are created from this template.



InstanceProperties
setMetadata(Metadata metadata)
The metadata key/value pairs to assign to instances that are created from this template.



InstanceProperties
setMinCpuPlatform(String minCpuPlatform)
Minimum cpu/platform to be used by this instance.



InstanceProperties
setNetworkInterfaces(List<NetworkInterface> networkInterfaces)
An array of network access configurations for this interface.



InstanceProperties
setReservationAffinity(ReservationAffinity reservationAffinity)
Specifies the reservations that this instance can consume from.



InstanceProperties
setScheduling(Scheduling scheduling)
Specifies the scheduling options for the instances that are created from this template.



InstanceProperties
setServiceAccounts(List<ServiceAccount> serviceAccounts)
A list of service accounts with specified scopes.



InstanceProperties
setShieldedInstanceConfig(ShieldedInstanceConfig shieldedInstanceConfig) 


InstanceProperties
setTags(Tags tags)
A list of tags to apply to the instances that are created from this template.







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





InstanceProperties
public InstanceProperties()









Method Detail





getCanIpForward
public Boolean getCanIpForward()
Enables instances created based on this template 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 InstanceProperties setCanIpForward(Boolean canIpForward)
Enables instances created based on this template 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








getDescription
public String getDescription()
An optional text description for the instances that are created from this instance template.

Returns:
value or null for none








setDescription
public InstanceProperties setDescription(String description)
An optional text description for the instances that are created from this instance template.

Parameters:
description - description or null for none








getDisks
public List<AttachedDisk> getDisks()
An array of disks that are associated with the instances that are created from this template.

Returns:
value or null for none








setDisks
public InstanceProperties setDisks(List<AttachedDisk> disks)
An array of disks that are associated with the instances that are created from this template.

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 the
 instance template.

Returns:
value or null for none








setGuestAccelerators
public InstanceProperties setGuestAccelerators(List<AcceleratorConfig> guestAccelerators)
A list of guest accelerator cards' type and count to use for instances created from the
 instance template.

Parameters:
guestAccelerators - guestAccelerators or null for none








getLabels
public Map<String,String> getLabels()
Labels to apply to instances that are created from this template.

Returns:
value or null for none








setLabels
public InstanceProperties setLabels(Map<String,String> labels)
Labels to apply to instances that are created from this template.

Parameters:
labels - labels or null for none








getMachineType
public String getMachineType()
The machine type to use for instances that are created from this template.

Returns:
value or null for none








setMachineType
public InstanceProperties setMachineType(String machineType)
The machine type to use for instances that are created from this template.

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 template. 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 InstanceProperties setMetadata(Metadata metadata)
The metadata key/value pairs to assign to instances that are created from this template. 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 this instance. 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 InstanceProperties setMinCpuPlatform(String minCpuPlatform)
Minimum cpu/platform to be used by this instance. 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 InstanceProperties setNetworkInterfaces(List<NetworkInterface> networkInterfaces)
An array of network access configurations for this interface.

Parameters:
networkInterfaces - networkInterfaces or null for none








getReservationAffinity
public ReservationAffinity getReservationAffinity()
Specifies the reservations that this instance can consume from.

Returns:
value or null for none








setReservationAffinity
public InstanceProperties setReservationAffinity(ReservationAffinity reservationAffinity)
Specifies the reservations that this instance can consume from.

Parameters:
reservationAffinity - reservationAffinity or null for none








getScheduling
public Scheduling getScheduling()
Specifies the scheduling options for the instances that are created from this template.

Returns:
value or null for none








setScheduling
public InstanceProperties setScheduling(Scheduling scheduling)
Specifies the scheduling options for the instances that are created from this template.

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 template. Use metadata queries to obtain
 the access tokens for these instances.

Returns:
value or null for none








setServiceAccounts
public InstanceProperties 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 template. Use metadata queries to obtain
 the access tokens for these instances.

Parameters:
serviceAccounts - serviceAccounts or null for none








getShieldedInstanceConfig
public ShieldedInstanceConfig getShieldedInstanceConfig()

Returns:
value or null for none








setShieldedInstanceConfig
public InstanceProperties setShieldedInstanceConfig(ShieldedInstanceConfig shieldedInstanceConfig)

Parameters:
shieldedInstanceConfig - shieldedInstanceConfig or null for none








getTags
public Tags getTags()
A list of tags to apply to the instances that are created from this template. 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 InstanceProperties setTags(Tags tags)
A list of tags to apply to the instances that are created from this template. 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 InstanceProperties set(String fieldName,
                              Object value)

Overrides:
set in class GenericJson








clone
public InstanceProperties clone()

Overrides:
clone in class GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2020 Google. All rights reserved.