1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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="redis_v1beta1.html">Google Cloud Memorystore for Redis API</a> . <a href="redis_v1beta1.projects.html">projects</a> . <a href="redis_v1beta1.projects.locations.html">locations</a> . <a href="redis_v1beta1.projects.locations.instances.html">instances</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#create">create(parent, body, instanceId=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Creates a Redis instance based on the specified tier and memory size.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes a specific Redis instance. Instance stops serving and data is</p> 83<p class="toc_element"> 84 <code><a href="#export">export(name, body, x__xgafv=None)</a></code></p> 85<p class="firstline">Export Redis instance data into a Redis RDB format file in Cloud Storage.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets the details of a specific Redis instance.</p> 89<p class="toc_element"> 90 <code><a href="#import_">import_(name, body, x__xgafv=None)</a></code></p> 91<p class="firstline">Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.</p> 92<p class="toc_element"> 93 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p> 94<p class="firstline">Lists all Redis instances owned by a project in either the specified</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, updateMask=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Updates the metadata and configuration of a specific Redis instance.</p> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="create">create(parent, body, instanceId=None, x__xgafv=None)</code> 104 <pre>Creates a Redis instance based on the specified tier and memory size. 105 106By default, the instance is accessible from the project's 107[default network](/compute/docs/networks-and-firewalls#networks). 108 109The creation is executed asynchronously and callers may check the returned 110operation to track its progress. Once the operation is completed the Redis 111instance will be fully functional. Completed longrunning.Operation will 112contain the new instance object in the response field. 113 114The returned operation is automatically deleted after a few hours, so there 115is no need to call DeleteOperation. 116 117Args: 118 parent: string, Required. The resource name of the instance location using the form: 119 `projects/{project_id}/locations/{location_id}` 120where `location_id` refers to a GCP region. (required) 121 body: object, The request body. (required) 122 The object takes the form of: 123 124{ # A Google Cloud Redis instance. 125 "labels": { # Resource labels to represent user provided metadata 126 "a_key": "A String", 127 }, 128 "displayName": "A String", # An arbitrary and optional user-provided name for the instance. 129 "name": "A String", # Required. Unique name of the resource in this scope including project and 130 # location using the form: 131 # `projects/{project_id}/locations/{location_id}/instances/{instance_id}` 132 # 133 # Note: Redis instances are managed and addressed at regional level so 134 # location_id here refers to a GCP region; however, users may choose which 135 # specific zone (or collection of zones for cross-zone instances) an instance 136 # should be provisioned in. Refer to [location_id] and 137 # [alternative_location_id] fields for more details. 138 "alternativeLocationId": "A String", # Optional. Only applicable to STANDARD_HA tier which protects the instance 139 # against zonal failures by provisioning it across two zones. If provided, it 140 # must be a different zone from the one provided in [location_id]. 141 "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic 142 # Tier instances, this will always be the same as the [location_id] 143 # provided by the user at creation time. For Standard Tier instances, 144 # this can be either [location_id] or [alternative_location_id] and can 145 # change after a failover event. 146 "reservedIpRange": "A String", # Optional. The CIDR range of internal addresses that are reserved for this 147 # instance. If not provided, the service will choose an unused /29 block, 148 # for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique 149 # and non-overlapping with existing subnets in an authorized network. 150 "redisVersion": "A String", # Optional. The version of Redis software. 151 # If not provided, latest supported version will be used. Updating the 152 # version will perform an upgrade/downgrade to the new version. Currently, 153 # the supported values are: 154 # 155 # * `REDIS_4_0` for Redis 4.0 compatibility 156 # * `REDIS_3_2` for Redis 3.2 compatibility (default) 157 "state": "A String", # Output only. The current state of this instance. 158 "createTime": "A String", # Output only. The time the instance was created. 159 "memorySizeGb": 42, # Required. Redis memory size in GiB. 160 "host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by 161 # clients to connect to the service. 162 "persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to 163 # transfer data to/from Cloud Storage. Format is 164 # "serviceAccount:<service_account_email>". The value may change over time 165 # for a given instance so should be checked before each import/export 166 # operation. 167 "authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine 168 # [network](/compute/docs/networks-and-firewalls#networks) to which the 169 # instance is connected. If left unspecified, the `default` network 170 # will be used. 171 "redisConfigs": { # Optional. Redis configuration parameters, according to 172 # http://redis.io/topics/config. Currently, the only supported parameters 173 # are: 174 # 175 # Redis 3.2 and above: 176 # 177 # * maxmemory-policy 178 # * notify-keyspace-events 179 # 180 # Redis 4.0 and above: 181 # 182 # * activedefrag 183 # * lfu-log-factor 184 # * lfu-decay-time 185 "a_key": "A String", 186 }, 187 "tier": "A String", # Required. The service tier of the instance. 188 "locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided, 189 # the service will choose a zone for the instance. For STANDARD_HA tier, 190 # instances will be created across two zones for protection against zonal 191 # failures. If [alternative_location_id] is also provided, it must be 192 # different from [location_id]. 193 "port": 42, # Output only. The port number of the exposed Redis endpoint. 194 "statusMessage": "A String", # Output only. Additional information about the current status of this 195 # instance, if available. 196} 197 198 instanceId: string, Required. The logical name of the Redis instance in the customer project 199with the following restrictions: 200 201* Must contain only lowercase letters, numbers, and hyphens. 202* Must start with a letter. 203* Must be between 1-40 characters. 204* Must end with a number or a letter. 205* Must be unique within the customer project / location 206 x__xgafv: string, V1 error format. 207 Allowed values 208 1 - v1 error format 209 2 - v2 error format 210 211Returns: 212 An object of the form: 213 214 { # This resource represents a long-running operation that is the result of a 215 # network API call. 216 "response": { # The normal response of the operation in case of success. If the original 217 # method returns no data on success, such as `Delete`, the response is 218 # `google.protobuf.Empty`. If the original method is standard 219 # `Get`/`Create`/`Update`, the response should be the resource. For other 220 # methods, the response should have the type `XxxResponse`, where `Xxx` 221 # is the original method name. For example, if the original method name 222 # is `TakeSnapshot()`, the inferred response type is 223 # `TakeSnapshotResponse`. 224 "a_key": "", # Properties of the object. Contains field @type with type URL. 225 }, 226 "metadata": { # { 227 # 228 # `createTime`: The time the operation was created. 229 # 230 # `endTime`: The time the operation finished running. 231 # 232 # `target`: Server-defined resource path for the target of the operation. 233 # 234 # `verb`: Name of the verb executed by the operation. 235 # 236 # `statusDetail`: Human-readable status of the operation, if any. 237 # 238 # `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. 239 # 240 # `apiVersion`: API version used to start the operation. 241 # 242 # } 243 "a_key": "", # Properties of the object. Contains field @type with type URL. 244 }, 245 "done": True or False, # If the value is `false`, it means the operation is still in progress. 246 # If `true`, the operation is completed, and either `error` or `response` is 247 # available. 248 "name": "A String", # The server-assigned name, which is only unique within the same service that 249 # originally returns it. If you use the default HTTP mapping, the 250 # `name` should be a resource name ending with `operations/{unique_id}`. 251 "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. 252 # different programming environments, including REST APIs and RPC APIs. It is 253 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 254 # three pieces of data: error code, error message, and error details. 255 # 256 # You can find out more about this error model and how to work with it in the 257 # [API Design Guide](https://cloud.google.com/apis/design/errors). 258 "message": "A String", # A developer-facing error message, which should be in English. Any 259 # user-facing error message should be localized and sent in the 260 # google.rpc.Status.details field, or localized by the client. 261 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 262 "details": [ # A list of messages that carry the error details. There is a common set of 263 # message types for APIs to use. 264 { 265 "a_key": "", # Properties of the object. Contains field @type with type URL. 266 }, 267 ], 268 }, 269 }</pre> 270</div> 271 272<div class="method"> 273 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 274 <pre>Deletes a specific Redis instance. Instance stops serving and data is 275deleted. 276 277Args: 278 name: string, Required. Redis instance resource name using the form: 279 `projects/{project_id}/locations/{location_id}/instances/{instance_id}` 280where `location_id` refers to a GCP region. (required) 281 x__xgafv: string, V1 error format. 282 Allowed values 283 1 - v1 error format 284 2 - v2 error format 285 286Returns: 287 An object of the form: 288 289 { # This resource represents a long-running operation that is the result of a 290 # network API call. 291 "response": { # The normal response of the operation in case of success. If the original 292 # method returns no data on success, such as `Delete`, the response is 293 # `google.protobuf.Empty`. If the original method is standard 294 # `Get`/`Create`/`Update`, the response should be the resource. For other 295 # methods, the response should have the type `XxxResponse`, where `Xxx` 296 # is the original method name. For example, if the original method name 297 # is `TakeSnapshot()`, the inferred response type is 298 # `TakeSnapshotResponse`. 299 "a_key": "", # Properties of the object. Contains field @type with type URL. 300 }, 301 "metadata": { # { 302 # 303 # `createTime`: The time the operation was created. 304 # 305 # `endTime`: The time the operation finished running. 306 # 307 # `target`: Server-defined resource path for the target of the operation. 308 # 309 # `verb`: Name of the verb executed by the operation. 310 # 311 # `statusDetail`: Human-readable status of the operation, if any. 312 # 313 # `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. 314 # 315 # `apiVersion`: API version used to start the operation. 316 # 317 # } 318 "a_key": "", # Properties of the object. Contains field @type with type URL. 319 }, 320 "done": True or False, # If the value is `false`, it means the operation is still in progress. 321 # If `true`, the operation is completed, and either `error` or `response` is 322 # available. 323 "name": "A String", # The server-assigned name, which is only unique within the same service that 324 # originally returns it. If you use the default HTTP mapping, the 325 # `name` should be a resource name ending with `operations/{unique_id}`. 326 "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. 327 # different programming environments, including REST APIs and RPC APIs. It is 328 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 329 # three pieces of data: error code, error message, and error details. 330 # 331 # You can find out more about this error model and how to work with it in the 332 # [API Design Guide](https://cloud.google.com/apis/design/errors). 333 "message": "A String", # A developer-facing error message, which should be in English. Any 334 # user-facing error message should be localized and sent in the 335 # google.rpc.Status.details field, or localized by the client. 336 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 337 "details": [ # A list of messages that carry the error details. There is a common set of 338 # message types for APIs to use. 339 { 340 "a_key": "", # Properties of the object. Contains field @type with type URL. 341 }, 342 ], 343 }, 344 }</pre> 345</div> 346 347<div class="method"> 348 <code class="details" id="export">export(name, body, x__xgafv=None)</code> 349 <pre>Export Redis instance data into a Redis RDB format file in Cloud Storage. 350 351Redis will continue serving during this operation. 352 353The returned operation is automatically deleted after a few hours, so 354there is no need to call DeleteOperation. 355 356Args: 357 name: string, Required. Redis instance resource name using the form: 358 `projects/{project_id}/locations/{location_id}/instances/{instance_id}` 359where `location_id` refers to a GCP region. (required) 360 body: object, The request body. (required) 361 The object takes the form of: 362 363{ # Request for Export. 364 "outputConfig": { # The output content # Required. Specify data to be exported. 365 "gcsDestination": { # The Cloud Storage location for the output content # Google Cloud Storage destination for output content. 366 "uri": "A String", # Required. Data destination URI (e.g. 367 # 'gs://my_bucket/my_object'). Existing files will be overwritten. 368 }, 369 }, 370 } 371 372 x__xgafv: string, V1 error format. 373 Allowed values 374 1 - v1 error format 375 2 - v2 error format 376 377Returns: 378 An object of the form: 379 380 { # This resource represents a long-running operation that is the result of a 381 # network API call. 382 "response": { # The normal response of the operation in case of success. If the original 383 # method returns no data on success, such as `Delete`, the response is 384 # `google.protobuf.Empty`. If the original method is standard 385 # `Get`/`Create`/`Update`, the response should be the resource. For other 386 # methods, the response should have the type `XxxResponse`, where `Xxx` 387 # is the original method name. For example, if the original method name 388 # is `TakeSnapshot()`, the inferred response type is 389 # `TakeSnapshotResponse`. 390 "a_key": "", # Properties of the object. Contains field @type with type URL. 391 }, 392 "metadata": { # { 393 # 394 # `createTime`: The time the operation was created. 395 # 396 # `endTime`: The time the operation finished running. 397 # 398 # `target`: Server-defined resource path for the target of the operation. 399 # 400 # `verb`: Name of the verb executed by the operation. 401 # 402 # `statusDetail`: Human-readable status of the operation, if any. 403 # 404 # `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. 405 # 406 # `apiVersion`: API version used to start the operation. 407 # 408 # } 409 "a_key": "", # Properties of the object. Contains field @type with type URL. 410 }, 411 "done": True or False, # If the value is `false`, it means the operation is still in progress. 412 # If `true`, the operation is completed, and either `error` or `response` is 413 # available. 414 "name": "A String", # The server-assigned name, which is only unique within the same service that 415 # originally returns it. If you use the default HTTP mapping, the 416 # `name` should be a resource name ending with `operations/{unique_id}`. 417 "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. 418 # different programming environments, including REST APIs and RPC APIs. It is 419 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 420 # three pieces of data: error code, error message, and error details. 421 # 422 # You can find out more about this error model and how to work with it in the 423 # [API Design Guide](https://cloud.google.com/apis/design/errors). 424 "message": "A String", # A developer-facing error message, which should be in English. Any 425 # user-facing error message should be localized and sent in the 426 # google.rpc.Status.details field, or localized by the client. 427 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 428 "details": [ # A list of messages that carry the error details. There is a common set of 429 # message types for APIs to use. 430 { 431 "a_key": "", # Properties of the object. Contains field @type with type URL. 432 }, 433 ], 434 }, 435 }</pre> 436</div> 437 438<div class="method"> 439 <code class="details" id="get">get(name, x__xgafv=None)</code> 440 <pre>Gets the details of a specific Redis instance. 441 442Args: 443 name: string, Required. Redis instance resource name using the form: 444 `projects/{project_id}/locations/{location_id}/instances/{instance_id}` 445where `location_id` refers to a GCP region. (required) 446 x__xgafv: string, V1 error format. 447 Allowed values 448 1 - v1 error format 449 2 - v2 error format 450 451Returns: 452 An object of the form: 453 454 { # A Google Cloud Redis instance. 455 "labels": { # Resource labels to represent user provided metadata 456 "a_key": "A String", 457 }, 458 "displayName": "A String", # An arbitrary and optional user-provided name for the instance. 459 "name": "A String", # Required. Unique name of the resource in this scope including project and 460 # location using the form: 461 # `projects/{project_id}/locations/{location_id}/instances/{instance_id}` 462 # 463 # Note: Redis instances are managed and addressed at regional level so 464 # location_id here refers to a GCP region; however, users may choose which 465 # specific zone (or collection of zones for cross-zone instances) an instance 466 # should be provisioned in. Refer to [location_id] and 467 # [alternative_location_id] fields for more details. 468 "alternativeLocationId": "A String", # Optional. Only applicable to STANDARD_HA tier which protects the instance 469 # against zonal failures by provisioning it across two zones. If provided, it 470 # must be a different zone from the one provided in [location_id]. 471 "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic 472 # Tier instances, this will always be the same as the [location_id] 473 # provided by the user at creation time. For Standard Tier instances, 474 # this can be either [location_id] or [alternative_location_id] and can 475 # change after a failover event. 476 "reservedIpRange": "A String", # Optional. The CIDR range of internal addresses that are reserved for this 477 # instance. If not provided, the service will choose an unused /29 block, 478 # for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique 479 # and non-overlapping with existing subnets in an authorized network. 480 "redisVersion": "A String", # Optional. The version of Redis software. 481 # If not provided, latest supported version will be used. Updating the 482 # version will perform an upgrade/downgrade to the new version. Currently, 483 # the supported values are: 484 # 485 # * `REDIS_4_0` for Redis 4.0 compatibility 486 # * `REDIS_3_2` for Redis 3.2 compatibility (default) 487 "state": "A String", # Output only. The current state of this instance. 488 "createTime": "A String", # Output only. The time the instance was created. 489 "memorySizeGb": 42, # Required. Redis memory size in GiB. 490 "host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by 491 # clients to connect to the service. 492 "persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to 493 # transfer data to/from Cloud Storage. Format is 494 # "serviceAccount:<service_account_email>". The value may change over time 495 # for a given instance so should be checked before each import/export 496 # operation. 497 "authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine 498 # [network](/compute/docs/networks-and-firewalls#networks) to which the 499 # instance is connected. If left unspecified, the `default` network 500 # will be used. 501 "redisConfigs": { # Optional. Redis configuration parameters, according to 502 # http://redis.io/topics/config. Currently, the only supported parameters 503 # are: 504 # 505 # Redis 3.2 and above: 506 # 507 # * maxmemory-policy 508 # * notify-keyspace-events 509 # 510 # Redis 4.0 and above: 511 # 512 # * activedefrag 513 # * lfu-log-factor 514 # * lfu-decay-time 515 "a_key": "A String", 516 }, 517 "tier": "A String", # Required. The service tier of the instance. 518 "locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided, 519 # the service will choose a zone for the instance. For STANDARD_HA tier, 520 # instances will be created across two zones for protection against zonal 521 # failures. If [alternative_location_id] is also provided, it must be 522 # different from [location_id]. 523 "port": 42, # Output only. The port number of the exposed Redis endpoint. 524 "statusMessage": "A String", # Output only. Additional information about the current status of this 525 # instance, if available. 526 }</pre> 527</div> 528 529<div class="method"> 530 <code class="details" id="import_">import_(name, body, x__xgafv=None)</code> 531 <pre>Import a Redis RDB snapshot file from Cloud Storage into a Redis instance. 532 533Redis may stop serving during this operation. Instance state will be 534IMPORTING for entire operation. When complete, the instance will contain 535only data from the imported file. 536 537The returned operation is automatically deleted after a few hours, so 538there is no need to call DeleteOperation. 539 540Args: 541 name: string, Required. Redis instance resource name using the form: 542 `projects/{project_id}/locations/{location_id}/instances/{instance_id}` 543where `location_id` refers to a GCP region. (required) 544 body: object, The request body. (required) 545 The object takes the form of: 546 547{ # Request for Import. 548 "inputConfig": { # The input content # Required. Specify data to be imported. 549 "gcsSource": { # The Cloud Storage location for the input content # Google Cloud Storage location where input content is located. 550 "uri": "A String", # Required. Source data URI. (e.g. 'gs://my_bucket/my_object'). 551 }, 552 }, 553 } 554 555 x__xgafv: string, V1 error format. 556 Allowed values 557 1 - v1 error format 558 2 - v2 error format 559 560Returns: 561 An object of the form: 562 563 { # This resource represents a long-running operation that is the result of a 564 # network API call. 565 "response": { # The normal response of the operation in case of success. If the original 566 # method returns no data on success, such as `Delete`, the response is 567 # `google.protobuf.Empty`. If the original method is standard 568 # `Get`/`Create`/`Update`, the response should be the resource. For other 569 # methods, the response should have the type `XxxResponse`, where `Xxx` 570 # is the original method name. For example, if the original method name 571 # is `TakeSnapshot()`, the inferred response type is 572 # `TakeSnapshotResponse`. 573 "a_key": "", # Properties of the object. Contains field @type with type URL. 574 }, 575 "metadata": { # { 576 # 577 # `createTime`: The time the operation was created. 578 # 579 # `endTime`: The time the operation finished running. 580 # 581 # `target`: Server-defined resource path for the target of the operation. 582 # 583 # `verb`: Name of the verb executed by the operation. 584 # 585 # `statusDetail`: Human-readable status of the operation, if any. 586 # 587 # `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. 588 # 589 # `apiVersion`: API version used to start the operation. 590 # 591 # } 592 "a_key": "", # Properties of the object. Contains field @type with type URL. 593 }, 594 "done": True or False, # If the value is `false`, it means the operation is still in progress. 595 # If `true`, the operation is completed, and either `error` or `response` is 596 # available. 597 "name": "A String", # The server-assigned name, which is only unique within the same service that 598 # originally returns it. If you use the default HTTP mapping, the 599 # `name` should be a resource name ending with `operations/{unique_id}`. 600 "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. 601 # different programming environments, including REST APIs and RPC APIs. It is 602 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 603 # three pieces of data: error code, error message, and error details. 604 # 605 # You can find out more about this error model and how to work with it in the 606 # [API Design Guide](https://cloud.google.com/apis/design/errors). 607 "message": "A String", # A developer-facing error message, which should be in English. Any 608 # user-facing error message should be localized and sent in the 609 # google.rpc.Status.details field, or localized by the client. 610 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 611 "details": [ # A list of messages that carry the error details. There is a common set of 612 # message types for APIs to use. 613 { 614 "a_key": "", # Properties of the object. Contains field @type with type URL. 615 }, 616 ], 617 }, 618 }</pre> 619</div> 620 621<div class="method"> 622 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code> 623 <pre>Lists all Redis instances owned by a project in either the specified 624location (region) or all locations. 625 626The location should have the following format: 627* `projects/{project_id}/locations/{location_id}` 628 629If `location_id` is specified as `-` (wildcard), then all regions 630available to the project are queried, and the results are aggregated. 631 632Args: 633 parent: string, Required. The resource name of the instance location using the form: 634 `projects/{project_id}/locations/{location_id}` 635where `location_id` refers to a GCP region. (required) 636 pageToken: string, The next_page_token value returned from a previous List request, 637if any. 638 x__xgafv: string, V1 error format. 639 Allowed values 640 1 - v1 error format 641 2 - v2 error format 642 pageSize: integer, The maximum number of items to return. 643 644If not specified, a default value of 1000 will be used by the service. 645Regardless of the page_size value, the response may include a partial list 646and a caller should only rely on response's 647next_page_token 648to determine if there are more instances left to be queried. 649 650Returns: 651 An object of the form: 652 653 { # Response for ListInstances. 654 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more 655 # results in the list. 656 "unreachable": [ # Locations that could not be reached. 657 "A String", 658 ], 659 "instances": [ # A list of Redis instances in the project in the specified location, 660 # or across all locations. 661 # 662 # If the `location_id` in the parent field of the request is "-", all regions 663 # available to the project are queried, and the results aggregated. 664 # If in such an aggregated query a location is unavailable, a dummy Redis 665 # entry is included in the response with the "name" field set to a value of 666 # the form projects/{project_id}/locations/{location_id}/instances/- and the 667 # "status" field set to ERROR and "status_message" field set to "location not 668 # available for ListInstances". 669 { # A Google Cloud Redis instance. 670 "labels": { # Resource labels to represent user provided metadata 671 "a_key": "A String", 672 }, 673 "displayName": "A String", # An arbitrary and optional user-provided name for the instance. 674 "name": "A String", # Required. Unique name of the resource in this scope including project and 675 # location using the form: 676 # `projects/{project_id}/locations/{location_id}/instances/{instance_id}` 677 # 678 # Note: Redis instances are managed and addressed at regional level so 679 # location_id here refers to a GCP region; however, users may choose which 680 # specific zone (or collection of zones for cross-zone instances) an instance 681 # should be provisioned in. Refer to [location_id] and 682 # [alternative_location_id] fields for more details. 683 "alternativeLocationId": "A String", # Optional. Only applicable to STANDARD_HA tier which protects the instance 684 # against zonal failures by provisioning it across two zones. If provided, it 685 # must be a different zone from the one provided in [location_id]. 686 "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic 687 # Tier instances, this will always be the same as the [location_id] 688 # provided by the user at creation time. For Standard Tier instances, 689 # this can be either [location_id] or [alternative_location_id] and can 690 # change after a failover event. 691 "reservedIpRange": "A String", # Optional. The CIDR range of internal addresses that are reserved for this 692 # instance. If not provided, the service will choose an unused /29 block, 693 # for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique 694 # and non-overlapping with existing subnets in an authorized network. 695 "redisVersion": "A String", # Optional. The version of Redis software. 696 # If not provided, latest supported version will be used. Updating the 697 # version will perform an upgrade/downgrade to the new version. Currently, 698 # the supported values are: 699 # 700 # * `REDIS_4_0` for Redis 4.0 compatibility 701 # * `REDIS_3_2` for Redis 3.2 compatibility (default) 702 "state": "A String", # Output only. The current state of this instance. 703 "createTime": "A String", # Output only. The time the instance was created. 704 "memorySizeGb": 42, # Required. Redis memory size in GiB. 705 "host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by 706 # clients to connect to the service. 707 "persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to 708 # transfer data to/from Cloud Storage. Format is 709 # "serviceAccount:<service_account_email>". The value may change over time 710 # for a given instance so should be checked before each import/export 711 # operation. 712 "authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine 713 # [network](/compute/docs/networks-and-firewalls#networks) to which the 714 # instance is connected. If left unspecified, the `default` network 715 # will be used. 716 "redisConfigs": { # Optional. Redis configuration parameters, according to 717 # http://redis.io/topics/config. Currently, the only supported parameters 718 # are: 719 # 720 # Redis 3.2 and above: 721 # 722 # * maxmemory-policy 723 # * notify-keyspace-events 724 # 725 # Redis 4.0 and above: 726 # 727 # * activedefrag 728 # * lfu-log-factor 729 # * lfu-decay-time 730 "a_key": "A String", 731 }, 732 "tier": "A String", # Required. The service tier of the instance. 733 "locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided, 734 # the service will choose a zone for the instance. For STANDARD_HA tier, 735 # instances will be created across two zones for protection against zonal 736 # failures. If [alternative_location_id] is also provided, it must be 737 # different from [location_id]. 738 "port": 42, # Output only. The port number of the exposed Redis endpoint. 739 "statusMessage": "A String", # Output only. Additional information about the current status of this 740 # instance, if available. 741 }, 742 ], 743 }</pre> 744</div> 745 746<div class="method"> 747 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 748 <pre>Retrieves the next page of results. 749 750Args: 751 previous_request: The request for the previous page. (required) 752 previous_response: The response from the request for the previous page. (required) 753 754Returns: 755 A request object that you can call 'execute()' on to request the next 756 page. Returns None if there are no more items in the collection. 757 </pre> 758</div> 759 760<div class="method"> 761 <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code> 762 <pre>Updates the metadata and configuration of a specific Redis instance. 763 764Completed longrunning.Operation will contain the new instance object 765in the response field. The returned operation is automatically deleted 766after a few hours, so there is no need to call DeleteOperation. 767 768Args: 769 name: string, Required. Unique name of the resource in this scope including project and 770location using the form: 771 `projects/{project_id}/locations/{location_id}/instances/{instance_id}` 772 773Note: Redis instances are managed and addressed at regional level so 774location_id here refers to a GCP region; however, users may choose which 775specific zone (or collection of zones for cross-zone instances) an instance 776should be provisioned in. Refer to [location_id] and 777[alternative_location_id] fields for more details. (required) 778 body: object, The request body. (required) 779 The object takes the form of: 780 781{ # A Google Cloud Redis instance. 782 "labels": { # Resource labels to represent user provided metadata 783 "a_key": "A String", 784 }, 785 "displayName": "A String", # An arbitrary and optional user-provided name for the instance. 786 "name": "A String", # Required. Unique name of the resource in this scope including project and 787 # location using the form: 788 # `projects/{project_id}/locations/{location_id}/instances/{instance_id}` 789 # 790 # Note: Redis instances are managed and addressed at regional level so 791 # location_id here refers to a GCP region; however, users may choose which 792 # specific zone (or collection of zones for cross-zone instances) an instance 793 # should be provisioned in. Refer to [location_id] and 794 # [alternative_location_id] fields for more details. 795 "alternativeLocationId": "A String", # Optional. Only applicable to STANDARD_HA tier which protects the instance 796 # against zonal failures by provisioning it across two zones. If provided, it 797 # must be a different zone from the one provided in [location_id]. 798 "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic 799 # Tier instances, this will always be the same as the [location_id] 800 # provided by the user at creation time. For Standard Tier instances, 801 # this can be either [location_id] or [alternative_location_id] and can 802 # change after a failover event. 803 "reservedIpRange": "A String", # Optional. The CIDR range of internal addresses that are reserved for this 804 # instance. If not provided, the service will choose an unused /29 block, 805 # for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique 806 # and non-overlapping with existing subnets in an authorized network. 807 "redisVersion": "A String", # Optional. The version of Redis software. 808 # If not provided, latest supported version will be used. Updating the 809 # version will perform an upgrade/downgrade to the new version. Currently, 810 # the supported values are: 811 # 812 # * `REDIS_4_0` for Redis 4.0 compatibility 813 # * `REDIS_3_2` for Redis 3.2 compatibility (default) 814 "state": "A String", # Output only. The current state of this instance. 815 "createTime": "A String", # Output only. The time the instance was created. 816 "memorySizeGb": 42, # Required. Redis memory size in GiB. 817 "host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by 818 # clients to connect to the service. 819 "persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to 820 # transfer data to/from Cloud Storage. Format is 821 # "serviceAccount:<service_account_email>". The value may change over time 822 # for a given instance so should be checked before each import/export 823 # operation. 824 "authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine 825 # [network](/compute/docs/networks-and-firewalls#networks) to which the 826 # instance is connected. If left unspecified, the `default` network 827 # will be used. 828 "redisConfigs": { # Optional. Redis configuration parameters, according to 829 # http://redis.io/topics/config. Currently, the only supported parameters 830 # are: 831 # 832 # Redis 3.2 and above: 833 # 834 # * maxmemory-policy 835 # * notify-keyspace-events 836 # 837 # Redis 4.0 and above: 838 # 839 # * activedefrag 840 # * lfu-log-factor 841 # * lfu-decay-time 842 "a_key": "A String", 843 }, 844 "tier": "A String", # Required. The service tier of the instance. 845 "locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided, 846 # the service will choose a zone for the instance. For STANDARD_HA tier, 847 # instances will be created across two zones for protection against zonal 848 # failures. If [alternative_location_id] is also provided, it must be 849 # different from [location_id]. 850 "port": 42, # Output only. The port number of the exposed Redis endpoint. 851 "statusMessage": "A String", # Output only. Additional information about the current status of this 852 # instance, if available. 853} 854 855 updateMask: string, Required. Mask of fields to update. At least one path must be supplied in 856this field. The elements of the repeated paths field may only include these 857fields from Instance: 858 859 * `displayName` 860 * `labels` 861 * `memorySizeGb` 862 * `redisConfig` 863 x__xgafv: string, V1 error format. 864 Allowed values 865 1 - v1 error format 866 2 - v2 error format 867 868Returns: 869 An object of the form: 870 871 { # This resource represents a long-running operation that is the result of a 872 # network API call. 873 "response": { # The normal response of the operation in case of success. If the original 874 # method returns no data on success, such as `Delete`, the response is 875 # `google.protobuf.Empty`. If the original method is standard 876 # `Get`/`Create`/`Update`, the response should be the resource. For other 877 # methods, the response should have the type `XxxResponse`, where `Xxx` 878 # is the original method name. For example, if the original method name 879 # is `TakeSnapshot()`, the inferred response type is 880 # `TakeSnapshotResponse`. 881 "a_key": "", # Properties of the object. Contains field @type with type URL. 882 }, 883 "metadata": { # { 884 # 885 # `createTime`: The time the operation was created. 886 # 887 # `endTime`: The time the operation finished running. 888 # 889 # `target`: Server-defined resource path for the target of the operation. 890 # 891 # `verb`: Name of the verb executed by the operation. 892 # 893 # `statusDetail`: Human-readable status of the operation, if any. 894 # 895 # `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. 896 # 897 # `apiVersion`: API version used to start the operation. 898 # 899 # } 900 "a_key": "", # Properties of the object. Contains field @type with type URL. 901 }, 902 "done": True or False, # If the value is `false`, it means the operation is still in progress. 903 # If `true`, the operation is completed, and either `error` or `response` is 904 # available. 905 "name": "A String", # The server-assigned name, which is only unique within the same service that 906 # originally returns it. If you use the default HTTP mapping, the 907 # `name` should be a resource name ending with `operations/{unique_id}`. 908 "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. 909 # different programming environments, including REST APIs and RPC APIs. It is 910 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 911 # three pieces of data: error code, error message, and error details. 912 # 913 # You can find out more about this error model and how to work with it in the 914 # [API Design Guide](https://cloud.google.com/apis/design/errors). 915 "message": "A String", # A developer-facing error message, which should be in English. Any 916 # user-facing error message should be localized and sent in the 917 # google.rpc.Status.details field, or localized by the client. 918 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 919 "details": [ # A list of messages that carry the error details. There is a common set of 920 # message types for APIs to use. 921 { 922 "a_key": "", # Properties of the object. Contains field @type with type URL. 923 }, 924 ], 925 }, 926 }</pre> 927</div> 928 929</body></html>