1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="config_v1.html">Infrastructure Manager API</a> . <a href="config_v1.projects.html">projects</a> . <a href="config_v1.projects.locations.html">locations</a> . <a href="config_v1.projects.locations.deployments.html">deployments</a> . <a href="config_v1.projects.locations.deployments.revisions.html">revisions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="config_v1.projects.locations.deployments.revisions.resources.html">resources()</a></code>
</p>
<p class="firstline">Returns the resources Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#exportState">exportState(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Exports Terraform state file from a given revision.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details about a Revision.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Revisions of a deployment.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="exportState">exportState(parent, body=None, x__xgafv=None)</code>
<pre>Exports Terraform state file from a given revision.
Args:
parent: string, Required. The parent in whose context the statefile is listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'. (required)
body: object, The request body.
The object takes the form of:
{ # A request to export a state file passed to a 'ExportRevisionStatefile' call.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains info about a Terraform state file
"signedUri": "A String", # Output only. Cloud Storage signed URI used for downloading or uploading the state file.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details about a Revision.
Args:
name: string, Required. The name of the Revision in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A child resource of a Deployment generated by a 'CreateDeployment' or 'UpdateDeployment' call. Each Revision contains metadata pertaining to a snapshot of a particular Deployment.
"action": "A String", # Output only. The action which created this revision
"applyResults": { # Outputs and artifacts from applying a deployment. # Output only. Outputs and artifacts from applying a deployment.
"artifacts": "A String", # Location of artifacts (e.g. logs) in Google Cloud Storage. Format: `gs://{bucket}/{object}`
"content": "A String", # Location of a blueprint copy and other manifests in Google Cloud Storage. Format: `gs://{bucket}/{object}`
"outputs": { # Map of output name to output info.
"a_key": { # Describes a Terraform output.
"sensitive": True or False, # Identifies whether Terraform has set this output as a potential sensitive value.
"value": "", # Value of output.
},
},
},
"build": "A String", # Output only. Cloud Build instance UUID associated with this revision.
"createTime": "A String", # Output only. Time when the revision was created.
"errorCode": "A String", # Output only. Code describing any errors that may have occurred.
"errorLogs": "A String", # Output only. Location of Terraform error logs in Google Cloud Storage. Format: `gs://{bucket}/{object}`.
"importExistingResources": True or False, # Output only. By default, Infra Manager will return a failure when Terraform encounters a 409 code (resource conflict error) during actuation. If this flag is set to true, Infra Manager will instead attempt to automatically import the resource into the Terraform state (for supported resource types) and continue actuation. Not all resource types are supported, refer to documentation.
"logs": "A String", # Output only. Location of Revision operation logs in `gs://{bucket}/{object}` format.
"name": "A String", # Revision name. Format: `projects/{project}/locations/{location}/deployments/{deployment}/ revisions/{revision}`
"providerConfig": { # ProviderConfig contains the provider configurations. # Output only. This field specifies the provider configurations.
"sourceType": "A String", # Optional. ProviderSource specifies the source type of the provider.
},
"quotaValidation": "A String", # Optional. Input to control quota checks for resources in terraform configuration files. There are limited resources on which quota validation applies.
"quotaValidationResults": "A String", # Output only. Cloud Storage path containing quota validation results. This field is set when a user sets Deployment.quota_validation field to ENABLED or ENFORCED. Format: `gs://{bucket}/{object}`.
"serviceAccount": "A String", # Output only. User-specified Service Account (SA) to be used as credential to manage resources. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}`
"state": "A String", # Output only. Current state of the revision.
"stateDetail": "A String", # Output only. Additional info regarding the current state.
"terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # Output only. A blueprint described using Terraform's HashiCorp Configuration Language as a root module.
"gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`
"gitSource": { # A set of files in a Git repository. # URI of a public Git repo.
"directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package'
"ref": "A String", # Optional. Git reference (e.g. branch or tag).
"repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git'
},
"inputValues": { # Optional. Input variable values for the Terraform blueprint.
"a_key": { # A Terraform input variable.
"inputValue": "", # Optional. Input variable value.
},
},
},
"tfErrors": [ # Output only. Errors encountered when creating or updating this deployment. Errors are truncated to 10 entries, see `delete_results` and `error_logs` for full details.
{ # Errors encountered during actuation using Terraform
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Original error response from underlying Google API, if available.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"errorDescription": "A String", # A human-readable error description.
"httpResponseCode": 42, # HTTP response code returned from Google Cloud Platform APIs when Terraform fails to provision the resource. If unset or 0, no HTTP response code was returned by Terraform.
"resourceAddress": "A String", # Address of the resource associated with the error, e.g. `google_compute_network.vpc_network`.
},
],
"tfVersion": "A String", # Output only. The version of Terraform used to create the Revision. It is in the format of "Major.Minor.Patch", for example, "1.3.10".
"tfVersionConstraint": "A String", # Output only. The user-specified Terraform version constraint. Example: "=1.3.10".
"updateTime": "A String", # Output only. Time when the revision was last modified.
"workerPool": "A String", # Output only. The user-specified Cloud Build worker pool resource in which the Cloud Build job will execute. Format: `projects/{project}/locations/{location}/workerPools/{workerPoolId}`. If this field is unspecified, the default Cloud Build worker pool will be used.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Revisions of a deployment.
Args:
parent: string, Required. The parent in whose context the Revisions are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'. (required)
filter: string, Lists the Revisions that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = "projects/foo/locations/us-central1/deployments/dep/revisions/bar - Filter by labels: - Resources that have a key called 'foo' labels.foo:* - Resources that have a key called 'foo' whose value is 'bar' labels.foo = bar - Filter by state: - Revisions in CREATING state. state=CREATING
orderBy: string, Field to use to sort the list.
pageSize: integer, When requesting a page of resources, `page_size` specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000.
pageToken: string, Token returned by previous call to 'ListRevisions' which specifies the position in the list from where to continue listing the resources.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A response to a 'ListRevisions' call. Contains a list of Revisions.
"nextPageToken": "A String", # A token to request the next page of resources from the 'ListRevisions' method. The value of an empty string means that there are no more resources to return.
"revisions": [ # List of Revisions.
{ # A child resource of a Deployment generated by a 'CreateDeployment' or 'UpdateDeployment' call. Each Revision contains metadata pertaining to a snapshot of a particular Deployment.
"action": "A String", # Output only. The action which created this revision
"applyResults": { # Outputs and artifacts from applying a deployment. # Output only. Outputs and artifacts from applying a deployment.
"artifacts": "A String", # Location of artifacts (e.g. logs) in Google Cloud Storage. Format: `gs://{bucket}/{object}`
"content": "A String", # Location of a blueprint copy and other manifests in Google Cloud Storage. Format: `gs://{bucket}/{object}`
"outputs": { # Map of output name to output info.
"a_key": { # Describes a Terraform output.
"sensitive": True or False, # Identifies whether Terraform has set this output as a potential sensitive value.
"value": "", # Value of output.
},
},
},
"build": "A String", # Output only. Cloud Build instance UUID associated with this revision.
"createTime": "A String", # Output only. Time when the revision was created.
"errorCode": "A String", # Output only. Code describing any errors that may have occurred.
"errorLogs": "A String", # Output only. Location of Terraform error logs in Google Cloud Storage. Format: `gs://{bucket}/{object}`.
"importExistingResources": True or False, # Output only. By default, Infra Manager will return a failure when Terraform encounters a 409 code (resource conflict error) during actuation. If this flag is set to true, Infra Manager will instead attempt to automatically import the resource into the Terraform state (for supported resource types) and continue actuation. Not all resource types are supported, refer to documentation.
"logs": "A String", # Output only. Location of Revision operation logs in `gs://{bucket}/{object}` format.
"name": "A String", # Revision name. Format: `projects/{project}/locations/{location}/deployments/{deployment}/ revisions/{revision}`
"providerConfig": { # ProviderConfig contains the provider configurations. # Output only. This field specifies the provider configurations.
"sourceType": "A String", # Optional. ProviderSource specifies the source type of the provider.
},
"quotaValidation": "A String", # Optional. Input to control quota checks for resources in terraform configuration files. There are limited resources on which quota validation applies.
"quotaValidationResults": "A String", # Output only. Cloud Storage path containing quota validation results. This field is set when a user sets Deployment.quota_validation field to ENABLED or ENFORCED. Format: `gs://{bucket}/{object}`.
"serviceAccount": "A String", # Output only. User-specified Service Account (SA) to be used as credential to manage resources. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}`
"state": "A String", # Output only. Current state of the revision.
"stateDetail": "A String", # Output only. Additional info regarding the current state.
"terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # Output only. A blueprint described using Terraform's HashiCorp Configuration Language as a root module.
"gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`
"gitSource": { # A set of files in a Git repository. # URI of a public Git repo.
"directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package'
"ref": "A String", # Optional. Git reference (e.g. branch or tag).
"repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git'
},
"inputValues": { # Optional. Input variable values for the Terraform blueprint.
"a_key": { # A Terraform input variable.
"inputValue": "", # Optional. Input variable value.
},
},
},
"tfErrors": [ # Output only. Errors encountered when creating or updating this deployment. Errors are truncated to 10 entries, see `delete_results` and `error_logs` for full details.
{ # Errors encountered during actuation using Terraform
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Original error response from underlying Google API, if available.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"errorDescription": "A String", # A human-readable error description.
"httpResponseCode": 42, # HTTP response code returned from Google Cloud Platform APIs when Terraform fails to provision the resource. If unset or 0, no HTTP response code was returned by Terraform.
"resourceAddress": "A String", # Address of the resource associated with the error, e.g. `google_compute_network.vpc_network`.
},
],
"tfVersion": "A String", # Output only. The version of Terraform used to create the Revision. It is in the format of "Major.Minor.Patch", for example, "1.3.10".
"tfVersionConstraint": "A String", # Output only. The user-specified Terraform version constraint. Example: "=1.3.10".
"updateTime": "A String", # Output only. Time when the revision was last modified.
"workerPool": "A String", # Output only. The user-specified Cloud Build worker pool resource in which the Cloud Build job will execute. Format: `projects/{project}/locations/{location}/workerPools/{workerPoolId}`. If this field is unspecified, the default Cloud Build worker pool will be used.
},
],
"unreachable": [ # Locations that could not be reached.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
