Skip to content

Commit c222b94

Browse files
feat(redis): update the api
#### redis:v1 The following keys were added: - resources.projects.resources.locations.resources.backupCollections.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.backupCollections.methods.list (Total Keys: 16) - resources.projects.resources.locations.resources.backupCollections.resources.backups.methods.delete (Total Keys: 13) - resources.projects.resources.locations.resources.backupCollections.resources.backups.methods.export (Total Keys: 12) - resources.projects.resources.locations.resources.backupCollections.resources.backups.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.backupCollections.resources.backups.methods.list (Total Keys: 16) - resources.projects.resources.locations.resources.clusters.methods.backup (Total Keys: 12) - schemas.AutomatedBackupConfig (Total Keys: 6) - schemas.Backup (Total Keys: 55) - schemas.Cluster.properties.automatedBackupConfig.$ref (Total Keys: 1) - schemas.Cluster.properties.backupCollection (Total Keys: 2) - schemas.Cluster.properties.gcsSource.$ref (Total Keys: 1) - schemas.Cluster.properties.managedBackupSource.$ref (Total Keys: 1) - schemas.ExportBackupRequest (Total Keys: 3) - schemas.FixedFrequencySchedule (Total Keys: 3) - schemas.GcsBackupSource (Total Keys: 4) - schemas.ListBackupCollectionsResponse (Total Keys: 7) - schemas.ListBackupsResponse (Total Keys: 7) - schemas.MachineConfiguration.properties.vcpuCount (Total Keys: 2) - schemas.ManagedBackupSource (Total Keys: 3) #### redis:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.backupCollections.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.backupCollections.methods.list (Total Keys: 16) - resources.projects.resources.locations.resources.backupCollections.resources.backups.methods.delete (Total Keys: 13) - resources.projects.resources.locations.resources.backupCollections.resources.backups.methods.export (Total Keys: 12) - resources.projects.resources.locations.resources.backupCollections.resources.backups.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.backupCollections.resources.backups.methods.list (Total Keys: 16) - resources.projects.resources.locations.resources.clusters.methods.backup (Total Keys: 12) - schemas.AutomatedBackupConfig (Total Keys: 6) - schemas.Backup (Total Keys: 55) - schemas.Cluster.properties.automatedBackupConfig.$ref (Total Keys: 1) - schemas.Cluster.properties.backupCollection (Total Keys: 2) - schemas.Cluster.properties.gcsSource.$ref (Total Keys: 1) - schemas.Cluster.properties.managedBackupSource.$ref (Total Keys: 1) - schemas.ExportBackupRequest (Total Keys: 3) - schemas.FixedFrequencySchedule (Total Keys: 3) - schemas.GcsBackupSource (Total Keys: 4) - schemas.ListBackupCollectionsResponse (Total Keys: 7) - schemas.ListBackupsResponse (Total Keys: 7) - schemas.MachineConfiguration.properties.vcpuCount (Total Keys: 2) - schemas.ManagedBackupSource (Total Keys: 3)
1 parent 3616688 commit c222b94

12 files changed

