target.apidocs.com.google.api.services.deploymentmanager.model.Deployment.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-deploymentmanager Show documentation

There is a newer version: v2-rev20250102-2.0.0

Show newest version







Deployment (Cloud Deployment Manager V2 API v2-rev20241122-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.deploymentmanager.model
Class Deployment



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.deploymentmanager.model.Deployment













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




public final class Deployment
extends com.google.api.client.json.GenericJson
Model definition for Deployment.

  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 Cloud Deployment Manager V2 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


Deployment() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Deployment
clone() 


byte[]
decodeFingerprint()
Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`,
 and `cancelPreview()` requests.



Deployment
encodeFingerprint(byte[] fingerprint)
Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`,
 and `cancelPreview()` requests.



String
getDescription()
An optional user-provided description of the deployment.



String
getFingerprint()
Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`,
 and `cancelPreview()` requests.



BigInteger
getId() 


String
getInsertTime()
Output only.



List<DeploymentLabelEntry>
getLabels()
Map of One Platform labels; provided by the client when the resource is created or updated.



String
getManifest()
Output only.



String
getName()
Name of the resource; provided by the client when the resource is created.



Operation
getOperation()
Output only.



String
getSelfLink()
Output only.



TargetConfiguration
getTarget()
[Input Only] The parameters that define your deployment, including the deployment configuration
 and relevant templates.



DeploymentUpdate
getUpdate()
Output only.



String
getUpdateTime()
Output only.



Deployment
set(String fieldName,
   Object value) 


Deployment
setDescription(String description)
An optional user-provided description of the deployment.



Deployment
setFingerprint(String fingerprint)
Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`,
 and `cancelPreview()` requests.



Deployment
setId(BigInteger id) 


Deployment
setInsertTime(String insertTime)
Output only.



Deployment
setLabels(List<DeploymentLabelEntry> labels)
Map of One Platform labels; provided by the client when the resource is created or updated.



Deployment
setManifest(String manifest)
Output only.



Deployment
setName(String name)
Name of the resource; provided by the client when the resource is created.



Deployment
setOperation(Operation operation)
Output only.



Deployment
setSelfLink(String selfLink)
Output only.



Deployment
setTarget(TargetConfiguration target)
[Input Only] The parameters that define your deployment, including the deployment configuration
 and relevant templates.



Deployment
setUpdate(DeploymentUpdate update)
Output only.



Deployment
setUpdateTime(String updateTime)
Output only.







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





Deployment
public Deployment()









Method Detail





getDescription
public String getDescription()
An optional user-provided description of the deployment.

Returns:
value or null for none








setDescription
public Deployment setDescription(String description)
An optional user-provided description of the deployment.

Parameters:
description - description or null for none








getFingerprint
public String getFingerprint()
Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`,
 and `cancelPreview()` requests. A fingerprint is a randomly generated value that must be
 provided with `update()`, `stop()`, and `cancelPreview()` requests to perform optimistic
 locking. This ensures optimistic concurrency so that only one request happens at a time. The
 fingerprint is initially generated by Deployment Manager and changes after every request to
 modify data. To get the latest fingerprint value, perform a `get()` request to a deployment.

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








decodeFingerprint
public byte[] decodeFingerprint()
Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`,
 and `cancelPreview()` requests. A fingerprint is a randomly generated value that must be
 provided with `update()`, `stop()`, and `cancelPreview()` requests to perform optimistic
 locking. This ensures optimistic concurrency so that only one request happens at a time. The
 fingerprint is initially generated by Deployment Manager and changes after every request to
 modify data. To get the latest fingerprint value, perform a `get()` request to a deployment.

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








setFingerprint
public Deployment setFingerprint(String fingerprint)
Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`,
 and `cancelPreview()` requests. A fingerprint is a randomly generated value that must be
 provided with `update()`, `stop()`, and `cancelPreview()` requests to perform optimistic
 locking. This ensures optimistic concurrency so that only one request happens at a time. The
 fingerprint is initially generated by Deployment Manager and changes after every request to
 modify data. To get the latest fingerprint value, perform a `get()` request to a deployment.

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








encodeFingerprint
public Deployment encodeFingerprint(byte[] fingerprint)
Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`,
 and `cancelPreview()` requests. A fingerprint is a randomly generated value that must be
 provided with `update()`, `stop()`, and `cancelPreview()` requests to perform optimistic
 locking. This ensures optimistic concurrency so that only one request happens at a time. The
 fingerprint is initially generated by Deployment Manager and changes after every request to
 modify data. To get the latest fingerprint value, perform a `get()` request to a deployment.

Since:
1.14
See Also:

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








getId
public BigInteger getId()

Returns:
value or null for none








setId
public Deployment setId(BigInteger id)

Parameters:
id - id or null for none








getInsertTime
public String getInsertTime()
Output only. Creation timestamp in RFC3339 text format.

Returns:
value or null for none








setInsertTime
public Deployment setInsertTime(String insertTime)
Output only. Creation timestamp in RFC3339 text format.

Parameters:
insertTime - insertTime or null for none








getLabels
public List<DeploymentLabelEntry> getLabels()
Map of One Platform labels; provided by the client when the resource is created or updated.
 Specifically: Label keys must be between 1 and 63 characters long and must conform to the
 following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and
 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

Returns:
value or null for none








setLabels
public Deployment setLabels(List<DeploymentLabelEntry> labels)
Map of One Platform labels; provided by the client when the resource is created or updated.
 Specifically: Label keys must be between 1 and 63 characters long and must conform to the
 following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and
 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

Parameters:
labels - labels or null for none








getManifest
public String getManifest()
Output only. URL of the manifest representing the last manifest that was successfully deployed.
 If no manifest has been successfully deployed, this field will be absent.

Returns:
value or null for none








setManifest
public Deployment setManifest(String manifest)
Output only. URL of the manifest representing the last manifest that was successfully deployed.
 If no manifest has been successfully deployed, this field will be absent.

Parameters:
manifest - manifest 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 Deployment 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








getOperation
public Operation getOperation()
Output only. The Operation that most recently ran, or is currently running, on this deployment.

Returns:
value or null for none








setOperation
public Deployment setOperation(Operation operation)
Output only. The Operation that most recently ran, or is currently running, on this deployment.

Parameters:
operation - operation or null for none








getSelfLink
public String getSelfLink()
Output only. Server defined URL for the resource.

Returns:
value or null for none








setSelfLink
public Deployment setSelfLink(String selfLink)
Output only. Server defined URL for the resource.

Parameters:
selfLink - selfLink or null for none








getTarget
public TargetConfiguration getTarget()
[Input Only] The parameters that define your deployment, including the deployment configuration
 and relevant templates.

Returns:
value or null for none








setTarget
public Deployment setTarget(TargetConfiguration target)
[Input Only] The parameters that define your deployment, including the deployment configuration
 and relevant templates.

Parameters:
target - target or null for none








getUpdate
public DeploymentUpdate getUpdate()
Output only. If Deployment Manager is currently updating or previewing an update to this
 deployment, the updated configuration appears here.

Returns:
value or null for none








setUpdate
public Deployment setUpdate(DeploymentUpdate update)
Output only. If Deployment Manager is currently updating or previewing an update to this
 deployment, the updated configuration appears here.

Parameters:
update - update or null for none








getUpdateTime
public String getUpdateTime()
Output only. Update timestamp in RFC3339 text format.

Returns:
value or null for none








setUpdateTime
public Deployment setUpdateTime(String updateTime)
Output only. Update timestamp in RFC3339 text format.

Parameters:
updateTime - updateTime or null for none








set
public Deployment set(String fieldName,
                      Object value)

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








clone
public Deployment 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–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`Deployment`	`clone()`
`byte[]`	`decodeFingerprint()` Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`, and `cancelPreview()` requests.
`Deployment`	`encodeFingerprint(byte[] fingerprint)` Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`, and `cancelPreview()` requests.
`String`	`getDescription()` An optional user-provided description of the deployment.
`String`	`getFingerprint()` Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`, and `cancelPreview()` requests.
`BigInteger`	`getId()`
`String`	`getInsertTime()` Output only.
`List<DeploymentLabelEntry>`	`getLabels()` Map of One Platform labels; provided by the client when the resource is created or updated.
`String`	`getManifest()` Output only.
`String`	`getName()` Name of the resource; provided by the client when the resource is created.
`Operation`	`getOperation()` Output only.
`String`	`getSelfLink()` Output only.
`TargetConfiguration`	`getTarget()` [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
`DeploymentUpdate`	`getUpdate()` Output only.
`String`	`getUpdateTime()` Output only.
`Deployment`	`set(String fieldName, Object value)`
`Deployment`	`setDescription(String description)` An optional user-provided description of the deployment.
`Deployment`	`setFingerprint(String fingerprint)` Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`, and `cancelPreview()` requests.
`Deployment`	`setId(BigInteger id)`
`Deployment`	`setInsertTime(String insertTime)` Output only.
`Deployment`	`setLabels(List<DeploymentLabelEntry> labels)` Map of One Platform labels; provided by the client when the resource is created or updated.
`Deployment`	`setManifest(String manifest)` Output only.
`Deployment`	`setName(String name)` Name of the resource; provided by the client when the resource is created.
`Deployment`	`setOperation(Operation operation)` Output only.
`Deployment`	`setSelfLink(String selfLink)` Output only.
`Deployment`	`setTarget(TargetConfiguration target)` [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
`Deployment`	`setUpdate(DeploymentUpdate update)` Output only.
`Deployment`	`setUpdateTime(String updateTime)` Output only.