| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="deploymentmanager_v2.html">Google Cloud Deployment Manager API</a> . <a href="deploymentmanager_v2.deployments.html">deployments</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 78 | <code><a href="#cancelPreview">cancelPreview(project, deployment, body=None)</a></code></p> |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 79 | <p class="firstline">Cancels and removes the preview currently associated with the deployment.</p> |
| 80 | <p class="toc_element"> |
| Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 81 | <code><a href="#delete">delete(project, deployment, deletePolicy=None)</a></code></p> |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 82 | <p class="firstline">Deletes a deployment and all of the resources in the deployment.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#get">get(project, deployment)</a></code></p> |
| 85 | <p class="firstline">Gets information about a specific deployment.</p> |
| 86 | <p class="toc_element"> |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 87 | <code><a href="#getIamPolicy">getIamPolicy(project, resource)</a></code></p> |
| 88 | <p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p> |
| 89 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 90 | <code><a href="#insert">insert(project, body=None, createPolicy=None, preview=None)</a></code></p> |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 91 | <p class="firstline">Creates a deployment and all of the resources described by the deployment manifest.</p> |
| 92 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 93 | <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None)</a></code></p> |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 94 | <p class="firstline">Lists all deployments for a given project.</p> |
| 95 | <p class="toc_element"> |
| 96 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 97 | <p class="firstline">Retrieves the next page of results.</p> |
| 98 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 99 | <code><a href="#patch">patch(project, deployment, body=None, createPolicy=None, deletePolicy=None, preview=None)</a></code></p> |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 100 | <p class="firstline">Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics.</p> |
| 101 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 102 | <code><a href="#setIamPolicy">setIamPolicy(project, resource, body=None)</a></code></p> |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 103 | <p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p> |
| 104 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 105 | <code><a href="#stop">stop(project, deployment, body=None)</a></code></p> |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 106 | <p class="firstline">Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started.</p> |
| 107 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 108 | <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None)</a></code></p> |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 109 | <p class="firstline">Returns permissions that a caller has on the specified resource.</p> |
| 110 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 111 | <code><a href="#update">update(project, deployment, body=None, createPolicy=None, deletePolicy=None, preview=None)</a></code></p> |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 112 | <p class="firstline">Updates a deployment and all of the resources described by the deployment manifest.</p> |
| 113 | <h3>Method Details</h3> |
| 114 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 115 | <code class="details" id="cancelPreview">cancelPreview(project, deployment, body=None)</code> |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 116 | <pre>Cancels and removes the preview currently associated with the deployment. |
| 117 | |
| 118 | Args: |
| 119 | project: string, The project ID for this request. (required) |
| 120 | deployment: string, The name of the deployment for this request. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 121 | body: object, The request body. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 122 | The object takes the form of: |
| 123 | |
| 124 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 125 | "fingerprint": "A String", # Specifies a fingerprint for cancelPreview() requests. A fingerprint is a randomly generated value that must be provided in cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to cancel a preview, this would prevent one of the requests). |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 126 | # |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 127 | # The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 128 | } |
| 129 | |
| 130 | |
| 131 | Returns: |
| 132 | An object of the form: |
| 133 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 134 | { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 135 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 136 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 137 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 138 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 139 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 140 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 141 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 142 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 143 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 144 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 145 | }, |
| 146 | ], |
| 147 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 148 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. |
| 149 | "httpErrorStatusCode": 42, # [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. |
| 150 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 151 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 152 | "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. |
| 153 | "name": "A String", # [Output Only] Name of the resource. |
| 154 | "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. |
| 155 | "progress": 42, # [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. |
| 156 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
| 157 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 158 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 159 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. |
| 160 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 161 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 162 | "targetLink": "A String", # [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. |
| 163 | "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. |
| 164 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 165 | { |
| 166 | "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| 167 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 168 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| 169 | { |
| 170 | "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). |
| 171 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 172 | }, |
| 173 | ], |
| 174 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 175 | }, |
| 176 | ], |
| 177 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 178 | }</pre> |
| 179 | </div> |
| 180 | |
| 181 | <div class="method"> |
| Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 182 | <code class="details" id="delete">delete(project, deployment, deletePolicy=None)</code> |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 183 | <pre>Deletes a deployment and all of the resources in the deployment. |
| 184 | |
| 185 | Args: |
| 186 | project: string, The project ID for this request. (required) |
| 187 | deployment: string, The name of the deployment for this request. (required) |
| Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 188 | deletePolicy: string, Sets the policy to use for deleting resources. |
| 189 | Allowed values |
| 190 | ABANDON - |
| 191 | DELETE - |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 192 | |
| 193 | Returns: |
| 194 | An object of the form: |
| 195 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 196 | { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 197 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 198 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 199 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 200 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 201 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 202 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 203 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 204 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 205 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 206 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 207 | }, |
| 208 | ], |
| 209 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 210 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. |
| 211 | "httpErrorStatusCode": 42, # [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. |
| 212 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 213 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 214 | "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. |
| 215 | "name": "A String", # [Output Only] Name of the resource. |
| 216 | "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. |
| 217 | "progress": 42, # [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. |
| 218 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
| 219 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 220 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 221 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. |
| 222 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 223 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 224 | "targetLink": "A String", # [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. |
| 225 | "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. |
| 226 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 227 | { |
| 228 | "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| 229 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 230 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| 231 | { |
| 232 | "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). |
| 233 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 234 | }, |
| 235 | ], |
| 236 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 237 | }, |
| 238 | ], |
| 239 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 240 | }</pre> |
| 241 | </div> |
| 242 | |
| 243 | <div class="method"> |
| 244 | <code class="details" id="get">get(project, deployment)</code> |
| 245 | <pre>Gets information about a specific deployment. |
| 246 | |
| 247 | Args: |
| 248 | project: string, The project ID for this request. (required) |
| 249 | deployment: string, The name of the deployment for this request. (required) |
| 250 | |
| 251 | Returns: |
| 252 | An object of the form: |
| 253 | |
| 254 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 255 | "description": "A String", # An optional user-provided description of the deployment. |
| 256 | "fingerprint": "A String", # 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. |
| 257 | # |
| 258 | # 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. |
| 259 | "id": "A String", |
| 260 | "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. |
| 261 | "labels": [ # Map of 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])?)? |
| 262 | { |
| 263 | "key": "A String", |
| 264 | "value": "A String", |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 265 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 266 | ], |
| 267 | "manifest": "A String", # Output only. URL of the manifest representing the last manifest that was successfully deployed. |
| 268 | "name": "A String", # 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. |
| 269 | "operation": { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) # Output only. The Operation that most recently ran, or is currently running, on this deployment. |
| 270 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 271 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 272 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 273 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 274 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 275 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 276 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 277 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 278 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 279 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 280 | }, |
| 281 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 282 | }, |
| 283 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. |
| 284 | "httpErrorStatusCode": 42, # [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. |
| 285 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 286 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 287 | "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. |
| 288 | "name": "A String", # [Output Only] Name of the resource. |
| 289 | "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. |
| 290 | "progress": 42, # [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. |
| 291 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
| 292 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 293 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 294 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. |
| 295 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 296 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 297 | "targetLink": "A String", # [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. |
| 298 | "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. |
| 299 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 300 | { |
| 301 | "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| 302 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 303 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 304 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 305 | "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). |
| 306 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 307 | }, |
| 308 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 309 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 310 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 311 | ], |
| 312 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
| 313 | }, |
| 314 | "selfLink": "A String", # Output only. Server defined URL for the resource. |
| 315 | "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates. |
| 316 | "config": { # The configuration to use for this deployment. |
| 317 | "content": "A String", # The contents of the file. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 318 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 319 | "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template. |
| 320 | { |
| 321 | "content": "A String", # The contents of the file. |
| 322 | "name": "A String", # The name of the file. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 323 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 324 | ], |
| 325 | }, |
| 326 | "update": { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here. |
| 327 | "description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied. |
| 328 | "labels": [ # Output only. Map of 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])?)? |
| 329 | { |
| 330 | "key": "A String", |
| 331 | "value": "A String", |
| 332 | }, |
| 333 | ], |
| 334 | "manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment. |
| 335 | }, |
| 336 | "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format. |
| 337 | }</pre> |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 338 | </div> |
| 339 | |
| 340 | <div class="method"> |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 341 | <code class="details" id="getIamPolicy">getIamPolicy(project, resource)</code> |
| 342 | <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists. |
| 343 | |
| 344 | Args: |
| 345 | project: string, Project ID for this request. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 346 | resource: string, Name or id of the resource for this request. (required) |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 347 | |
| 348 | Returns: |
| 349 | An object of the form: |
| 350 | |
| 351 | { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. |
| 352 | # |
| 353 | # |
| 354 | # |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 355 | # A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 356 | # |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 357 | # **JSON Example** |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 358 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 359 | # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 360 | # |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 361 | # **YAML Example** |
| 362 | # |
| 363 | # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer |
| 364 | # |
| 365 | # |
| 366 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 367 | # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). |
| 368 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 369 | { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 370 | # |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 371 | # If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. |
| Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 372 | # |
| 373 | # Example Policy with multiple AuditConfigs: |
| 374 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 375 | # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } |
| Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 376 | # |
| 377 | # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 378 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 379 | { # Provides the configuration for logging a type of permissions. Example: |
| 380 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 381 | # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 382 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 383 | # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. |
| 384 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. |
| 385 | "A String", |
| Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 386 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 387 | "logType": "A String", # The log type that this config enables. |
| Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 388 | }, |
| 389 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 390 | "exemptedMembers": [ |
| 391 | "A String", |
| 392 | ], |
| 393 | "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 394 | }, |
| 395 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 396 | "bindings": [ # Associates a list of `members` to a `role`. `bindings` with no members will result in an error. |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 397 | { # Associates `members` with a `role`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 398 | "condition": { # Represents an expression text. Example: # Unimplemented. The condition that is associated with this binding. NOTE: an unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. |
| 399 | # |
| 400 | # title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" |
| 401 | "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. |
| 402 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 403 | # |
| 404 | # The application context of the containing message determines which well-known feature set of CEL is supported. |
| 405 | "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. |
| 406 | "title": "A String", # An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. |
| 407 | }, |
| 408 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 409 | # |
| 410 | # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. |
| 411 | # |
| 412 | # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. |
| 413 | # |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 414 | # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 415 | # |
| Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 416 | # |
| 417 | # |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 418 | # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| 419 | # |
| 420 | # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. |
| 421 | # |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 422 | # |
| 423 | # |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 424 | # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 425 | "A String", |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 426 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 427 | "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 428 | }, |
| 429 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 430 | "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. |
| 431 | # |
| 432 | # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. |
| 433 | "iamOwned": True or False, |
| 434 | "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. |
| 435 | { # A rule to be applied in a Policy. |
| 436 | "action": "A String", # Required |
| 437 | "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match. |
| 438 | { # A condition to be met. |
| 439 | "iam": "A String", # Trusted attributes supplied by the IAM system. |
| 440 | "op": "A String", # An operator to apply the subject with. |
| 441 | "svc": "A String", # Trusted attributes discharged by the service. |
| 442 | "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. |
| 443 | "value": "A String", # DEPRECATED. Use 'values' instead. |
| 444 | "values": [ # The objects of the condition. This is mutually exclusive with 'value'. |
| 445 | "A String", |
| 446 | ], |
| 447 | }, |
| 448 | ], |
| 449 | "description": "A String", # Human-readable description of the rule. |
| 450 | "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. |
| 451 | "A String", |
| 452 | ], |
| 453 | "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. |
| 454 | { # Specifies what kind of log the caller must write |
| 455 | "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. |
| 456 | "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline. |
| 457 | "permissionType": "A String", # The type of the permission that was checked. |
| 458 | }, |
| 459 | "logName": "A String", # The log_name to populate in the Cloud Audit Record. |
| 460 | }, |
| 461 | "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options. |
| 462 | # |
| 463 | # Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. |
| 464 | # |
| 465 | # Field names correspond to IAM request parameters and field values are their respective values. |
| 466 | # |
| 467 | # Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. |
| 468 | # |
| 469 | # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} |
| 470 | # |
| 471 | # At this time we do not support multiple field names (though this may be supported in the future). |
| 472 | "field": "A String", # The field value to attribute. |
| 473 | "metric": "A String", # The metric to update. |
| 474 | }, |
| 475 | "dataAccess": { # Write a Data Access (Gin) log # Data access options. |
| 476 | "logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. |
| 477 | # |
| 478 | # NOTE: Logging to Gin in a fail-closed manner is currently unsupported while work is being done to satisfy the requirements of go/345. Currently, setting LOG_FAIL_CLOSED mode will have no effect, but still exists because there is active work being done to support it (b/115874152). |
| 479 | }, |
| 480 | }, |
| 481 | ], |
| 482 | "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. |
| 483 | "A String", |
| 484 | ], |
| 485 | "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. |
| 486 | "A String", |
| 487 | ], |
| 488 | }, |
| 489 | ], |
| 490 | "version": 42, # Deprecated. |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 491 | }</pre> |
| 492 | </div> |
| 493 | |
| 494 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 495 | <code class="details" id="insert">insert(project, body=None, createPolicy=None, preview=None)</code> |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 496 | <pre>Creates a deployment and all of the resources described by the deployment manifest. |
| 497 | |
| 498 | Args: |
| 499 | project: string, The project ID for this request. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 500 | body: object, The request body. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 501 | The object takes the form of: |
| 502 | |
| 503 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 504 | "description": "A String", # An optional user-provided description of the deployment. |
| 505 | "fingerprint": "A String", # 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. |
| 506 | # |
| 507 | # 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. |
| 508 | "id": "A String", |
| 509 | "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. |
| 510 | "labels": [ # Map of 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])?)? |
| 511 | { |
| 512 | "key": "A String", |
| 513 | "value": "A String", |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 514 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 515 | ], |
| 516 | "manifest": "A String", # Output only. URL of the manifest representing the last manifest that was successfully deployed. |
| 517 | "name": "A String", # 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. |
| 518 | "operation": { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) # Output only. The Operation that most recently ran, or is currently running, on this deployment. |
| 519 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 520 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 521 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 522 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 523 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 524 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 525 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 526 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 527 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 528 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 529 | }, |
| 530 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 531 | }, |
| 532 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. |
| 533 | "httpErrorStatusCode": 42, # [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. |
| 534 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 535 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 536 | "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. |
| 537 | "name": "A String", # [Output Only] Name of the resource. |
| 538 | "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. |
| 539 | "progress": 42, # [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. |
| 540 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
| 541 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 542 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 543 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. |
| 544 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 545 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 546 | "targetLink": "A String", # [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. |
| 547 | "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. |
| 548 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 549 | { |
| 550 | "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| 551 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 552 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 553 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 554 | "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). |
| 555 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 556 | }, |
| 557 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 558 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 559 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 560 | ], |
| 561 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
| 562 | }, |
| 563 | "selfLink": "A String", # Output only. Server defined URL for the resource. |
| 564 | "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates. |
| 565 | "config": { # The configuration to use for this deployment. |
| 566 | "content": "A String", # The contents of the file. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 567 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 568 | "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template. |
| 569 | { |
| 570 | "content": "A String", # The contents of the file. |
| 571 | "name": "A String", # The name of the file. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 572 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 573 | ], |
| 574 | }, |
| 575 | "update": { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here. |
| 576 | "description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied. |
| 577 | "labels": [ # Output only. Map of 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])?)? |
| 578 | { |
| 579 | "key": "A String", |
| 580 | "value": "A String", |
| 581 | }, |
| 582 | ], |
| 583 | "manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment. |
| 584 | }, |
| 585 | "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format. |
| 586 | } |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 587 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 588 | createPolicy: string, Sets the policy to use for creating new resources. |
| 589 | Allowed values |
| 590 | ACQUIRE - |
| 591 | CREATE_OR_ACQUIRE - |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 592 | 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 the cancelPreview() 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. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 593 | |
| 594 | Returns: |
| 595 | An object of the form: |
| 596 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 597 | { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 598 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 599 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 600 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 601 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 602 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 603 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 604 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 605 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 606 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 607 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 608 | }, |
| 609 | ], |
| 610 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 611 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. |
| 612 | "httpErrorStatusCode": 42, # [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. |
| 613 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 614 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 615 | "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. |
| 616 | "name": "A String", # [Output Only] Name of the resource. |
| 617 | "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. |
| 618 | "progress": 42, # [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. |
| 619 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
| 620 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 621 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 622 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. |
| 623 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 624 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 625 | "targetLink": "A String", # [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. |
| 626 | "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. |
| 627 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 628 | { |
| 629 | "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| 630 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 631 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| 632 | { |
| 633 | "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). |
| 634 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 635 | }, |
| 636 | ], |
| 637 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 638 | }, |
| 639 | ], |
| 640 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 641 | }</pre> |
| 642 | </div> |
| 643 | |
| 644 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 645 | <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None)</code> |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 646 | <pre>Lists all deployments for a given project. |
| 647 | |
| 648 | Args: |
| 649 | project: string, The project ID for this request. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 650 | filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 651 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 652 | For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 653 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 654 | You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 655 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 656 | To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). |
| 657 | maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) |
| 658 | orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. |
| 659 | |
| 660 | You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. |
| 661 | |
| 662 | Currently, only sorting by name or creationTimestamp desc is supported. |
| 663 | pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 664 | |
| 665 | Returns: |
| 666 | An object of the form: |
| 667 | |
| 668 | { # A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 669 | "deployments": [ # Output only. The deployments contained in this response. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 670 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 671 | "description": "A String", # An optional user-provided description of the deployment. |
| 672 | "fingerprint": "A String", # 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. |
| 673 | # |
| 674 | # 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. |
| 675 | "id": "A String", |
| 676 | "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. |
| 677 | "labels": [ # Map of 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])?)? |
| 678 | { |
| 679 | "key": "A String", |
| 680 | "value": "A String", |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 681 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 682 | ], |
| 683 | "manifest": "A String", # Output only. URL of the manifest representing the last manifest that was successfully deployed. |
| 684 | "name": "A String", # 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. |
| 685 | "operation": { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) # Output only. The Operation that most recently ran, or is currently running, on this deployment. |
| 686 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 687 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 688 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 689 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 690 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 691 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 692 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 693 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 694 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 695 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 696 | }, |
| 697 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 698 | }, |
| 699 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. |
| 700 | "httpErrorStatusCode": 42, # [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. |
| 701 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 702 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 703 | "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. |
| 704 | "name": "A String", # [Output Only] Name of the resource. |
| 705 | "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. |
| 706 | "progress": 42, # [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. |
| 707 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
| 708 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 709 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 710 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. |
| 711 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 712 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 713 | "targetLink": "A String", # [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. |
| 714 | "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. |
| 715 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 716 | { |
| 717 | "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| 718 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 719 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 720 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 721 | "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). |
| 722 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 723 | }, |
| 724 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 725 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 726 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 727 | ], |
| 728 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 729 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 730 | "selfLink": "A String", # Output only. Server defined URL for the resource. |
| 731 | "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates. |
| 732 | "config": { # The configuration to use for this deployment. |
| 733 | "content": "A String", # The contents of the file. |
| 734 | }, |
| 735 | "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template. |
| 736 | { |
| 737 | "content": "A String", # The contents of the file. |
| 738 | "name": "A String", # The name of the file. |
| 739 | }, |
| 740 | ], |
| 741 | }, |
| 742 | "update": { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here. |
| 743 | "description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied. |
| 744 | "labels": [ # Output only. Map of 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])?)? |
| 745 | { |
| 746 | "key": "A String", |
| 747 | "value": "A String", |
| 748 | }, |
| 749 | ], |
| 750 | "manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment. |
| 751 | }, |
| 752 | "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format. |
| 753 | }, |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 754 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 755 | "nextPageToken": "A String", # Output only. A token used to continue a truncated list request. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 756 | }</pre> |
| 757 | </div> |
| 758 | |
| 759 | <div class="method"> |
| 760 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 761 | <pre>Retrieves the next page of results. |
| 762 | |
| 763 | Args: |
| 764 | previous_request: The request for the previous page. (required) |
| 765 | previous_response: The response from the request for the previous page. (required) |
| 766 | |
| 767 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 768 | A request object that you can call 'execute()' on to request the next |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 769 | page. Returns None if there are no more items in the collection. |
| 770 | </pre> |
| 771 | </div> |
| 772 | |
| 773 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 774 | <code class="details" id="patch">patch(project, deployment, body=None, createPolicy=None, deletePolicy=None, preview=None)</code> |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 775 | <pre>Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics. |
| 776 | |
| 777 | Args: |
| 778 | project: string, The project ID for this request. (required) |
| 779 | deployment: string, The name of the deployment for this request. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 780 | body: object, The request body. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 781 | The object takes the form of: |
| 782 | |
| 783 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 784 | "description": "A String", # An optional user-provided description of the deployment. |
| 785 | "fingerprint": "A String", # 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. |
| 786 | # |
| 787 | # 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. |
| 788 | "id": "A String", |
| 789 | "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. |
| 790 | "labels": [ # Map of 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])?)? |
| 791 | { |
| 792 | "key": "A String", |
| 793 | "value": "A String", |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 794 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 795 | ], |
| 796 | "manifest": "A String", # Output only. URL of the manifest representing the last manifest that was successfully deployed. |
| 797 | "name": "A String", # 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. |
| 798 | "operation": { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) # Output only. The Operation that most recently ran, or is currently running, on this deployment. |
| 799 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 800 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 801 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 802 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 803 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 804 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 805 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 806 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 807 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 808 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 809 | }, |
| 810 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 811 | }, |
| 812 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. |
| 813 | "httpErrorStatusCode": 42, # [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. |
| 814 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 815 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 816 | "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. |
| 817 | "name": "A String", # [Output Only] Name of the resource. |
| 818 | "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. |
| 819 | "progress": 42, # [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. |
| 820 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
| 821 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 822 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 823 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. |
| 824 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 825 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 826 | "targetLink": "A String", # [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. |
| 827 | "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. |
| 828 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 829 | { |
| 830 | "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| 831 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 832 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 833 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 834 | "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). |
| 835 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 836 | }, |
| 837 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 838 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 839 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 840 | ], |
| 841 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
| 842 | }, |
| 843 | "selfLink": "A String", # Output only. Server defined URL for the resource. |
| 844 | "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates. |
| 845 | "config": { # The configuration to use for this deployment. |
| 846 | "content": "A String", # The contents of the file. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 847 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 848 | "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template. |
| 849 | { |
| 850 | "content": "A String", # The contents of the file. |
| 851 | "name": "A String", # The name of the file. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 852 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 853 | ], |
| 854 | }, |
| 855 | "update": { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here. |
| 856 | "description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied. |
| 857 | "labels": [ # Output only. Map of 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])?)? |
| 858 | { |
| 859 | "key": "A String", |
| 860 | "value": "A String", |
| 861 | }, |
| 862 | ], |
| 863 | "manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment. |
| 864 | }, |
| 865 | "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format. |
| 866 | } |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 867 | |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 868 | createPolicy: string, Sets the policy to use for creating new resources. |
| 869 | Allowed values |
| 870 | ACQUIRE - |
| 871 | CREATE_OR_ACQUIRE - |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 872 | deletePolicy: string, Sets the policy to use for deleting resources. |
| 873 | Allowed values |
| 874 | ABANDON - |
| 875 | DELETE - |
| 876 | preview: boolean, If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove 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. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 877 | |
| 878 | Returns: |
| 879 | An object of the form: |
| 880 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 881 | { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 882 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 883 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 884 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 885 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 886 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 887 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 888 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 889 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 890 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 891 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 892 | }, |
| 893 | ], |
| 894 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 895 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. |
| 896 | "httpErrorStatusCode": 42, # [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. |
| 897 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 898 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 899 | "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. |
| 900 | "name": "A String", # [Output Only] Name of the resource. |
| 901 | "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. |
| 902 | "progress": 42, # [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. |
| 903 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
| 904 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 905 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 906 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. |
| 907 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 908 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 909 | "targetLink": "A String", # [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. |
| 910 | "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. |
| 911 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 912 | { |
| 913 | "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| 914 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 915 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| 916 | { |
| 917 | "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). |
| 918 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 919 | }, |
| 920 | ], |
| 921 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 922 | }, |
| 923 | ], |
| 924 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 925 | }</pre> |
| 926 | </div> |
| 927 | |
| 928 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 929 | <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None)</code> |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 930 | <pre>Sets the access control policy on the specified resource. Replaces any existing policy. |
| 931 | |
| 932 | Args: |
| 933 | project: string, Project ID for this request. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 934 | resource: string, Name or id of the resource for this request. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 935 | body: object, The request body. |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 936 | The object takes the form of: |
| 937 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 938 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 939 | "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. |
| 940 | { # Associates `members` with a `role`. |
| 941 | "condition": { # Represents an expression text. Example: # Unimplemented. The condition that is associated with this binding. NOTE: an unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. |
| 942 | # |
| 943 | # title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" |
| 944 | "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. |
| 945 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 946 | # |
| 947 | # The application context of the containing message determines which well-known feature set of CEL is supported. |
| 948 | "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. |
| 949 | "title": "A String", # An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. |
| 950 | }, |
| 951 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: |
| 952 | # |
| 953 | # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. |
| 954 | # |
| 955 | # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. |
| 956 | # |
| 957 | # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . |
| 958 | # |
| 959 | # |
| 960 | # |
| 961 | # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| 962 | # |
| 963 | # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. |
| 964 | # |
| 965 | # |
| 966 | # |
| 967 | # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. |
| 968 | "A String", |
| 969 | ], |
| 970 | "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| 971 | }, |
| 972 | ], |
| 973 | "etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. |
| 974 | "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 975 | # |
| Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 976 | # |
| Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 977 | # |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 978 | # A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. |
| Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 979 | # |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 980 | # **JSON Example** |
| 981 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 982 | # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 983 | # |
| 984 | # **YAML Example** |
| 985 | # |
| 986 | # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer |
| 987 | # |
| 988 | # |
| 989 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 990 | # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). |
| 991 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 992 | { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 993 | # |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 994 | # If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 995 | # |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 996 | # Example Policy with multiple AuditConfigs: |
| 997 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 998 | # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 999 | # |
| 1000 | # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1001 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1002 | { # Provides the configuration for logging a type of permissions. Example: |
| 1003 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1004 | # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1005 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1006 | # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. |
| 1007 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. |
| 1008 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1009 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1010 | "logType": "A String", # The log type that this config enables. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1011 | }, |
| 1012 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1013 | "exemptedMembers": [ |
| 1014 | "A String", |
| 1015 | ], |
| 1016 | "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. |
| Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 1017 | }, |
| 1018 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1019 | "bindings": [ # Associates a list of `members` to a `role`. `bindings` with no members will result in an error. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1020 | { # Associates `members` with a `role`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1021 | "condition": { # Represents an expression text. Example: # Unimplemented. The condition that is associated with this binding. NOTE: an unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. |
| 1022 | # |
| 1023 | # title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" |
| 1024 | "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. |
| 1025 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 1026 | # |
| 1027 | # The application context of the containing message determines which well-known feature set of CEL is supported. |
| 1028 | "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. |
| 1029 | "title": "A String", # An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. |
| 1030 | }, |
| 1031 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1032 | # |
| 1033 | # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. |
| 1034 | # |
| 1035 | # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. |
| 1036 | # |
| 1037 | # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . |
| 1038 | # |
| 1039 | # |
| 1040 | # |
| 1041 | # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| 1042 | # |
| 1043 | # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. |
| 1044 | # |
| 1045 | # |
| 1046 | # |
| 1047 | # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1048 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1049 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1050 | "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 1051 | }, |
| 1052 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1053 | "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. |
| 1054 | # |
| 1055 | # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. |
| 1056 | "iamOwned": True or False, |
| 1057 | "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. |
| 1058 | { # A rule to be applied in a Policy. |
| 1059 | "action": "A String", # Required |
| 1060 | "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match. |
| 1061 | { # A condition to be met. |
| 1062 | "iam": "A String", # Trusted attributes supplied by the IAM system. |
| 1063 | "op": "A String", # An operator to apply the subject with. |
| 1064 | "svc": "A String", # Trusted attributes discharged by the service. |
| 1065 | "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. |
| 1066 | "value": "A String", # DEPRECATED. Use 'values' instead. |
| 1067 | "values": [ # The objects of the condition. This is mutually exclusive with 'value'. |
| 1068 | "A String", |
| 1069 | ], |
| 1070 | }, |
| 1071 | ], |
| 1072 | "description": "A String", # Human-readable description of the rule. |
| 1073 | "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. |
| 1074 | "A String", |
| 1075 | ], |
| 1076 | "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. |
| 1077 | { # Specifies what kind of log the caller must write |
| 1078 | "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. |
| 1079 | "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline. |
| 1080 | "permissionType": "A String", # The type of the permission that was checked. |
| 1081 | }, |
| 1082 | "logName": "A String", # The log_name to populate in the Cloud Audit Record. |
| 1083 | }, |
| 1084 | "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options. |
| 1085 | # |
| 1086 | # Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. |
| 1087 | # |
| 1088 | # Field names correspond to IAM request parameters and field values are their respective values. |
| 1089 | # |
| 1090 | # Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. |
| 1091 | # |
| 1092 | # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} |
| 1093 | # |
| 1094 | # At this time we do not support multiple field names (though this may be supported in the future). |
| 1095 | "field": "A String", # The field value to attribute. |
| 1096 | "metric": "A String", # The metric to update. |
| 1097 | }, |
| 1098 | "dataAccess": { # Write a Data Access (Gin) log # Data access options. |
| 1099 | "logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. |
| 1100 | # |
| 1101 | # NOTE: Logging to Gin in a fail-closed manner is currently unsupported while work is being done to satisfy the requirements of go/345. Currently, setting LOG_FAIL_CLOSED mode will have no effect, but still exists because there is active work being done to support it (b/115874152). |
| 1102 | }, |
| 1103 | }, |
| 1104 | ], |
| 1105 | "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. |
| 1106 | "A String", |
| 1107 | ], |
| 1108 | "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. |
| 1109 | "A String", |
| 1110 | ], |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 1111 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1112 | ], |
| 1113 | "version": 42, # Deprecated. |
| 1114 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1115 | } |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 1116 | |
| 1117 | |
| 1118 | Returns: |
| 1119 | An object of the form: |
| 1120 | |
| 1121 | { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. |
| 1122 | # |
| 1123 | # |
| 1124 | # |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1125 | # A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 1126 | # |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1127 | # **JSON Example** |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 1128 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1129 | # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 1130 | # |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1131 | # **YAML Example** |
| 1132 | # |
| 1133 | # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer |
| 1134 | # |
| 1135 | # |
| 1136 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1137 | # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). |
| 1138 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 1139 | { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1140 | # |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1141 | # If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. |
| Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 1142 | # |
| 1143 | # Example Policy with multiple AuditConfigs: |
| 1144 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1145 | # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } |
| Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 1146 | # |
| 1147 | # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1148 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1149 | { # Provides the configuration for logging a type of permissions. Example: |
| 1150 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1151 | # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1152 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1153 | # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. |
| 1154 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. |
| 1155 | "A String", |
| Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 1156 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1157 | "logType": "A String", # The log type that this config enables. |
| Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 1158 | }, |
| 1159 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1160 | "exemptedMembers": [ |
| 1161 | "A String", |
| 1162 | ], |
| 1163 | "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 1164 | }, |
| 1165 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1166 | "bindings": [ # Associates a list of `members` to a `role`. `bindings` with no members will result in an error. |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 1167 | { # Associates `members` with a `role`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1168 | "condition": { # Represents an expression text. Example: # Unimplemented. The condition that is associated with this binding. NOTE: an unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. |
| 1169 | # |
| 1170 | # title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" |
| 1171 | "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. |
| 1172 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 1173 | # |
| 1174 | # The application context of the containing message determines which well-known feature set of CEL is supported. |
| 1175 | "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. |
| 1176 | "title": "A String", # An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. |
| 1177 | }, |
| 1178 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 1179 | # |
| 1180 | # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. |
| 1181 | # |
| 1182 | # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. |
| 1183 | # |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1184 | # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 1185 | # |
| Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 1186 | # |
| 1187 | # |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 1188 | # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| 1189 | # |
| 1190 | # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. |
| 1191 | # |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1192 | # |
| 1193 | # |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 1194 | # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1195 | "A String", |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 1196 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1197 | "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 1198 | }, |
| 1199 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1200 | "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. |
| 1201 | # |
| 1202 | # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. |
| 1203 | "iamOwned": True or False, |
| 1204 | "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. |
| 1205 | { # A rule to be applied in a Policy. |
| 1206 | "action": "A String", # Required |
| 1207 | "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match. |
| 1208 | { # A condition to be met. |
| 1209 | "iam": "A String", # Trusted attributes supplied by the IAM system. |
| 1210 | "op": "A String", # An operator to apply the subject with. |
| 1211 | "svc": "A String", # Trusted attributes discharged by the service. |
| 1212 | "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. |
| 1213 | "value": "A String", # DEPRECATED. Use 'values' instead. |
| 1214 | "values": [ # The objects of the condition. This is mutually exclusive with 'value'. |
| 1215 | "A String", |
| 1216 | ], |
| 1217 | }, |
| 1218 | ], |
| 1219 | "description": "A String", # Human-readable description of the rule. |
| 1220 | "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. |
| 1221 | "A String", |
| 1222 | ], |
| 1223 | "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. |
| 1224 | { # Specifies what kind of log the caller must write |
| 1225 | "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. |
| 1226 | "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline. |
| 1227 | "permissionType": "A String", # The type of the permission that was checked. |
| 1228 | }, |
| 1229 | "logName": "A String", # The log_name to populate in the Cloud Audit Record. |
| 1230 | }, |
| 1231 | "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options. |
| 1232 | # |
| 1233 | # Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. |
| 1234 | # |
| 1235 | # Field names correspond to IAM request parameters and field values are their respective values. |
| 1236 | # |
| 1237 | # Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. |
| 1238 | # |
| 1239 | # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} |
| 1240 | # |
| 1241 | # At this time we do not support multiple field names (though this may be supported in the future). |
| 1242 | "field": "A String", # The field value to attribute. |
| 1243 | "metric": "A String", # The metric to update. |
| 1244 | }, |
| 1245 | "dataAccess": { # Write a Data Access (Gin) log # Data access options. |
| 1246 | "logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. |
| 1247 | # |
| 1248 | # NOTE: Logging to Gin in a fail-closed manner is currently unsupported while work is being done to satisfy the requirements of go/345. Currently, setting LOG_FAIL_CLOSED mode will have no effect, but still exists because there is active work being done to support it (b/115874152). |
| 1249 | }, |
| 1250 | }, |
| 1251 | ], |
| 1252 | "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. |
| 1253 | "A String", |
| 1254 | ], |
| 1255 | "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. |
| 1256 | "A String", |
| 1257 | ], |
| 1258 | }, |
| 1259 | ], |
| 1260 | "version": 42, # Deprecated. |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 1261 | }</pre> |
| 1262 | </div> |
| 1263 | |
| 1264 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1265 | <code class="details" id="stop">stop(project, deployment, body=None)</code> |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1266 | <pre>Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started. |
| 1267 | |
| 1268 | Args: |
| 1269 | project: string, The project ID for this request. (required) |
| 1270 | deployment: string, The name of the deployment for this request. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1271 | body: object, The request body. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1272 | The object takes the form of: |
| 1273 | |
| 1274 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1275 | "fingerprint": "A String", # Specifies a fingerprint for stop() requests. A fingerprint is a randomly generated value that must be provided in stop() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to stop an ongoing update request, this would prevent a collision). |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1276 | # |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 1277 | # The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1278 | } |
| 1279 | |
| 1280 | |
| 1281 | Returns: |
| 1282 | An object of the form: |
| 1283 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1284 | { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1285 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 1286 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 1287 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 1288 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 1289 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 1290 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1291 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1292 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 1293 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 1294 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1295 | }, |
| 1296 | ], |
| 1297 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1298 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. |
| 1299 | "httpErrorStatusCode": 42, # [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. |
| 1300 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 1301 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 1302 | "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. |
| 1303 | "name": "A String", # [Output Only] Name of the resource. |
| 1304 | "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. |
| 1305 | "progress": 42, # [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. |
| 1306 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
| 1307 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 1308 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 1309 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. |
| 1310 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 1311 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 1312 | "targetLink": "A String", # [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. |
| 1313 | "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. |
| 1314 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 1315 | { |
| 1316 | "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| 1317 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 1318 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| 1319 | { |
| 1320 | "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). |
| 1321 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 1322 | }, |
| 1323 | ], |
| 1324 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 1325 | }, |
| 1326 | ], |
| 1327 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1328 | }</pre> |
| 1329 | </div> |
| 1330 | |
| 1331 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1332 | <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code> |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 1333 | <pre>Returns permissions that a caller has on the specified resource. |
| 1334 | |
| 1335 | Args: |
| 1336 | project: string, Project ID for this request. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1337 | resource: string, Name or id of the resource for this request. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1338 | body: object, The request body. |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 1339 | The object takes the form of: |
| 1340 | |
| 1341 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1342 | "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. |
| 1343 | "A String", |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 1344 | ], |
| 1345 | } |
| 1346 | |
| 1347 | |
| 1348 | Returns: |
| 1349 | An object of the form: |
| 1350 | |
| 1351 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1352 | "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. |
| 1353 | "A String", |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 1354 | ], |
| 1355 | }</pre> |
| 1356 | </div> |
| 1357 | |
| 1358 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1359 | <code class="details" id="update">update(project, deployment, body=None, createPolicy=None, deletePolicy=None, preview=None)</code> |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1360 | <pre>Updates a deployment and all of the resources described by the deployment manifest. |
| 1361 | |
| 1362 | Args: |
| 1363 | project: string, The project ID for this request. (required) |
| 1364 | deployment: string, The name of the deployment for this request. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1365 | body: object, The request body. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1366 | The object takes the form of: |
| 1367 | |
| 1368 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1369 | "description": "A String", # An optional user-provided description of the deployment. |
| 1370 | "fingerprint": "A String", # 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. |
| 1371 | # |
| 1372 | # 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. |
| 1373 | "id": "A String", |
| 1374 | "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. |
| 1375 | "labels": [ # Map of 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])?)? |
| 1376 | { |
| 1377 | "key": "A String", |
| 1378 | "value": "A String", |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1379 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1380 | ], |
| 1381 | "manifest": "A String", # Output only. URL of the manifest representing the last manifest that was successfully deployed. |
| 1382 | "name": "A String", # 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. |
| 1383 | "operation": { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) # Output only. The Operation that most recently ran, or is currently running, on this deployment. |
| 1384 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 1385 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 1386 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 1387 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 1388 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 1389 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1390 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1391 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 1392 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 1393 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1394 | }, |
| 1395 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1396 | }, |
| 1397 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. |
| 1398 | "httpErrorStatusCode": 42, # [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. |
| 1399 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 1400 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 1401 | "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. |
| 1402 | "name": "A String", # [Output Only] Name of the resource. |
| 1403 | "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. |
| 1404 | "progress": 42, # [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. |
| 1405 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
| 1406 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 1407 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 1408 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. |
| 1409 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 1410 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 1411 | "targetLink": "A String", # [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. |
| 1412 | "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. |
| 1413 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 1414 | { |
| 1415 | "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| 1416 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 1417 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1418 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1419 | "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). |
| 1420 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1421 | }, |
| 1422 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1423 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1424 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1425 | ], |
| 1426 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
| 1427 | }, |
| 1428 | "selfLink": "A String", # Output only. Server defined URL for the resource. |
| 1429 | "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates. |
| 1430 | "config": { # The configuration to use for this deployment. |
| 1431 | "content": "A String", # The contents of the file. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1432 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1433 | "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template. |
| 1434 | { |
| 1435 | "content": "A String", # The contents of the file. |
| 1436 | "name": "A String", # The name of the file. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1437 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1438 | ], |
| 1439 | }, |
| 1440 | "update": { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here. |
| 1441 | "description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied. |
| 1442 | "labels": [ # Output only. Map of 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])?)? |
| 1443 | { |
| 1444 | "key": "A String", |
| 1445 | "value": "A String", |
| 1446 | }, |
| 1447 | ], |
| 1448 | "manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment. |
| 1449 | }, |
| 1450 | "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format. |
| 1451 | } |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1452 | |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1453 | createPolicy: string, Sets the policy to use for creating new resources. |
| 1454 | Allowed values |
| 1455 | ACQUIRE - |
| 1456 | CREATE_OR_ACQUIRE - |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1457 | deletePolicy: string, Sets the policy to use for deleting resources. |
| 1458 | Allowed values |
| 1459 | ABANDON - |
| 1460 | DELETE - |
| 1461 | preview: boolean, If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove 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. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1462 | |
| 1463 | Returns: |
| 1464 | An object of the form: |
| 1465 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1466 | { # An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1467 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 1468 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 1469 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 1470 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 1471 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 1472 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1473 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1474 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 1475 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 1476 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1477 | }, |
| 1478 | ], |
| 1479 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1480 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. |
| 1481 | "httpErrorStatusCode": 42, # [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. |
| 1482 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 1483 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 1484 | "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. |
| 1485 | "name": "A String", # [Output Only] Name of the resource. |
| 1486 | "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. |
| 1487 | "progress": 42, # [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. |
| 1488 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
| 1489 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 1490 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 1491 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. |
| 1492 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 1493 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 1494 | "targetLink": "A String", # [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. |
| 1495 | "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. |
| 1496 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 1497 | { |
| 1498 | "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| 1499 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 1500 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| 1501 | { |
| 1502 | "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). |
| 1503 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 1504 | }, |
| 1505 | ], |
| 1506 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 1507 | }, |
| 1508 | ], |
| 1509 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1510 | }</pre> |
| 1511 | </div> |
| 1512 | |
| 1513 | </body></html> |