Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 70161c7

Browse files
committedOct 3, 2023
feat(redis): update the api
#### redis:v1 The following keys were added: - resources.projects.resources.locations.resources.clusters.methods.create (Total Keys: 16) - resources.projects.resources.locations.resources.clusters.methods.delete (Total Keys: 13) - resources.projects.resources.locations.resources.clusters.methods.get (Total Keys: 22) - resources.projects.resources.locations.resources.clusters.methods.list (Total Keys: 16) - resources.projects.resources.locations.resources.clusters.methods.patch (Total Keys: 17) - schemas.CertChain (Total Keys: 4) - schemas.CertificateAuthority (Total Keys: 3) - schemas.Cluster (Total Keys: 29) - schemas.DiscoveryEndpoint (Total Keys: 9) - schemas.ListClustersResponse (Total Keys: 7) - schemas.ManagedCertificateAuthority (Total Keys: 4) - schemas.OperationMetadata (Total Keys: 18) - schemas.PscConfig (Total Keys: 3) - schemas.PscConnection (Total Keys: 11) - schemas.StateInfo (Total Keys: 3) - schemas.UpdateInfo (Total Keys: 6)
1 parent d78cc18 commit 70161c7

File tree

4 files changed

+982
-2
lines changed

4 files changed

+982
-2
lines changed
 

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

+468
Large diffs are not rendered by default.

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

+5
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,11 @@
7474

7575
<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></h1>
7676
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="redis_v1.projects.locations.clusters.html">clusters()</a></code>
79+
</p>
80+
<p class="firstline">Returns the clusters Resource.</p>
81+
7782
<p class="toc_element">
7883
<code><a href="redis_v1.projects.locations.instances.html">instances()</a></code>
7984
</p>

‎googleapiclient/discovery_cache/documents/redis.v1.json

