| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -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="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.nodeTemplates.html">nodeTemplates</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 78 | <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 79 | <p class="firstline">Retrieves an aggregated list of node templates.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p> |
| 82 | <p class="firstline">Retrieves the next page of results.</p> |
| 83 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 84 | <code><a href="#close">close()</a></code></p> |
| 85 | <p class="firstline">Close httplib2 connections.</p> |
| 86 | <p class="toc_element"> |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 87 | <code><a href="#delete">delete(project, region, nodeTemplate, requestId=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 88 | <p class="firstline">Deletes the specified NodeTemplate resource.</p> |
| 89 | <p class="toc_element"> |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 90 | <code><a href="#get">get(project, region, nodeTemplate, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 91 | <p class="firstline">Returns the specified node template. Gets a list of available node templates by making a list() request.</p> |
| 92 | <p class="toc_element"> |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 93 | <code><a href="#getIamPolicy">getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 94 | <p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p> |
| 95 | <p class="toc_element"> |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 96 | <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 97 | <p class="firstline">Creates a NodeTemplate resource in the specified project using the data included in the request.</p> |
| 98 | <p class="toc_element"> |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 99 | <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 100 | <p class="firstline">Retrieves a list of node templates available to the specified project.</p> |
| 101 | <p class="toc_element"> |
| 102 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 103 | <p class="firstline">Retrieves the next page of results.</p> |
| 104 | <p class="toc_element"> |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 105 | <code><a href="#setIamPolicy">setIamPolicy(project, region, resource, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 106 | <p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p> |
| 107 | <p class="toc_element"> |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 108 | <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 109 | <p class="firstline">Returns permissions that a caller has on the specified resource.</p> |
| 110 | <h3>Method Details</h3> |
| 111 | <div class="method"> |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 112 | <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 113 | <pre>Retrieves an aggregated list of node templates. |
| 114 | |
| 115 | Args: |
| 116 | project: string, Project ID for this request. (required) |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 117 | 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 `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. 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. 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) ``` |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 118 | includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 119 | 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`) |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 120 | orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 121 | 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 122 | returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 123 | x__xgafv: string, V1 error format. |
| 124 | Allowed values |
| 125 | 1 - v1 error format |
| 126 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 127 | |
| 128 | Returns: |
| 129 | An object of the form: |
| 130 | |
| 131 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 132 | "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| 133 | "items": { # A list of NodeTemplatesScopedList resources. |
| 134 | "a_key": { # [Output Only] Name of the scope containing this set of node templates. |
| 135 | "nodeTemplates": [ # [Output Only] A list of node templates contained in this scope. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 136 | { # Represent a sole-tenant Node Template resource. You can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 137 | "accelerators": [ |
| 138 | { # A specification of the type and number of accelerator cards attached to the instance. |
| 139 | "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. |
| 140 | "acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 141 | }, |
| 142 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 143 | "cpuOvercommitType": "A String", # CPU overcommit. |
| 144 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| 145 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| 146 | "disks": [ |
| 147 | { |
| 148 | "diskCount": 42, # Specifies the number of such disks. |
| 149 | "diskSizeGb": 42, # Specifies the size of the disk in base-2 GB. |
| 150 | "diskType": "A String", # Specifies the desired disk type on the node. This disk type must be a local storage type (e.g.: local-ssd). Note that for nodeTemplates, this should be the name of the disk type and not its URL. |
| 151 | }, |
| 152 | ], |
| 153 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 154 | "kind": "compute#nodeTemplate", # [Output Only] The type of the resource. Always compute#nodeTemplate for node templates. |
| 155 | "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. |
| 156 | "nodeAffinityLabels": { # Labels to use for node affinity, which will be used in instance scheduling. |
| 157 | "a_key": "A String", |
| 158 | }, |
| 159 | "nodeType": "A String", # The node type to use for nodes group that are created from this template. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 160 | "nodeTypeFlexibility": { # The flexible properties of the desired node type. Node groups that use this node template will create nodes of a type that matches these properties. This field is mutually exclusive with the node_type property; you can only define one or the other, but not both. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 161 | "cpus": "A String", |
| 162 | "localSsd": "A String", |
| 163 | "memory": "A String", |
| 164 | }, |
| 165 | "region": "A String", # [Output Only] The name of the region where the node template resides, such as us-central1. |
| 166 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 167 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 168 | "serverBinding": { # Sets the binding properties for the physical server. Valid values include: - *[Default]* RESTART_NODE_ON_ANY_SERVER: Restarts VMs on any available physical server - RESTART_NODE_ON_MINIMAL_SERVER: Restarts VMs on the same physical server whenever possible See Sole-tenant node options for more information. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 169 | "type": "A String", |
| 170 | }, |
| 171 | "status": "A String", # [Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING. |
| 172 | "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 173 | }, |
| 174 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 175 | "warning": { # [Output Only] An informational warning that appears when the node templates list is empty. |
| 176 | "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. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 177 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 178 | { |
| 179 | "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). |
| 180 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 181 | }, |
| 182 | ], |
| 183 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 184 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 185 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 186 | }, |
| 187 | "kind": "compute#nodeTemplateAggregatedList", # [Output Only] Type of resource.Always compute#nodeTemplateAggregatedList for aggregated lists of node templates. |
| 188 | "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. |
| 189 | "selfLink": "A String", # [Output Only] Server-defined URL for this resource. |
| 190 | "unreachables": [ # [Output Only] Unreachable resources. |
| 191 | "A String", |
| 192 | ], |
| 193 | "warning": { # [Output Only] Informational warning message. |
| 194 | "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. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 195 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 196 | { |
| 197 | "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). |
| 198 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 199 | }, |
| 200 | ], |
| 201 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 202 | }, |
| 203 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 204 | </div> |
| 205 | |
| 206 | <div class="method"> |
| 207 | <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> |
| 208 | <pre>Retrieves the next page of results. |
| 209 | |
| 210 | Args: |
| 211 | previous_request: The request for the previous page. (required) |
| 212 | previous_response: The response from the request for the previous page. (required) |
| 213 | |
| 214 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 215 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 216 | page. Returns None if there are no more items in the collection. |
| 217 | </pre> |
| 218 | </div> |
| 219 | |
| 220 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 221 | <code class="details" id="close">close()</code> |
| 222 | <pre>Close httplib2 connections.</pre> |
| 223 | </div> |
| 224 | |
| 225 | <div class="method"> |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 226 | <code class="details" id="delete">delete(project, region, nodeTemplate, requestId=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 227 | <pre>Deletes the specified NodeTemplate resource. |
| 228 | |
| 229 | Args: |
| 230 | project: string, Project ID for this request. (required) |
| 231 | region: string, The name of the region for this request. (required) |
| 232 | nodeTemplate: string, Name of the NodeTemplate resource to delete. (required) |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 233 | requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). |
| 234 | x__xgafv: string, V1 error format. |
| 235 | Allowed values |
| 236 | 1 - v1 error format |
| 237 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 238 | |
| 239 | Returns: |
| 240 | An object of the form: |
| 241 | |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 242 | { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 243 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 244 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 245 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 246 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 247 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 248 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 249 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 250 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 251 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 252 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 253 | }, |
| 254 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 255 | }, |
| 256 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 257 | "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. |
| 258 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 259 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 260 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| 261 | "name": "A String", # [Output Only] Name of the operation. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 262 | "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 263 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 264 | "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. |
| 265 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 266 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 267 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 268 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 269 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 270 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 271 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 272 | "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. |
| 273 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 274 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 275 | { |
| 276 | "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. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 277 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 278 | { |
| 279 | "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). |
| 280 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 281 | }, |
| 282 | ], |
| 283 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 284 | }, |
| 285 | ], |
| 286 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 287 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 288 | </div> |
| 289 | |
| 290 | <div class="method"> |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 291 | <code class="details" id="get">get(project, region, nodeTemplate, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 292 | <pre>Returns the specified node template. Gets a list of available node templates by making a list() request. |
| 293 | |
| 294 | Args: |
| 295 | project: string, Project ID for this request. (required) |
| 296 | region: string, The name of the region for this request. (required) |
| 297 | nodeTemplate: string, Name of the node template to return. (required) |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 298 | x__xgafv: string, V1 error format. |
| 299 | Allowed values |
| 300 | 1 - v1 error format |
| 301 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 302 | |
| 303 | Returns: |
| 304 | An object of the form: |
| 305 | |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 306 | { # Represent a sole-tenant Node Template resource. You can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 307 | "accelerators": [ |
| 308 | { # A specification of the type and number of accelerator cards attached to the instance. |
| 309 | "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. |
| 310 | "acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types. |
| 311 | }, |
| 312 | ], |
| 313 | "cpuOvercommitType": "A String", # CPU overcommit. |
| 314 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| 315 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| 316 | "disks": [ |
| 317 | { |
| 318 | "diskCount": 42, # Specifies the number of such disks. |
| 319 | "diskSizeGb": 42, # Specifies the size of the disk in base-2 GB. |
| 320 | "diskType": "A String", # Specifies the desired disk type on the node. This disk type must be a local storage type (e.g.: local-ssd). Note that for nodeTemplates, this should be the name of the disk type and not its URL. |
| 321 | }, |
| 322 | ], |
| 323 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 324 | "kind": "compute#nodeTemplate", # [Output Only] The type of the resource. Always compute#nodeTemplate for node templates. |
| 325 | "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. |
| 326 | "nodeAffinityLabels": { # Labels to use for node affinity, which will be used in instance scheduling. |
| 327 | "a_key": "A String", |
| 328 | }, |
| 329 | "nodeType": "A String", # The node type to use for nodes group that are created from this template. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 330 | "nodeTypeFlexibility": { # The flexible properties of the desired node type. Node groups that use this node template will create nodes of a type that matches these properties. This field is mutually exclusive with the node_type property; you can only define one or the other, but not both. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 331 | "cpus": "A String", |
| 332 | "localSsd": "A String", |
| 333 | "memory": "A String", |
| 334 | }, |
| 335 | "region": "A String", # [Output Only] The name of the region where the node template resides, such as us-central1. |
| 336 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 337 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 338 | "serverBinding": { # Sets the binding properties for the physical server. Valid values include: - *[Default]* RESTART_NODE_ON_ANY_SERVER: Restarts VMs on any available physical server - RESTART_NODE_ON_MINIMAL_SERVER: Restarts VMs on the same physical server whenever possible See Sole-tenant node options for more information. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 339 | "type": "A String", |
| 340 | }, |
| 341 | "status": "A String", # [Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING. |
| 342 | "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. |
| 343 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 344 | </div> |
| 345 | |
| 346 | <div class="method"> |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 347 | <code class="details" id="getIamPolicy">getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 348 | <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists. |
| 349 | |
| 350 | Args: |
| 351 | project: string, Project ID for this request. (required) |
| 352 | region: string, The name of the region for this request. (required) |
| 353 | 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] | 354 | optionsRequestedPolicyVersion: integer, Requested IAM Policy version. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 355 | x__xgafv: string, V1 error format. |
| 356 | Allowed values |
| 357 | 1 - v1 error format |
| 358 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 359 | |
| 360 | Returns: |
| 361 | An object of the form: |
| 362 | |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 363 | { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 364 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 365 | { # 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. 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. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 366 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 367 | { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. |
| 368 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 369 | "A String", |
| 370 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 371 | "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 372 | "logType": "A String", # The log type that this config enables. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 373 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 374 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 375 | "exemptedMembers": [ # This is deprecated and has no effect. Do not use. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 376 | "A String", |
| 377 | ], |
| 378 | "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. |
| 379 | }, |
| 380 | ], |
| 381 | "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. |
| 382 | { # Associates `members` with a `role`. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 383 | "bindingId": "A String", # This is deprecated and has no effect. Do not use. |
| 384 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 385 | "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. |
| 386 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 387 | "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. |
| 388 | "title": "A String", # 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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 389 | }, |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 390 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 391 | "A String", |
| 392 | ], |
| 393 | "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| 394 | }, |
| 395 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 396 | "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. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. |
| 397 | "iamOwned": True or False, # This is deprecated and has no effect. Do not use. |
| 398 | "rules": [ # This is deprecated and has no effect. Do not use. |
| 399 | { # This is deprecated and has no effect. Do not use. |
| 400 | "action": "A String", # This is deprecated and has no effect. Do not use. |
| 401 | "conditions": [ # This is deprecated and has no effect. Do not use. |
| 402 | { # This is deprecated and has no effect. Do not use. |
| 403 | "iam": "A String", # This is deprecated and has no effect. Do not use. |
| 404 | "op": "A String", # This is deprecated and has no effect. Do not use. |
| 405 | "svc": "A String", # This is deprecated and has no effect. Do not use. |
| 406 | "sys": "A String", # This is deprecated and has no effect. Do not use. |
| 407 | "values": [ # This is deprecated and has no effect. Do not use. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 408 | "A String", |
| 409 | ], |
| 410 | }, |
| 411 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 412 | "description": "A String", # This is deprecated and has no effect. Do not use. |
| 413 | "ins": [ # This is deprecated and has no effect. Do not use. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 414 | "A String", |
| 415 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 416 | "logConfigs": [ # This is deprecated and has no effect. Do not use. |
| 417 | { # This is deprecated and has no effect. Do not use. |
| 418 | "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. |
| 419 | "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. |
| 420 | "permissionType": "A String", # This is deprecated and has no effect. Do not use. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 421 | }, |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 422 | "logName": "A String", # This is deprecated and has no effect. Do not use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 423 | }, |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 424 | "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. |
| 425 | "customFields": [ # This is deprecated and has no effect. Do not use. |
| 426 | { # This is deprecated and has no effect. Do not use. |
| 427 | "name": "A String", # This is deprecated and has no effect. Do not use. |
| 428 | "value": "A String", # This is deprecated and has no effect. Do not use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 429 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 430 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 431 | "field": "A String", # This is deprecated and has no effect. Do not use. |
| 432 | "metric": "A String", # This is deprecated and has no effect. Do not use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 433 | }, |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 434 | "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. |
| 435 | "logMode": "A String", # This is deprecated and has no effect. Do not use. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 436 | }, |
| 437 | }, |
| 438 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 439 | "notIns": [ # This is deprecated and has no effect. Do not use. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 440 | "A String", |
| 441 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 442 | "permissions": [ # This is deprecated and has no effect. Do not use. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 443 | "A String", |
| 444 | ], |
| 445 | }, |
| 446 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 447 | "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 448 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 449 | </div> |
| 450 | |
| 451 | <div class="method"> |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 452 | <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 453 | <pre>Creates a NodeTemplate resource in the specified project using the data included in the request. |
| 454 | |
| 455 | Args: |
| 456 | project: string, Project ID for this request. (required) |
| 457 | region: string, The name of the region for this request. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 458 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 459 | The object takes the form of: |
| 460 | |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 461 | { # Represent a sole-tenant Node Template resource. You can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 462 | "accelerators": [ |
| 463 | { # A specification of the type and number of accelerator cards attached to the instance. |
| 464 | "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. |
| 465 | "acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types. |
| 466 | }, |
| 467 | ], |
| 468 | "cpuOvercommitType": "A String", # CPU overcommit. |
| 469 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| 470 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| 471 | "disks": [ |
| 472 | { |
| 473 | "diskCount": 42, # Specifies the number of such disks. |
| 474 | "diskSizeGb": 42, # Specifies the size of the disk in base-2 GB. |
| 475 | "diskType": "A String", # Specifies the desired disk type on the node. This disk type must be a local storage type (e.g.: local-ssd). Note that for nodeTemplates, this should be the name of the disk type and not its URL. |
| 476 | }, |
| 477 | ], |
| 478 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 479 | "kind": "compute#nodeTemplate", # [Output Only] The type of the resource. Always compute#nodeTemplate for node templates. |
| 480 | "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. |
| 481 | "nodeAffinityLabels": { # Labels to use for node affinity, which will be used in instance scheduling. |
| 482 | "a_key": "A String", |
| 483 | }, |
| 484 | "nodeType": "A String", # The node type to use for nodes group that are created from this template. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 485 | "nodeTypeFlexibility": { # The flexible properties of the desired node type. Node groups that use this node template will create nodes of a type that matches these properties. This field is mutually exclusive with the node_type property; you can only define one or the other, but not both. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 486 | "cpus": "A String", |
| 487 | "localSsd": "A String", |
| 488 | "memory": "A String", |
| 489 | }, |
| 490 | "region": "A String", # [Output Only] The name of the region where the node template resides, such as us-central1. |
| 491 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 492 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 493 | "serverBinding": { # Sets the binding properties for the physical server. Valid values include: - *[Default]* RESTART_NODE_ON_ANY_SERVER: Restarts VMs on any available physical server - RESTART_NODE_ON_MINIMAL_SERVER: Restarts VMs on the same physical server whenever possible See Sole-tenant node options for more information. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 494 | "type": "A String", |
| 495 | }, |
| 496 | "status": "A String", # [Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING. |
| 497 | "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. |
| 498 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 499 | |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 500 | requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). |
| 501 | x__xgafv: string, V1 error format. |
| 502 | Allowed values |
| 503 | 1 - v1 error format |
| 504 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 505 | |
| 506 | Returns: |
| 507 | An object of the form: |
| 508 | |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 509 | { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 510 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 511 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 512 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 513 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 514 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 515 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 516 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 517 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 518 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 519 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 520 | }, |
| 521 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 522 | }, |
| 523 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 524 | "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. |
| 525 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 526 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 527 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| 528 | "name": "A String", # [Output Only] Name of the operation. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 529 | "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 530 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 531 | "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. |
| 532 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 533 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 534 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 535 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 536 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 537 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 538 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 539 | "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. |
| 540 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 541 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 542 | { |
| 543 | "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. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 544 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 545 | { |
| 546 | "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). |
| 547 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 548 | }, |
| 549 | ], |
| 550 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 551 | }, |
| 552 | ], |
| 553 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 554 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 555 | </div> |
| 556 | |
| 557 | <div class="method"> |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 558 | <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 559 | <pre>Retrieves a list of node templates available to the specified project. |
| 560 | |
| 561 | Args: |
| 562 | project: string, Project ID for this request. (required) |
| 563 | region: string, The name of the region for this request. (required) |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 564 | 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 `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. 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. 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) ``` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 565 | 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`) |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 566 | orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 567 | 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 568 | returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 569 | x__xgafv: string, V1 error format. |
| 570 | Allowed values |
| 571 | 1 - v1 error format |
| 572 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 573 | |
| 574 | Returns: |
| 575 | An object of the form: |
| 576 | |
| 577 | { # Contains a list of node templates. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 578 | "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| 579 | "items": [ # A list of NodeTemplate resources. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 580 | { # Represent a sole-tenant Node Template resource. You can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 581 | "accelerators": [ |
| 582 | { # A specification of the type and number of accelerator cards attached to the instance. |
| 583 | "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. |
| 584 | "acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 585 | }, |
| 586 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 587 | "cpuOvercommitType": "A String", # CPU overcommit. |
| 588 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| 589 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| 590 | "disks": [ |
| 591 | { |
| 592 | "diskCount": 42, # Specifies the number of such disks. |
| 593 | "diskSizeGb": 42, # Specifies the size of the disk in base-2 GB. |
| 594 | "diskType": "A String", # Specifies the desired disk type on the node. This disk type must be a local storage type (e.g.: local-ssd). Note that for nodeTemplates, this should be the name of the disk type and not its URL. |
| 595 | }, |
| 596 | ], |
| 597 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 598 | "kind": "compute#nodeTemplate", # [Output Only] The type of the resource. Always compute#nodeTemplate for node templates. |
| 599 | "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource 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. |
| 600 | "nodeAffinityLabels": { # Labels to use for node affinity, which will be used in instance scheduling. |
| 601 | "a_key": "A String", |
| 602 | }, |
| 603 | "nodeType": "A String", # The node type to use for nodes group that are created from this template. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 604 | "nodeTypeFlexibility": { # The flexible properties of the desired node type. Node groups that use this node template will create nodes of a type that matches these properties. This field is mutually exclusive with the node_type property; you can only define one or the other, but not both. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 605 | "cpus": "A String", |
| 606 | "localSsd": "A String", |
| 607 | "memory": "A String", |
| 608 | }, |
| 609 | "region": "A String", # [Output Only] The name of the region where the node template resides, such as us-central1. |
| 610 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 611 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 612 | "serverBinding": { # Sets the binding properties for the physical server. Valid values include: - *[Default]* RESTART_NODE_ON_ANY_SERVER: Restarts VMs on any available physical server - RESTART_NODE_ON_MINIMAL_SERVER: Restarts VMs on the same physical server whenever possible See Sole-tenant node options for more information. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 613 | "type": "A String", |
| 614 | }, |
| 615 | "status": "A String", # [Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING. |
| 616 | "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 617 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 618 | ], |
| 619 | "kind": "compute#nodeTemplateList", # [Output Only] Type of resource.Always compute#nodeTemplateList for lists of node templates. |
| 620 | "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. |
| 621 | "selfLink": "A String", # [Output Only] Server-defined URL for this resource. |
| 622 | "warning": { # [Output Only] Informational warning message. |
| 623 | "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. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 624 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 625 | { |
| 626 | "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). |
| 627 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 628 | }, |
| 629 | ], |
| 630 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 631 | }, |
| 632 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 633 | </div> |
| 634 | |
| 635 | <div class="method"> |
| 636 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 637 | <pre>Retrieves the next page of results. |
| 638 | |
| 639 | Args: |
| 640 | previous_request: The request for the previous page. (required) |
| 641 | previous_response: The response from the request for the previous page. (required) |
| 642 | |
| 643 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 644 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 645 | page. Returns None if there are no more items in the collection. |
| 646 | </pre> |
| 647 | </div> |
| 648 | |
| 649 | <div class="method"> |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 650 | <code class="details" id="setIamPolicy">setIamPolicy(project, region, resource, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 651 | <pre>Sets the access control policy on the specified resource. Replaces any existing policy. |
| 652 | |
| 653 | Args: |
| 654 | project: string, Project ID for this request. (required) |
| 655 | region: string, The name of the region for this request. (required) |
| 656 | 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] | 657 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 658 | The object takes the form of: |
| 659 | |
| 660 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 661 | "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. |
| 662 | { # Associates `members` with a `role`. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 663 | "bindingId": "A String", # This is deprecated and has no effect. Do not use. |
| 664 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 665 | "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. |
| 666 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 667 | "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. |
| 668 | "title": "A String", # 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. |
| 669 | }, |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 670 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 671 | "A String", |
| 672 | ], |
| 673 | "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 674 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 675 | ], |
| 676 | "etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 677 | "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # 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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 678 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 679 | { # 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. 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. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 680 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 681 | { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. |
| 682 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 683 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 684 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 685 | "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 686 | "logType": "A String", # The log type that this config enables. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 687 | }, |
| 688 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 689 | "exemptedMembers": [ # This is deprecated and has no effect. Do not use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 690 | "A String", |
| 691 | ], |
| 692 | "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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 693 | }, |
| 694 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 695 | "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 696 | { # Associates `members` with a `role`. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 697 | "bindingId": "A String", # This is deprecated and has no effect. Do not use. |
| 698 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 699 | "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. |
| 700 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 701 | "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. |
| 702 | "title": "A String", # 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. |
| 703 | }, |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 704 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) 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] | 705 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 706 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 707 | "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 708 | }, |
| 709 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 710 | "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. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. |
| 711 | "iamOwned": True or False, # This is deprecated and has no effect. Do not use. |
| 712 | "rules": [ # This is deprecated and has no effect. Do not use. |
| 713 | { # This is deprecated and has no effect. Do not use. |
| 714 | "action": "A String", # This is deprecated and has no effect. Do not use. |
| 715 | "conditions": [ # This is deprecated and has no effect. Do not use. |
| 716 | { # This is deprecated and has no effect. Do not use. |
| 717 | "iam": "A String", # This is deprecated and has no effect. Do not use. |
| 718 | "op": "A String", # This is deprecated and has no effect. Do not use. |
| 719 | "svc": "A String", # This is deprecated and has no effect. Do not use. |
| 720 | "sys": "A String", # This is deprecated and has no effect. Do not use. |
| 721 | "values": [ # This is deprecated and has no effect. Do not use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 722 | "A String", |
| 723 | ], |
| 724 | }, |
| 725 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 726 | "description": "A String", # This is deprecated and has no effect. Do not use. |
| 727 | "ins": [ # This is deprecated and has no effect. Do not use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 728 | "A String", |
| 729 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 730 | "logConfigs": [ # This is deprecated and has no effect. Do not use. |
| 731 | { # This is deprecated and has no effect. Do not use. |
| 732 | "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. |
| 733 | "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. |
| 734 | "permissionType": "A String", # This is deprecated and has no effect. Do not use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 735 | }, |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 736 | "logName": "A String", # This is deprecated and has no effect. Do not use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 737 | }, |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 738 | "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. |
| 739 | "customFields": [ # This is deprecated and has no effect. Do not use. |
| 740 | { # This is deprecated and has no effect. Do not use. |
| 741 | "name": "A String", # This is deprecated and has no effect. Do not use. |
| 742 | "value": "A String", # This is deprecated and has no effect. Do not use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 743 | }, |
| 744 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 745 | "field": "A String", # This is deprecated and has no effect. Do not use. |
| 746 | "metric": "A String", # This is deprecated and has no effect. Do not use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 747 | }, |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 748 | "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. |
| 749 | "logMode": "A String", # This is deprecated and has no effect. Do not use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 750 | }, |
| 751 | }, |
| 752 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 753 | "notIns": [ # This is deprecated and has no effect. Do not use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 754 | "A String", |
| 755 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 756 | "permissions": [ # This is deprecated and has no effect. Do not use. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 757 | "A String", |
| 758 | ], |
| 759 | }, |
| 760 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 761 | "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 762 | }, |
| 763 | } |
| 764 | |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 765 | x__xgafv: string, V1 error format. |
| 766 | Allowed values |
| 767 | 1 - v1 error format |
| 768 | 2 - v2 error format |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 769 | |
| 770 | Returns: |
| 771 | An object of the form: |
| 772 | |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 773 | { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 774 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 775 | { # 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. 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. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 776 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 777 | { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. |
| 778 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 779 | "A String", |
| 780 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 781 | "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 782 | "logType": "A String", # The log type that this config enables. |
| 783 | }, |
| 784 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 785 | "exemptedMembers": [ # This is deprecated and has no effect. Do not use. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 786 | "A String", |
| 787 | ], |
| 788 | "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. |
| 789 | }, |
| 790 | ], |
| 791 | "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. |
| 792 | { # Associates `members` with a `role`. |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 793 | "bindingId": "A String", # This is deprecated and has no effect. Do not use. |
| 794 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 795 | "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. |
| 796 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 797 | "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. |
| 798 | "title": "A String", # 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. |
| 799 | }, |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 800 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 801 | "A String", |
| 802 | ], |
| 803 | "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| 804 | }, |
| 805 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 806 | "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. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. |
| 807 | "iamOwned": True or False, # This is deprecated and has no effect. Do not use. |
| 808 | "rules": [ # This is deprecated and has no effect. Do not use. |
| 809 | { # This is deprecated and has no effect. Do not use. |
| 810 | "action": "A String", # This is deprecated and has no effect. Do not use. |
| 811 | "conditions": [ # This is deprecated and has no effect. Do not use. |
| 812 | { # This is deprecated and has no effect. Do not use. |
| 813 | "iam": "A String", # This is deprecated and has no effect. Do not use. |
| 814 | "op": "A String", # This is deprecated and has no effect. Do not use. |
| 815 | "svc": "A String", # This is deprecated and has no effect. Do not use. |
| 816 | "sys": "A String", # This is deprecated and has no effect. Do not use. |
| 817 | "values": [ # This is deprecated and has no effect. Do not use. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 818 | "A String", |
| 819 | ], |
| 820 | }, |
| 821 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 822 | "description": "A String", # This is deprecated and has no effect. Do not use. |
| 823 | "ins": [ # This is deprecated and has no effect. Do not use. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 824 | "A String", |
| 825 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 826 | "logConfigs": [ # This is deprecated and has no effect. Do not use. |
| 827 | { # This is deprecated and has no effect. Do not use. |
| 828 | "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. |
| 829 | "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. |
| 830 | "permissionType": "A String", # This is deprecated and has no effect. Do not use. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 831 | }, |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 832 | "logName": "A String", # This is deprecated and has no effect. Do not use. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 833 | }, |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 834 | "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. |
| 835 | "customFields": [ # This is deprecated and has no effect. Do not use. |
| 836 | { # This is deprecated and has no effect. Do not use. |
| 837 | "name": "A String", # This is deprecated and has no effect. Do not use. |
| 838 | "value": "A String", # This is deprecated and has no effect. Do not use. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 839 | }, |
| 840 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 841 | "field": "A String", # This is deprecated and has no effect. Do not use. |
| 842 | "metric": "A String", # This is deprecated and has no effect. Do not use. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 843 | }, |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 844 | "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. |
| 845 | "logMode": "A String", # This is deprecated and has no effect. Do not use. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 846 | }, |
| 847 | }, |
| 848 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 849 | "notIns": [ # This is deprecated and has no effect. Do not use. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 850 | "A String", |
| 851 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 852 | "permissions": [ # This is deprecated and has no effect. Do not use. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 853 | "A String", |
| 854 | ], |
| 855 | }, |
| 856 | ], |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 857 | "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 858 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 859 | </div> |
| 860 | |
| 861 | <div class="method"> |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 862 | <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 863 | <pre>Returns permissions that a caller has on the specified resource. |
| 864 | |
| 865 | Args: |
| 866 | project: string, Project ID for this request. (required) |
| 867 | region: string, The name of the region for this request. (required) |
| 868 | 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] | 869 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 870 | The object takes the form of: |
| 871 | |
| 872 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 873 | "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. |
| 874 | "A String", |
| 875 | ], |
| 876 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 877 | |
| yoshi-code-bot | 0f0918f | 2021-06-11 00:22:02 -0700 | [diff] [blame^] | 878 | x__xgafv: string, V1 error format. |
| 879 | Allowed values |
| 880 | 1 - v1 error format |
| 881 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 882 | |
| 883 | Returns: |
| 884 | An object of the form: |
| 885 | |
| 886 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 887 | "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. |
| 888 | "A String", |
| 889 | ], |
| 890 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 891 | </div> |
| 892 | |
| 893 | </body></html> |