+2251
-9
lines changed
Lines changed: 277 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,277 @@
1+
<html><body>
2+
<style>
3+
4+
body, h1, h2, h3, div, span, p, pre, a {
5+
margin: 0;
6+
padding: 0;
7+
border: 0;
8+
font-weight: inherit;
9+
font-style: inherit;
10+
font-size: 100%;
11+
font-family: inherit;
12+
vertical-align: baseline;
13+
}
14+
15+
body {
16+
font-size: 13px;
17+
padding: 1em;
18+
}
19+
20+
h1 {
21+
font-size: 26px;
22+
margin-bottom: 1em;
23+
}
24+
25+
h2 {
26+
font-size: 24px;
27+
margin-bottom: 1em;
28+
}
29+
30+
h3 {
31+
font-size: 20px;
32+
margin-bottom: 1em;
33+
margin-top: 1em;
34+
}
35+
36+
pre, code {
37+
line-height: 1.5;
38+
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39+
}
40+
41+
pre {
42+
margin-top: 0.5em;
43+
}
44+
45+
h1, h2, h3, p {
46+
font-family: Arial, sans serif;
47+
}
48+
49+
h1, h2, h3 {
50+
border-bottom: solid #CCC 1px;
51+
}
52+
53+
.toc_element {
54+
margin-top: 0.5em;
55+
}
56+
57+
.firstline {
58+
margin-left: 2 em;
59+
}
60+
61+
.method {
62+
margin-top: 1em;
63+
border: solid 1px #CCC;
64+
padding: 1em;
65+
background: #EEE;
66+
}
67+
68+
.details {
69+
font-weight: bold;
70+
font-size: 14px;
71+
}
72+
73+
</style>
74+
75+
<h1><a href="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.backupCollections.html">backupCollections</a> . <a href="redis_v1.projects.locations.backupCollections.backups.html">backups</a></h1>
76+
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="#close">close()</a></code></p>
79+
<p class="firstline">Close httplib2 connections.</p>
80+
<p class="toc_element">
81+
<code><a href="#delete">delete(name, requestId=None, x__xgafv=None)</a></code></p>
82+
<p class="firstline">Deletes a specific backup.</p>
83+
<p class="toc_element">
84+
<code><a href="#export">export(name, body=None, x__xgafv=None)</a></code></p>
85+
<p class="firstline">Exports a specific backup to a customer target Cloud Storage URI.</p>
86+
<p class="toc_element">
87+
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88+
<p class="firstline">Gets the details of a specific backup.</p>
89+
<p class="toc_element">
90+
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
91+
<p class="firstline">Lists all backups owned by a backup collection.</p>
92+
<p class="toc_element">
93+
<code><a href="#list_next">list_next()</a></code></p>
94+
<p class="firstline">Retrieves the next page of results.</p>
95+
<h3>Method Details</h3>
96+
<div class="method">
97+
<code class="details" id="close">close()</code>
98+
<pre>Close httplib2 connections.</pre>
99+
</div>
100+
101+
<div class="method">
102+
<code class="details" id="delete">delete(name, requestId=None, x__xgafv=None)</code>
103+
<pre>Deletes a specific backup.
104+
105+
Args:
106+
name: string, Required. Redis backup resource name using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}` (required)
107+
requestId: string, Optional. Idempotent request UUID.
108+
x__xgafv: string, V1 error format.
109+
Allowed values
110+
1 - v1 error format
111+
2 - v2 error format
112+
113+
Returns:
114+
An object of the form:
115+
116+
{ # This resource represents a long-running operation that is the result of a network API call.
117+
&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.
118+
&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.
119+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
120+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
121+
{
122+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
123+
},
124+
],
125+
&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.
126+
},
127+
&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. }
128+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
129+
},
130+
&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}`.
131+
&quot;response&quot;: { # The normal, successful response of the operation. 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`.
132+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
133+
},
134+
}</pre>
135+
</div>
136+
137+
<div class="method">
138+
<code class="details" id="export">export(name, body=None, x__xgafv=None)</code>
139+
<pre>Exports a specific backup to a customer target Cloud Storage URI.
140+
141+
Args:
142+
name: string, Required. Redis backup resource name using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}` (required)
143+
body: object, The request body.
144+
The object takes the form of:
145+
146+
{ # Request for [ExportBackup].
147+
&quot;gcsBucket&quot;: &quot;A String&quot;, # Google Cloud Storage bucket, like &quot;my-bucket&quot;.
148+
}
149+
150+
x__xgafv: string, V1 error format.
151+
Allowed values
152+
1 - v1 error format
153+
2 - v2 error format
154+
155+
Returns:
156+
An object of the form:
157+
158+
{ # This resource represents a long-running operation that is the result of a network API call.
159+
&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.
160+
&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.
161+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
162+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
163+
{
164+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
165+
},
166+
],
167+
&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.
168+
},
169+
&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. }
170+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
171+
},
172+
&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}`.
173+
&quot;response&quot;: { # The normal, successful response of the operation. 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`.
174+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
175+
},
176+
}</pre>
177+
</div>
178+
179+
<div class="method">
180+
<code class="details" id="get">get(name, x__xgafv=None)</code>
181+
<pre>Gets the details of a specific backup.
182+
183+
Args:
184+
name: string, Required. Redis backup resource name using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}` (required)
185+
x__xgafv: string, V1 error format.
186+
Allowed values
187+
1 - v1 error format
188+
2 - v2 error format
189+
190+
Returns:
191+
An object of the form:
192+
193+
{ # Backup of a cluster.
194+
&quot;backupFiles&quot;: [ # Output only. List of backup files of the backup.
195+
{ # Backup is consisted of multiple backup files.
196+
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the backup file was created.
197+
&quot;fileName&quot;: &quot;A String&quot;, # Output only. e.g: .rdb
198+
&quot;sizeBytes&quot;: &quot;A String&quot;, # Output only. Size of the backup file in bytes.
199+
},
200+
],
201+
&quot;backupType&quot;: &quot;A String&quot;, # Output only. Type of the backup.
202+
&quot;cluster&quot;: &quot;A String&quot;, # Output only. Cluster resource path of this backup.
203+
&quot;clusterUid&quot;: &quot;A String&quot;, # Output only. Cluster uid of this backup.
204+
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the backup was created.
205+
&quot;engineVersion&quot;: &quot;A String&quot;, # Output only. redis-7.2, valkey-7.5
206+
&quot;expireTime&quot;: &quot;A String&quot;, # Output only. The time when the backup will expire.
207+
&quot;name&quot;: &quot;A String&quot;, # Identifier. Full resource path of the backup. the last part of the name is the backup id with the following format: [YYYYMMDDHHMMSS]_[Shorted Cluster UID] OR customer specified while backup cluster. Example: 20240515123000_1234
208+
&quot;nodeType&quot;: &quot;A String&quot;, # Output only. Node type of the cluster.
209+
&quot;replicaCount&quot;: 42, # Output only. Number of replicas for the cluster.
210+
&quot;shardCount&quot;: 42, # Output only. Number of shards for the cluster.
211+
&quot;state&quot;: &quot;A String&quot;, # Output only. State of the backup.
212+
&quot;totalSizeBytes&quot;: &quot;A String&quot;, # Output only. Total size of the backup in bytes.
213+
}</pre>
214+
</div>
215+
216+
<div class="method">
217+
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
218+
<pre>Lists all backups owned by a backup collection.
219+
220+
Args:
221+
parent: string, Required. The resource name of the backupCollection using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}` (required)
222+
pageSize: integer, Optional. 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 clusters left to be queried.
223+
pageToken: string, Optional. The `next_page_token` value returned from a previous [ListBackupCollections] request, if any.
224+
x__xgafv: string, V1 error format.
225+
Allowed values
226+
1 - v1 error format
227+
2 - v2 error format
228+
229+
Returns:
230+
An object of the form:
231+
232+
{ # Response for [ListBackups].
233+
&quot;backups&quot;: [ # A list of backups in the project.
234+
{ # Backup of a cluster.
235+
&quot;backupFiles&quot;: [ # Output only. List of backup files of the backup.
236+
{ # Backup is consisted of multiple backup files.
237+
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the backup file was created.
238+
&quot;fileName&quot;: &quot;A String&quot;, # Output only. e.g: .rdb
239+
&quot;sizeBytes&quot;: &quot;A String&quot;, # Output only. Size of the backup file in bytes.
240+
},
241+
],
242+
&quot;backupType&quot;: &quot;A String&quot;, # Output only. Type of the backup.
243+
&quot;cluster&quot;: &quot;A String&quot;, # Output only. Cluster resource path of this backup.
244+
&quot;clusterUid&quot;: &quot;A String&quot;, # Output only. Cluster uid of this backup.
245+
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the backup was created.
246+
&quot;engineVersion&quot;: &quot;A String&quot;, # Output only. redis-7.2, valkey-7.5
247+
&quot;expireTime&quot;: &quot;A String&quot;, # Output only. The time when the backup will expire.
248+
&quot;name&quot;: &quot;A String&quot;, # Identifier. Full resource path of the backup. the last part of the name is the backup id with the following format: [YYYYMMDDHHMMSS]_[Shorted Cluster UID] OR customer specified while backup cluster. Example: 20240515123000_1234
249+
&quot;nodeType&quot;: &quot;A String&quot;, # Output only. Node type of the cluster.
250+
&quot;replicaCount&quot;: 42, # Output only. Number of replicas for the cluster.
251+
&quot;shardCount&quot;: 42, # Output only. Number of shards for the cluster.
252+
&quot;state&quot;: &quot;A String&quot;, # Output only. State of the backup.
253+
&quot;totalSizeBytes&quot;: &quot;A String&quot;, # Output only. Total size of the backup in bytes.
254+
},
255+
],
256+
&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.
257+
&quot;unreachable&quot;: [ # Backups that could not be reached.
258+
&quot;A String&quot;,
259+
],
260+
}</pre>
261+
</div>
262+
263+
<div class="method">
264+
<code class="details" id="list_next">list_next()</code>
265+
<pre>Retrieves the next page of results.
266+
267+
Args:
268+
previous_request: The request for the previous page. (required)
269+
previous_response: The response from the request for the previous page. (required)
270+
271+
Returns:
272+
A request object that you can call &#x27;execute()&#x27; on to request the next
273+
page. Returns None if there are no more items in the collection.
274+
</pre>
275+
</div>
276+
277+
</body></html>

0 commit comments

Comments
 (0)