| 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.resources.html">resources</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#get">get(project, deployment, resource)</a></code></p> |
| 79 | <p class="firstline">Gets information about a single resource.</p> |
| 80 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 81 | <code><a href="#list">list(project, deployment, filter=None, maxResults=None, orderBy=None, pageToken=None)</a></code></p> |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 82 | <p class="firstline">Lists all resources in a given deployment.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 85 | <p class="firstline">Retrieves the next page of results.</p> |
| 86 | <h3>Method Details</h3> |
| 87 | <div class="method"> |
| 88 | <code class="details" id="get">get(project, deployment, resource)</code> |
| 89 | <pre>Gets information about a single resource. |
| 90 | |
| 91 | Args: |
| 92 | project: string, The project ID for this request. (required) |
| 93 | deployment: string, The name of the deployment for this request. (required) |
| 94 | resource: string, The name of the resource for this request. (required) |
| 95 | |
| 96 | Returns: |
| 97 | An object of the form: |
| 98 | |
| 99 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 100 | "accessControl": { # The access controls set on the resource. # The Access Control Policy set on this resource. |
| 101 | "gcpIamPolicy": "A String", # The GCP IAM Policy to set on the resource. |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 102 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 103 | "finalProperties": "A String", # Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML. |
| 104 | "id": "A String", |
| 105 | "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. |
| 106 | "manifest": "A String", # Output only. URL of the manifest representing the current configuration of this resource. |
| 107 | "name": "A String", # Output only. The name of the resource as it appears in the YAML config. |
| 108 | "properties": "A String", # Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML. |
| 109 | "type": "A String", # Output only. The type of the resource, for example compute.v1.instance, or cloudfunctions.v1beta1.function. |
| 110 | "update": { # Output only. If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here. |
| 111 | "accessControl": { # The access controls set on the resource. # The Access Control Policy to set on this resource after updating the resource itself. |
| 112 | "gcpIamPolicy": "A String", # The GCP IAM Policy to set on the resource. |
| 113 | }, |
| 114 | "error": { # Output only. If errors are generated during update of the resource, this field will be populated. |
| 115 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 116 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 117 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 118 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 119 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 120 | }, |
| 121 | ], |
| 122 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 123 | "finalProperties": "A String", # Output only. The expanded properties of the resource with reference values expanded. Returned as serialized YAML. |
| 124 | "intent": "A String", # Output only. The intent of the resource: PREVIEW, UPDATE, or CANCEL. |
| 125 | "manifest": "A String", # Output only. URL of the manifest representing the update configuration of this resource. |
| 126 | "properties": "A String", # Output only. The set of updated properties for this resource, before references are expanded. Returned as serialized YAML. |
| 127 | "state": "A String", # Output only. The state of the resource. |
| 128 | "warnings": [ # Output only. If warning messages are generated during processing of this resource, this field will be populated. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 129 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 130 | "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. |
| 131 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 132 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 133 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 134 | "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). |
| 135 | "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] | 136 | }, |
| 137 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 138 | "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] | 139 | }, |
| 140 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 141 | }, |
| 142 | "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format. |
| 143 | "url": "A String", # Output only. The URL of the actual resource. |
| 144 | "warnings": [ # Output only. If warning messages are generated during processing of this resource, this field will be populated. |
| 145 | { |
| 146 | "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. |
| 147 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 148 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 149 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 150 | "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). |
| 151 | "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] | 152 | }, |
| 153 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 154 | "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] | 155 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 156 | ], |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 157 | }</pre> |
| 158 | </div> |
| 159 | |
| 160 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 161 | <code class="details" id="list">list(project, deployment, filter=None, maxResults=None, orderBy=None, pageToken=None)</code> |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 162 | <pre>Lists all resources in a given deployment. |
| 163 | |
| 164 | Args: |
| 165 | project: string, The project ID for this request. (required) |
| 166 | deployment: string, The name of the deployment for this request. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 167 | 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] | 168 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 169 | 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] | 170 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 171 | 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] | 172 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 173 | 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). |
| 174 | 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) |
| 175 | orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. |
| 176 | |
| 177 | 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. |
| 178 | |
| 179 | Currently, only sorting by name or creationTimestamp desc is supported. |
| 180 | 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] | 181 | |
| 182 | Returns: |
| 183 | An object of the form: |
| 184 | |
| 185 | { # A response containing a partial list of resources 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^] | 186 | "nextPageToken": "A String", # A token used to continue a truncated list request. |
| 187 | "resources": [ # Resources contained in this list response. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 188 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 189 | "accessControl": { # The access controls set on the resource. # The Access Control Policy set on this resource. |
| 190 | "gcpIamPolicy": "A String", # The GCP IAM Policy to set on the resource. |
| Sai Cheemalapati | ea3a5e1 | 2016-10-12 14:05:53 -0700 | [diff] [blame] | 191 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 192 | "finalProperties": "A String", # Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML. |
| 193 | "id": "A String", |
| 194 | "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format. |
| 195 | "manifest": "A String", # Output only. URL of the manifest representing the current configuration of this resource. |
| 196 | "name": "A String", # Output only. The name of the resource as it appears in the YAML config. |
| 197 | "properties": "A String", # Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML. |
| 198 | "type": "A String", # Output only. The type of the resource, for example compute.v1.instance, or cloudfunctions.v1beta1.function. |
| 199 | "update": { # Output only. If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here. |
| 200 | "accessControl": { # The access controls set on the resource. # The Access Control Policy to set on this resource after updating the resource itself. |
| 201 | "gcpIamPolicy": "A String", # The GCP IAM Policy to set on the resource. |
| 202 | }, |
| 203 | "error": { # Output only. If errors are generated during update of the resource, this field will be populated. |
| 204 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 205 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 206 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 207 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 208 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 209 | }, |
| 210 | ], |
| 211 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 212 | "finalProperties": "A String", # Output only. The expanded properties of the resource with reference values expanded. Returned as serialized YAML. |
| 213 | "intent": "A String", # Output only. The intent of the resource: PREVIEW, UPDATE, or CANCEL. |
| 214 | "manifest": "A String", # Output only. URL of the manifest representing the update configuration of this resource. |
| 215 | "properties": "A String", # Output only. The set of updated properties for this resource, before references are expanded. Returned as serialized YAML. |
| 216 | "state": "A String", # Output only. The state of the resource. |
| 217 | "warnings": [ # Output only. If warning messages are generated during processing of this resource, this field will be populated. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 218 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 219 | "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. |
| 220 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 221 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 222 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 223 | "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). |
| 224 | "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] | 225 | }, |
| 226 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 227 | "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] | 228 | }, |
| 229 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 230 | }, |
| 231 | "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format. |
| 232 | "url": "A String", # Output only. The URL of the actual resource. |
| 233 | "warnings": [ # Output only. If warning messages are generated during processing of this resource, this field will be populated. |
| 234 | { |
| 235 | "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. |
| 236 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 237 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 238 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 239 | "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). |
| 240 | "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] | 241 | }, |
| 242 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 243 | "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] | 244 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 245 | ], |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 246 | }, |
| 247 | ], |
| 248 | }</pre> |
| 249 | </div> |
| 250 | |
| 251 | <div class="method"> |
| 252 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 253 | <pre>Retrieves the next page of results. |
| 254 | |
| 255 | Args: |
| 256 | previous_request: The request for the previous page. (required) |
| 257 | previous_response: The response from the request for the previous page. (required) |
| 258 | |
| 259 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 260 | 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] | 261 | page. Returns None if there are no more items in the collection. |
| 262 | </pre> |
| 263 | </div> |
| 264 | |
| 265 | </body></html> |