Skip to content

Commit 99c6007

Browse files
feat(redis): update the api
#### redis:v1 The following keys were added: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes (Total Keys: 3) #### redis:v1beta1 The following keys were added: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes (Total Keys: 3)
1 parent 7482f9a commit 99c6007

8 files changed

+56
-42
lines changed

docs/dyn/redis_v1.projects.locations.backupCollections.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ <h3>Method Details</h3>
102102
<pre>Get a backup collection.
103103

104104
Args:
105-
name: string, Required. Redis backupCollection resource name using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}` where `location_id` refers to a GCP region. (required)
105+
name: string, Required. Redis backupCollection resource name using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}` where `location_id` refers to a Google Cloud region. (required)
106106
x__xgafv: string, V1 error format.
107107
Allowed values
108108
1 - v1 error format
@@ -126,7 +126,7 @@ <h3>Method Details</h3>
126126
<pre>Lists all backup collections owned by a consumer project in either the specified location (region) or all locations. If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated.
127127

128128
Args:
129-
parent: string, Required. The resource name of the backupCollection location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region. (required)
129+
parent: string, Required. The resource name of the backupCollection location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a Google Cloud region. (required)
130130
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.
131131
pageToken: string, Optional. The `next_page_token` value returned from a previous [ListBackupCollections] request, if any.
132132
x__xgafv: string, V1 error format.

docs/dyn/redis_v1.projects.locations.clusters.html

+7-7
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ <h3>Method Details</h3>
110110
<pre>Backup Redis Cluster. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the cluster&#x27;s internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.
111111

112112
Args:
113-
name: string, Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region. (required)
113+
name: string, Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a Google Cloud region. (required)
114114
body: object, The request body.
115115
The object takes the form of:
116116

@@ -158,7 +158,7 @@ <h3>Method Details</h3>
158158
<pre>Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
159159

160160
Args:
161-
parent: string, Required. The resource name of the cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region. (required)
161+
parent: string, Required. The resource name of the cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a Google Cloud region. (required)
162162
body: object, The request body.
163163
The object takes the form of:
164164

@@ -376,7 +376,7 @@ <h3>Method Details</h3>
376376
<pre>Deletes a specific Redis cluster. Cluster stops serving and data is deleted.
377377

378378
Args:
379-
name: string, Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region. (required)
379+
name: string, Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a Google Cloud region. (required)
380380
requestId: string, Optional. Idempotent request UUID.
381381
x__xgafv: string, V1 error format.
382382
Allowed values
@@ -412,7 +412,7 @@ <h3>Method Details</h3>
412412
<pre>Gets the details of a specific Redis cluster.
413413

414414
Args:
415-
name: string, Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region. (required)
415+
name: string, Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a Google Cloud region. (required)
416416
x__xgafv: string, V1 error format.
417417
Allowed values
418418
1 - v1 error format
@@ -605,7 +605,7 @@ <h3>Method Details</h3>
605605
<pre>Gets the details of certificate authority information for Redis cluster.
606606

607607
Args:
608-
name: string, Required. Redis cluster certificate authority resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}/certificateAuthority` where `location_id` refers to a GCP region. (required)
608+
name: string, Required. Redis cluster certificate authority resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}/certificateAuthority` where `location_id` refers to a Google Cloud region. (required)
609609
x__xgafv: string, V1 error format.
610610
Allowed values
611611
1 - v1 error format
@@ -633,7 +633,7 @@ <h3>Method Details</h3>
633633
<pre>Lists all Redis clusters 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.
634634

635635
Args:
636-
parent: string, Required. The resource name of the cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region. (required)
636+
parent: string, Required. The resource name of the cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a Google Cloud region. (required)
637637
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 clusters left to be queried.
638638
pageToken: string, The `next_page_token` value returned from a previous ListClusters request, if any.
639639
x__xgafv: string, V1 error format.
@@ -1068,7 +1068,7 @@ <h3>Method Details</h3>
10681068
<pre>Reschedules upcoming maintenance event.
10691069

10701070
Args:
1071-
name: string, Required. Redis Cluster instance resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region. (required)
1071+
name: string, Required. Redis Cluster instance resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a Google Cloud region. (required)
10721072
body: object, The request body.
10731073
The object takes the form of:
10741074

docs/dyn/redis_v1.projects.locations.html

+3-2
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ <h2>Instance Methods</h2>
101101
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
102102
<p class="firstline">Gets information about a location.</p>
103103
<p class="toc_element">
104-
<code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
104+
<code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
105105
<p class="firstline">Lists information about the supported locations for this service.</p>
106106
<p class="toc_element">
107107
<code><a href="#list_next">list_next()</a></code></p>
@@ -140,11 +140,12 @@ <h3>Method Details</h3>
140140
</div>
141141

142142
<div class="method">
143-
<code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
143+
<code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
144144
<pre>Lists information about the supported locations for this service.
145145

