Creates a deployment and all of the resources described by the deployment manifest.
Scopes
You will need authorization for at least one of the following scopes to make a valid call:
- https://www.googleapis.com/auth/cloud-platform
- https://www.googleapis.com/auth/ndev.cloudman
If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform.
You can set the scope for this method like this: deploymentmanager2 --scope <scope> deployments insert ...
Required Scalar Argument
- <project> (string)
- The project ID for this request.
Required Request Value
The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.
For example, a structure like this:
Deployment:
description: string
fingerprint: string
id: string
insert-time: string
manifest: string
name: string
operation:
client-operation-id: string
creation-timestamp: string
description: string
end-time: string
http-error-message: string
http-error-status-code: integer
id: string
insert-time: string
kind: string
name: string
operation-group-id: string
operation-type: string
progress: integer
region: string
self-link: string
set-common-instance-metadata-operation-metadata:
client-operation-id: string
start-time: string
status: string
status-message: string
target-id: string
target-link: string
user: string
zone: string
self-link: string
target:
config:
content: string
update:
description: string
manifest: string
update-time: string
can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.
-r . description=magna
- An optional user-provided description of the deployment.
fingerprint=no
- Provides a fingerprint to use in requests to modify a deployment, such as
update()
,stop()
, andcancelPreview()
requests. A fingerprint is a randomly generated value that must be provided withupdate()
,stop()
, andcancelPreview()
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 aget()
request to a deployment.
- Provides a fingerprint to use in requests to modify a deployment, such as
id=ipsum
- No description provided.
insert-time=voluptua.
- Output only. Creation timestamp in RFC3339 text format.
manifest=at
- 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.
name=sanctus
- 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.
- 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
operation client-operation-id=sed
- [Output Only] The value of
requestId
if you provided it in the request. Not present otherwise.
- [Output Only] The value of
creation-timestamp=amet.
- [Deprecated] This field is deprecated.
description=takimata
- [Output Only] A textual description of the operation, which is set when the operation is created.
end-time=amet.
- [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
http-error-message=duo
- [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as
NOT FOUND
.
- [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as
http-error-status-code=46
- [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a
404
means the resource was not found.
- [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a
id=gubergren
- [Output Only] The unique identifier for the operation. This identifier is defined by the server.
insert-time=lorem
- [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
kind=gubergren
- [Output Only] Type of the resource. Always
compute#operation
for Operation resources.
- [Output Only] Type of the resource. Always
name=eos
- [Output Only] Name of the operation.
operation-group-id=dolor
- [Output Only] An ID that represents a group of operations, such as when a group of operations results from a
bulkInsert
API request.
- [Output Only] An ID that represents a group of operations, such as when a group of operations results from a
operation-type=ea
- [Output Only] The type of operation, such as
insert
,update
, ordelete
, and so on.
- [Output Only] The type of operation, such as
progress=46
- [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
region=invidunt
- [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
self-link=amet
- [Output Only] Server-defined URL for the resource.
-
set-common-instance-metadata-operation-metadata client-operation-id=duo
- [Output Only] The client operation id.
-
.. start-time=ipsum
- [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
status=sed
- [Output Only] The status of the operation, which can be one of the following:
PENDING
,RUNNING
, orDONE
.
- [Output Only] The status of the operation, which can be one of the following:
status-message=ut
- [Output Only] An optional textual description of the current status of the operation.
target-id=gubergren
- [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
target-link=rebum.
- [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
user=est
- [Output Only] User who requested the operation, for example:
user@example.com
oralice_smith_identifier (global/workforcePools/example-com-us-employees)
.
- [Output Only] User who requested the operation, for example:
-
zone=ipsum
- [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
-
.. self-link=ipsum
- Output only. Server defined URL for the resource.
-
target.config content=est
- The contents of the file.
-
...update description=gubergren
- Output only. An optional user-provided description of the deployment after the current update has been applied.
-
manifest=ea
- Output only. URL of the manifest representing the update configuration of this deployment.
-
.. update-time=dolor
- Output only. Update timestamp in RFC3339 text format.
About Cursors
The cursor position is key to comfortably set complex nested structures. The following rules apply:
- The cursor position is always set relative to the current one, unless the field name starts with the
.
character. Fields can be nested such as in-r f.s.o
. - The cursor position is set relative to the top-level structure if it starts with
.
, e.g.-r .s.s
- You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify
-r struct.sub_struct=bar
. - You can move the cursor one level up by using
..
. Each additional.
moves it up one additional level. E.g....
would go three levels up.
Optional Output Flags
The method's return value a JSON encoded structure, which will be written to standard output by default.
- -o out
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
-
to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
Optional Method Properties
You may set the following properties to further configure the call. Please note that -p
is followed by one
or more key-value-pairs, and is called like this -p k1=v1 k2=v2
even though the listing below repeats the
-p
for completeness.
-
-p create-policy=string
- Sets the policy to use for creating new resources.
-
-p preview=boolean
- If set to true, creates a deployment and creates "shell" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the
update()
method or you can use thecancelPreview()
method to cancel the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.
- If set to true, creates a deployment and creates "shell" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the
Optional General Properties
The following properties can configure any call, and are not specific to this method.
-
-p $-xgafv=string
- V1 error format.
-
-p access-token=string
- OAuth access token.
-
-p alt=string
- Data format for response.
-
-p callback=string
- JSONP
-
-p fields=string
- Selector specifying which fields to include in a partial response.
-
-p key=string
- API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
-
-p oauth-token=string
- OAuth 2.0 token for the current user.
-
-p pretty-print=boolean
- Returns response with indentations and line breaks.
-
-p quota-user=string
- Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
-
-p upload-type=string
- Legacy upload protocol for media (e.g. "media", "multipart").
-
-p upload-protocol=string
- Upload protocol for media (e.g. "raw", "multipart").