+508-1
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,203 @@
177177
}
178178
},
179179
"resources": {
180+
"clusters": {
181+
"methods": {
182+
"create": {
183+
"description": "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.",
184+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters",
185+
"httpMethod": "POST",
186+
"id": "redis.projects.locations.clusters.create",
187+
"parameterOrder": [
188+
"parent"
189+
],
190+
"parameters": {
191+
"clusterId": {
192+
"description": "Required. The logical name of the Redis cluster 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-63 characters. * Must end with a number or a letter. * Must be unique within the customer project / location",
193+
"location": "query",
194+
"type": "string"
195+
},
196+
"parent": {
197+
"description": "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.",
198+
"location": "path",
199+
"pattern": "^projects/[^/]+/locations/[^/]+$",
200+
"required": true,
201+
"type": "string"
202+
},
203+
"requestId": {
204+
"description": "Idempotent request UUID.",
205+
"location": "query",
206+
"type": "string"
207+
}
208+
},
209+
"path": "v1/{+parent}/clusters",
210+
"request": {
211+
"$ref": "Cluster"
212+
},
213+
"response": {
214+
"$ref": "Operation"
215+
},
216+
"scopes": [
217+
"https://www.googleapis.com/auth/cloud-platform"
218+
]
219+
},
220+
"delete": {
221+
"description": "Deletes a specific Redis cluster. Cluster stops serving and data is deleted.",
222+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
223+
"httpMethod": "DELETE",
224+
"id": "redis.projects.locations.clusters.delete",
225+
"parameterOrder": [
226+
"name"
227+
],
228+
"parameters": {
229+
"name": {
230+
"description": "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.",
231+
"location": "path",
232+
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
233+
"required": true,
234+
"type": "string"
235+
},
236+
"requestId": {
237+
"description": "Idempotent request UUID.",
238+
"location": "query",
239+
"type": "string"
240+
}
241+
},
242+
"path": "v1/{+name}",
243+
"response": {
244+
"$ref": "Operation"
245+
},
246+
"scopes": [
247+
"https://www.googleapis.com/auth/cloud-platform"
248+
]
249+
},
250+
"get": {
251+
"description": "Gets the details of a specific Redis cluster.",
252+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
253+
"httpMethod": "GET",
254+
"id": "redis.projects.locations.clusters.get",
255+
"parameterOrder": [
256+
"name"
257+
],
258+
"parameters": {
259+
"name": {
260+
"description": "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.",
261+
"location": "path",
262+
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
263+
"required": true,
264+
"type": "string"
265+
}
266+
},
267+
"path": "v1/{+name}",
268+
"response": {
269+
"$ref": "Cluster"
270+
},
271+
"scopes": [
272+
"https://www.googleapis.com/auth/cloud-platform"
273+
]
274+
},
275+
"getCertificateAuthority": {
276+
"description": "Gets the details of certificate authority information for Redis cluster.",
277+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/certificateAuthority",
278+
"httpMethod": "GET",
279+
"id": "redis.projects.locations.clusters.getCertificateAuthority",
280+
"parameterOrder": [
281+
"name"
282+
],
283+
"parameters": {
284+
"name": {
285+
"description": "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.",
286+
"location": "path",
287+
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
288+
"required": true,
289+
"type": "string"
290+
}
291+
},
292+
"path": "v1/{+name}/certificateAuthority",
293+
"response": {
294+
"$ref": "CertificateAuthority"
295+
},
296+
"scopes": [
297+
"https://www.googleapis.com/auth/cloud-platform"
298+
]
299+
},
300+
"list": {
301+
"description": "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.",
302+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters",
303+
"httpMethod": "GET",
304+
"id": "redis.projects.locations.clusters.list",
305+
"parameterOrder": [
306+
"parent"
307+
],
308+
"parameters": {
309+
"pageSize": {
310+
"description": "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's `next_page_token` to determine if there are more clusters left to be queried.",
311+
"format": "int32",
312+
"location": "query",
313+
"type": "integer"
314+
},
315+
"pageToken": {
316+
"description": "The `next_page_token` value returned from a previous ListClusters request, if any.",
317+
"location": "query",
318+
"type": "string"
319+
},
320+
"parent": {
321+
"description": "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.",
322+
"location": "path",
323+
"pattern": "^projects/[^/]+/locations/[^/]+$",
324+
"required": true,
325+
"type": "string"
326+
}
327+
},
328+
"path": "v1/{+parent}/clusters",
329+
"response": {
330+
"$ref": "ListClustersResponse"
331+
},
332+
"scopes": [
333+
"https://www.googleapis.com/auth/cloud-platform"
334+
]
335+
},
336+
"patch": {
337+
"description": "Updates the metadata and configuration of a specific Redis cluster. 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.",
338+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
339+
"httpMethod": "PATCH",
340+
"id": "redis.projects.locations.clusters.patch",
341+
"parameterOrder": [
342+
"name"
343+
],
344+
"parameters": {
345+
"name": {
346+
"description": "Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`",
347+
"location": "path",
348+
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
349+
"required": true,
350+
"type": "string"
351+
},
352+
"requestId": {
353+
"description": "Idempotent request UUID.",
354+
"location": "query",
355+
"type": "string"
356+
},
357+
"updateMask": {
358+
"description": "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 Cluster: * `size_gb` * `replica_count`",
359+
"format": "google-fieldmask",
360+
"location": "query",
361+
"type": "string"
362+
}
363+
},
364+
"path": "v1/{+name}",
365+
"request": {
366+
"$ref": "Cluster"
367+
},
368+
"response": {
369+
"$ref": "Operation"
370+
},
371+
"scopes": [
372+
"https://www.googleapis.com/auth/cloud-platform"
373+
]
374+
}
375+
}
376+
},
180377
"instances": {
181378
"methods": {
182379
"create": {
@@ -624,9 +821,168 @@
624821
}
625822
}
626823
},
627-
"revision": "20230915",
824+
"revision": "20230925",
628825
"rootUrl": "https://redis.googleapis.com/",
629826
"schemas": {
827+
"CertChain": {
828+
"id": "CertChain",
829+
"properties": {
830+
"certificates": {
831+
"description": "The certificates that form the CA chain, from leaf to root order.",
832+
"items": {
833+
"type": "string"
834+
},
835+
"type": "array"
836+
}
837+
},
838+
"type": "object"
839+
},
840+
"CertificateAuthority": {
841+
"description": "Redis cluster certificate authority",
842+
"id": "CertificateAuthority",
843+
"properties": {
844+
"managedServerCa": {
845+
"$ref": "ManagedCertificateAuthority"
846+
}
847+
},
848+
"type": "object"
849+
},
850+
"Cluster": {
851+
"description": "A cluster instance.",
852+
"id": "Cluster",
853+
"properties": {
854+
"authorizationMode": {
855+
"description": "Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.",
856+
"enum": [
857+
"AUTH_MODE_UNSPECIFIED",
858+
"AUTH_MODE_IAM_AUTH",
859+
"AUTH_MODE_DISABLED"
860+
],
861+
"enumDescriptions": [
862+
"Not set.",
863+
"IAM basic authorization mode",
864+
"Authorization disabled mode"
865+
],
866+
"type": "string"
867+
},
868+
"createTime": {
869+
"description": "Output only. The timestamp associated with the cluster creation request.",
870+
"format": "google-datetime",
871+
"readOnly": true,
872+
"type": "string"
873+
},
874+
"discoveryEndpoints": {
875+
"description": "Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.",
876+
"items": {
877+
"$ref": "DiscoveryEndpoint"
878+
},
879+
"readOnly": true,
880+
"type": "array"
881+
},
882+
"name": {
883+
"description": "Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`",
884+
"type": "string"
885+
},
886+
"pscConfigs": {
887+
"description": "Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.",
888+
"items": {
889+
"$ref": "PscConfig"
890+
},
891+
"type": "array"
892+
},
893+
"pscConnections": {
894+
"description": "Output only. PSC connections for discovery of the cluster topology and accessing the cluster.",
895+
"items": {
896+
"$ref": "PscConnection"
897+
},
898+
"readOnly": true,
899+
"type": "array"
900+
},
901+
"replicaCount": {
902+
"description": "Optional. The number of replica nodes per shard.",
903+
"format": "int32",
904+
"type": "integer"
905+
},
906+
"shardCount": {
907+
"description": "Required. Number of shards for the Redis cluster.",
908+
"format": "int32",
909+
"type": "integer"
910+
},
911+
"sizeGb": {
912+
"description": "Output only. Redis memory size in GB for the entire cluster.",
913+
"format": "int32",
914+
"readOnly": true,
915+
"type": "integer"
916+
},
917+
"state": {
918+
"description": "Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED",
919+
"enum": [
920+
"STATE_UNSPECIFIED",
921+
"CREATING",
922+
"ACTIVE",
923+
"UPDATING",
924+
"DELETING"
925+
],
926+
"enumDescriptions": [
927+
"Not set.",
928+
"Redis cluster is being created.",
929+
"Redis cluster has been created and is fully usable.",
930+
"Redis cluster configuration is being updated.",
931+
"Redis cluster is being deleted."
932+
],
933+
"readOnly": true,
934+
"type": "string"
935+
},
936+
"stateInfo": {
937+
"$ref": "StateInfo",
938+
"description": "Output only. Additional information about the current state of the cluster.",
939+
"readOnly": true
940+
},
941+
"transitEncryptionMode": {
942+
"description": "Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster.",
943+
"enum": [
944+
"TRANSIT_ENCRYPTION_MODE_UNSPECIFIED",
945+
"TRANSIT_ENCRYPTION_MODE_DISABLED",
946+
"TRANSIT_ENCRYPTION_MODE_SERVER_AUTHENTICATION"
947+
],
948+
"enumDescriptions": [
949+
"In-transit encryption not set.",
950+
"In-transit encryption disabled.",
951+
"Use server managed encryption for in-transit encryption."
952+
],
953+
"type": "string"
954+
},
955+
"uid": {
956+
"description": "Output only. System assigned, unique identifier for the cluster.",
957+
"readOnly": true,
958+
"type": "string"
959+
}
960+
},
961+
"type": "object"
962+
},
963+
"DiscoveryEndpoint": {
964+
"description": "Endpoints on each network, for Redis clients to connect to the cluster.",
965+
"id": "DiscoveryEndpoint",
966+
"properties": {
967+
"address": {
968+
"description": "Output only. Address of the exposed Redis endpoint used by clients to connect to the service. The address could be either IP or hostname.",
969+
"readOnly": true,
970+
"type": "string"
971+
},
972+
"port": {
973+
"description": "Output only. The port number of the exposed Redis endpoint.",
974+
"format": "int32",
975+
"readOnly": true,
976+
"type": "integer"
977+
},
978+
"pscConfig": {
979+
"$ref": "PscConfig",
980+
"description": "Output only. Customer configuration for where the endpoint is created and accessed from.",
981+
"readOnly": true
982+
}
983+
},
984+
"type": "object"
985+
},
630986
"Empty": {
631987
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
632988
"id": "Empty",
@@ -1030,6 +1386,31 @@
10301386
},
10311387
"type": "object"
10321388
},
1389+
"ListClustersResponse": {
1390+
"description": "Response for ListClusters.",
1391+
"id": "ListClustersResponse",
1392+
"properties": {
1393+
"clusters": {
1394+
"description": "A list of Redis clusters in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is \"-\", all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a 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}/clusters/`- and the `status` field set to ERROR and `status_message` field set to \"location not available for ListClusters\".",
1395+
"items": {
1396+
"$ref": "Cluster"
1397+
},
1398+
"type": "array"
1399+
},
1400+
"nextPageToken": {
1401+
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
1402+
"type": "string"
1403+
},
1404+
"unreachable": {
1405+
"description": "Locations that could not be reached.",
1406+
"items": {
1407+
"type": "string"
1408+
},
1409+
"type": "array"
1410+
}
1411+
},
1412+
"type": "object"
1413+
},
10331414
"ListInstancesResponse": {
10341415
"description": "Response for ListInstances.",
10351416
"id": "ListInstancesResponse",
@@ -1185,6 +1566,19 @@
11851566
},
11861567
"type": "object"
11871568
},
1569+
"ManagedCertificateAuthority": {
1570+
"id": "ManagedCertificateAuthority",
1571+
"properties": {
1572+
"caCerts": {
1573+
"description": "The PEM encoded CA certificate chains for redis managed server authentication",
1574+
"items": {
1575+
"$ref": "CertChain"
1576+
},
1577+
"type": "array"
1578+
}
1579+
},
1580+
"type": "object"
1581+
},
11881582
"NodeInfo": {
11891583
"description": "Node specific properties.",
11901584
"id": "NodeInfo",
@@ -1237,6 +1631,50 @@
12371631
},
12381632
"type": "object"
12391633
},
1634+
"OperationMetadata": {
1635+
"description": "Pre-defined metadata fields.",
1636+
"id": "OperationMetadata",
1637+
"properties": {
1638+
"apiVersion": {
1639+
"description": "Output only. API version used to start the operation.",
1640+
"readOnly": true,
1641+
"type": "string"
1642+
},
1643+
"createTime": {
1644+
"description": "Output only. The time the operation was created.",
1645+
"format": "google-datetime",
1646+
"readOnly": true,
1647+
"type": "string"
1648+
},
1649+
"endTime": {
1650+
"description": "Output only. The time the operation finished running.",
1651+
"format": "google-datetime",
1652+
"readOnly": true,
1653+
"type": "string"
1654+
},
1655+
"requestedCancellation": {
1656+
"description": "Output only. 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`.",
1657+
"readOnly": true,
1658+
"type": "boolean"
1659+
},
1660+
"statusMessage": {
1661+
"description": "Output only. Human-readable status of the operation, if any.",
1662+
"readOnly": true,
1663+
"type": "string"
1664+
},
1665+
"target": {
1666+
"description": "Output only. Server-defined resource path for the target of the operation.",
1667+
"readOnly": true,
1668+
"type": "string"
1669+
},
1670+
"verb": {
1671+
"description": "Output only. Name of the verb executed by the operation.",
1672+
"readOnly": true,
1673+
"type": "string"
1674+
}
1675+
},
1676+
"type": "object"
1677+
},
12401678
"OutputConfig": {
12411679
"description": "The output content",
12421680
"id": "OutputConfig",
@@ -1298,6 +1736,47 @@
12981736
},
12991737
"type": "object"
13001738
},
1739+
"PscConfig": {
1740+
"id": "PscConfig",
1741+
"properties": {
1742+
"network": {
1743+
"description": "Required. The network where the IP address of the discovery endpoint will be reserved, in the form of projects/{network_project}/global/networks/{network_id}.",
1744+
"type": "string"
1745+
}
1746+
},
1747+
"type": "object"
1748+
},
1749+
"PscConnection": {
1750+
"description": "Details of consumer resources in a PSC connection.",
1751+
"id": "PscConnection",
1752+
"properties": {
1753+
"address": {
1754+
"description": "Output only. The IP allocated on the consumer network for the PSC forwarding rule.",
1755+
"readOnly": true,
1756+
"type": "string"
1757+
},
1758+
"forwardingRule": {
1759+
"description": "Output only. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}.",
1760+
"readOnly": true,
1761+
"type": "string"
1762+
},
1763+
"network": {
1764+
"description": "The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}.",
1765+
"type": "string"
1766+
},
1767+
"projectId": {
1768+
"description": "Output only. The consumer project_id where the forwarding rule is created from.",
1769+
"readOnly": true,
1770+
"type": "string"
1771+
},
1772+
"pscConnectionId": {
1773+
"description": "Output only. The PSC connection id of the forwarding rule connected to the service attachment.",
1774+
"readOnly": true,
1775+
"type": "string"
1776+
}
1777+
},
1778+
"type": "object"
1779+
},
13011780
"ReconciliationOperationMetadata": {
13021781
"description": "Operation metadata returned by the CLH during resource state reconciliation.",
13031782
"id": "ReconciliationOperationMetadata",
@@ -1357,6 +1836,17 @@
13571836
},
13581837
"type": "object"
13591838
},
1839+
"StateInfo": {
1840+
"description": "Represents additional information about the state of the cluster.",
1841+
"id": "StateInfo",
1842+
"properties": {
1843+
"updateInfo": {
1844+
"$ref": "UpdateInfo",
1845+
"description": "Describes ongoing update on the cluster when cluster state is UPDATING."
1846+
}
1847+
},
1848+
"type": "object"
1849+
},
13601850
"Status": {
13611851
"description": "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).",
13621852
"id": "Status",
@@ -1442,6 +1932,23 @@
14421932
},
14431933
"type": "object"
14441934
},
1935+
"UpdateInfo": {
1936+
"description": "Represents information about an updating cluster.",
1937+
"id": "UpdateInfo",
1938+
"properties": {
1939+
"targetReplicaCount": {
1940+
"description": "Target number of replica nodes per shard.",
1941+
"format": "int32",
1942+
"type": "integer"
1943+
},
1944+
"targetShardCount": {
1945+
"description": "Target number of shards for redis cluster",
1946+
"format": "int32",
1947+
"type": "integer"
1948+
}
1949+
},
1950+
"type": "object"
1951+
},
14451952
"UpgradeInstanceRequest": {
14461953
"description": "Request for UpgradeInstance.",
14471954
"id": "UpgradeInstanceRequest",

‎googleapiclient/discovery_cache/documents/redis.v1beta1.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -821,7 +821,7 @@
821821
}
822822
}
823823
},
824-
"revision": "20230915",
824+
"revision": "20230925",
825825
"rootUrl": "https://redis.googleapis.com/",
826826
"schemas": {
827827
"CertChain": {

0 commit comments

Comments
 (0)
Please sign in to comment.