Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 25fba648ea647b62f2a6edc54ae927c1ed381b45 / . / docs / dyn / redis_v1.projects.locations.instances.html
blob: fe2689fdc73ec684b20c0987489ef3621448b8e9 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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_v1.html">Google Cloud Memorystore for Redis API</a> . <a href="redis_v1.projects.html">projects</a> . <a href="redis_v1.projects.locations.html">locations</a> . <a href="redis_v1.projects.locations.instances.html">instances</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#create">create(parent, body=None, instanceId=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Creates a Redis instance based on the specified tier and memory size. By default, the instance is accessible from the project's [default network](https://cloud.google.com/vpc/docs/vpc). The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">Deletes a specific Redis instance. Instance stops serving and data is deleted.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]87 <code><a href="#export">export(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88<p class="firstline">Export Redis instance data into a Redis RDB format file in Cloud Storage. Redis will continue serving during this operation. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]90 <code><a href="#failover">failover(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91<p class="firstline">Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92<p class="toc_element">
93 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
94<p class="firstline">Gets the details of a specific Redis instance.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]96 <code><a href="#import_">import_(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]97<p class="firstline">Import a Redis RDB snapshot file from Cloud Storage into a Redis instance. Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When complete, the instance will contain only data from the imported file. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]99 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100<p class="firstline">Lists all Redis instances owned by a project in either the specified 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 available to the project are queried, and the results are aggregated.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]101<p class="toc_element">
102 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
103<p class="firstline">Retrieves the next page of results.</p>
104<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]105 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]106<p class="firstline">Updates the metadata and configuration of a specific Redis instance. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.</p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]107<p class="toc_element">
108 <code><a href="#upgrade">upgrade(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]109<p class="firstline">Upgrades Redis instance to the newer Redis version specified in the request.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110<h3>Method Details</h3>
111<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]112 <code class="details" id="close">close()</code>
113 <pre>Close httplib2 connections.</pre>
114</div>
115
116<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]117 <code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]118 <pre>Creates a Redis instance based on the specified tier and memory size. By default, the instance is accessible from the project&#x27;s [default network](https://cloud.google.com/vpc/docs/vpc). The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]119
120Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]121 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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]122 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]123 The object takes the form of:
124
125{ # A Google Cloud Redis instance.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]126 &quot;alternativeLocationId&quot;: &quot;A String&quot;, # 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.
127 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of this instance.
128 &quot;redisConfigs&quot;: { # Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries
129 &quot;a_key&quot;: &quot;A String&quot;,
130 },
131 &quot;labels&quot;: { # Resource labels to represent user provided metadata
132 &quot;a_key&quot;: &quot;A String&quot;,
133 },
134 &quot;currentLocationId&quot;: &quot;A String&quot;, # 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.
135 &quot;authorizedNetwork&quot;: &quot;A String&quot;, # Optional. The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used.
136 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the instance was created.
137 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the current status of this instance, if available.
138 &quot;memorySizeGb&quot;: 42, # Required. Redis memory size in GiB.
139 &quot;name&quot;: &quot;A String&quot;, # Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` 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.
140 &quot;host&quot;: &quot;A String&quot;, # Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
141 &quot;connectMode&quot;: &quot;A String&quot;, # Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.
142 &quot;displayName&quot;: &quot;A String&quot;, # An arbitrary and optional user-provided name for the instance.
143 &quot;reservedIpRange&quot;: &quot;A String&quot;, # 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.
144 &quot;redisVersion&quot;: &quot;A String&quot;, # Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * `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
145 &quot;port&quot;: 42, # Output only. The port number of the exposed Redis endpoint.
146 &quot;tier&quot;: &quot;A String&quot;, # Required. The service tier of the instance.
147 &quot;persistenceIamIdentity&quot;: &quot;A String&quot;, # Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is &quot;serviceAccount:&quot;. The value may change over time for a given instance so should be checked before each import/export operation.
148 &quot;locationId&quot;: &quot;A String&quot;, # 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.
149}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]150
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]151 instanceId: string, Required. The logical name of the Redis instance in the customer project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-40 characters. * Must end with a number or a letter. * Must be unique within the customer project / location
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]152 x__xgafv: string, V1 error format.
153 Allowed values
154 1 - v1 error format
155 2 - v2 error format
156
157Returns:
158 An object of the form:
159
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]160 { # This resource represents a long-running operation that is the result of a network API call.
161 &quot;metadata&quot;: { # { `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. }
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]162 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
163 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]164 &quot;response&quot;: { # 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`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]165 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]166 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]167 &quot;name&quot;: &quot;A String&quot;, # 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}`.
168 &quot;done&quot;: 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.
169 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation.
170 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
171 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]172 {
173 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
174 },
175 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]176 &quot;message&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]177 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]178 }</pre>
179</div>
180
181<div class="method">
182 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]183 <pre>Deletes a specific Redis instance. Instance stops serving and data is deleted.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]184
185Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]186 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)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]187 x__xgafv: string, V1 error format.
188 Allowed values
189 1 - v1 error format
190 2 - v2 error format
191
192Returns:
193 An object of the form:
194
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]195 { # This resource represents a long-running operation that is the result of a network API call.
196 &quot;metadata&quot;: { # { `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. }
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]197 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
198 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]199 &quot;response&quot;: { # 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`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]200 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]201 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]202 &quot;name&quot;: &quot;A String&quot;, # 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}`.
203 &quot;done&quot;: 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.
204 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation.
205 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
206 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]207 {
208 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
209 },
210 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]211 &quot;message&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]212 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]213 }</pre>
214</div>
215
216<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]217 <code class="details" id="export">export(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]218 <pre>Export Redis instance data into a Redis RDB format file in Cloud Storage. Redis will continue serving during this operation. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]219
220Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]221 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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]222 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]223 The object takes the form of:
224
225{ # Request for Export.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]226 &quot;outputConfig&quot;: { # The output content # Required. Specify data to be exported.
227 &quot;gcsDestination&quot;: { # The Cloud Storage location for the output content # Google Cloud Storage destination for output content.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]228 &quot;uri&quot;: &quot;A String&quot;, # Required. Data destination URI (e.g. &#x27;gs://my_bucket/my_object&#x27;). Existing files will be overwritten.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]229 },
230 },
231 }
232
233 x__xgafv: string, V1 error format.
234 Allowed values
235 1 - v1 error format
236 2 - v2 error format
237
238Returns:
239 An object of the form:
240
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]241 { # This resource represents a long-running operation that is the result of a network API call.
242 &quot;metadata&quot;: { # { `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. }
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]243 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
244 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]245 &quot;response&quot;: { # 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`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]246 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]247 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]248 &quot;name&quot;: &quot;A String&quot;, # 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}`.
249 &quot;done&quot;: 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.
250 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation.
251 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
252 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]253 {
254 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
255 },
256 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]257 &quot;message&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]258 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]259 }</pre>
260</div>
261
262<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]263 <code class="details" id="failover">failover(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]264 <pre>Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]265
266Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]267 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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]268 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]269 The object takes the form of:
270
271{ # Request for Failover.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]272 &quot;dataProtectionMode&quot;: &quot;A String&quot;, # Optional. Available data protection modes that the user can choose. If it&#x27;s unspecified, data protection mode will be LIMITED_DATA_LOSS by default.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]273 }
274
275 x__xgafv: string, V1 error format.
276 Allowed values
277 1 - v1 error format
278 2 - v2 error format
279
280Returns:
281 An object of the form:
282
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]283 { # This resource represents a long-running operation that is the result of a network API call.
284 &quot;metadata&quot;: { # { `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. }
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]285 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
286 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]287 &quot;response&quot;: { # 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`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]288 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]289 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]290 &quot;name&quot;: &quot;A String&quot;, # 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}`.
291 &quot;done&quot;: 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.
292 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation.
293 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
294 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]295 {
296 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
297 },
298 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]299 &quot;message&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]300 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]301 }</pre>
302</div>
303
304<div class="method">
305 <code class="details" id="get">get(name, x__xgafv=None)</code>
306 <pre>Gets the details of a specific Redis instance.
307
308Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]309 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)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]310 x__xgafv: string, V1 error format.
311 Allowed values
312 1 - v1 error format
313 2 - v2 error format
314
315Returns:
316 An object of the form:
317
318 { # A Google Cloud Redis instance.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]319 &quot;alternativeLocationId&quot;: &quot;A String&quot;, # 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.
320 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of this instance.
321 &quot;redisConfigs&quot;: { # Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries
322 &quot;a_key&quot;: &quot;A String&quot;,
323 },
324 &quot;labels&quot;: { # Resource labels to represent user provided metadata
325 &quot;a_key&quot;: &quot;A String&quot;,
326 },
327 &quot;currentLocationId&quot;: &quot;A String&quot;, # 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.
328 &quot;authorizedNetwork&quot;: &quot;A String&quot;, # Optional. The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used.
329 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the instance was created.
330 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the current status of this instance, if available.
331 &quot;memorySizeGb&quot;: 42, # Required. Redis memory size in GiB.
332 &quot;name&quot;: &quot;A String&quot;, # Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` 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.
333 &quot;host&quot;: &quot;A String&quot;, # Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
334 &quot;connectMode&quot;: &quot;A String&quot;, # Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.
335 &quot;displayName&quot;: &quot;A String&quot;, # An arbitrary and optional user-provided name for the instance.
336 &quot;reservedIpRange&quot;: &quot;A String&quot;, # 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.
337 &quot;redisVersion&quot;: &quot;A String&quot;, # Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * `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
338 &quot;port&quot;: 42, # Output only. The port number of the exposed Redis endpoint.
339 &quot;tier&quot;: &quot;A String&quot;, # Required. The service tier of the instance.
340 &quot;persistenceIamIdentity&quot;: &quot;A String&quot;, # Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is &quot;serviceAccount:&quot;. The value may change over time for a given instance so should be checked before each import/export operation.
341 &quot;locationId&quot;: &quot;A String&quot;, # 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.
342 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]343</div>
344
345<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]346 <code class="details" id="import_">import_(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]347 <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 IMPORTING for entire operation. When complete, the instance will contain only data from the imported file. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]348
349Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]350 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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]351 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]352 The object takes the form of:
353
354{ # Request for Import.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]355 &quot;inputConfig&quot;: { # The input content # Required. Specify data to be imported.
356 &quot;gcsSource&quot;: { # The Cloud Storage location for the input content # Google Cloud Storage location where input content is located.
357 &quot;uri&quot;: &quot;A String&quot;, # Required. Source data URI. (e.g. &#x27;gs://my_bucket/my_object&#x27;).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]358 },
359 },
360 }
361
362 x__xgafv: string, V1 error format.
363 Allowed values
364 1 - v1 error format
365 2 - v2 error format
366
367Returns:
368 An object of the form:
369
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]370 { # This resource represents a long-running operation that is the result of a network API call.
371 &quot;metadata&quot;: { # { `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. }
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]372 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
373 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]374 &quot;response&quot;: { # 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`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]375 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]376 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]377 &quot;name&quot;: &quot;A String&quot;, # 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}`.
378 &quot;done&quot;: 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.
379 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation.
380 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
381 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]382 {
383 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
384 },
385 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]386 &quot;message&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]387 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]388 }</pre>
389</div>
390
391<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]392 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]393 <pre>Lists all Redis instances owned by a project in either the specified 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 available to the project are queried, and the results are aggregated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]394
395Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]396 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)
397 pageSize: integer, The maximum number of items to return. 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&#x27;s `next_page_token` to determine if there are more instances left to be queried.
398 pageToken: string, The `next_page_token` value returned from a previous ListInstances request, if any.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]399 x__xgafv: string, V1 error format.
400 Allowed values
401 1 - v1 error format
402 2 - v2 error format
403
404Returns:
405 An object of the form:
406
407 { # Response for ListInstances.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]408 &quot;instances&quot;: [ # 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 &quot;-&quot;, all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a placeholder 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 &quot;location not available for ListInstances&quot;.
409 { # A Google Cloud Redis instance.
410 &quot;alternativeLocationId&quot;: &quot;A String&quot;, # 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.
411 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of this instance.
412 &quot;redisConfigs&quot;: { # Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries
413 &quot;a_key&quot;: &quot;A String&quot;,
414 },
415 &quot;labels&quot;: { # Resource labels to represent user provided metadata
416 &quot;a_key&quot;: &quot;A String&quot;,
417 },
418 &quot;currentLocationId&quot;: &quot;A String&quot;, # 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.
419 &quot;authorizedNetwork&quot;: &quot;A String&quot;, # Optional. The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used.
420 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the instance was created.
421 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the current status of this instance, if available.
422 &quot;memorySizeGb&quot;: 42, # Required. Redis memory size in GiB.
423 &quot;name&quot;: &quot;A String&quot;, # Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` 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.
424 &quot;host&quot;: &quot;A String&quot;, # Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
425 &quot;connectMode&quot;: &quot;A String&quot;, # Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.
426 &quot;displayName&quot;: &quot;A String&quot;, # An arbitrary and optional user-provided name for the instance.
427 &quot;reservedIpRange&quot;: &quot;A String&quot;, # 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.
428 &quot;redisVersion&quot;: &quot;A String&quot;, # Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * `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
429 &quot;port&quot;: 42, # Output only. The port number of the exposed Redis endpoint.
430 &quot;tier&quot;: &quot;A String&quot;, # Required. The service tier of the instance.
431 &quot;persistenceIamIdentity&quot;: &quot;A String&quot;, # Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is &quot;serviceAccount:&quot;. The value may change over time for a given instance so should be checked before each import/export operation.
432 &quot;locationId&quot;: &quot;A String&quot;, # 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.
433 },
434 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]435 &quot;unreachable&quot;: [ # Locations that could not be reached.
436 &quot;A String&quot;,
437 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]438 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]439 }</pre>
440</div>
441
442<div class="method">
443 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
444 <pre>Retrieves the next page of results.
445
446Args:
447 previous_request: The request for the previous page. (required)
448 previous_response: The response from the request for the previous page. (required)
449
450Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]451 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]452 page. Returns None if there are no more items in the collection.
453 </pre>
454</div>
455
456<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]457 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]458 <pre>Updates the metadata and configuration of a specific Redis instance. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]459
460Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]461 name: string, Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` 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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]462 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]463 The object takes the form of:
464
465{ # A Google Cloud Redis instance.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]466 &quot;alternativeLocationId&quot;: &quot;A String&quot;, # 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.
467 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of this instance.
468 &quot;redisConfigs&quot;: { # Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries
469 &quot;a_key&quot;: &quot;A String&quot;,
470 },
471 &quot;labels&quot;: { # Resource labels to represent user provided metadata
472 &quot;a_key&quot;: &quot;A String&quot;,
473 },
474 &quot;currentLocationId&quot;: &quot;A String&quot;, # 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.
475 &quot;authorizedNetwork&quot;: &quot;A String&quot;, # Optional. The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used.
476 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the instance was created.
477 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the current status of this instance, if available.
478 &quot;memorySizeGb&quot;: 42, # Required. Redis memory size in GiB.
479 &quot;name&quot;: &quot;A String&quot;, # Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` 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.
480 &quot;host&quot;: &quot;A String&quot;, # Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
481 &quot;connectMode&quot;: &quot;A String&quot;, # Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.
482 &quot;displayName&quot;: &quot;A String&quot;, # An arbitrary and optional user-provided name for the instance.
483 &quot;reservedIpRange&quot;: &quot;A String&quot;, # 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.
484 &quot;redisVersion&quot;: &quot;A String&quot;, # Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * `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
485 &quot;port&quot;: 42, # Output only. The port number of the exposed Redis endpoint.
486 &quot;tier&quot;: &quot;A String&quot;, # Required. The service tier of the instance.
487 &quot;persistenceIamIdentity&quot;: &quot;A String&quot;, # Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is &quot;serviceAccount:&quot;. The value may change over time for a given instance so should be checked before each import/export operation.
488 &quot;locationId&quot;: &quot;A String&quot;, # 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.
489}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]490
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]491 updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Instance: * `displayName` * `labels` * `memorySizeGb` * `redisConfig`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]492 x__xgafv: string, V1 error format.
493 Allowed values
494 1 - v1 error format
495 2 - v2 error format
496
497Returns:
498 An object of the form:
499
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]500 { # This resource represents a long-running operation that is the result of a network API call.
501 &quot;metadata&quot;: { # { `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. }
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]502 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
503 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]504 &quot;response&quot;: { # 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`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]505 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]506 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]507 &quot;name&quot;: &quot;A String&quot;, # 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}`.
508 &quot;done&quot;: 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.
509 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation.
510 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
511 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]512 {
513 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
514 },
515 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]516 &quot;message&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]517 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]518 }</pre>
519</div>
520
521<div class="method">
522 <code class="details" id="upgrade">upgrade(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]523 <pre>Upgrades Redis instance to the newer Redis version specified in the request.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]524
525Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]526 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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]527 body: object, The request body.
528 The object takes the form of:
529
530{ # Request for UpgradeInstance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]531 &quot;redisVersion&quot;: &quot;A String&quot;, # Required. Specifies the target version of Redis software to upgrade to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]532 }
533
534 x__xgafv: string, V1 error format.
535 Allowed values
536 1 - v1 error format
537 2 - v2 error format
538
539Returns:
540 An object of the form:
541
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]542 { # This resource represents a long-running operation that is the result of a network API call.
543 &quot;metadata&quot;: { # { `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. }
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]544 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
545 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]546 &quot;response&quot;: { # 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`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]547 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]548 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]549 &quot;name&quot;: &quot;A String&quot;, # 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}`.
550 &quot;done&quot;: 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.
551 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation.
552 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
553 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]554 {
555 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
556 },
557 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]558 &quot;message&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]559 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]560 }</pre>
561</div>
562
563</body></html>