146146
Args:
147147
name: string, The resource that owns the locations collection, if applicable. (required)
148+
extraLocationTypes: string, Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. (repeated)
148149
filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `&quot;displayName=tokyo&quot;`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
149150
pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
150151
pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

docs/dyn/redis_v1beta1.projects.locations.backupCollections.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ <h3>Method Details</h3>
102102
<pre>Get a backup collection.
103103

104104
Args:
105-
name: string, Required. Redis backupCollection resource name using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}` where `location_id` refers to a GCP region. (required)
105+
name: string, Required. Redis backupCollection resource name using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}` where `location_id` refers to a Google Cloud region. (required)
106106
x__xgafv: string, V1 error format.
107107
Allowed values
108108
1 - v1 error format
@@ -126,7 +126,7 @@ <h3>Method Details</h3>
126126
<pre>Lists all backup collections owned by a consumer project in either the specified location (region) or all locations. If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated.
127127

128128
Args:
129-
parent: string, Required. The resource name of the backupCollection location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region. (required)
129+
parent: string, Required. The resource name of the backupCollection location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a Google Cloud region. (required)
130130
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.
131131
pageToken: string, Optional. The `next_page_token` value returned from a previous [ListBackupCollections] request, if any.
132132
x__xgafv: string, V1 error format.

docs/dyn/redis_v1beta1.projects.locations.clusters.html

+7-7
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ <h3>Method Details</h3>
110110
<pre>Backup Redis Cluster. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the cluster&#x27;s internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.
111111

112112
Args:
113-
name: string, Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region. (required)
113+
name: string, Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a Google Cloud region. (required)
114114
body: object, The request body.
115115
The object takes the form of:
116116

@@ -158,7 +158,7 @@ <h3>Method Details</h3>
158158
<pre>Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
159159

160160
Args:
161-
parent: string, Required. The resource name of the cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region. (required)
161+
parent: string, Required. The resource name of the cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a Google Cloud region. (required)
162162
body: object, The request body.
163163
The object takes the form of:
164164

@@ -376,7 +376,7 @@ <h3>Method Details</h3>
376376
<pre>Deletes a specific Redis cluster. Cluster stops serving and data is deleted.
377377

378378
Args:
379-
name: string, Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region. (required)
379+
name: string, Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a Google Cloud region. (required)
380380
requestId: string, Optional. Idempotent request UUID.
381381
x__xgafv: string, V1 error format.
382382
Allowed values
@@ -412,7 +412,7 @@ <h3>Method Details</h3>
412412
<pre>Gets the details of a specific Redis cluster.
413413

414414
Args:
415-
name: string, Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region. (required)
415+
name: string, Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a Google Cloud region. (required)
416416
x__xgafv: string, V1 error format.
417417
Allowed values
418418
1 - v1 error format
@@ -605,7 +605,7 @@ <h3>Method Details</h3>
605605
<pre>Gets the details of certificate authority information for Redis cluster.
606606

607607
Args:
608-
name: string, Required. Redis cluster certificate authority resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}/certificateAuthority` where `location_id` refers to a GCP region. (required)
608+
name: string, Required. Redis cluster certificate authority resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}/certificateAuthority` where `location_id` refers to a Google Cloud region. (required)
609609
x__xgafv: string, V1 error format.
610610
Allowed values
611611
1 - v1 error format
@@ -633,7 +633,7 @@ <h3>Method Details</h3>
633633
<pre>Lists all Redis clusters 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.
634634

635635
Args:
636-
parent: string, Required. The resource name of the cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region. (required)
636+
parent: string, Required. The resource name of the cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a Google Cloud region. (required)
637637
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 clusters left to be queried.
638638
pageToken: string, The `next_page_token` value returned from a previous ListClusters request, if any.
639639
x__xgafv: string, V1 error format.
@@ -1068,7 +1068,7 @@ <h3>Method Details</h3>
10681068
<pre>Reschedules upcoming maintenance event.
10691069

10701070
Args:
1071-
name: string, Required. Redis Cluster instance resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region. (required)
1071+
name: string, Required. Redis Cluster instance resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a Google Cloud region. (required)
10721072
body: object, The request body.
10731073
The object takes the form of:
10741074

docs/dyn/redis_v1beta1.projects.locations.html

+3-2
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ <h2>Instance Methods</h2>
101101
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
102102
<p class="firstline">Gets information about a location.</p>
103103
<p class="toc_element">
104-
<code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
104+
<code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
105105
<p class="firstline">Lists information about the supported locations for this service.</p>
106106
<p class="toc_element">
107107
<code><a href="#list_next">list_next()</a></code></p>
@@ -140,11 +140,12 @@ <h3>Method Details</h3>
140140
</div>
141141

142142
<div class="method">
143-
<code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
143+
<code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
144144
<pre>Lists information about the supported locations for this service.
145145

146146
Args:
147147
name: string, The resource that owns the locations collection, if applicable. (required)
148+
extraLocationTypes: string, Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. (repeated)
148149
filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `&quot;displayName=tokyo&quot;`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
149150
pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
150151
pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

0 commit comments

Comments
 (0)