chore: regens API reference docs (#889)
diff --git a/docs/dyn/redis_v1beta1.projects.locations.instances.html b/docs/dyn/redis_v1beta1.projects.locations.instances.html
index 658cfbd..6cb948f 100644
--- a/docs/dyn/redis_v1beta1.projects.locations.instances.html
+++ b/docs/dyn/redis_v1beta1.projects.locations.instances.html
@@ -75,19 +75,22 @@
<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>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#create">create(parent, body, instanceId=None, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent, body=None, instanceId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a Redis instance based on the specified tier and memory size.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a specific Redis instance. Instance stops serving and data is</p>
<p class="toc_element">
- <code><a href="#export">export(name, body, x__xgafv=None)</a></code></p>
+ <code><a href="#export">export(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Export Redis instance data into a Redis RDB format file in Cloud Storage.</p>
<p class="toc_element">
+ <code><a href="#failover">failover(name, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Initiates a failover of the master node to current replica node for a</p>
+<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the details of a specific Redis instance.</p>
<p class="toc_element">
- <code><a href="#import_">import_(name, body, x__xgafv=None)</a></code></p>
+ <code><a href="#import_">import_(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
@@ -96,11 +99,14 @@
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>
+ <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the metadata and configuration of a specific Redis instance.</p>
+<p class="toc_element">
+ <code><a href="#upgrade">upgrade(name, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Upgrades Redis instance to the newer Redis version specified in the</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(parent, body, instanceId=None, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code>
<pre>Creates a Redis instance based on the specified tier and memory size.
By default, the instance is accessible from the project's
@@ -118,7 +124,7 @@
parent: string, Required. The resource name of the instance location using the form:
`projects/{project_id}/locations/{location_id}`
where `location_id` refers to a GCP region. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # A Google Cloud Redis instance.
@@ -133,66 +139,74 @@
# Note: Redis instances are managed and addressed at regional level so
# location_id here refers to a GCP region; however, users may choose which
# specific zone (or collection of zones for cross-zone instances) an instance
- # should be provisioned in. Refer to [location_id] and
- # [alternative_location_id] fields for more details.
+ # should be provisioned in. Refer to location_id and
+ # alternative_location_id fields for more details.
"alternativeLocationId": "A String", # Optional. Only applicable to STANDARD_HA tier which protects the instance
# against zonal failures by provisioning it across two zones. If provided, it
- # must be a different zone from the one provided in [location_id].
- "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic
- # Tier instances, this will always be the same as the [location_id]
- # provided by the user at creation time. For Standard Tier instances,
- # this can be either [location_id] or [alternative_location_id] and can
- # change after a failover event.
+ # must be a different zone from the one provided in location_id.
+ "locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,
+ # the service will choose a zone for the instance. For STANDARD_HA tier,
+ # instances will be created across two zones for protection against zonal
+ # failures. If alternative_location_id is also provided, it must be
+ # different from location_id.
"reservedIpRange": "A String", # Optional. The CIDR range of internal addresses that are reserved for this
# instance. If not provided, the service will choose an unused /29 block,
# for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique
# and non-overlapping with existing subnets in an authorized network.
"redisVersion": "A String", # Optional. The version of Redis software.
- # If not provided, latest supported version will be used. Updating the
- # version will perform an upgrade/downgrade to the new version. Currently,
- # the supported values are:
+ # If not provided, latest supported version will be used. Currently, the
+ # supported values are:
#
- # * `REDIS_4_0` for Redis 4.0 compatibility
- # * `REDIS_3_2` for Redis 3.2 compatibility (default)
- "state": "A String", # Output only. The current state of this instance.
- "createTime": "A String", # Output only. The time the instance was created.
- "memorySizeGb": 42, # Required. Redis memory size in GiB.
+ # * `REDIS_3_2` for Redis 3.2 compatibility
+ # * `REDIS_4_0` for Redis 4.0 compatibility (default)
+ # * `REDIS_5_0` for Redis 5.0 compatibility
"host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by
# clients to connect to the service.
+ "createTime": "A String", # Output only. The time the instance was created.
+ "memorySizeGb": 42, # Required. Redis memory size in GiB.
+ "state": "A String", # Output only. The current state of this instance.
"persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to
# transfer data to/from Cloud Storage. Format is
- # "serviceAccount:<service_account_email>". The value may change over time
+ # "serviceAccount:<service_account_email>". The value may change over time
# for a given instance so should be checked before each import/export
# operation.
- "authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine
- # [network](/compute/docs/networks-and-firewalls#networks) to which the
- # instance is connected. If left unspecified, the `default` network
- # will be used.
+ "statusMessage": "A String", # Output only. Additional information about the current status of this
+ # instance, if available.
"redisConfigs": { # Optional. Redis configuration parameters, according to
# http://redis.io/topics/config. Currently, the only supported parameters
# are:
#
- # Redis 3.2 and above:
+ # Redis version 3.2 and newer:
#
# * maxmemory-policy
# * notify-keyspace-events
#
- # Redis 4.0 and above:
+ # Redis version 4.0 and newer:
#
# * activedefrag
- # * lfu-log-factor
# * lfu-decay-time
+ # * lfu-log-factor
+ # * maxmemory-gb
+ #
+ # Redis version 5.0 and newer:
+ #
+ # * stream-node-max-bytes
+ # * stream-node-max-entries
"a_key": "A String",
},
"tier": "A String", # Required. The service tier of the instance.
- "locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,
- # the service will choose a zone for the instance. For STANDARD_HA tier,
- # instances will be created across two zones for protection against zonal
- # failures. If [alternative_location_id] is also provided, it must be
- # different from [location_id].
+ "connectMode": "A String", # Optional. The network connect mode of the Redis instance.
+ # If not provided, the connect mode defaults to DIRECT_PEERING.
+ "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic
+ # Tier instances, this will always be the same as the location_id
+ # provided by the user at creation time. For Standard Tier instances,
+ # this can be either location_id or alternative_location_id and can
+ # change after a failover event.
"port": 42, # Output only. The port number of the exposed Redis endpoint.
- "statusMessage": "A String", # Output only. Additional information about the current status of this
- # instance, if available.
+ "authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine
+ # [network](/compute/docs/networks-and-firewalls#networks) to which the
+ # instance is connected. If left unspecified, the `default` network
+ # will be used.
}
instanceId: string, Required. The logical name of the Redis instance in the customer project
@@ -213,16 +227,6 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # The normal response of the operation in case of success. If the original
- # method returns no data on success, such as `Delete`, the response is
- # `google.protobuf.Empty`. If the original method is standard
- # `Get`/`Create`/`Update`, the response should be the resource. For other
- # methods, the response should have the type `XxxResponse`, where `Xxx`
- # is the original method name. For example, if the original method name
- # is `TakeSnapshot()`, the inferred response type is
- # `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
"metadata": { # {
#
# `createTime`: The time the operation was created.
@@ -242,12 +246,6 @@
# }
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
- # If `true`, the operation is completed, and either `error` or `response` is
- # available.
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
"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.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -266,6 +264,22 @@
},
],
},
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
+ "response": { # The normal response of the operation in case of success. If the original
+ # method returns no data on success, such as `Delete`, the response is
+ # `google.protobuf.Empty`. If the original method is standard
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should be a resource name ending with `operations/{unique_id}`.
}</pre>
</div>
@@ -288,16 +302,6 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # The normal response of the operation in case of success. If the original
- # method returns no data on success, such as `Delete`, the response is
- # `google.protobuf.Empty`. If the original method is standard
- # `Get`/`Create`/`Update`, the response should be the resource. For other
- # methods, the response should have the type `XxxResponse`, where `Xxx`
- # is the original method name. For example, if the original method name
- # is `TakeSnapshot()`, the inferred response type is
- # `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
"metadata": { # {
#
# `createTime`: The time the operation was created.
@@ -317,12 +321,6 @@
# }
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
- # If `true`, the operation is completed, and either `error` or `response` is
- # available.
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
"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.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -341,11 +339,27 @@
},
],
},
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
+ "response": { # The normal response of the operation in case of success. If the original
+ # method returns no data on success, such as `Delete`, the response is
+ # `google.protobuf.Empty`. If the original method is standard
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should be a resource name ending with `operations/{unique_id}`.
}</pre>
</div>
<div class="method">
- <code class="details" id="export">export(name, body, x__xgafv=None)</code>
+ <code class="details" id="export">export(name, body=None, x__xgafv=None)</code>
<pre>Export Redis instance data into a Redis RDB format file in Cloud Storage.
Redis will continue serving during this operation.
@@ -357,7 +371,7 @@
name: string, Required. Redis instance resource name using the form:
`projects/{project_id}/locations/{location_id}/instances/{instance_id}`
where `location_id` refers to a GCP region. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request for Export.
@@ -379,16 +393,6 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # The normal response of the operation in case of success. If the original
- # method returns no data on success, such as `Delete`, the response is
- # `google.protobuf.Empty`. If the original method is standard
- # `Get`/`Create`/`Update`, the response should be the resource. For other
- # methods, the response should have the type `XxxResponse`, where `Xxx`
- # is the original method name. For example, if the original method name
- # is `TakeSnapshot()`, the inferred response type is
- # `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
"metadata": { # {
#
# `createTime`: The time the operation was created.
@@ -408,12 +412,6 @@
# }
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
- # If `true`, the operation is completed, and either `error` or `response` is
- # available.
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
"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.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -432,6 +430,105 @@
},
],
},
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
+ "response": { # The normal response of the operation in case of success. If the original
+ # method returns no data on success, such as `Delete`, the response is
+ # `google.protobuf.Empty`. If the original method is standard
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should be a resource name ending with `operations/{unique_id}`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="failover">failover(name, body=None, x__xgafv=None)</code>
+ <pre>Initiates a failover of the master node to current replica node for a
+specific STANDARD tier Cloud Memorystore for Redis instance.
+
+Args:
+ name: string, Required. Redis instance resource name using the form:
+ `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
+where `location_id` refers to a GCP region. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for Failover.
+ "dataProtectionMode": "A String", # Optional. Available data protection modes that the user can choose. If it's
+ # unspecified, data protection mode will be LIMITED_DATA_LOSS by default.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a
+ # network API call.
+ "metadata": { # {
+ #
+ # `createTime`: The time the operation was created.
+ #
+ # `endTime`: The time the operation finished running.
+ #
+ # `target`: Server-defined resource path for the target of the operation.
+ #
+ # `verb`: Name of the verb executed by the operation.
+ #
+ # `statusDetail`: Human-readable status of the operation, if any.
+ #
+ # `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`.
+ #
+ # `apiVersion`: API version used to start the operation.
+ #
+ # }
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "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.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
+ "response": { # The normal response of the operation in case of success. If the original
+ # method returns no data on success, such as `Delete`, the response is
+ # `google.protobuf.Empty`. If the original method is standard
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should be a resource name ending with `operations/{unique_id}`.
}</pre>
</div>
@@ -463,71 +560,79 @@
# Note: Redis instances are managed and addressed at regional level so
# location_id here refers to a GCP region; however, users may choose which
# specific zone (or collection of zones for cross-zone instances) an instance
- # should be provisioned in. Refer to [location_id] and
- # [alternative_location_id] fields for more details.
+ # should be provisioned in. Refer to location_id and
+ # alternative_location_id fields for more details.
"alternativeLocationId": "A String", # Optional. Only applicable to STANDARD_HA tier which protects the instance
# against zonal failures by provisioning it across two zones. If provided, it
- # must be a different zone from the one provided in [location_id].
- "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic
- # Tier instances, this will always be the same as the [location_id]
- # provided by the user at creation time. For Standard Tier instances,
- # this can be either [location_id] or [alternative_location_id] and can
- # change after a failover event.
+ # must be a different zone from the one provided in location_id.
+ "locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,
+ # the service will choose a zone for the instance. For STANDARD_HA tier,
+ # instances will be created across two zones for protection against zonal
+ # failures. If alternative_location_id is also provided, it must be
+ # different from location_id.
"reservedIpRange": "A String", # Optional. The CIDR range of internal addresses that are reserved for this
# instance. If not provided, the service will choose an unused /29 block,
# for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique
# and non-overlapping with existing subnets in an authorized network.
"redisVersion": "A String", # Optional. The version of Redis software.
- # If not provided, latest supported version will be used. Updating the
- # version will perform an upgrade/downgrade to the new version. Currently,
- # the supported values are:
+ # If not provided, latest supported version will be used. Currently, the
+ # supported values are:
#
- # * `REDIS_4_0` for Redis 4.0 compatibility
- # * `REDIS_3_2` for Redis 3.2 compatibility (default)
- "state": "A String", # Output only. The current state of this instance.
- "createTime": "A String", # Output only. The time the instance was created.
- "memorySizeGb": 42, # Required. Redis memory size in GiB.
+ # * `REDIS_3_2` for Redis 3.2 compatibility
+ # * `REDIS_4_0` for Redis 4.0 compatibility (default)
+ # * `REDIS_5_0` for Redis 5.0 compatibility
"host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by
# clients to connect to the service.
+ "createTime": "A String", # Output only. The time the instance was created.
+ "memorySizeGb": 42, # Required. Redis memory size in GiB.
+ "state": "A String", # Output only. The current state of this instance.
"persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to
# transfer data to/from Cloud Storage. Format is
- # "serviceAccount:<service_account_email>". The value may change over time
+ # "serviceAccount:<service_account_email>". The value may change over time
# for a given instance so should be checked before each import/export
# operation.
- "authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine
- # [network](/compute/docs/networks-and-firewalls#networks) to which the
- # instance is connected. If left unspecified, the `default` network
- # will be used.
+ "statusMessage": "A String", # Output only. Additional information about the current status of this
+ # instance, if available.
"redisConfigs": { # Optional. Redis configuration parameters, according to
# http://redis.io/topics/config. Currently, the only supported parameters
# are:
#
- # Redis 3.2 and above:
+ # Redis version 3.2 and newer:
#
# * maxmemory-policy
# * notify-keyspace-events
#
- # Redis 4.0 and above:
+ # Redis version 4.0 and newer:
#
# * activedefrag
- # * lfu-log-factor
# * lfu-decay-time
+ # * lfu-log-factor
+ # * maxmemory-gb
+ #
+ # Redis version 5.0 and newer:
+ #
+ # * stream-node-max-bytes
+ # * stream-node-max-entries
"a_key": "A String",
},
"tier": "A String", # Required. The service tier of the instance.
- "locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,
- # the service will choose a zone for the instance. For STANDARD_HA tier,
- # instances will be created across two zones for protection against zonal
- # failures. If [alternative_location_id] is also provided, it must be
- # different from [location_id].
+ "connectMode": "A String", # Optional. The network connect mode of the Redis instance.
+ # If not provided, the connect mode defaults to DIRECT_PEERING.
+ "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic
+ # Tier instances, this will always be the same as the location_id
+ # provided by the user at creation time. For Standard Tier instances,
+ # this can be either location_id or alternative_location_id and can
+ # change after a failover event.
"port": 42, # Output only. The port number of the exposed Redis endpoint.
- "statusMessage": "A String", # Output only. Additional information about the current status of this
- # instance, if available.
+ "authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine
+ # [network](/compute/docs/networks-and-firewalls#networks) to which the
+ # instance is connected. If left unspecified, the `default` network
+ # will be used.
}</pre>
</div>
<div class="method">
- <code class="details" id="import_">import_(name, body, x__xgafv=None)</code>
+ <code class="details" id="import_">import_(name, body=None, x__xgafv=None)</code>
<pre>Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.
Redis may stop serving during this operation. Instance state will be
@@ -541,7 +646,7 @@
name: string, Required. Redis instance resource name using the form:
`projects/{project_id}/locations/{location_id}/instances/{instance_id}`
where `location_id` refers to a GCP region. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request for Import.
@@ -562,16 +667,6 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # The normal response of the operation in case of success. If the original
- # method returns no data on success, such as `Delete`, the response is
- # `google.protobuf.Empty`. If the original method is standard
- # `Get`/`Create`/`Update`, the response should be the resource. For other
- # methods, the response should have the type `XxxResponse`, where `Xxx`
- # is the original method name. For example, if the original method name
- # is `TakeSnapshot()`, the inferred response type is
- # `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
"metadata": { # {
#
# `createTime`: The time the operation was created.
@@ -591,12 +686,6 @@
# }
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
- # If `true`, the operation is completed, and either `error` or `response` is
- # available.
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
"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.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -615,6 +704,22 @@
},
],
},
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
+ "response": { # The normal response of the operation in case of success. If the original
+ # method returns no data on success, such as `Delete`, the response is
+ # `google.protobuf.Empty`. If the original method is standard
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should be a resource name ending with `operations/{unique_id}`.
}</pre>
</div>
@@ -624,6 +729,7 @@
location (region) or all locations.
The location should have the following format:
+
* `projects/{project_id}/locations/{location_id}`
If `location_id` is specified as `-` (wildcard), then all regions
@@ -633,8 +739,8 @@
parent: string, Required. The resource name of the instance location using the form:
`projects/{project_id}/locations/{location_id}`
where `location_id` refers to a GCP region. (required)
- pageToken: string, The next_page_token value returned from a previous List request,
-if any.
+ pageToken: string, The `next_page_token` value returned from a previous
+ListInstances request, if any.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -644,7 +750,7 @@
If not specified, a default value of 1000 will be used by the service.
Regardless of the page_size value, the response may include a partial list
and a caller should only rely on response's
-next_page_token
+`next_page_token`
to determine if there are more instances left to be queried.
Returns:
@@ -653,19 +759,16 @@
{ # Response for ListInstances.
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more
# results in the list.
- "unreachable": [ # Locations that could not be reached.
- "A String",
- ],
"instances": [ # A list of Redis instances in the project in the specified location,
# or across all locations.
#
# If the `location_id` in the parent field of the request is "-", all regions
# available to the project are queried, and the results aggregated.
# If in such an aggregated query a location is unavailable, a dummy Redis
- # entry is included in the response with the "name" field set to a value of
- # the form projects/{project_id}/locations/{location_id}/instances/- and the
- # "status" field set to ERROR and "status_message" field set to "location not
- # available for ListInstances".
+ # entry is included in the response with the `name` field set to a value of
+ # the form `projects/{project_id}/locations/{location_id}/instances/`- and
+ # the `status` field set to ERROR and `status_message` field set to "location
+ # not available for ListInstances".
{ # A Google Cloud Redis instance.
"labels": { # Resource labels to represent user provided metadata
"a_key": "A String",
@@ -678,68 +781,79 @@
# Note: Redis instances are managed and addressed at regional level so
# location_id here refers to a GCP region; however, users may choose which
# specific zone (or collection of zones for cross-zone instances) an instance
- # should be provisioned in. Refer to [location_id] and
- # [alternative_location_id] fields for more details.
+ # should be provisioned in. Refer to location_id and
+ # alternative_location_id fields for more details.
"alternativeLocationId": "A String", # Optional. Only applicable to STANDARD_HA tier which protects the instance
# against zonal failures by provisioning it across two zones. If provided, it
- # must be a different zone from the one provided in [location_id].
- "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic
- # Tier instances, this will always be the same as the [location_id]
- # provided by the user at creation time. For Standard Tier instances,
- # this can be either [location_id] or [alternative_location_id] and can
- # change after a failover event.
+ # must be a different zone from the one provided in location_id.
+ "locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,
+ # the service will choose a zone for the instance. For STANDARD_HA tier,
+ # instances will be created across two zones for protection against zonal
+ # failures. If alternative_location_id is also provided, it must be
+ # different from location_id.
"reservedIpRange": "A String", # Optional. The CIDR range of internal addresses that are reserved for this
# instance. If not provided, the service will choose an unused /29 block,
# for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique
# and non-overlapping with existing subnets in an authorized network.
"redisVersion": "A String", # Optional. The version of Redis software.
- # If not provided, latest supported version will be used. Updating the
- # version will perform an upgrade/downgrade to the new version. Currently,
- # the supported values are:
+ # If not provided, latest supported version will be used. Currently, the
+ # supported values are:
#
- # * `REDIS_4_0` for Redis 4.0 compatibility
- # * `REDIS_3_2` for Redis 3.2 compatibility (default)
- "state": "A String", # Output only. The current state of this instance.
- "createTime": "A String", # Output only. The time the instance was created.
- "memorySizeGb": 42, # Required. Redis memory size in GiB.
+ # * `REDIS_3_2` for Redis 3.2 compatibility
+ # * `REDIS_4_0` for Redis 4.0 compatibility (default)
+ # * `REDIS_5_0` for Redis 5.0 compatibility
"host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by
# clients to connect to the service.
+ "createTime": "A String", # Output only. The time the instance was created.
+ "memorySizeGb": 42, # Required. Redis memory size in GiB.
+ "state": "A String", # Output only. The current state of this instance.
"persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to
# transfer data to/from Cloud Storage. Format is
- # "serviceAccount:<service_account_email>". The value may change over time
+ # "serviceAccount:<service_account_email>". The value may change over time
# for a given instance so should be checked before each import/export
# operation.
- "authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine
- # [network](/compute/docs/networks-and-firewalls#networks) to which the
- # instance is connected. If left unspecified, the `default` network
- # will be used.
+ "statusMessage": "A String", # Output only. Additional information about the current status of this
+ # instance, if available.
"redisConfigs": { # Optional. Redis configuration parameters, according to
# http://redis.io/topics/config. Currently, the only supported parameters
# are:
#
- # Redis 3.2 and above:
+ # Redis version 3.2 and newer:
#
# * maxmemory-policy
# * notify-keyspace-events
#
- # Redis 4.0 and above:
+ # Redis version 4.0 and newer:
#
# * activedefrag
- # * lfu-log-factor
# * lfu-decay-time
+ # * lfu-log-factor
+ # * maxmemory-gb
+ #
+ # Redis version 5.0 and newer:
+ #
+ # * stream-node-max-bytes
+ # * stream-node-max-entries
"a_key": "A String",
},
"tier": "A String", # Required. The service tier of the instance.
- "locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,
- # the service will choose a zone for the instance. For STANDARD_HA tier,
- # instances will be created across two zones for protection against zonal
- # failures. If [alternative_location_id] is also provided, it must be
- # different from [location_id].
+ "connectMode": "A String", # Optional. The network connect mode of the Redis instance.
+ # If not provided, the connect mode defaults to DIRECT_PEERING.
+ "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic
+ # Tier instances, this will always be the same as the location_id
+ # provided by the user at creation time. For Standard Tier instances,
+ # this can be either location_id or alternative_location_id and can
+ # change after a failover event.
"port": 42, # Output only. The port number of the exposed Redis endpoint.
- "statusMessage": "A String", # Output only. Additional information about the current status of this
- # instance, if available.
+ "authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine
+ # [network](/compute/docs/networks-and-firewalls#networks) to which the
+ # instance is connected. If left unspecified, the `default` network
+ # will be used.
},
],
+ "unreachable": [ # Locations that could not be reached.
+ "A String",
+ ],
}</pre>
</div>
@@ -758,7 +872,7 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
+ <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the metadata and configuration of a specific Redis instance.
Completed longrunning.Operation will contain the new instance object
@@ -773,9 +887,9 @@
Note: Redis instances are managed and addressed at regional level so
location_id here refers to a GCP region; however, users may choose which
specific zone (or collection of zones for cross-zone instances) an instance
-should be provisioned in. Refer to [location_id] and
-[alternative_location_id] fields for more details. (required)
- body: object, The request body. (required)
+should be provisioned in. Refer to location_id and
+alternative_location_id fields for more details. (required)
+ body: object, The request body.
The object takes the form of:
{ # A Google Cloud Redis instance.
@@ -790,66 +904,74 @@
# Note: Redis instances are managed and addressed at regional level so
# location_id here refers to a GCP region; however, users may choose which
# specific zone (or collection of zones for cross-zone instances) an instance
- # should be provisioned in. Refer to [location_id] and
- # [alternative_location_id] fields for more details.
+ # should be provisioned in. Refer to location_id and
+ # alternative_location_id fields for more details.
"alternativeLocationId": "A String", # Optional. Only applicable to STANDARD_HA tier which protects the instance
# against zonal failures by provisioning it across two zones. If provided, it
- # must be a different zone from the one provided in [location_id].
- "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic
- # Tier instances, this will always be the same as the [location_id]
- # provided by the user at creation time. For Standard Tier instances,
- # this can be either [location_id] or [alternative_location_id] and can
- # change after a failover event.
+ # must be a different zone from the one provided in location_id.
+ "locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,
+ # the service will choose a zone for the instance. For STANDARD_HA tier,
+ # instances will be created across two zones for protection against zonal
+ # failures. If alternative_location_id is also provided, it must be
+ # different from location_id.
"reservedIpRange": "A String", # Optional. The CIDR range of internal addresses that are reserved for this
# instance. If not provided, the service will choose an unused /29 block,
# for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique
# and non-overlapping with existing subnets in an authorized network.
"redisVersion": "A String", # Optional. The version of Redis software.
- # If not provided, latest supported version will be used. Updating the
- # version will perform an upgrade/downgrade to the new version. Currently,
- # the supported values are:
+ # If not provided, latest supported version will be used. Currently, the
+ # supported values are:
#
- # * `REDIS_4_0` for Redis 4.0 compatibility
- # * `REDIS_3_2` for Redis 3.2 compatibility (default)
- "state": "A String", # Output only. The current state of this instance.
- "createTime": "A String", # Output only. The time the instance was created.
- "memorySizeGb": 42, # Required. Redis memory size in GiB.
+ # * `REDIS_3_2` for Redis 3.2 compatibility
+ # * `REDIS_4_0` for Redis 4.0 compatibility (default)
+ # * `REDIS_5_0` for Redis 5.0 compatibility
"host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by
# clients to connect to the service.
+ "createTime": "A String", # Output only. The time the instance was created.
+ "memorySizeGb": 42, # Required. Redis memory size in GiB.
+ "state": "A String", # Output only. The current state of this instance.
"persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to
# transfer data to/from Cloud Storage. Format is
- # "serviceAccount:<service_account_email>". The value may change over time
+ # "serviceAccount:<service_account_email>". The value may change over time
# for a given instance so should be checked before each import/export
# operation.
- "authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine
- # [network](/compute/docs/networks-and-firewalls#networks) to which the
- # instance is connected. If left unspecified, the `default` network
- # will be used.
+ "statusMessage": "A String", # Output only. Additional information about the current status of this
+ # instance, if available.
"redisConfigs": { # Optional. Redis configuration parameters, according to
# http://redis.io/topics/config. Currently, the only supported parameters
# are:
#
- # Redis 3.2 and above:
+ # Redis version 3.2 and newer:
#
# * maxmemory-policy
# * notify-keyspace-events
#
- # Redis 4.0 and above:
+ # Redis version 4.0 and newer:
#
# * activedefrag
- # * lfu-log-factor
# * lfu-decay-time
+ # * lfu-log-factor
+ # * maxmemory-gb
+ #
+ # Redis version 5.0 and newer:
+ #
+ # * stream-node-max-bytes
+ # * stream-node-max-entries
"a_key": "A String",
},
"tier": "A String", # Required. The service tier of the instance.
- "locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,
- # the service will choose a zone for the instance. For STANDARD_HA tier,
- # instances will be created across two zones for protection against zonal
- # failures. If [alternative_location_id] is also provided, it must be
- # different from [location_id].
+ "connectMode": "A String", # Optional. The network connect mode of the Redis instance.
+ # If not provided, the connect mode defaults to DIRECT_PEERING.
+ "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic
+ # Tier instances, this will always be the same as the location_id
+ # provided by the user at creation time. For Standard Tier instances,
+ # this can be either location_id or alternative_location_id and can
+ # change after a failover event.
"port": 42, # Output only. The port number of the exposed Redis endpoint.
- "statusMessage": "A String", # Output only. Additional information about the current status of this
- # instance, if available.
+ "authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine
+ # [network](/compute/docs/networks-and-firewalls#networks) to which the
+ # instance is connected. If left unspecified, the `default` network
+ # will be used.
}
updateMask: string, Required. Mask of fields to update. At least one path must be supplied in
@@ -870,16 +992,6 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # The normal response of the operation in case of success. If the original
- # method returns no data on success, such as `Delete`, the response is
- # `google.protobuf.Empty`. If the original method is standard
- # `Get`/`Create`/`Update`, the response should be the resource. For other
- # methods, the response should have the type `XxxResponse`, where `Xxx`
- # is the original method name. For example, if the original method name
- # is `TakeSnapshot()`, the inferred response type is
- # `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
"metadata": { # {
#
# `createTime`: The time the operation was created.
@@ -899,12 +1011,6 @@
# }
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
- # If `true`, the operation is completed, and either `error` or `response` is
- # available.
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
"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.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -923,6 +1029,104 @@
},
],
},
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
+ "response": { # The normal response of the operation in case of success. If the original
+ # method returns no data on success, such as `Delete`, the response is
+ # `google.protobuf.Empty`. If the original method is standard
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should be a resource name ending with `operations/{unique_id}`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="upgrade">upgrade(name, body=None, x__xgafv=None)</code>
+ <pre>Upgrades Redis instance to the newer Redis version specified in the
+request.
+
+Args:
+ name: string, Required. Redis instance resource name using the form:
+ `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
+where `location_id` refers to a GCP region. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for UpgradeInstance.
+ "redisVersion": "A String", # Required. Specifies the target version of Redis software to upgrade to.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a
+ # network API call.
+ "metadata": { # {
+ #
+ # `createTime`: The time the operation was created.
+ #
+ # `endTime`: The time the operation finished running.
+ #
+ # `target`: Server-defined resource path for the target of the operation.
+ #
+ # `verb`: Name of the verb executed by the operation.
+ #
+ # `statusDetail`: Human-readable status of the operation, if any.
+ #
+ # `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`.
+ #
+ # `apiVersion`: API version used to start the operation.
+ #
+ # }
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "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.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
+ "response": { # The normal response of the operation in case of success. If the original
+ # method returns no data on success, such as `Delete`, the response is
+ # `google.protobuf.Empty`. If the original method is standard
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should be a resource name ending with `operations/{unique_id}`.
}</pre>
</div>