| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -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="memcache_v1beta2.html">Cloud Memorystore for Memcached API</a> . <a href="memcache_v1beta2.projects.html">projects</a> . <a href="memcache_v1beta2.projects.locations.html">locations</a> . <a href="memcache_v1beta2.projects.locations.instances.html">instances</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#applyParameters">applyParameters(name, body=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">ApplyParameters will update current set of Parameters to the set of</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#create">create(parent, body=None, instanceId=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Creates a new Instance in a given project and location.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Deletes a single Instance.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Gets details of a single Instance.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p> |
| 91 | <p class="firstline">Gets the access control policy for a resource.</p> |
| 92 | <p class="toc_element"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 93 | <code><a href="#list">list(parent, pageToken=None, orderBy=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 94 | <p class="firstline">Lists Instances in a given project and location.</p> |
| 95 | <p class="toc_element"> |
| 96 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 97 | <p class="firstline">Retrieves the next page of results.</p> |
| 98 | <p class="toc_element"> |
| 99 | <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 100 | <p class="firstline">Updates an existing Instance in a given project and location.</p> |
| 101 | <p class="toc_element"> |
| 102 | <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> |
| 103 | <p class="firstline">Sets the access control policy on the specified resource. Replaces any</p> |
| 104 | <p class="toc_element"> |
| 105 | <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p> |
| 106 | <p class="firstline">Returns permissions that a caller has on the specified resource.</p> |
| 107 | <p class="toc_element"> |
| 108 | <code><a href="#updateParameters">updateParameters(name, body=None, x__xgafv=None)</a></code></p> |
| 109 | <p class="firstline">Updates the defined Memcached Parameters for an existing Instance.</p> |
| 110 | <h3>Method Details</h3> |
| 111 | <div class="method"> |
| 112 | <code class="details" id="applyParameters">applyParameters(name, body=None, x__xgafv=None)</code> |
| 113 | <pre>ApplyParameters will update current set of Parameters to the set of |
| 114 | specified nodes of the Memcached Instance. |
| 115 | |
| 116 | Args: |
| 117 | name: string, Required. Resource name of the Memcached instance for which parameter group updates |
| 118 | should be applied. (required) |
| 119 | body: object, The request body. |
| 120 | The object takes the form of: |
| 121 | |
| 122 | { # Request for ApplyParameters. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 123 | "applyAll": True or False, # Whether to apply instance-level parameter group to all nodes. If set to |
| 124 | # true, will explicitly restrict users from specifying any nodes, and apply |
| 125 | # parameter group updates to all nodes within the instance. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 126 | "nodeIds": [ # Nodes to which we should apply the instance-level parameter group. |
| 127 | "A String", |
| 128 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 129 | } |
| 130 | |
| 131 | x__xgafv: string, V1 error format. |
| 132 | Allowed values |
| 133 | 1 - v1 error format |
| 134 | 2 - v2 error format |
| 135 | |
| 136 | Returns: |
| 137 | An object of the form: |
| 138 | |
| 139 | { # This resource represents a long-running operation that is the result of a |
| 140 | # network API call. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 141 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 142 | # contains progress information and common metadata such as create time. |
| 143 | # Some services might not provide such metadata. Any method that returns a |
| 144 | # long-running operation should document the metadata type, if any. |
| 145 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 146 | }, |
| 147 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 148 | # If `true`, the operation is completed, and either `error` or `response` is |
| 149 | # available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 150 | "response": { # The normal response of the operation in case of success. If the original |
| 151 | # method returns no data on success, such as `Delete`, the response is |
| 152 | # `google.protobuf.Empty`. If the original method is standard |
| 153 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 154 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 155 | # is the original method name. For example, if the original method name |
| 156 | # is `TakeSnapshot()`, the inferred response type is |
| 157 | # `TakeSnapshotResponse`. |
| 158 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 159 | }, |
| 160 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 161 | # originally returns it. If you use the default HTTP mapping, the |
| 162 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| 163 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 164 | # different programming environments, including REST APIs and RPC APIs. It is |
| 165 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 166 | # three pieces of data: error code, error message, and error details. |
| 167 | # |
| 168 | # You can find out more about this error model and how to work with it in the |
| 169 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 170 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 171 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 172 | # user-facing error message should be localized and sent in the |
| 173 | # google.rpc.Status.details field, or localized by the client. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 174 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 175 | # message types for APIs to use. |
| 176 | { |
| 177 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 178 | }, |
| 179 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 180 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 181 | }</pre> |
| 182 | </div> |
| 183 | |
| 184 | <div class="method"> |
| 185 | <code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code> |
| 186 | <pre>Creates a new Instance in a given project and location. |
| 187 | |
| 188 | Args: |
| 189 | parent: string, Required. The resource name of the instance location using the form: |
| 190 | `projects/{project_id}/locations/{location_id}` |
| 191 | where `location_id` refers to a GCP region (required) |
| 192 | body: object, The request body. |
| 193 | The object takes the form of: |
| 194 | |
| 195 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 196 | "memcacheNodes": [ # Output only. List of Memcached nodes. |
| 197 | # Refer to [Node] message for more details. |
| 198 | { |
| 199 | "port": 42, # Output only. The port number of the Memcached server on this node. |
| 200 | "nodeId": "A String", # Output only. Identifier of the Memcached node. The node id does not |
| 201 | # include project or location like the Memcached instance name. |
| 202 | "host": "A String", # Output only. Hostname or IP address of the Memcached node used by the |
| 203 | # clients to connect to the Memcached server on this node. |
| 204 | "zone": "A String", # Output only. Location (GCP Zone) for the Memcached node. |
| 205 | "state": "A String", # Output only. Current state of the Memcached node. |
| 206 | "parameters": { # User defined parameters currently applied to the node. |
| 207 | "id": "A String", # Output only. The unique ID associated with this set of parameters. Users |
| 208 | # can use this id to determine if the parameters associated with the instance |
| 209 | # differ from the parameters associated with the nodes and any action needs |
| 210 | # to be taken to apply parameters on nodes. |
| 211 | "params": { # User defined set of parameters to use in the memcached process. |
| 212 | "a_key": "A String", |
| 213 | }, |
| 214 | }, |
| 215 | }, |
| 216 | ], |
| 217 | "nodeConfig": { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes. |
| 218 | "cpuCount": 42, # Required. Number of cpus per Memcached node. |
| 219 | "memorySizeMb": 42, # Required. Memory size in MiB for each Memcached node. |
| 220 | }, |
| 221 | "memcacheVersion": "A String", # Optional. The major version of Memcached software. |
| 222 | # If not provided, latest supported version will be used. Currently the |
| 223 | # latest supported major version is MEMCACHE_1_5. |
| 224 | # The minor version will be automatically determined by our system based on |
| 225 | # the latest supported minor version. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 226 | "memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. |
| 227 | # System automatically determines the full memcached version for an instance |
| 228 | # based on the input MemcacheVersion. |
| 229 | # The full version format will be "memcached-1.5.16". |
| 230 | "instanceMessages": [ # List of messages that describe current statuses of memcached instance. |
| 231 | { |
| 232 | "code": "A String", # A code that correspond to one type of user-facing message. |
| 233 | "message": "A String", # Message on memcached instance which will be exposed to users. |
| 234 | }, |
| 235 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 236 | "authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine |
| 237 | # [network](/compute/docs/networks-and-firewalls#networks) to which the |
| 238 | # instance is connected. If left unspecified, the `default` network |
| 239 | # will be used. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 240 | "state": "A String", # Output only. The state of this Memcached instance. |
| 241 | "name": "A String", # Required. Unique name of the resource in this scope including project and |
| 242 | # location using the form: |
| 243 | # `projects/{project_id}/locations/{location_id}/instances/{instance_id}` |
| 244 | # |
| 245 | # Note: Memcached instances are managed and addressed at regional level so |
| 246 | # location_id here refers to a GCP region; however, users may choose which |
| 247 | # zones Memcached nodes within an instances should be provisioned in. |
| 248 | # Refer to [zones] field for more details. |
| 249 | "discoveryEndpoint": "A String", # Output only. Endpoint for Discovery API |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 250 | "displayName": "A String", # Optional. User provided name for the instance only used for display |
| 251 | # purposes. Cannot be more than 80 characters. |
| 252 | "nodeCount": 42, # Required. Number of nodes in the Memcached instance. |
| 253 | "createTime": "A String", # Output only. The time the instance was created. |
| 254 | "labels": { # Optional. Resource labels to represent user-provided metadata. |
| 255 | # Refer to cloud documentation on labels for more details. |
| 256 | # https://cloud.google.com/compute/docs/labeling-resources |
| 257 | "a_key": "A String", |
| 258 | }, |
| 259 | "zones": [ # Optional. Zones where Memcached nodes should be provisioned in. |
| 260 | # Memcached nodes will be equally distributed across these zones. If not |
| 261 | # provided, the service will by default create nodes in all zones in the |
| 262 | # region for the instance. |
| 263 | "A String", |
| 264 | ], |
| 265 | "updateTime": "A String", # Output only. The time the instance was updated. |
| 266 | "parameters": { # Optional: User defined parameters to apply to the memcached process |
| 267 | # on each node. |
| 268 | "id": "A String", # Output only. The unique ID associated with this set of parameters. Users |
| 269 | # can use this id to determine if the parameters associated with the instance |
| 270 | # differ from the parameters associated with the nodes and any action needs |
| 271 | # to be taken to apply parameters on nodes. |
| 272 | "params": { # User defined set of parameters to use in the memcached process. |
| 273 | "a_key": "A String", |
| 274 | }, |
| 275 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 276 | } |
| 277 | |
| 278 | instanceId: string, Required. The logical name of the Memcached instance in the user |
| 279 | project with the following restrictions: |
| 280 | |
| 281 | * Must contain only lowercase letters, numbers, and hyphens. |
| 282 | * Must start with a letter. |
| 283 | * Must be between 1-40 characters. |
| 284 | * Must end with a number or a letter. |
| 285 | * Must be unique within the user project / location |
| 286 | x__xgafv: string, V1 error format. |
| 287 | Allowed values |
| 288 | 1 - v1 error format |
| 289 | 2 - v2 error format |
| 290 | |
| 291 | Returns: |
| 292 | An object of the form: |
| 293 | |
| 294 | { # This resource represents a long-running operation that is the result of a |
| 295 | # network API call. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 296 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 297 | # contains progress information and common metadata such as create time. |
| 298 | # Some services might not provide such metadata. Any method that returns a |
| 299 | # long-running operation should document the metadata type, if any. |
| 300 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 301 | }, |
| 302 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 303 | # If `true`, the operation is completed, and either `error` or `response` is |
| 304 | # available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 305 | "response": { # The normal response of the operation in case of success. If the original |
| 306 | # method returns no data on success, such as `Delete`, the response is |
| 307 | # `google.protobuf.Empty`. If the original method is standard |
| 308 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 309 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 310 | # is the original method name. For example, if the original method name |
| 311 | # is `TakeSnapshot()`, the inferred response type is |
| 312 | # `TakeSnapshotResponse`. |
| 313 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 314 | }, |
| 315 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 316 | # originally returns it. If you use the default HTTP mapping, the |
| 317 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| 318 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 319 | # different programming environments, including REST APIs and RPC APIs. It is |
| 320 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 321 | # three pieces of data: error code, error message, and error details. |
| 322 | # |
| 323 | # You can find out more about this error model and how to work with it in the |
| 324 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 325 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 326 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 327 | # user-facing error message should be localized and sent in the |
| 328 | # google.rpc.Status.details field, or localized by the client. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 329 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 330 | # message types for APIs to use. |
| 331 | { |
| 332 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 333 | }, |
| 334 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 335 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 336 | }</pre> |
| 337 | </div> |
| 338 | |
| 339 | <div class="method"> |
| 340 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 341 | <pre>Deletes a single Instance. |
| 342 | |
| 343 | Args: |
| 344 | name: string, Required. Memcached instance resource name in the format: |
| 345 | `projects/{project_id}/locations/{location_id}/instances/{instance_id}` |
| 346 | where `location_id` refers to a GCP region (required) |
| 347 | x__xgafv: string, V1 error format. |
| 348 | Allowed values |
| 349 | 1 - v1 error format |
| 350 | 2 - v2 error format |
| 351 | |
| 352 | Returns: |
| 353 | An object of the form: |
| 354 | |
| 355 | { # This resource represents a long-running operation that is the result of a |
| 356 | # network API call. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 357 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 358 | # contains progress information and common metadata such as create time. |
| 359 | # Some services might not provide such metadata. Any method that returns a |
| 360 | # long-running operation should document the metadata type, if any. |
| 361 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 362 | }, |
| 363 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 364 | # If `true`, the operation is completed, and either `error` or `response` is |
| 365 | # available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 366 | "response": { # The normal response of the operation in case of success. If the original |
| 367 | # method returns no data on success, such as `Delete`, the response is |
| 368 | # `google.protobuf.Empty`. If the original method is standard |
| 369 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 370 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 371 | # is the original method name. For example, if the original method name |
| 372 | # is `TakeSnapshot()`, the inferred response type is |
| 373 | # `TakeSnapshotResponse`. |
| 374 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 375 | }, |
| 376 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 377 | # originally returns it. If you use the default HTTP mapping, the |
| 378 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| 379 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 380 | # different programming environments, including REST APIs and RPC APIs. It is |
| 381 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 382 | # three pieces of data: error code, error message, and error details. |
| 383 | # |
| 384 | # You can find out more about this error model and how to work with it in the |
| 385 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 386 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 387 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 388 | # user-facing error message should be localized and sent in the |
| 389 | # google.rpc.Status.details field, or localized by the client. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 390 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 391 | # message types for APIs to use. |
| 392 | { |
| 393 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 394 | }, |
| 395 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 396 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 397 | }</pre> |
| 398 | </div> |
| 399 | |
| 400 | <div class="method"> |
| 401 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 402 | <pre>Gets details of a single Instance. |
| 403 | |
| 404 | Args: |
| 405 | name: string, Required. Memcached instance resource name in the format: |
| 406 | `projects/{project_id}/locations/{location_id}/instances/{instance_id}` |
| 407 | where `location_id` refers to a GCP region (required) |
| 408 | x__xgafv: string, V1 error format. |
| 409 | Allowed values |
| 410 | 1 - v1 error format |
| 411 | 2 - v2 error format |
| 412 | |
| 413 | Returns: |
| 414 | An object of the form: |
| 415 | |
| 416 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 417 | "memcacheNodes": [ # Output only. List of Memcached nodes. |
| 418 | # Refer to [Node] message for more details. |
| 419 | { |
| 420 | "port": 42, # Output only. The port number of the Memcached server on this node. |
| 421 | "nodeId": "A String", # Output only. Identifier of the Memcached node. The node id does not |
| 422 | # include project or location like the Memcached instance name. |
| 423 | "host": "A String", # Output only. Hostname or IP address of the Memcached node used by the |
| 424 | # clients to connect to the Memcached server on this node. |
| 425 | "zone": "A String", # Output only. Location (GCP Zone) for the Memcached node. |
| 426 | "state": "A String", # Output only. Current state of the Memcached node. |
| 427 | "parameters": { # User defined parameters currently applied to the node. |
| 428 | "id": "A String", # Output only. The unique ID associated with this set of parameters. Users |
| 429 | # can use this id to determine if the parameters associated with the instance |
| 430 | # differ from the parameters associated with the nodes and any action needs |
| 431 | # to be taken to apply parameters on nodes. |
| 432 | "params": { # User defined set of parameters to use in the memcached process. |
| 433 | "a_key": "A String", |
| 434 | }, |
| 435 | }, |
| 436 | }, |
| 437 | ], |
| 438 | "nodeConfig": { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes. |
| 439 | "cpuCount": 42, # Required. Number of cpus per Memcached node. |
| 440 | "memorySizeMb": 42, # Required. Memory size in MiB for each Memcached node. |
| 441 | }, |
| 442 | "memcacheVersion": "A String", # Optional. The major version of Memcached software. |
| 443 | # If not provided, latest supported version will be used. Currently the |
| 444 | # latest supported major version is MEMCACHE_1_5. |
| 445 | # The minor version will be automatically determined by our system based on |
| 446 | # the latest supported minor version. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 447 | "memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. |
| 448 | # System automatically determines the full memcached version for an instance |
| 449 | # based on the input MemcacheVersion. |
| 450 | # The full version format will be "memcached-1.5.16". |
| 451 | "instanceMessages": [ # List of messages that describe current statuses of memcached instance. |
| 452 | { |
| 453 | "code": "A String", # A code that correspond to one type of user-facing message. |
| 454 | "message": "A String", # Message on memcached instance which will be exposed to users. |
| 455 | }, |
| 456 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 457 | "authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine |
| 458 | # [network](/compute/docs/networks-and-firewalls#networks) to which the |
| 459 | # instance is connected. If left unspecified, the `default` network |
| 460 | # will be used. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 461 | "state": "A String", # Output only. The state of this Memcached instance. |
| 462 | "name": "A String", # Required. Unique name of the resource in this scope including project and |
| 463 | # location using the form: |
| 464 | # `projects/{project_id}/locations/{location_id}/instances/{instance_id}` |
| 465 | # |
| 466 | # Note: Memcached instances are managed and addressed at regional level so |
| 467 | # location_id here refers to a GCP region; however, users may choose which |
| 468 | # zones Memcached nodes within an instances should be provisioned in. |
| 469 | # Refer to [zones] field for more details. |
| 470 | "discoveryEndpoint": "A String", # Output only. Endpoint for Discovery API |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 471 | "displayName": "A String", # Optional. User provided name for the instance only used for display |
| 472 | # purposes. Cannot be more than 80 characters. |
| 473 | "nodeCount": 42, # Required. Number of nodes in the Memcached instance. |
| 474 | "createTime": "A String", # Output only. The time the instance was created. |
| 475 | "labels": { # Optional. Resource labels to represent user-provided metadata. |
| 476 | # Refer to cloud documentation on labels for more details. |
| 477 | # https://cloud.google.com/compute/docs/labeling-resources |
| 478 | "a_key": "A String", |
| 479 | }, |
| 480 | "zones": [ # Optional. Zones where Memcached nodes should be provisioned in. |
| 481 | # Memcached nodes will be equally distributed across these zones. If not |
| 482 | # provided, the service will by default create nodes in all zones in the |
| 483 | # region for the instance. |
| 484 | "A String", |
| 485 | ], |
| 486 | "updateTime": "A String", # Output only. The time the instance was updated. |
| 487 | "parameters": { # Optional: User defined parameters to apply to the memcached process |
| 488 | # on each node. |
| 489 | "id": "A String", # Output only. The unique ID associated with this set of parameters. Users |
| 490 | # can use this id to determine if the parameters associated with the instance |
| 491 | # differ from the parameters associated with the nodes and any action needs |
| 492 | # to be taken to apply parameters on nodes. |
| 493 | "params": { # User defined set of parameters to use in the memcached process. |
| 494 | "a_key": "A String", |
| 495 | }, |
| 496 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 497 | }</pre> |
| 498 | </div> |
| 499 | |
| 500 | <div class="method"> |
| 501 | <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code> |
| 502 | <pre>Gets the access control policy for a resource. |
| 503 | Returns an empty policy if the resource exists and does not have a policy |
| 504 | set. |
| 505 | |
| 506 | Args: |
| 507 | resource: string, REQUIRED: The resource for which the policy is being requested. |
| 508 | See the operation documentation for the appropriate value for this field. (required) |
| 509 | options_requestedPolicyVersion: integer, Optional. The policy format version to be returned. |
| 510 | |
| 511 | Valid values are 0, 1, and 3. Requests specifying an invalid value will be |
| 512 | rejected. |
| 513 | |
| 514 | Requests for policies with any conditional bindings must specify version 3. |
| 515 | Policies without any conditional bindings may specify any valid value or |
| 516 | leave the field unset. |
| 517 | |
| 518 | To learn which resources support conditions in their IAM policies, see the |
| 519 | [IAM |
| 520 | documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 521 | x__xgafv: string, V1 error format. |
| 522 | Allowed values |
| 523 | 1 - v1 error format |
| 524 | 2 - v2 error format |
| 525 | |
| 526 | Returns: |
| 527 | An object of the form: |
| 528 | |
| 529 | { # An Identity and Access Management (IAM) policy, which specifies access |
| 530 | # controls for Google Cloud resources. |
| 531 | # |
| 532 | # |
| 533 | # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| 534 | # `members` to a single `role`. Members can be user accounts, service accounts, |
| 535 | # Google groups, and domains (such as G Suite). A `role` is a named list of |
| 536 | # permissions; each `role` can be an IAM predefined role or a user-created |
| 537 | # custom role. |
| 538 | # |
| 539 | # For some types of Google Cloud resources, a `binding` can also specify a |
| 540 | # `condition`, which is a logical expression that allows access to a resource |
| 541 | # only if the expression evaluates to `true`. A condition can add constraints |
| 542 | # based on attributes of the request, the resource, or both. To learn which |
| 543 | # resources support conditions in their IAM policies, see the |
| 544 | # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 545 | # |
| 546 | # **JSON example:** |
| 547 | # |
| 548 | # { |
| 549 | # "bindings": [ |
| 550 | # { |
| 551 | # "role": "roles/resourcemanager.organizationAdmin", |
| 552 | # "members": [ |
| 553 | # "user:mike@example.com", |
| 554 | # "group:admins@example.com", |
| 555 | # "domain:google.com", |
| 556 | # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| 557 | # ] |
| 558 | # }, |
| 559 | # { |
| 560 | # "role": "roles/resourcemanager.organizationViewer", |
| 561 | # "members": [ |
| 562 | # "user:eve@example.com" |
| 563 | # ], |
| 564 | # "condition": { |
| 565 | # "title": "expirable access", |
| 566 | # "description": "Does not grant access after Sep 2020", |
| 567 | # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| 568 | # } |
| 569 | # } |
| 570 | # ], |
| 571 | # "etag": "BwWWja0YfJA=", |
| 572 | # "version": 3 |
| 573 | # } |
| 574 | # |
| 575 | # **YAML example:** |
| 576 | # |
| 577 | # bindings: |
| 578 | # - members: |
| 579 | # - user:mike@example.com |
| 580 | # - group:admins@example.com |
| 581 | # - domain:google.com |
| 582 | # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| 583 | # role: roles/resourcemanager.organizationAdmin |
| 584 | # - members: |
| 585 | # - user:eve@example.com |
| 586 | # role: roles/resourcemanager.organizationViewer |
| 587 | # condition: |
| 588 | # title: expirable access |
| 589 | # description: Does not grant access after Sep 2020 |
| 590 | # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| 591 | # - etag: BwWWja0YfJA= |
| 592 | # - version: 3 |
| 593 | # |
| 594 | # For a description of IAM and its features, see the |
| 595 | # [IAM documentation](https://cloud.google.com/iam/docs/). |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 596 | "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| 597 | # `condition` that determines how and when the `bindings` are applied. Each |
| 598 | # of the `bindings` must contain at least one member. |
| 599 | { # Associates `members` with a `role`. |
| 600 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. |
| 601 | # |
| 602 | # If the condition evaluates to `true`, then this binding applies to the |
| 603 | # current request. |
| 604 | # |
| 605 | # If the condition evaluates to `false`, then this binding does not apply to |
| 606 | # the current request. However, a different role binding might grant the same |
| 607 | # role to one or more of the members in this binding. |
| 608 | # |
| 609 | # To learn which resources support conditions in their IAM policies, see the |
| 610 | # [IAM |
| 611 | # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 612 | # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| 613 | # are documented at https://github.com/google/cel-spec. |
| 614 | # |
| 615 | # Example (Comparison): |
| 616 | # |
| 617 | # title: "Summary size limit" |
| 618 | # description: "Determines if a summary is less than 100 chars" |
| 619 | # expression: "document.summary.size() < 100" |
| 620 | # |
| 621 | # Example (Equality): |
| 622 | # |
| 623 | # title: "Requestor is owner" |
| 624 | # description: "Determines if requestor is the document owner" |
| 625 | # expression: "document.owner == request.auth.claims.email" |
| 626 | # |
| 627 | # Example (Logic): |
| 628 | # |
| 629 | # title: "Public documents" |
| 630 | # description: "Determine whether the document should be publicly visible" |
| 631 | # expression: "document.type != 'private' && document.type != 'internal'" |
| 632 | # |
| 633 | # Example (Data Manipulation): |
| 634 | # |
| 635 | # title: "Notification string" |
| 636 | # description: "Create a notification string with a timestamp." |
| 637 | # expression: "'New message received at ' + string(document.create_time)" |
| 638 | # |
| 639 | # The exact variables and functions that may be referenced within an expression |
| 640 | # are determined by the service that evaluates it. See the service |
| 641 | # documentation for additional information. |
| 642 | "expression": "A String", # Textual representation of an expression in Common Expression Language |
| 643 | # syntax. |
| 644 | "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| 645 | # its purpose. This can be used e.g. in UIs which allow to enter the |
| 646 | # expression. |
| 647 | "location": "A String", # Optional. String indicating the location of the expression for error |
| 648 | # reporting, e.g. a file name and a position in the file. |
| 649 | "description": "A String", # Optional. Description of the expression. This is a longer text which |
| 650 | # describes the expression, e.g. when hovered over it in a UI. |
| 651 | }, |
| 652 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| 653 | # `members` can have the following values: |
| 654 | # |
| 655 | # * `allUsers`: A special identifier that represents anyone who is |
| 656 | # on the internet; with or without a Google account. |
| 657 | # |
| 658 | # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| 659 | # who is authenticated with a Google account or a service account. |
| 660 | # |
| 661 | # * `user:{emailid}`: An email address that represents a specific Google |
| 662 | # account. For example, `alice@example.com` . |
| 663 | # |
| 664 | # |
| 665 | # * `serviceAccount:{emailid}`: An email address that represents a service |
| 666 | # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| 667 | # |
| 668 | # * `group:{emailid}`: An email address that represents a Google group. |
| 669 | # For example, `admins@example.com`. |
| 670 | # |
| 671 | # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| 672 | # identifier) representing a user that has been recently deleted. For |
| 673 | # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| 674 | # recovered, this value reverts to `user:{emailid}` and the recovered user |
| 675 | # retains the role in the binding. |
| 676 | # |
| 677 | # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| 678 | # unique identifier) representing a service account that has been recently |
| 679 | # deleted. For example, |
| 680 | # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| 681 | # If the service account is undeleted, this value reverts to |
| 682 | # `serviceAccount:{emailid}` and the undeleted service account retains the |
| 683 | # role in the binding. |
| 684 | # |
| 685 | # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| 686 | # identifier) representing a Google group that has been recently |
| 687 | # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| 688 | # the group is recovered, this value reverts to `group:{emailid}` and the |
| 689 | # recovered group retains the role in the binding. |
| 690 | # |
| 691 | # |
| 692 | # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| 693 | # users of that domain. For example, `google.com` or `example.com`. |
| 694 | # |
| 695 | "A String", |
| 696 | ], |
| 697 | "role": "A String", # Role that is assigned to `members`. |
| 698 | # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| 699 | }, |
| 700 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 701 | "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| 702 | # prevent simultaneous updates of a policy from overwriting each other. |
| 703 | # It is strongly suggested that systems make use of the `etag` in the |
| 704 | # read-modify-write cycle to perform policy updates in order to avoid race |
| 705 | # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| 706 | # systems are expected to put that etag in the request to `setIamPolicy` to |
| 707 | # ensure that their change will be applied to the same version of the policy. |
| 708 | # |
| 709 | # **Important:** If you use IAM Conditions, you must include the `etag` field |
| 710 | # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| 711 | # you to overwrite a version `3` policy with a version `1` policy, and all of |
| 712 | # the conditions in the version `3` policy are lost. |
| 713 | "version": 42, # Specifies the format of the policy. |
| 714 | # |
| 715 | # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| 716 | # are rejected. |
| 717 | # |
| 718 | # Any operation that affects conditional role bindings must specify version |
| 719 | # `3`. This requirement applies to the following operations: |
| 720 | # |
| 721 | # * Getting a policy that includes a conditional role binding |
| 722 | # * Adding a conditional role binding to a policy |
| 723 | # * Changing a conditional role binding in a policy |
| 724 | # * Removing any role binding, with or without a condition, from a policy |
| 725 | # that includes conditions |
| 726 | # |
| 727 | # **Important:** If you use IAM Conditions, you must include the `etag` field |
| 728 | # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| 729 | # you to overwrite a version `3` policy with a version `1` policy, and all of |
| 730 | # the conditions in the version `3` policy are lost. |
| 731 | # |
| 732 | # If a policy does not include any conditions, operations on that policy may |
| 733 | # specify any valid version or leave the field unset. |
| 734 | # |
| 735 | # To learn which resources support conditions in their IAM policies, see the |
| 736 | # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 737 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| 738 | { # Specifies the audit configuration for a service. |
| 739 | # The configuration determines which permission types are logged, and what |
| 740 | # identities, if any, are exempted from logging. |
| 741 | # An AuditConfig must have one or more AuditLogConfigs. |
| 742 | # |
| 743 | # If there are AuditConfigs for both `allServices` and a specific service, |
| 744 | # the union of the two AuditConfigs is used for that service: the log_types |
| 745 | # specified in each AuditConfig are enabled, and the exempted_members in each |
| 746 | # AuditLogConfig are exempted. |
| 747 | # |
| 748 | # Example Policy with multiple AuditConfigs: |
| 749 | # |
| 750 | # { |
| 751 | # "audit_configs": [ |
| 752 | # { |
| 753 | # "service": "allServices" |
| 754 | # "audit_log_configs": [ |
| 755 | # { |
| 756 | # "log_type": "DATA_READ", |
| 757 | # "exempted_members": [ |
| 758 | # "user:jose@example.com" |
| 759 | # ] |
| 760 | # }, |
| 761 | # { |
| 762 | # "log_type": "DATA_WRITE", |
| 763 | # }, |
| 764 | # { |
| 765 | # "log_type": "ADMIN_READ", |
| 766 | # } |
| 767 | # ] |
| 768 | # }, |
| 769 | # { |
| 770 | # "service": "sampleservice.googleapis.com" |
| 771 | # "audit_log_configs": [ |
| 772 | # { |
| 773 | # "log_type": "DATA_READ", |
| 774 | # }, |
| 775 | # { |
| 776 | # "log_type": "DATA_WRITE", |
| 777 | # "exempted_members": [ |
| 778 | # "user:aliya@example.com" |
| 779 | # ] |
| 780 | # } |
| 781 | # ] |
| 782 | # } |
| 783 | # ] |
| 784 | # } |
| 785 | # |
| 786 | # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| 787 | # logging. It also exempts jose@example.com from DATA_READ logging, and |
| 788 | # aliya@example.com from DATA_WRITE logging. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 789 | "service": "A String", # Specifies a service that will be enabled for audit logging. |
| 790 | # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. |
| 791 | # `allServices` is a special value that covers all services. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 792 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| 793 | { # Provides the configuration for logging a type of permissions. |
| 794 | # Example: |
| 795 | # |
| 796 | # { |
| 797 | # "audit_log_configs": [ |
| 798 | # { |
| 799 | # "log_type": "DATA_READ", |
| 800 | # "exempted_members": [ |
| 801 | # "user:jose@example.com" |
| 802 | # ] |
| 803 | # }, |
| 804 | # { |
| 805 | # "log_type": "DATA_WRITE", |
| 806 | # } |
| 807 | # ] |
| 808 | # } |
| 809 | # |
| 810 | # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| 811 | # jose@example.com from DATA_READ logging. |
| 812 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of |
| 813 | # permission. |
| 814 | # Follows the same format of Binding.members. |
| 815 | "A String", |
| 816 | ], |
| 817 | "logType": "A String", # The log type that this config enables. |
| 818 | }, |
| 819 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 820 | }, |
| 821 | ], |
| 822 | }</pre> |
| 823 | </div> |
| 824 | |
| 825 | <div class="method"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 826 | <code class="details" id="list">list(parent, pageToken=None, orderBy=None, pageSize=None, filter=None, x__xgafv=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 827 | <pre>Lists Instances in a given project and location. |
| 828 | |
| 829 | Args: |
| 830 | parent: string, Required. The resource name of the instance location using the form: |
| 831 | `projects/{project_id}/locations/{location_id}` |
| 832 | where `location_id` refers to a GCP region (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 833 | pageToken: string, The next_page_token value returned from a previous List request, |
| 834 | if any. |
| 835 | orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted). |
| 836 | pageSize: integer, The maximum number of items to return. |
| 837 | |
| 838 | If not specified, a default value of 1000 will be used by the service. |
| 839 | Regardless of the page_size value, the response may include a partial list |
| 840 | and a caller should only rely on response's |
| 841 | next_page_token |
| 842 | to determine if there are more instances left to be queried. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 843 | filter: string, List filter. For example, exclude all Memcached instances with name as |
| 844 | my-instance by specifying "name != my-instance". |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 845 | x__xgafv: string, V1 error format. |
| 846 | Allowed values |
| 847 | 1 - v1 error format |
| 848 | 2 - v2 error format |
| 849 | |
| 850 | Returns: |
| 851 | An object of the form: |
| 852 | |
| 853 | { # Response for ListInstances. |
| 854 | "resources": [ # A list of Memcached instances in the project in the specified location, |
| 855 | # or across all locations. |
| 856 | # |
| 857 | # If the `location_id` in the parent field of the request is "-", all regions |
| 858 | # available to the project are queried, and the results aggregated. |
| 859 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 860 | "memcacheNodes": [ # Output only. List of Memcached nodes. |
| 861 | # Refer to [Node] message for more details. |
| 862 | { |
| 863 | "port": 42, # Output only. The port number of the Memcached server on this node. |
| 864 | "nodeId": "A String", # Output only. Identifier of the Memcached node. The node id does not |
| 865 | # include project or location like the Memcached instance name. |
| 866 | "host": "A String", # Output only. Hostname or IP address of the Memcached node used by the |
| 867 | # clients to connect to the Memcached server on this node. |
| 868 | "zone": "A String", # Output only. Location (GCP Zone) for the Memcached node. |
| 869 | "state": "A String", # Output only. Current state of the Memcached node. |
| 870 | "parameters": { # User defined parameters currently applied to the node. |
| 871 | "id": "A String", # Output only. The unique ID associated with this set of parameters. Users |
| 872 | # can use this id to determine if the parameters associated with the instance |
| 873 | # differ from the parameters associated with the nodes and any action needs |
| 874 | # to be taken to apply parameters on nodes. |
| 875 | "params": { # User defined set of parameters to use in the memcached process. |
| 876 | "a_key": "A String", |
| 877 | }, |
| 878 | }, |
| 879 | }, |
| 880 | ], |
| 881 | "nodeConfig": { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes. |
| 882 | "cpuCount": 42, # Required. Number of cpus per Memcached node. |
| 883 | "memorySizeMb": 42, # Required. Memory size in MiB for each Memcached node. |
| 884 | }, |
| 885 | "memcacheVersion": "A String", # Optional. The major version of Memcached software. |
| 886 | # If not provided, latest supported version will be used. Currently the |
| 887 | # latest supported major version is MEMCACHE_1_5. |
| 888 | # The minor version will be automatically determined by our system based on |
| 889 | # the latest supported minor version. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 890 | "memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. |
| 891 | # System automatically determines the full memcached version for an instance |
| 892 | # based on the input MemcacheVersion. |
| 893 | # The full version format will be "memcached-1.5.16". |
| 894 | "instanceMessages": [ # List of messages that describe current statuses of memcached instance. |
| 895 | { |
| 896 | "code": "A String", # A code that correspond to one type of user-facing message. |
| 897 | "message": "A String", # Message on memcached instance which will be exposed to users. |
| 898 | }, |
| 899 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 900 | "authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine |
| 901 | # [network](/compute/docs/networks-and-firewalls#networks) to which the |
| 902 | # instance is connected. If left unspecified, the `default` network |
| 903 | # will be used. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 904 | "state": "A String", # Output only. The state of this Memcached instance. |
| 905 | "name": "A String", # Required. Unique name of the resource in this scope including project and |
| 906 | # location using the form: |
| 907 | # `projects/{project_id}/locations/{location_id}/instances/{instance_id}` |
| 908 | # |
| 909 | # Note: Memcached instances are managed and addressed at regional level so |
| 910 | # location_id here refers to a GCP region; however, users may choose which |
| 911 | # zones Memcached nodes within an instances should be provisioned in. |
| 912 | # Refer to [zones] field for more details. |
| 913 | "discoveryEndpoint": "A String", # Output only. Endpoint for Discovery API |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 914 | "displayName": "A String", # Optional. User provided name for the instance only used for display |
| 915 | # purposes. Cannot be more than 80 characters. |
| 916 | "nodeCount": 42, # Required. Number of nodes in the Memcached instance. |
| 917 | "createTime": "A String", # Output only. The time the instance was created. |
| 918 | "labels": { # Optional. Resource labels to represent user-provided metadata. |
| 919 | # Refer to cloud documentation on labels for more details. |
| 920 | # https://cloud.google.com/compute/docs/labeling-resources |
| 921 | "a_key": "A String", |
| 922 | }, |
| 923 | "zones": [ # Optional. Zones where Memcached nodes should be provisioned in. |
| 924 | # Memcached nodes will be equally distributed across these zones. If not |
| 925 | # provided, the service will by default create nodes in all zones in the |
| 926 | # region for the instance. |
| 927 | "A String", |
| 928 | ], |
| 929 | "updateTime": "A String", # Output only. The time the instance was updated. |
| 930 | "parameters": { # Optional: User defined parameters to apply to the memcached process |
| 931 | # on each node. |
| 932 | "id": "A String", # Output only. The unique ID associated with this set of parameters. Users |
| 933 | # can use this id to determine if the parameters associated with the instance |
| 934 | # differ from the parameters associated with the nodes and any action needs |
| 935 | # to be taken to apply parameters on nodes. |
| 936 | "params": { # User defined set of parameters to use in the memcached process. |
| 937 | "a_key": "A String", |
| 938 | }, |
| 939 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 940 | }, |
| 941 | ], |
| 942 | "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more |
| 943 | # results in the list. |
| 944 | "unreachable": [ # Locations that could not be reached. |
| 945 | "A String", |
| 946 | ], |
| 947 | }</pre> |
| 948 | </div> |
| 949 | |
| 950 | <div class="method"> |
| 951 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 952 | <pre>Retrieves the next page of results. |
| 953 | |
| 954 | Args: |
| 955 | previous_request: The request for the previous page. (required) |
| 956 | previous_response: The response from the request for the previous page. (required) |
| 957 | |
| 958 | Returns: |
| 959 | A request object that you can call 'execute()' on to request the next |
| 960 | page. Returns None if there are no more items in the collection. |
| 961 | </pre> |
| 962 | </div> |
| 963 | |
| 964 | <div class="method"> |
| 965 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| 966 | <pre>Updates an existing Instance in a given project and location. |
| 967 | |
| 968 | Args: |
| 969 | name: string, Required. Unique name of the resource in this scope including project and |
| 970 | location using the form: |
| 971 | `projects/{project_id}/locations/{location_id}/instances/{instance_id}` |
| 972 | |
| 973 | Note: Memcached instances are managed and addressed at regional level so |
| 974 | location_id here refers to a GCP region; however, users may choose which |
| 975 | zones Memcached nodes within an instances should be provisioned in. |
| 976 | Refer to [zones] field for more details. (required) |
| 977 | body: object, The request body. |
| 978 | The object takes the form of: |
| 979 | |
| 980 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 981 | "memcacheNodes": [ # Output only. List of Memcached nodes. |
| 982 | # Refer to [Node] message for more details. |
| 983 | { |
| 984 | "port": 42, # Output only. The port number of the Memcached server on this node. |
| 985 | "nodeId": "A String", # Output only. Identifier of the Memcached node. The node id does not |
| 986 | # include project or location like the Memcached instance name. |
| 987 | "host": "A String", # Output only. Hostname or IP address of the Memcached node used by the |
| 988 | # clients to connect to the Memcached server on this node. |
| 989 | "zone": "A String", # Output only. Location (GCP Zone) for the Memcached node. |
| 990 | "state": "A String", # Output only. Current state of the Memcached node. |
| 991 | "parameters": { # User defined parameters currently applied to the node. |
| 992 | "id": "A String", # Output only. The unique ID associated with this set of parameters. Users |
| 993 | # can use this id to determine if the parameters associated with the instance |
| 994 | # differ from the parameters associated with the nodes and any action needs |
| 995 | # to be taken to apply parameters on nodes. |
| 996 | "params": { # User defined set of parameters to use in the memcached process. |
| 997 | "a_key": "A String", |
| 998 | }, |
| 999 | }, |
| 1000 | }, |
| 1001 | ], |
| 1002 | "nodeConfig": { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes. |
| 1003 | "cpuCount": 42, # Required. Number of cpus per Memcached node. |
| 1004 | "memorySizeMb": 42, # Required. Memory size in MiB for each Memcached node. |
| 1005 | }, |
| 1006 | "memcacheVersion": "A String", # Optional. The major version of Memcached software. |
| 1007 | # If not provided, latest supported version will be used. Currently the |
| 1008 | # latest supported major version is MEMCACHE_1_5. |
| 1009 | # The minor version will be automatically determined by our system based on |
| 1010 | # the latest supported minor version. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1011 | "memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. |
| 1012 | # System automatically determines the full memcached version for an instance |
| 1013 | # based on the input MemcacheVersion. |
| 1014 | # The full version format will be "memcached-1.5.16". |
| 1015 | "instanceMessages": [ # List of messages that describe current statuses of memcached instance. |
| 1016 | { |
| 1017 | "code": "A String", # A code that correspond to one type of user-facing message. |
| 1018 | "message": "A String", # Message on memcached instance which will be exposed to users. |
| 1019 | }, |
| 1020 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1021 | "authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine |
| 1022 | # [network](/compute/docs/networks-and-firewalls#networks) to which the |
| 1023 | # instance is connected. If left unspecified, the `default` network |
| 1024 | # will be used. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1025 | "state": "A String", # Output only. The state of this Memcached instance. |
| 1026 | "name": "A String", # Required. Unique name of the resource in this scope including project and |
| 1027 | # location using the form: |
| 1028 | # `projects/{project_id}/locations/{location_id}/instances/{instance_id}` |
| 1029 | # |
| 1030 | # Note: Memcached instances are managed and addressed at regional level so |
| 1031 | # location_id here refers to a GCP region; however, users may choose which |
| 1032 | # zones Memcached nodes within an instances should be provisioned in. |
| 1033 | # Refer to [zones] field for more details. |
| 1034 | "discoveryEndpoint": "A String", # Output only. Endpoint for Discovery API |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1035 | "displayName": "A String", # Optional. User provided name for the instance only used for display |
| 1036 | # purposes. Cannot be more than 80 characters. |
| 1037 | "nodeCount": 42, # Required. Number of nodes in the Memcached instance. |
| 1038 | "createTime": "A String", # Output only. The time the instance was created. |
| 1039 | "labels": { # Optional. Resource labels to represent user-provided metadata. |
| 1040 | # Refer to cloud documentation on labels for more details. |
| 1041 | # https://cloud.google.com/compute/docs/labeling-resources |
| 1042 | "a_key": "A String", |
| 1043 | }, |
| 1044 | "zones": [ # Optional. Zones where Memcached nodes should be provisioned in. |
| 1045 | # Memcached nodes will be equally distributed across these zones. If not |
| 1046 | # provided, the service will by default create nodes in all zones in the |
| 1047 | # region for the instance. |
| 1048 | "A String", |
| 1049 | ], |
| 1050 | "updateTime": "A String", # Output only. The time the instance was updated. |
| 1051 | "parameters": { # Optional: User defined parameters to apply to the memcached process |
| 1052 | # on each node. |
| 1053 | "id": "A String", # Output only. The unique ID associated with this set of parameters. Users |
| 1054 | # can use this id to determine if the parameters associated with the instance |
| 1055 | # differ from the parameters associated with the nodes and any action needs |
| 1056 | # to be taken to apply parameters on nodes. |
| 1057 | "params": { # User defined set of parameters to use in the memcached process. |
| 1058 | "a_key": "A String", |
| 1059 | }, |
| 1060 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1061 | } |
| 1062 | |
| 1063 | updateMask: string, Required. Mask of fields to update. |
| 1064 | * `displayName` |
| 1065 | x__xgafv: string, V1 error format. |
| 1066 | Allowed values |
| 1067 | 1 - v1 error format |
| 1068 | 2 - v2 error format |
| 1069 | |
| 1070 | Returns: |
| 1071 | An object of the form: |
| 1072 | |
| 1073 | { # This resource represents a long-running operation that is the result of a |
| 1074 | # network API call. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1075 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 1076 | # contains progress information and common metadata such as create time. |
| 1077 | # Some services might not provide such metadata. Any method that returns a |
| 1078 | # long-running operation should document the metadata type, if any. |
| 1079 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1080 | }, |
| 1081 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 1082 | # If `true`, the operation is completed, and either `error` or `response` is |
| 1083 | # available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1084 | "response": { # The normal response of the operation in case of success. If the original |
| 1085 | # method returns no data on success, such as `Delete`, the response is |
| 1086 | # `google.protobuf.Empty`. If the original method is standard |
| 1087 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 1088 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 1089 | # is the original method name. For example, if the original method name |
| 1090 | # is `TakeSnapshot()`, the inferred response type is |
| 1091 | # `TakeSnapshotResponse`. |
| 1092 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1093 | }, |
| 1094 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 1095 | # originally returns it. If you use the default HTTP mapping, the |
| 1096 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| 1097 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 1098 | # different programming environments, including REST APIs and RPC APIs. It is |
| 1099 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 1100 | # three pieces of data: error code, error message, and error details. |
| 1101 | # |
| 1102 | # You can find out more about this error model and how to work with it in the |
| 1103 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1104 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 1105 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 1106 | # user-facing error message should be localized and sent in the |
| 1107 | # google.rpc.Status.details field, or localized by the client. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1108 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 1109 | # message types for APIs to use. |
| 1110 | { |
| 1111 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1112 | }, |
| 1113 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1114 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1115 | }</pre> |
| 1116 | </div> |
| 1117 | |
| 1118 | <div class="method"> |
| 1119 | <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code> |
| 1120 | <pre>Sets the access control policy on the specified resource. Replaces any |
| 1121 | existing policy. |
| 1122 | |
| 1123 | Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. |
| 1124 | |
| 1125 | Args: |
| 1126 | resource: string, REQUIRED: The resource for which the policy is being specified. |
| 1127 | See the operation documentation for the appropriate value for this field. (required) |
| 1128 | body: object, The request body. |
| 1129 | The object takes the form of: |
| 1130 | |
| 1131 | { # Request message for `SetIamPolicy` method. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1132 | "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of |
| 1133 | # the policy is limited to a few 10s of KB. An empty policy is a |
| 1134 | # valid policy but certain Cloud Platform services (such as Projects) |
| 1135 | # might reject them. |
| 1136 | # controls for Google Cloud resources. |
| 1137 | # |
| 1138 | # |
| 1139 | # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| 1140 | # `members` to a single `role`. Members can be user accounts, service accounts, |
| 1141 | # Google groups, and domains (such as G Suite). A `role` is a named list of |
| 1142 | # permissions; each `role` can be an IAM predefined role or a user-created |
| 1143 | # custom role. |
| 1144 | # |
| 1145 | # For some types of Google Cloud resources, a `binding` can also specify a |
| 1146 | # `condition`, which is a logical expression that allows access to a resource |
| 1147 | # only if the expression evaluates to `true`. A condition can add constraints |
| 1148 | # based on attributes of the request, the resource, or both. To learn which |
| 1149 | # resources support conditions in their IAM policies, see the |
| 1150 | # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 1151 | # |
| 1152 | # **JSON example:** |
| 1153 | # |
| 1154 | # { |
| 1155 | # "bindings": [ |
| 1156 | # { |
| 1157 | # "role": "roles/resourcemanager.organizationAdmin", |
| 1158 | # "members": [ |
| 1159 | # "user:mike@example.com", |
| 1160 | # "group:admins@example.com", |
| 1161 | # "domain:google.com", |
| 1162 | # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| 1163 | # ] |
| 1164 | # }, |
| 1165 | # { |
| 1166 | # "role": "roles/resourcemanager.organizationViewer", |
| 1167 | # "members": [ |
| 1168 | # "user:eve@example.com" |
| 1169 | # ], |
| 1170 | # "condition": { |
| 1171 | # "title": "expirable access", |
| 1172 | # "description": "Does not grant access after Sep 2020", |
| 1173 | # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| 1174 | # } |
| 1175 | # } |
| 1176 | # ], |
| 1177 | # "etag": "BwWWja0YfJA=", |
| 1178 | # "version": 3 |
| 1179 | # } |
| 1180 | # |
| 1181 | # **YAML example:** |
| 1182 | # |
| 1183 | # bindings: |
| 1184 | # - members: |
| 1185 | # - user:mike@example.com |
| 1186 | # - group:admins@example.com |
| 1187 | # - domain:google.com |
| 1188 | # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| 1189 | # role: roles/resourcemanager.organizationAdmin |
| 1190 | # - members: |
| 1191 | # - user:eve@example.com |
| 1192 | # role: roles/resourcemanager.organizationViewer |
| 1193 | # condition: |
| 1194 | # title: expirable access |
| 1195 | # description: Does not grant access after Sep 2020 |
| 1196 | # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| 1197 | # - etag: BwWWja0YfJA= |
| 1198 | # - version: 3 |
| 1199 | # |
| 1200 | # For a description of IAM and its features, see the |
| 1201 | # [IAM documentation](https://cloud.google.com/iam/docs/). |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1202 | "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| 1203 | # `condition` that determines how and when the `bindings` are applied. Each |
| 1204 | # of the `bindings` must contain at least one member. |
| 1205 | { # Associates `members` with a `role`. |
| 1206 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. |
| 1207 | # |
| 1208 | # If the condition evaluates to `true`, then this binding applies to the |
| 1209 | # current request. |
| 1210 | # |
| 1211 | # If the condition evaluates to `false`, then this binding does not apply to |
| 1212 | # the current request. However, a different role binding might grant the same |
| 1213 | # role to one or more of the members in this binding. |
| 1214 | # |
| 1215 | # To learn which resources support conditions in their IAM policies, see the |
| 1216 | # [IAM |
| 1217 | # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 1218 | # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| 1219 | # are documented at https://github.com/google/cel-spec. |
| 1220 | # |
| 1221 | # Example (Comparison): |
| 1222 | # |
| 1223 | # title: "Summary size limit" |
| 1224 | # description: "Determines if a summary is less than 100 chars" |
| 1225 | # expression: "document.summary.size() < 100" |
| 1226 | # |
| 1227 | # Example (Equality): |
| 1228 | # |
| 1229 | # title: "Requestor is owner" |
| 1230 | # description: "Determines if requestor is the document owner" |
| 1231 | # expression: "document.owner == request.auth.claims.email" |
| 1232 | # |
| 1233 | # Example (Logic): |
| 1234 | # |
| 1235 | # title: "Public documents" |
| 1236 | # description: "Determine whether the document should be publicly visible" |
| 1237 | # expression: "document.type != 'private' && document.type != 'internal'" |
| 1238 | # |
| 1239 | # Example (Data Manipulation): |
| 1240 | # |
| 1241 | # title: "Notification string" |
| 1242 | # description: "Create a notification string with a timestamp." |
| 1243 | # expression: "'New message received at ' + string(document.create_time)" |
| 1244 | # |
| 1245 | # The exact variables and functions that may be referenced within an expression |
| 1246 | # are determined by the service that evaluates it. See the service |
| 1247 | # documentation for additional information. |
| 1248 | "expression": "A String", # Textual representation of an expression in Common Expression Language |
| 1249 | # syntax. |
| 1250 | "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| 1251 | # its purpose. This can be used e.g. in UIs which allow to enter the |
| 1252 | # expression. |
| 1253 | "location": "A String", # Optional. String indicating the location of the expression for error |
| 1254 | # reporting, e.g. a file name and a position in the file. |
| 1255 | "description": "A String", # Optional. Description of the expression. This is a longer text which |
| 1256 | # describes the expression, e.g. when hovered over it in a UI. |
| 1257 | }, |
| 1258 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| 1259 | # `members` can have the following values: |
| 1260 | # |
| 1261 | # * `allUsers`: A special identifier that represents anyone who is |
| 1262 | # on the internet; with or without a Google account. |
| 1263 | # |
| 1264 | # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| 1265 | # who is authenticated with a Google account or a service account. |
| 1266 | # |
| 1267 | # * `user:{emailid}`: An email address that represents a specific Google |
| 1268 | # account. For example, `alice@example.com` . |
| 1269 | # |
| 1270 | # |
| 1271 | # * `serviceAccount:{emailid}`: An email address that represents a service |
| 1272 | # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| 1273 | # |
| 1274 | # * `group:{emailid}`: An email address that represents a Google group. |
| 1275 | # For example, `admins@example.com`. |
| 1276 | # |
| 1277 | # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| 1278 | # identifier) representing a user that has been recently deleted. For |
| 1279 | # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| 1280 | # recovered, this value reverts to `user:{emailid}` and the recovered user |
| 1281 | # retains the role in the binding. |
| 1282 | # |
| 1283 | # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| 1284 | # unique identifier) representing a service account that has been recently |
| 1285 | # deleted. For example, |
| 1286 | # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| 1287 | # If the service account is undeleted, this value reverts to |
| 1288 | # `serviceAccount:{emailid}` and the undeleted service account retains the |
| 1289 | # role in the binding. |
| 1290 | # |
| 1291 | # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| 1292 | # identifier) representing a Google group that has been recently |
| 1293 | # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| 1294 | # the group is recovered, this value reverts to `group:{emailid}` and the |
| 1295 | # recovered group retains the role in the binding. |
| 1296 | # |
| 1297 | # |
| 1298 | # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| 1299 | # users of that domain. For example, `google.com` or `example.com`. |
| 1300 | # |
| 1301 | "A String", |
| 1302 | ], |
| 1303 | "role": "A String", # Role that is assigned to `members`. |
| 1304 | # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| 1305 | }, |
| 1306 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1307 | "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| 1308 | # prevent simultaneous updates of a policy from overwriting each other. |
| 1309 | # It is strongly suggested that systems make use of the `etag` in the |
| 1310 | # read-modify-write cycle to perform policy updates in order to avoid race |
| 1311 | # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| 1312 | # systems are expected to put that etag in the request to `setIamPolicy` to |
| 1313 | # ensure that their change will be applied to the same version of the policy. |
| 1314 | # |
| 1315 | # **Important:** If you use IAM Conditions, you must include the `etag` field |
| 1316 | # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| 1317 | # you to overwrite a version `3` policy with a version `1` policy, and all of |
| 1318 | # the conditions in the version `3` policy are lost. |
| 1319 | "version": 42, # Specifies the format of the policy. |
| 1320 | # |
| 1321 | # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| 1322 | # are rejected. |
| 1323 | # |
| 1324 | # Any operation that affects conditional role bindings must specify version |
| 1325 | # `3`. This requirement applies to the following operations: |
| 1326 | # |
| 1327 | # * Getting a policy that includes a conditional role binding |
| 1328 | # * Adding a conditional role binding to a policy |
| 1329 | # * Changing a conditional role binding in a policy |
| 1330 | # * Removing any role binding, with or without a condition, from a policy |
| 1331 | # that includes conditions |
| 1332 | # |
| 1333 | # **Important:** If you use IAM Conditions, you must include the `etag` field |
| 1334 | # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| 1335 | # you to overwrite a version `3` policy with a version `1` policy, and all of |
| 1336 | # the conditions in the version `3` policy are lost. |
| 1337 | # |
| 1338 | # If a policy does not include any conditions, operations on that policy may |
| 1339 | # specify any valid version or leave the field unset. |
| 1340 | # |
| 1341 | # To learn which resources support conditions in their IAM policies, see the |
| 1342 | # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 1343 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| 1344 | { # Specifies the audit configuration for a service. |
| 1345 | # The configuration determines which permission types are logged, and what |
| 1346 | # identities, if any, are exempted from logging. |
| 1347 | # An AuditConfig must have one or more AuditLogConfigs. |
| 1348 | # |
| 1349 | # If there are AuditConfigs for both `allServices` and a specific service, |
| 1350 | # the union of the two AuditConfigs is used for that service: the log_types |
| 1351 | # specified in each AuditConfig are enabled, and the exempted_members in each |
| 1352 | # AuditLogConfig are exempted. |
| 1353 | # |
| 1354 | # Example Policy with multiple AuditConfigs: |
| 1355 | # |
| 1356 | # { |
| 1357 | # "audit_configs": [ |
| 1358 | # { |
| 1359 | # "service": "allServices" |
| 1360 | # "audit_log_configs": [ |
| 1361 | # { |
| 1362 | # "log_type": "DATA_READ", |
| 1363 | # "exempted_members": [ |
| 1364 | # "user:jose@example.com" |
| 1365 | # ] |
| 1366 | # }, |
| 1367 | # { |
| 1368 | # "log_type": "DATA_WRITE", |
| 1369 | # }, |
| 1370 | # { |
| 1371 | # "log_type": "ADMIN_READ", |
| 1372 | # } |
| 1373 | # ] |
| 1374 | # }, |
| 1375 | # { |
| 1376 | # "service": "sampleservice.googleapis.com" |
| 1377 | # "audit_log_configs": [ |
| 1378 | # { |
| 1379 | # "log_type": "DATA_READ", |
| 1380 | # }, |
| 1381 | # { |
| 1382 | # "log_type": "DATA_WRITE", |
| 1383 | # "exempted_members": [ |
| 1384 | # "user:aliya@example.com" |
| 1385 | # ] |
| 1386 | # } |
| 1387 | # ] |
| 1388 | # } |
| 1389 | # ] |
| 1390 | # } |
| 1391 | # |
| 1392 | # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| 1393 | # logging. It also exempts jose@example.com from DATA_READ logging, and |
| 1394 | # aliya@example.com from DATA_WRITE logging. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1395 | "service": "A String", # Specifies a service that will be enabled for audit logging. |
| 1396 | # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. |
| 1397 | # `allServices` is a special value that covers all services. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1398 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| 1399 | { # Provides the configuration for logging a type of permissions. |
| 1400 | # Example: |
| 1401 | # |
| 1402 | # { |
| 1403 | # "audit_log_configs": [ |
| 1404 | # { |
| 1405 | # "log_type": "DATA_READ", |
| 1406 | # "exempted_members": [ |
| 1407 | # "user:jose@example.com" |
| 1408 | # ] |
| 1409 | # }, |
| 1410 | # { |
| 1411 | # "log_type": "DATA_WRITE", |
| 1412 | # } |
| 1413 | # ] |
| 1414 | # } |
| 1415 | # |
| 1416 | # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| 1417 | # jose@example.com from DATA_READ logging. |
| 1418 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of |
| 1419 | # permission. |
| 1420 | # Follows the same format of Binding.members. |
| 1421 | "A String", |
| 1422 | ], |
| 1423 | "logType": "A String", # The log type that this config enables. |
| 1424 | }, |
| 1425 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1426 | }, |
| 1427 | ], |
| 1428 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1429 | "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only |
| 1430 | # the fields in the mask will be modified. If no mask is provided, the |
| 1431 | # following default mask is used: |
| 1432 | # |
| 1433 | # `paths: "bindings, etag"` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1434 | } |
| 1435 | |
| 1436 | x__xgafv: string, V1 error format. |
| 1437 | Allowed values |
| 1438 | 1 - v1 error format |
| 1439 | 2 - v2 error format |
| 1440 | |
| 1441 | Returns: |
| 1442 | An object of the form: |
| 1443 | |
| 1444 | { # An Identity and Access Management (IAM) policy, which specifies access |
| 1445 | # controls for Google Cloud resources. |
| 1446 | # |
| 1447 | # |
| 1448 | # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| 1449 | # `members` to a single `role`. Members can be user accounts, service accounts, |
| 1450 | # Google groups, and domains (such as G Suite). A `role` is a named list of |
| 1451 | # permissions; each `role` can be an IAM predefined role or a user-created |
| 1452 | # custom role. |
| 1453 | # |
| 1454 | # For some types of Google Cloud resources, a `binding` can also specify a |
| 1455 | # `condition`, which is a logical expression that allows access to a resource |
| 1456 | # only if the expression evaluates to `true`. A condition can add constraints |
| 1457 | # based on attributes of the request, the resource, or both. To learn which |
| 1458 | # resources support conditions in their IAM policies, see the |
| 1459 | # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 1460 | # |
| 1461 | # **JSON example:** |
| 1462 | # |
| 1463 | # { |
| 1464 | # "bindings": [ |
| 1465 | # { |
| 1466 | # "role": "roles/resourcemanager.organizationAdmin", |
| 1467 | # "members": [ |
| 1468 | # "user:mike@example.com", |
| 1469 | # "group:admins@example.com", |
| 1470 | # "domain:google.com", |
| 1471 | # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| 1472 | # ] |
| 1473 | # }, |
| 1474 | # { |
| 1475 | # "role": "roles/resourcemanager.organizationViewer", |
| 1476 | # "members": [ |
| 1477 | # "user:eve@example.com" |
| 1478 | # ], |
| 1479 | # "condition": { |
| 1480 | # "title": "expirable access", |
| 1481 | # "description": "Does not grant access after Sep 2020", |
| 1482 | # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| 1483 | # } |
| 1484 | # } |
| 1485 | # ], |
| 1486 | # "etag": "BwWWja0YfJA=", |
| 1487 | # "version": 3 |
| 1488 | # } |
| 1489 | # |
| 1490 | # **YAML example:** |
| 1491 | # |
| 1492 | # bindings: |
| 1493 | # - members: |
| 1494 | # - user:mike@example.com |
| 1495 | # - group:admins@example.com |
| 1496 | # - domain:google.com |
| 1497 | # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| 1498 | # role: roles/resourcemanager.organizationAdmin |
| 1499 | # - members: |
| 1500 | # - user:eve@example.com |
| 1501 | # role: roles/resourcemanager.organizationViewer |
| 1502 | # condition: |
| 1503 | # title: expirable access |
| 1504 | # description: Does not grant access after Sep 2020 |
| 1505 | # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| 1506 | # - etag: BwWWja0YfJA= |
| 1507 | # - version: 3 |
| 1508 | # |
| 1509 | # For a description of IAM and its features, see the |
| 1510 | # [IAM documentation](https://cloud.google.com/iam/docs/). |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1511 | "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| 1512 | # `condition` that determines how and when the `bindings` are applied. Each |
| 1513 | # of the `bindings` must contain at least one member. |
| 1514 | { # Associates `members` with a `role`. |
| 1515 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. |
| 1516 | # |
| 1517 | # If the condition evaluates to `true`, then this binding applies to the |
| 1518 | # current request. |
| 1519 | # |
| 1520 | # If the condition evaluates to `false`, then this binding does not apply to |
| 1521 | # the current request. However, a different role binding might grant the same |
| 1522 | # role to one or more of the members in this binding. |
| 1523 | # |
| 1524 | # To learn which resources support conditions in their IAM policies, see the |
| 1525 | # [IAM |
| 1526 | # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 1527 | # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| 1528 | # are documented at https://github.com/google/cel-spec. |
| 1529 | # |
| 1530 | # Example (Comparison): |
| 1531 | # |
| 1532 | # title: "Summary size limit" |
| 1533 | # description: "Determines if a summary is less than 100 chars" |
| 1534 | # expression: "document.summary.size() < 100" |
| 1535 | # |
| 1536 | # Example (Equality): |
| 1537 | # |
| 1538 | # title: "Requestor is owner" |
| 1539 | # description: "Determines if requestor is the document owner" |
| 1540 | # expression: "document.owner == request.auth.claims.email" |
| 1541 | # |
| 1542 | # Example (Logic): |
| 1543 | # |
| 1544 | # title: "Public documents" |
| 1545 | # description: "Determine whether the document should be publicly visible" |
| 1546 | # expression: "document.type != 'private' && document.type != 'internal'" |
| 1547 | # |
| 1548 | # Example (Data Manipulation): |
| 1549 | # |
| 1550 | # title: "Notification string" |
| 1551 | # description: "Create a notification string with a timestamp." |
| 1552 | # expression: "'New message received at ' + string(document.create_time)" |
| 1553 | # |
| 1554 | # The exact variables and functions that may be referenced within an expression |
| 1555 | # are determined by the service that evaluates it. See the service |
| 1556 | # documentation for additional information. |
| 1557 | "expression": "A String", # Textual representation of an expression in Common Expression Language |
| 1558 | # syntax. |
| 1559 | "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| 1560 | # its purpose. This can be used e.g. in UIs which allow to enter the |
| 1561 | # expression. |
| 1562 | "location": "A String", # Optional. String indicating the location of the expression for error |
| 1563 | # reporting, e.g. a file name and a position in the file. |
| 1564 | "description": "A String", # Optional. Description of the expression. This is a longer text which |
| 1565 | # describes the expression, e.g. when hovered over it in a UI. |
| 1566 | }, |
| 1567 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| 1568 | # `members` can have the following values: |
| 1569 | # |
| 1570 | # * `allUsers`: A special identifier that represents anyone who is |
| 1571 | # on the internet; with or without a Google account. |
| 1572 | # |
| 1573 | # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| 1574 | # who is authenticated with a Google account or a service account. |
| 1575 | # |
| 1576 | # * `user:{emailid}`: An email address that represents a specific Google |
| 1577 | # account. For example, `alice@example.com` . |
| 1578 | # |
| 1579 | # |
| 1580 | # * `serviceAccount:{emailid}`: An email address that represents a service |
| 1581 | # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| 1582 | # |
| 1583 | # * `group:{emailid}`: An email address that represents a Google group. |
| 1584 | # For example, `admins@example.com`. |
| 1585 | # |
| 1586 | # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| 1587 | # identifier) representing a user that has been recently deleted. For |
| 1588 | # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| 1589 | # recovered, this value reverts to `user:{emailid}` and the recovered user |
| 1590 | # retains the role in the binding. |
| 1591 | # |
| 1592 | # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| 1593 | # unique identifier) representing a service account that has been recently |
| 1594 | # deleted. For example, |
| 1595 | # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| 1596 | # If the service account is undeleted, this value reverts to |
| 1597 | # `serviceAccount:{emailid}` and the undeleted service account retains the |
| 1598 | # role in the binding. |
| 1599 | # |
| 1600 | # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| 1601 | # identifier) representing a Google group that has been recently |
| 1602 | # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| 1603 | # the group is recovered, this value reverts to `group:{emailid}` and the |
| 1604 | # recovered group retains the role in the binding. |
| 1605 | # |
| 1606 | # |
| 1607 | # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| 1608 | # users of that domain. For example, `google.com` or `example.com`. |
| 1609 | # |
| 1610 | "A String", |
| 1611 | ], |
| 1612 | "role": "A String", # Role that is assigned to `members`. |
| 1613 | # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| 1614 | }, |
| 1615 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1616 | "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| 1617 | # prevent simultaneous updates of a policy from overwriting each other. |
| 1618 | # It is strongly suggested that systems make use of the `etag` in the |
| 1619 | # read-modify-write cycle to perform policy updates in order to avoid race |
| 1620 | # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| 1621 | # systems are expected to put that etag in the request to `setIamPolicy` to |
| 1622 | # ensure that their change will be applied to the same version of the policy. |
| 1623 | # |
| 1624 | # **Important:** If you use IAM Conditions, you must include the `etag` field |
| 1625 | # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| 1626 | # you to overwrite a version `3` policy with a version `1` policy, and all of |
| 1627 | # the conditions in the version `3` policy are lost. |
| 1628 | "version": 42, # Specifies the format of the policy. |
| 1629 | # |
| 1630 | # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| 1631 | # are rejected. |
| 1632 | # |
| 1633 | # Any operation that affects conditional role bindings must specify version |
| 1634 | # `3`. This requirement applies to the following operations: |
| 1635 | # |
| 1636 | # * Getting a policy that includes a conditional role binding |
| 1637 | # * Adding a conditional role binding to a policy |
| 1638 | # * Changing a conditional role binding in a policy |
| 1639 | # * Removing any role binding, with or without a condition, from a policy |
| 1640 | # that includes conditions |
| 1641 | # |
| 1642 | # **Important:** If you use IAM Conditions, you must include the `etag` field |
| 1643 | # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| 1644 | # you to overwrite a version `3` policy with a version `1` policy, and all of |
| 1645 | # the conditions in the version `3` policy are lost. |
| 1646 | # |
| 1647 | # If a policy does not include any conditions, operations on that policy may |
| 1648 | # specify any valid version or leave the field unset. |
| 1649 | # |
| 1650 | # To learn which resources support conditions in their IAM policies, see the |
| 1651 | # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 1652 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| 1653 | { # Specifies the audit configuration for a service. |
| 1654 | # The configuration determines which permission types are logged, and what |
| 1655 | # identities, if any, are exempted from logging. |
| 1656 | # An AuditConfig must have one or more AuditLogConfigs. |
| 1657 | # |
| 1658 | # If there are AuditConfigs for both `allServices` and a specific service, |
| 1659 | # the union of the two AuditConfigs is used for that service: the log_types |
| 1660 | # specified in each AuditConfig are enabled, and the exempted_members in each |
| 1661 | # AuditLogConfig are exempted. |
| 1662 | # |
| 1663 | # Example Policy with multiple AuditConfigs: |
| 1664 | # |
| 1665 | # { |
| 1666 | # "audit_configs": [ |
| 1667 | # { |
| 1668 | # "service": "allServices" |
| 1669 | # "audit_log_configs": [ |
| 1670 | # { |
| 1671 | # "log_type": "DATA_READ", |
| 1672 | # "exempted_members": [ |
| 1673 | # "user:jose@example.com" |
| 1674 | # ] |
| 1675 | # }, |
| 1676 | # { |
| 1677 | # "log_type": "DATA_WRITE", |
| 1678 | # }, |
| 1679 | # { |
| 1680 | # "log_type": "ADMIN_READ", |
| 1681 | # } |
| 1682 | # ] |
| 1683 | # }, |
| 1684 | # { |
| 1685 | # "service": "sampleservice.googleapis.com" |
| 1686 | # "audit_log_configs": [ |
| 1687 | # { |
| 1688 | # "log_type": "DATA_READ", |
| 1689 | # }, |
| 1690 | # { |
| 1691 | # "log_type": "DATA_WRITE", |
| 1692 | # "exempted_members": [ |
| 1693 | # "user:aliya@example.com" |
| 1694 | # ] |
| 1695 | # } |
| 1696 | # ] |
| 1697 | # } |
| 1698 | # ] |
| 1699 | # } |
| 1700 | # |
| 1701 | # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| 1702 | # logging. It also exempts jose@example.com from DATA_READ logging, and |
| 1703 | # aliya@example.com from DATA_WRITE logging. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1704 | "service": "A String", # Specifies a service that will be enabled for audit logging. |
| 1705 | # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. |
| 1706 | # `allServices` is a special value that covers all services. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1707 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| 1708 | { # Provides the configuration for logging a type of permissions. |
| 1709 | # Example: |
| 1710 | # |
| 1711 | # { |
| 1712 | # "audit_log_configs": [ |
| 1713 | # { |
| 1714 | # "log_type": "DATA_READ", |
| 1715 | # "exempted_members": [ |
| 1716 | # "user:jose@example.com" |
| 1717 | # ] |
| 1718 | # }, |
| 1719 | # { |
| 1720 | # "log_type": "DATA_WRITE", |
| 1721 | # } |
| 1722 | # ] |
| 1723 | # } |
| 1724 | # |
| 1725 | # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| 1726 | # jose@example.com from DATA_READ logging. |
| 1727 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of |
| 1728 | # permission. |
| 1729 | # Follows the same format of Binding.members. |
| 1730 | "A String", |
| 1731 | ], |
| 1732 | "logType": "A String", # The log type that this config enables. |
| 1733 | }, |
| 1734 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1735 | }, |
| 1736 | ], |
| 1737 | }</pre> |
| 1738 | </div> |
| 1739 | |
| 1740 | <div class="method"> |
| 1741 | <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code> |
| 1742 | <pre>Returns permissions that a caller has on the specified resource. |
| 1743 | If the resource does not exist, this will return an empty set of |
| 1744 | permissions, not a `NOT_FOUND` error. |
| 1745 | |
| 1746 | Note: This operation is designed to be used for building permission-aware |
| 1747 | UIs and command-line tools, not for authorization checking. This operation |
| 1748 | may "fail open" without warning. |
| 1749 | |
| 1750 | Args: |
| 1751 | resource: string, REQUIRED: The resource for which the policy detail is being requested. |
| 1752 | See the operation documentation for the appropriate value for this field. (required) |
| 1753 | body: object, The request body. |
| 1754 | The object takes the form of: |
| 1755 | |
| 1756 | { # Request message for `TestIamPermissions` method. |
| 1757 | "permissions": [ # The set of permissions to check for the `resource`. Permissions with |
| 1758 | # wildcards (such as '*' or 'storage.*') are not allowed. For more |
| 1759 | # information see |
| 1760 | # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). |
| 1761 | "A String", |
| 1762 | ], |
| 1763 | } |
| 1764 | |
| 1765 | x__xgafv: string, V1 error format. |
| 1766 | Allowed values |
| 1767 | 1 - v1 error format |
| 1768 | 2 - v2 error format |
| 1769 | |
| 1770 | Returns: |
| 1771 | An object of the form: |
| 1772 | |
| 1773 | { # Response message for `TestIamPermissions` method. |
| 1774 | "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is |
| 1775 | # allowed. |
| 1776 | "A String", |
| 1777 | ], |
| 1778 | }</pre> |
| 1779 | </div> |
| 1780 | |
| 1781 | <div class="method"> |
| 1782 | <code class="details" id="updateParameters">updateParameters(name, body=None, x__xgafv=None)</code> |
| 1783 | <pre>Updates the defined Memcached Parameters for an existing Instance. |
| 1784 | This method only stages the parameters, it must be followed by |
| 1785 | ApplyParameters to apply the parameters to nodes of the Memcached Instance. |
| 1786 | |
| 1787 | Args: |
| 1788 | name: string, Required. Resource name of the Memcached instance for which the parameters should be |
| 1789 | updated. (required) |
| 1790 | body: object, The request body. |
| 1791 | The object takes the form of: |
| 1792 | |
| 1793 | { # Request for UpdateParameters. |
| 1794 | "updateMask": "A String", # Required. Mask of fields to update. |
| 1795 | "parameters": { # The parameters to apply to the instance. |
| 1796 | "id": "A String", # Output only. The unique ID associated with this set of parameters. Users |
| 1797 | # can use this id to determine if the parameters associated with the instance |
| 1798 | # differ from the parameters associated with the nodes and any action needs |
| 1799 | # to be taken to apply parameters on nodes. |
| 1800 | "params": { # User defined set of parameters to use in the memcached process. |
| 1801 | "a_key": "A String", |
| 1802 | }, |
| 1803 | }, |
| 1804 | } |
| 1805 | |
| 1806 | x__xgafv: string, V1 error format. |
| 1807 | Allowed values |
| 1808 | 1 - v1 error format |
| 1809 | 2 - v2 error format |
| 1810 | |
| 1811 | Returns: |
| 1812 | An object of the form: |
| 1813 | |
| 1814 | { # This resource represents a long-running operation that is the result of a |
| 1815 | # network API call. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1816 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 1817 | # contains progress information and common metadata such as create time. |
| 1818 | # Some services might not provide such metadata. Any method that returns a |
| 1819 | # long-running operation should document the metadata type, if any. |
| 1820 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1821 | }, |
| 1822 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 1823 | # If `true`, the operation is completed, and either `error` or `response` is |
| 1824 | # available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1825 | "response": { # The normal response of the operation in case of success. If the original |
| 1826 | # method returns no data on success, such as `Delete`, the response is |
| 1827 | # `google.protobuf.Empty`. If the original method is standard |
| 1828 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 1829 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 1830 | # is the original method name. For example, if the original method name |
| 1831 | # is `TakeSnapshot()`, the inferred response type is |
| 1832 | # `TakeSnapshotResponse`. |
| 1833 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1834 | }, |
| 1835 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 1836 | # originally returns it. If you use the default HTTP mapping, the |
| 1837 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| 1838 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 1839 | # different programming environments, including REST APIs and RPC APIs. It is |
| 1840 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 1841 | # three pieces of data: error code, error message, and error details. |
| 1842 | # |
| 1843 | # You can find out more about this error model and how to work with it in the |
| 1844 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1845 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 1846 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 1847 | # user-facing error message should be localized and sent in the |
| 1848 | # google.rpc.Status.details field, or localized by the client. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1849 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 1850 | # message types for APIs to use. |
| 1851 | { |
| 1852 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1853 | }, |
| 1854 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1855 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1856 | }</pre> |
| 1857 | </div> |
| 1858 | |
| 1859 | </body></html> |