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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-compute Show documentation

There is a newer version: v1-rev20250320-2.0.0

Show newest version







InstanceSettings (Compute Engine API v1-rev20250107-2.0.0)











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 InstanceSettings



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













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




public final class InstanceSettings
extends com.google.api.client.json.GenericJson
Represents a Instance Settings resource. You can use instance settings to configure default
 settings for Compute Engine VM instances. For example, you can use it to configure default
 machine type of Compute Engine VM 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
com.google.api.client.util.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


InstanceSettings() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


InstanceSettings
clone() 


byte[]
decodeFingerprint()
Specifies a fingerprint for instance settings, which is essentially a hash of the instance
 settings resource's contents and used for optimistic locking.



InstanceSettings
encodeFingerprint(byte[] fingerprint)
Specifies a fingerprint for instance settings, which is essentially a hash of the instance
 settings resource's contents and used for optimistic locking.



String
getFingerprint()
Specifies a fingerprint for instance settings, which is essentially a hash of the instance
 settings resource's contents and used for optimistic locking.



String
getKind()
[Output Only] Type of the resource.



InstanceSettingsMetadata
getMetadata()
The metadata key/value pairs assigned to all the instances in the corresponding scope.



String
getZone()
[Output Only] URL of the zone where the resource resides You must specify this field as part of
 the HTTP request URL.



InstanceSettings
set(String fieldName,
   Object value) 


InstanceSettings
setFingerprint(String fingerprint)
Specifies a fingerprint for instance settings, which is essentially a hash of the instance
 settings resource's contents and used for optimistic locking.



InstanceSettings
setKind(String kind)
[Output Only] Type of the resource.



InstanceSettings
setMetadata(InstanceSettingsMetadata metadata)
The metadata key/value pairs assigned to all the instances in the corresponding scope.



InstanceSettings
setZone(String zone)
[Output Only] URL of the zone where the resource resides You must specify this field as part of
 the HTTP request URL.







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





InstanceSettings
public InstanceSettings()









Method Detail





getFingerprint
public String getFingerprint()
Specifies a fingerprint for instance settings, which is essentially a hash of the instance
 settings resource's contents and used for optimistic locking. The fingerprint is initially
 generated by Compute Engine and changes after every request to modify or update the instance
 settings resource. You must always provide an up-to-date fingerprint hash in order to update or
 change the resource, otherwise the request will fail with error 412 conditionNotMet. To see the
 latest fingerprint, make a get() request to retrieve the resource.

Returns:
value or null for none
See Also:
decodeFingerprint()








decodeFingerprint
public byte[] decodeFingerprint()
Specifies a fingerprint for instance settings, which is essentially a hash of the instance
 settings resource's contents and used for optimistic locking. The fingerprint is initially
 generated by Compute Engine and changes after every request to modify or update the instance
 settings resource. You must always provide an up-to-date fingerprint hash in order to update or
 change the resource, otherwise the request will fail with error 412 conditionNotMet. To see the
 latest fingerprint, make a get() request to retrieve the resource.

Returns:
Base64 decoded value or null for none
Since:
1.14
See Also:
getFingerprint()








setFingerprint
public InstanceSettings setFingerprint(String fingerprint)
Specifies a fingerprint for instance settings, which is essentially a hash of the instance
 settings resource's contents and used for optimistic locking. The fingerprint is initially
 generated by Compute Engine and changes after every request to modify or update the instance
 settings resource. You must always provide an up-to-date fingerprint hash in order to update or
 change the resource, otherwise the request will fail with error 412 conditionNotMet. To see the
 latest fingerprint, make a get() request to retrieve the resource.

Parameters:
fingerprint - fingerprint or null for none
See Also:
#encodeFingerprint()








encodeFingerprint
public InstanceSettings encodeFingerprint(byte[] fingerprint)
Specifies a fingerprint for instance settings, which is essentially a hash of the instance
 settings resource's contents and used for optimistic locking. The fingerprint is initially
 generated by Compute Engine and changes after every request to modify or update the instance
 settings resource. You must always provide an up-to-date fingerprint hash in order to update or
 change the resource, otherwise the request will fail with error 412 conditionNotMet. To see the
 latest fingerprint, make a get() request to retrieve the resource.

Since:
1.14
See Also:

 The value is encoded Base64 or {@code null} for none.
 








getKind
public String getKind()
[Output Only] Type of the resource. Always compute#instance_settings for instance settings.

Returns:
value or null for none








setKind
public InstanceSettings setKind(String kind)
[Output Only] Type of the resource. Always compute#instance_settings for instance settings.

Parameters:
kind - kind or null for none








getMetadata
public InstanceSettingsMetadata getMetadata()
The metadata key/value pairs assigned to all the instances in the corresponding scope.

Returns:
value or null for none








setMetadata
public InstanceSettings setMetadata(InstanceSettingsMetadata metadata)
The metadata key/value pairs assigned to all the instances in the corresponding scope.

Parameters:
metadata - metadata or null for none








getZone
public String getZone()
[Output Only] URL of the zone where the resource 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 InstanceSettings setZone(String zone)
[Output Only] URL of the zone where the resource 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 InstanceSettings set(String fieldName,
                            Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public InstanceSettings clone()

Overrides:
clone in class com.google.api.client.json.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–2025 Google. All rights reserved.

Modifier and Type	Method and Description
`InstanceSettings`	`clone()`
`byte[]`	`decodeFingerprint()` Specifies a fingerprint for instance settings, which is essentially a hash of the instance settings resource's contents and used for optimistic locking.
`InstanceSettings`	`encodeFingerprint(byte[] fingerprint)` Specifies a fingerprint for instance settings, which is essentially a hash of the instance settings resource's contents and used for optimistic locking.
`String`	`getFingerprint()` Specifies a fingerprint for instance settings, which is essentially a hash of the instance settings resource's contents and used for optimistic locking.
`String`	`getKind()` [Output Only] Type of the resource.
`InstanceSettingsMetadata`	`getMetadata()` The metadata key/value pairs assigned to all the instances in the corresponding scope.
`String`	`getZone()` [Output Only] URL of the zone where the resource resides You must specify this field as part of the HTTP request URL.
`InstanceSettings`	`set(String fieldName, Object value)`
`InstanceSettings`	`setFingerprint(String fingerprint)` Specifies a fingerprint for instance settings, which is essentially a hash of the instance settings resource's contents and used for optimistic locking.
`InstanceSettings`	`setKind(String kind)` [Output Only] Type of the resource.
`InstanceSettings`	`setMetadata(InstanceSettingsMetadata metadata)` The metadata key/value pairs assigned to all the instances in the corresponding scope.
`InstanceSettings`	`setZone(String zone)` [Output Only] URL of the zone where the resource resides You must specify this field as part of the HTTP request URL.