@maxim_mazurok/gapi.client.redis-v1 0.2.20260309 → 0.2.20260604
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +642 -10
- package/package.json +1 -1
- package/readme.md +18 -0
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://redis.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260604
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -24,10 +24,46 @@ declare namespace gapi.client {
|
|
|
24
24
|
function load(name: 'redis', version: 'v1', callback: () => any): void;
|
|
25
25
|
|
|
26
26
|
namespace redis {
|
|
27
|
+
interface AclPolicy {
|
|
28
|
+
/** Output only. Etag for the ACL policy. */
|
|
29
|
+
etag?: string;
|
|
30
|
+
/** Identifier. Full resource path of the ACL policy. */
|
|
31
|
+
name?: string;
|
|
32
|
+
/** Required. The ACL rules within the ACL policy. */
|
|
33
|
+
rules?: AclRule[];
|
|
34
|
+
/** Output only. The state of the ACL policy. */
|
|
35
|
+
state?: 'STATE_UNSPECIFIED' | 'ACTIVE' | 'UPDATING' | 'DELETING';
|
|
36
|
+
/** Output only. The version of the ACL policy. Used in drift resolution. */
|
|
37
|
+
version?: string;
|
|
38
|
+
}
|
|
39
|
+
interface AclRule {
|
|
40
|
+
/** Required. The rule to be applied to the username. Ex: "on >password123 ~* +@all" The format of the rule is defined by Redis OSS: https://redis.io/docs/latest/operate/oss_and_stack/management/security/acl/ */
|
|
41
|
+
rule?: string;
|
|
42
|
+
/** Required. Specifies the IAM user or service account to be added to the ACL policy. This username will be directly set on the Redis OSS. */
|
|
43
|
+
username?: string;
|
|
44
|
+
}
|
|
45
|
+
interface AddAuthTokenRequest {
|
|
46
|
+
/** Required. The auth token to add. */
|
|
47
|
+
authToken?: AuthToken;
|
|
48
|
+
}
|
|
49
|
+
interface AddTokenAuthUserRequest {
|
|
50
|
+
/** Required. The id of the token auth user to add. */
|
|
51
|
+
tokenAuthUser?: string;
|
|
52
|
+
}
|
|
27
53
|
interface AOFConfig {
|
|
28
54
|
/** Optional. fsync configuration. */
|
|
29
55
|
appendFsync?: 'APPEND_FSYNC_UNSPECIFIED' | 'NO' | 'EVERYSEC' | 'ALWAYS';
|
|
30
56
|
}
|
|
57
|
+
interface AuthToken {
|
|
58
|
+
/** Output only. Create time of the auth token. */
|
|
59
|
+
createTime?: string;
|
|
60
|
+
/** Identifier. Name of the auth token. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token} */
|
|
61
|
+
name?: string;
|
|
62
|
+
/** Output only. State of the auth token. */
|
|
63
|
+
state?: 'STATE_UNSPECIFIED' | 'ACTIVE' | 'CREATING' | 'DELETING';
|
|
64
|
+
/** Output only. The service generated authentication token used to connect to the Redis cluster. */
|
|
65
|
+
token?: string;
|
|
66
|
+
}
|
|
31
67
|
interface AutomatedBackupConfig {
|
|
32
68
|
/** Optional. The automated backup mode. If the mode is disabled, the other fields will be ignored. */
|
|
33
69
|
automatedBackupMode?:
|
|
@@ -79,7 +115,10 @@ declare namespace gapi.client {
|
|
|
79
115
|
| 'REDIS_SHARED_CORE_NANO'
|
|
80
116
|
| 'REDIS_HIGHMEM_MEDIUM'
|
|
81
117
|
| 'REDIS_HIGHMEM_XLARGE'
|
|
82
|
-
| 'REDIS_STANDARD_SMALL'
|
|
118
|
+
| 'REDIS_STANDARD_SMALL'
|
|
119
|
+
| 'REDIS_HIGHCPU_MEDIUM'
|
|
120
|
+
| 'REDIS_STANDARD_LARGE'
|
|
121
|
+
| 'REDIS_HIGHMEM_2XLARGE';
|
|
83
122
|
/** Output only. Number of replicas for the cluster. */
|
|
84
123
|
replicaCount?: number;
|
|
85
124
|
/** Output only. Number of shards for the cluster. */
|
|
@@ -178,6 +217,8 @@ declare namespace gapi.client {
|
|
|
178
217
|
interface Cluster {
|
|
179
218
|
/** Optional. The ACL policy to be applied to the cluster. */
|
|
180
219
|
aclPolicy?: string;
|
|
220
|
+
/** Optional. Output only. Indicates whether the ACL rules applied to the cluster are in sync with the latest ACL policy rules. This field is only applicable if the ACL policy is set for the cluster. */
|
|
221
|
+
aclPolicyInSync?: boolean;
|
|
181
222
|
/** Optional. Immutable. Deprecated, do not use. */
|
|
182
223
|
allowFewerZonesDeployment?: boolean;
|
|
183
224
|
/** Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted. */
|
|
@@ -186,7 +227,8 @@ declare namespace gapi.client {
|
|
|
186
227
|
authorizationMode?:
|
|
187
228
|
| 'AUTH_MODE_UNSPECIFIED'
|
|
188
229
|
| 'AUTH_MODE_IAM_AUTH'
|
|
189
|
-
| 'AUTH_MODE_DISABLED'
|
|
230
|
+
| 'AUTH_MODE_DISABLED'
|
|
231
|
+
| 'AUTH_MODE_TOKEN_AUTH';
|
|
190
232
|
/** Optional. The automated backup config for the cluster. */
|
|
191
233
|
automatedBackupConfig?: AutomatedBackupConfig;
|
|
192
234
|
/** Output only. This field is used to determine the available maintenance versions for the self service update. */
|
|
@@ -229,7 +271,10 @@ declare namespace gapi.client {
|
|
|
229
271
|
| 'REDIS_SHARED_CORE_NANO'
|
|
230
272
|
| 'REDIS_HIGHMEM_MEDIUM'
|
|
231
273
|
| 'REDIS_HIGHMEM_XLARGE'
|
|
232
|
-
| 'REDIS_STANDARD_SMALL'
|
|
274
|
+
| 'REDIS_STANDARD_SMALL'
|
|
275
|
+
| 'REDIS_HIGHCPU_MEDIUM'
|
|
276
|
+
| 'REDIS_STANDARD_LARGE'
|
|
277
|
+
| 'REDIS_HIGHMEM_2XLARGE';
|
|
233
278
|
/** Optional. Input only. Ondemand maintenance for the cluster. This field can be used to trigger ondemand critical update on the cluster. */
|
|
234
279
|
ondemandMaintenance?: boolean;
|
|
235
280
|
/** Optional. Persistence config (RDB, AOF) for the cluster. */
|
|
@@ -582,6 +627,8 @@ declare namespace gapi.client {
|
|
|
582
627
|
uniqueId?: string;
|
|
583
628
|
}
|
|
584
629
|
interface DatabaseResourceMetadata {
|
|
630
|
+
/** Field to ingest additional metadata whichd does not support proto format. */
|
|
631
|
+
additionalMetadata?: {[P in string]: any};
|
|
585
632
|
/** Availability configuration for this instance */
|
|
586
633
|
availabilityConfiguration?: AvailabilityConfiguration;
|
|
587
634
|
/** Backup configuration for this instance */
|
|
@@ -640,6 +687,10 @@ declare namespace gapi.client {
|
|
|
640
687
|
| 'SUB_RESOURCE_TYPE_RESERVATION'
|
|
641
688
|
| 'SUB_RESOURCE_TYPE_DATASET'
|
|
642
689
|
| 'SUB_RESOURCE_TYPE_OTHER';
|
|
690
|
+
/** Field to ingest additional metadata which support proto format. */
|
|
691
|
+
internalAdditionalMetadata?: {[P in string]: any};
|
|
692
|
+
/** Optional. Private and public IP address of the resource. */
|
|
693
|
+
ipAddress?: IpAddress;
|
|
643
694
|
/** Optional. Whether deletion protection is enabled for this resource. */
|
|
644
695
|
isDeletionProtectionEnabled?: boolean;
|
|
645
696
|
/** The resource location. REQUIRED */
|
|
@@ -648,6 +699,12 @@ declare namespace gapi.client {
|
|
|
648
699
|
machineConfiguration?: MachineConfiguration;
|
|
649
700
|
/** Optional. Maintenance info for the resource. */
|
|
650
701
|
maintenanceInfo?: ResourceMaintenanceInfo;
|
|
702
|
+
/** Optional. The modes of the database resource. */
|
|
703
|
+
modes?:
|
|
704
|
+
| 'MODE_UNSPECIFIED'
|
|
705
|
+
| 'MODE_NATIVE'
|
|
706
|
+
| 'MODE_MONGODB_COMPATIBLE'
|
|
707
|
+
| 'MODE_DATASTORE'[];
|
|
651
708
|
/** Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional. */
|
|
652
709
|
primaryResourceId?: DatabaseResourceId;
|
|
653
710
|
/** Primary resource location. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional. */
|
|
@@ -816,7 +873,7 @@ declare namespace gapi.client {
|
|
|
816
873
|
fullResourceName?: string;
|
|
817
874
|
/** Required. Last time signal was refreshed */
|
|
818
875
|
lastRefreshTime?: string;
|
|
819
|
-
/** Resource location. */
|
|
876
|
+
/** Required. Resource location. */
|
|
820
877
|
location?: string;
|
|
821
878
|
/** Database resource id. */
|
|
822
879
|
resourceId?: DatabaseResourceId;
|
|
@@ -1074,6 +1131,28 @@ declare namespace gapi.client {
|
|
|
1074
1131
|
/** Required. internal resource name for spanner this will be database name e.g."spanner.googleapis.com/projects/123/abc/instances/inst1/databases/db1" */
|
|
1075
1132
|
resourceName?: string;
|
|
1076
1133
|
}
|
|
1134
|
+
interface IpAddress {
|
|
1135
|
+
/** The private IP address assigned to the resource within a Virtual Private Cloud (VPC). This IP is only reachable from within the same VPC network. Stored in standard string format (e.g., "10.0.0.2"). */
|
|
1136
|
+
privateIp?: string;
|
|
1137
|
+
/** The public IP address assigned to the resource. This IP is reachable from the internet. Stored in standard string format (e.g., "34.72.1.1"). */
|
|
1138
|
+
publicIp?: string;
|
|
1139
|
+
}
|
|
1140
|
+
interface ListAclPoliciesResponse {
|
|
1141
|
+
/** A list of ACL policies 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. */
|
|
1142
|
+
aclPolicies?: AclPolicy[];
|
|
1143
|
+
/** Token to retrieve the next page of results, or empty if there are no more results in the list. */
|
|
1144
|
+
nextPageToken?: string;
|
|
1145
|
+
/** Locations that could not be reached. */
|
|
1146
|
+
unreachable?: string[];
|
|
1147
|
+
}
|
|
1148
|
+
interface ListAuthTokensResponse {
|
|
1149
|
+
/** A list of auth tokens in the project. */
|
|
1150
|
+
authTokens?: AuthToken[];
|
|
1151
|
+
/** Token to retrieve the next page of results, or empty if there are no more results in the list. */
|
|
1152
|
+
nextPageToken?: string;
|
|
1153
|
+
/** Unordered list. Auth tokens that could not be reached. */
|
|
1154
|
+
unreachable?: string[];
|
|
1155
|
+
}
|
|
1077
1156
|
interface ListBackupCollectionsResponse {
|
|
1078
1157
|
/** A list of backupCollections in the project. 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 backupCollection entry is included in the response with the `name` field set to a value of the form `projects/{project_id}/locations/{location_id}/backupCollections/`- and the `status` field set to ERROR and `status_message` field set to "location not available for ListBackupCollections". */
|
|
1079
1158
|
backupCollections?: BackupCollection[];
|
|
@@ -1120,6 +1199,14 @@ declare namespace gapi.client {
|
|
|
1120
1199
|
/** Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. */
|
|
1121
1200
|
unreachable?: string[];
|
|
1122
1201
|
}
|
|
1202
|
+
interface ListTokenAuthUsersResponse {
|
|
1203
|
+
/** Token to retrieve the next page of results, or empty if there are no more results in the list. */
|
|
1204
|
+
nextPageToken?: string;
|
|
1205
|
+
/** A list of token auth users in the project. */
|
|
1206
|
+
tokenAuthUsers?: TokenAuthUser[];
|
|
1207
|
+
/** Unordered list. Token auth users that could not be reached. */
|
|
1208
|
+
unreachable?: string[];
|
|
1209
|
+
}
|
|
1123
1210
|
interface Location {
|
|
1124
1211
|
/** The friendly name for this location, typically a nearby city name. For example, "Tokyo". */
|
|
1125
1212
|
displayName?: string;
|
|
@@ -1289,6 +1376,7 @@ declare namespace gapi.client {
|
|
|
1289
1376
|
| 'ENGINE_CLOUD_SPANNER_WITH_GOOGLESQL_DIALECT'
|
|
1290
1377
|
| 'ENGINE_MEMORYSTORE_FOR_REDIS'
|
|
1291
1378
|
| 'ENGINE_MEMORYSTORE_FOR_REDIS_CLUSTER'
|
|
1379
|
+
| 'ENGINE_MEMORSTORE_FOR_VALKEY'
|
|
1292
1380
|
| 'ENGINE_OTHER'
|
|
1293
1381
|
| 'ENGINE_FIRESTORE_WITH_NATIVE_MODE'
|
|
1294
1382
|
| 'ENGINE_FIRESTORE_WITH_DATASTORE_MODE'
|
|
@@ -1467,6 +1555,8 @@ declare namespace gapi.client {
|
|
|
1467
1555
|
| 'ERROR';
|
|
1468
1556
|
/** Optional. Current Maintenance version of the database resource. Example: "MYSQL_8_0_41.R20250531.01_15" */
|
|
1469
1557
|
maintenanceVersion?: string;
|
|
1558
|
+
/** Optional. List of next available maintenance versions. */
|
|
1559
|
+
nextAvailableMaintenanceVersions?: string[];
|
|
1470
1560
|
/** Optional. Upcoming maintenance for the database resource. This field is populated once SLM generates and publishes upcoming maintenance window. */
|
|
1471
1561
|
upcomingMaintenance?: UpcomingMaintenance;
|
|
1472
1562
|
}
|
|
@@ -1521,7 +1611,7 @@ declare namespace gapi.client {
|
|
|
1521
1611
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
1522
1612
|
code?: number;
|
|
1523
1613
|
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
1524
|
-
details?:
|
|
1614
|
+
details?: {[P in string]: any}[];
|
|
1525
1615
|
/** 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. */
|
|
1526
1616
|
message?: string;
|
|
1527
1617
|
}
|
|
@@ -1551,6 +1641,17 @@ declare namespace gapi.client {
|
|
|
1551
1641
|
/** Sha1 Fingerprint of the certificate. */
|
|
1552
1642
|
sha1Fingerprint?: string;
|
|
1553
1643
|
}
|
|
1644
|
+
interface TokenAuthUser {
|
|
1645
|
+
/** Identifier. The resource name of the token based auth user. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user} */
|
|
1646
|
+
name?: string;
|
|
1647
|
+
/** Output only. The state of the token based auth user. */
|
|
1648
|
+
state?:
|
|
1649
|
+
| 'STATE_UNSPECIFIED'
|
|
1650
|
+
| 'ACTIVE'
|
|
1651
|
+
| 'CREATING'
|
|
1652
|
+
| 'UPDATING'
|
|
1653
|
+
| 'DELETING';
|
|
1654
|
+
}
|
|
1554
1655
|
interface TypedValue {
|
|
1555
1656
|
/** For boolean value */
|
|
1556
1657
|
boolValue?: boolean;
|
|
@@ -1574,7 +1675,10 @@ declare namespace gapi.client {
|
|
|
1574
1675
|
| 'REDIS_SHARED_CORE_NANO'
|
|
1575
1676
|
| 'REDIS_HIGHMEM_MEDIUM'
|
|
1576
1677
|
| 'REDIS_HIGHMEM_XLARGE'
|
|
1577
|
-
| 'REDIS_STANDARD_SMALL'
|
|
1678
|
+
| 'REDIS_STANDARD_SMALL'
|
|
1679
|
+
| 'REDIS_HIGHCPU_MEDIUM'
|
|
1680
|
+
| 'REDIS_STANDARD_LARGE'
|
|
1681
|
+
| 'REDIS_HIGHMEM_2XLARGE';
|
|
1578
1682
|
/** Target number of replica nodes per shard. */
|
|
1579
1683
|
targetReplicaCount?: number;
|
|
1580
1684
|
/** Target number of shards for redis cluster */
|
|
@@ -1612,6 +1716,229 @@ declare namespace gapi.client {
|
|
|
1612
1716
|
/** Optional. When SINGLE ZONE distribution is selected, zone field would be used to allocate all resources in that zone. This is not applicable to MULTI_ZONE, and would be ignored for MULTI_ZONE clusters. */
|
|
1613
1717
|
zone?: string;
|
|
1614
1718
|
}
|
|
1719
|
+
interface AclPoliciesResource {
|
|
1720
|
+
/** Creates an ACL Policy. The creation is executed synchronously and the policy is available for use immediately after the RPC returns. */
|
|
1721
|
+
create(request: {
|
|
1722
|
+
/** V1 error format. */
|
|
1723
|
+
'$.xgafv'?: '1' | '2';
|
|
1724
|
+
/** OAuth access token. */
|
|
1725
|
+
access_token?: string;
|
|
1726
|
+
/** Required. The logical name of the ACL Policy 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 */
|
|
1727
|
+
aclPolicyId?: string;
|
|
1728
|
+
/** Data format for response. */
|
|
1729
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1730
|
+
/** JSONP */
|
|
1731
|
+
callback?: string;
|
|
1732
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1733
|
+
fields?: string;
|
|
1734
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1735
|
+
key?: string;
|
|
1736
|
+
/** OAuth 2.0 token for the current user. */
|
|
1737
|
+
oauth_token?: string;
|
|
1738
|
+
/** 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. */
|
|
1739
|
+
parent: string;
|
|
1740
|
+
/** Returns response with indentations and line breaks. */
|
|
1741
|
+
prettyPrint?: boolean;
|
|
1742
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1743
|
+
quotaUser?: string;
|
|
1744
|
+
/** Optional. Idempotent request UUID. . */
|
|
1745
|
+
requestId?: string;
|
|
1746
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1747
|
+
upload_protocol?: string;
|
|
1748
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1749
|
+
uploadType?: string;
|
|
1750
|
+
/** Request body */
|
|
1751
|
+
resource: AclPolicy;
|
|
1752
|
+
}): Request<AclPolicy>;
|
|
1753
|
+
create(
|
|
1754
|
+
request: {
|
|
1755
|
+
/** V1 error format. */
|
|
1756
|
+
'$.xgafv'?: '1' | '2';
|
|
1757
|
+
/** OAuth access token. */
|
|
1758
|
+
access_token?: string;
|
|
1759
|
+
/** Required. The logical name of the ACL Policy 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 */
|
|
1760
|
+
aclPolicyId?: string;
|
|
1761
|
+
/** Data format for response. */
|
|
1762
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1763
|
+
/** JSONP */
|
|
1764
|
+
callback?: string;
|
|
1765
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1766
|
+
fields?: string;
|
|
1767
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1768
|
+
key?: string;
|
|
1769
|
+
/** OAuth 2.0 token for the current user. */
|
|
1770
|
+
oauth_token?: string;
|
|
1771
|
+
/** 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. */
|
|
1772
|
+
parent: string;
|
|
1773
|
+
/** Returns response with indentations and line breaks. */
|
|
1774
|
+
prettyPrint?: boolean;
|
|
1775
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1776
|
+
quotaUser?: string;
|
|
1777
|
+
/** Optional. Idempotent request UUID. . */
|
|
1778
|
+
requestId?: string;
|
|
1779
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1780
|
+
upload_protocol?: string;
|
|
1781
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1782
|
+
uploadType?: string;
|
|
1783
|
+
},
|
|
1784
|
+
body: AclPolicy,
|
|
1785
|
+
): Request<AclPolicy>;
|
|
1786
|
+
/** Deletes a specific Acl Policy. This action will delete the Acl Policy and all the rules associated with it. An ACL policy cannot be deleted if it is attached to a cluster. */
|
|
1787
|
+
delete(request?: {
|
|
1788
|
+
/** V1 error format. */
|
|
1789
|
+
'$.xgafv'?: '1' | '2';
|
|
1790
|
+
/** OAuth access token. */
|
|
1791
|
+
access_token?: string;
|
|
1792
|
+
/** Data format for response. */
|
|
1793
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1794
|
+
/** JSONP */
|
|
1795
|
+
callback?: string;
|
|
1796
|
+
/** Optional. Etag of the ACL policy. If this is different from the server's etag, the request will fail with an ABORTED error. */
|
|
1797
|
+
etag?: string;
|
|
1798
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1799
|
+
fields?: string;
|
|
1800
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1801
|
+
key?: string;
|
|
1802
|
+
/** Required. Redis ACL Policy resource name using the form: `projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id}` where `location_id` refers to a GCP region. */
|
|
1803
|
+
name: string;
|
|
1804
|
+
/** OAuth 2.0 token for the current user. */
|
|
1805
|
+
oauth_token?: string;
|
|
1806
|
+
/** Returns response with indentations and line breaks. */
|
|
1807
|
+
prettyPrint?: boolean;
|
|
1808
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1809
|
+
quotaUser?: string;
|
|
1810
|
+
/** Optional. Idempotent request UUID. */
|
|
1811
|
+
requestId?: string;
|
|
1812
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1813
|
+
upload_protocol?: string;
|
|
1814
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1815
|
+
uploadType?: string;
|
|
1816
|
+
}): Request<Operation>;
|
|
1817
|
+
/** Gets the details of a specific Redis Cluster ACL Policy. */
|
|
1818
|
+
get(request?: {
|
|
1819
|
+
/** V1 error format. */
|
|
1820
|
+
'$.xgafv'?: '1' | '2';
|
|
1821
|
+
/** OAuth access token. */
|
|
1822
|
+
access_token?: string;
|
|
1823
|
+
/** Data format for response. */
|
|
1824
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1825
|
+
/** JSONP */
|
|
1826
|
+
callback?: string;
|
|
1827
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1828
|
+
fields?: string;
|
|
1829
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1830
|
+
key?: string;
|
|
1831
|
+
/** Required. Redis ACL Policy resource name using the form: `projects/{project_id}/locations/{location_id}/aclPolicies/{acl_policy_id}` where `location_id` refers to a GCP region. */
|
|
1832
|
+
name: string;
|
|
1833
|
+
/** OAuth 2.0 token for the current user. */
|
|
1834
|
+
oauth_token?: string;
|
|
1835
|
+
/** Returns response with indentations and line breaks. */
|
|
1836
|
+
prettyPrint?: boolean;
|
|
1837
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1838
|
+
quotaUser?: string;
|
|
1839
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1840
|
+
upload_protocol?: string;
|
|
1841
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1842
|
+
uploadType?: string;
|
|
1843
|
+
}): Request<AclPolicy>;
|
|
1844
|
+
/** Lists all ACL Policies 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. */
|
|
1845
|
+
list(request?: {
|
|
1846
|
+
/** V1 error format. */
|
|
1847
|
+
'$.xgafv'?: '1' | '2';
|
|
1848
|
+
/** OAuth access token. */
|
|
1849
|
+
access_token?: string;
|
|
1850
|
+
/** Data format for response. */
|
|
1851
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1852
|
+
/** JSONP */
|
|
1853
|
+
callback?: string;
|
|
1854
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1855
|
+
fields?: string;
|
|
1856
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1857
|
+
key?: string;
|
|
1858
|
+
/** OAuth 2.0 token for the current user. */
|
|
1859
|
+
oauth_token?: string;
|
|
1860
|
+
/** 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's `next_page_token` to determine if there are more ACL policies left to be queried. The maximum value is 1000; values above 1000 will be coerced to 1000. */
|
|
1861
|
+
pageSize?: number;
|
|
1862
|
+
/** Optional. The `next_page_token` value returned from a previous `ListAclPolicies` request, if any. */
|
|
1863
|
+
pageToken?: string;
|
|
1864
|
+
/** 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. */
|
|
1865
|
+
parent: string;
|
|
1866
|
+
/** Returns response with indentations and line breaks. */
|
|
1867
|
+
prettyPrint?: boolean;
|
|
1868
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1869
|
+
quotaUser?: string;
|
|
1870
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1871
|
+
upload_protocol?: string;
|
|
1872
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1873
|
+
uploadType?: string;
|
|
1874
|
+
}): Request<ListAclPoliciesResponse>;
|
|
1875
|
+
/** Updates the ACL policy. The operation applies the updated ACL policy to all of the linked clusters. If Memorystore can apply the policy to all clusters, then the operation returns a SUCCESS status. If Memorystore can't apply the policy to all clusters, then to ensure eventual consistency, Memorystore uses reconciliation to apply the policy to the failed clusters. Completed longrunning.Operation will contain the new ACL Policy object in the response field. */
|
|
1876
|
+
patch(request: {
|
|
1877
|
+
/** V1 error format. */
|
|
1878
|
+
'$.xgafv'?: '1' | '2';
|
|
1879
|
+
/** OAuth access token. */
|
|
1880
|
+
access_token?: string;
|
|
1881
|
+
/** Data format for response. */
|
|
1882
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1883
|
+
/** JSONP */
|
|
1884
|
+
callback?: string;
|
|
1885
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1886
|
+
fields?: string;
|
|
1887
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1888
|
+
key?: string;
|
|
1889
|
+
/** Identifier. Full resource path of the ACL policy. */
|
|
1890
|
+
name: string;
|
|
1891
|
+
/** OAuth 2.0 token for the current user. */
|
|
1892
|
+
oauth_token?: string;
|
|
1893
|
+
/** Returns response with indentations and line breaks. */
|
|
1894
|
+
prettyPrint?: boolean;
|
|
1895
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1896
|
+
quotaUser?: string;
|
|
1897
|
+
/** Optional. Idempotent request UUID. */
|
|
1898
|
+
requestId?: string;
|
|
1899
|
+
/** Optional. Mask of fields to be updated. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from `AclPolicy`: * `rules` */
|
|
1900
|
+
updateMask?: string;
|
|
1901
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1902
|
+
upload_protocol?: string;
|
|
1903
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1904
|
+
uploadType?: string;
|
|
1905
|
+
/** Request body */
|
|
1906
|
+
resource: AclPolicy;
|
|
1907
|
+
}): Request<Operation>;
|
|
1908
|
+
patch(
|
|
1909
|
+
request: {
|
|
1910
|
+
/** V1 error format. */
|
|
1911
|
+
'$.xgafv'?: '1' | '2';
|
|
1912
|
+
/** OAuth access token. */
|
|
1913
|
+
access_token?: string;
|
|
1914
|
+
/** Data format for response. */
|
|
1915
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1916
|
+
/** JSONP */
|
|
1917
|
+
callback?: string;
|
|
1918
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1919
|
+
fields?: string;
|
|
1920
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1921
|
+
key?: string;
|
|
1922
|
+
/** Identifier. Full resource path of the ACL policy. */
|
|
1923
|
+
name: string;
|
|
1924
|
+
/** OAuth 2.0 token for the current user. */
|
|
1925
|
+
oauth_token?: string;
|
|
1926
|
+
/** Returns response with indentations and line breaks. */
|
|
1927
|
+
prettyPrint?: boolean;
|
|
1928
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1929
|
+
quotaUser?: string;
|
|
1930
|
+
/** Optional. Idempotent request UUID. */
|
|
1931
|
+
requestId?: string;
|
|
1932
|
+
/** Optional. Mask of fields to be updated. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from `AclPolicy`: * `rules` */
|
|
1933
|
+
updateMask?: string;
|
|
1934
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1935
|
+
upload_protocol?: string;
|
|
1936
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1937
|
+
uploadType?: string;
|
|
1938
|
+
},
|
|
1939
|
+
body: AclPolicy,
|
|
1940
|
+
): Request<Operation>;
|
|
1941
|
+
}
|
|
1615
1942
|
interface BackupsResource {
|
|
1616
1943
|
/** Deletes a specific backup. */
|
|
1617
1944
|
delete(request?: {
|
|
@@ -1820,7 +2147,310 @@ declare namespace gapi.client {
|
|
|
1820
2147
|
}): Request<ListBackupCollectionsResponse>;
|
|
1821
2148
|
backups: BackupsResource;
|
|
1822
2149
|
}
|
|
2150
|
+
interface AuthTokensResource {
|
|
2151
|
+
/** Removes a auth token for a user of a token based auth enabled instance. */
|
|
2152
|
+
delete(request?: {
|
|
2153
|
+
/** V1 error format. */
|
|
2154
|
+
'$.xgafv'?: '1' | '2';
|
|
2155
|
+
/** OAuth access token. */
|
|
2156
|
+
access_token?: string;
|
|
2157
|
+
/** Data format for response. */
|
|
2158
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2159
|
+
/** JSONP */
|
|
2160
|
+
callback?: string;
|
|
2161
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2162
|
+
fields?: string;
|
|
2163
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2164
|
+
key?: string;
|
|
2165
|
+
/** Required. The name of the token auth user resource that this auth token will be deleted from. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token} */
|
|
2166
|
+
name: string;
|
|
2167
|
+
/** OAuth 2.0 token for the current user. */
|
|
2168
|
+
oauth_token?: string;
|
|
2169
|
+
/** Returns response with indentations and line breaks. */
|
|
2170
|
+
prettyPrint?: boolean;
|
|
2171
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2172
|
+
quotaUser?: string;
|
|
2173
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2174
|
+
upload_protocol?: string;
|
|
2175
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2176
|
+
uploadType?: string;
|
|
2177
|
+
}): Request<Operation>;
|
|
2178
|
+
/** Gets a specific auth token for a specific token auth user. */
|
|
2179
|
+
get(request?: {
|
|
2180
|
+
/** V1 error format. */
|
|
2181
|
+
'$.xgafv'?: '1' | '2';
|
|
2182
|
+
/** OAuth access token. */
|
|
2183
|
+
access_token?: string;
|
|
2184
|
+
/** Data format for response. */
|
|
2185
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2186
|
+
/** JSONP */
|
|
2187
|
+
callback?: string;
|
|
2188
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2189
|
+
fields?: string;
|
|
2190
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2191
|
+
key?: string;
|
|
2192
|
+
/** Required. The name of auth token for a token based auth enabled cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token} */
|
|
2193
|
+
name: string;
|
|
2194
|
+
/** OAuth 2.0 token for the current user. */
|
|
2195
|
+
oauth_token?: string;
|
|
2196
|
+
/** Returns response with indentations and line breaks. */
|
|
2197
|
+
prettyPrint?: boolean;
|
|
2198
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2199
|
+
quotaUser?: string;
|
|
2200
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2201
|
+
upload_protocol?: string;
|
|
2202
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2203
|
+
uploadType?: string;
|
|
2204
|
+
}): Request<AuthToken>;
|
|
2205
|
+
/** Lists all the auth tokens for a specific token auth user. */
|
|
2206
|
+
list(request?: {
|
|
2207
|
+
/** V1 error format. */
|
|
2208
|
+
'$.xgafv'?: '1' | '2';
|
|
2209
|
+
/** OAuth access token. */
|
|
2210
|
+
access_token?: string;
|
|
2211
|
+
/** Data format for response. */
|
|
2212
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2213
|
+
/** JSONP */
|
|
2214
|
+
callback?: string;
|
|
2215
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2216
|
+
fields?: string;
|
|
2217
|
+
/** Optional. Expression for filtering results. */
|
|
2218
|
+
filter?: string;
|
|
2219
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2220
|
+
key?: string;
|
|
2221
|
+
/** OAuth 2.0 token for the current user. */
|
|
2222
|
+
oauth_token?: string;
|
|
2223
|
+
/** Optional. Sort results by a defined order. */
|
|
2224
|
+
orderBy?: string;
|
|
2225
|
+
/** Optional. The maximum number of items to return. The maximum value is 1000; values above 1000 will be coerced to 1000. 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. */
|
|
2226
|
+
pageSize?: number;
|
|
2227
|
+
/** Optional. The `next_page_token` value returned from a previous [ListTokenAuthUsers] request, if any. */
|
|
2228
|
+
pageToken?: string;
|
|
2229
|
+
/** Required. The parent resource that this auth token will be listed for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user} */
|
|
2230
|
+
parent: string;
|
|
2231
|
+
/** Returns response with indentations and line breaks. */
|
|
2232
|
+
prettyPrint?: boolean;
|
|
2233
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2234
|
+
quotaUser?: string;
|
|
2235
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2236
|
+
upload_protocol?: string;
|
|
2237
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2238
|
+
uploadType?: string;
|
|
2239
|
+
}): Request<ListAuthTokensResponse>;
|
|
2240
|
+
}
|
|
2241
|
+
interface TokenAuthUsersResource {
|
|
2242
|
+
/** Adds a auth token for a user of a token based auth enabled cluster. */
|
|
2243
|
+
addAuthToken(request: {
|
|
2244
|
+
/** V1 error format. */
|
|
2245
|
+
'$.xgafv'?: '1' | '2';
|
|
2246
|
+
/** OAuth access token. */
|
|
2247
|
+
access_token?: string;
|
|
2248
|
+
/** Data format for response. */
|
|
2249
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2250
|
+
/** JSONP */
|
|
2251
|
+
callback?: string;
|
|
2252
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2253
|
+
fields?: string;
|
|
2254
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2255
|
+
key?: string;
|
|
2256
|
+
/** OAuth 2.0 token for the current user. */
|
|
2257
|
+
oauth_token?: string;
|
|
2258
|
+
/** Returns response with indentations and line breaks. */
|
|
2259
|
+
prettyPrint?: boolean;
|
|
2260
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2261
|
+
quotaUser?: string;
|
|
2262
|
+
/** Required. The name of the token auth user resource that this auth token will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user} */
|
|
2263
|
+
tokenAuthUser: string;
|
|
2264
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2265
|
+
upload_protocol?: string;
|
|
2266
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2267
|
+
uploadType?: string;
|
|
2268
|
+
/** Request body */
|
|
2269
|
+
resource: AddAuthTokenRequest;
|
|
2270
|
+
}): Request<Operation>;
|
|
2271
|
+
addAuthToken(
|
|
2272
|
+
request: {
|
|
2273
|
+
/** V1 error format. */
|
|
2274
|
+
'$.xgafv'?: '1' | '2';
|
|
2275
|
+
/** OAuth access token. */
|
|
2276
|
+
access_token?: string;
|
|
2277
|
+
/** Data format for response. */
|
|
2278
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2279
|
+
/** JSONP */
|
|
2280
|
+
callback?: string;
|
|
2281
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2282
|
+
fields?: string;
|
|
2283
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2284
|
+
key?: string;
|
|
2285
|
+
/** OAuth 2.0 token for the current user. */
|
|
2286
|
+
oauth_token?: string;
|
|
2287
|
+
/** Returns response with indentations and line breaks. */
|
|
2288
|
+
prettyPrint?: boolean;
|
|
2289
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2290
|
+
quotaUser?: string;
|
|
2291
|
+
/** Required. The name of the token auth user resource that this auth token will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user} */
|
|
2292
|
+
tokenAuthUser: string;
|
|
2293
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2294
|
+
upload_protocol?: string;
|
|
2295
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2296
|
+
uploadType?: string;
|
|
2297
|
+
},
|
|
2298
|
+
body: AddAuthTokenRequest,
|
|
2299
|
+
): Request<Operation>;
|
|
2300
|
+
/** Deletes a token auth user for a token based auth enabled cluster. */
|
|
2301
|
+
delete(request?: {
|
|
2302
|
+
/** V1 error format. */
|
|
2303
|
+
'$.xgafv'?: '1' | '2';
|
|
2304
|
+
/** OAuth access token. */
|
|
2305
|
+
access_token?: string;
|
|
2306
|
+
/** Data format for response. */
|
|
2307
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2308
|
+
/** JSONP */
|
|
2309
|
+
callback?: string;
|
|
2310
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2311
|
+
fields?: string;
|
|
2312
|
+
/** Optional. If set to true, any child auth tokens of this user will also be deleted. Otherwise, the request will only work if the user has no auth tokens. */
|
|
2313
|
+
force?: boolean;
|
|
2314
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2315
|
+
key?: string;
|
|
2316
|
+
/** Required. The name of the token auth user to delete. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user} */
|
|
2317
|
+
name: string;
|
|
2318
|
+
/** OAuth 2.0 token for the current user. */
|
|
2319
|
+
oauth_token?: string;
|
|
2320
|
+
/** Returns response with indentations and line breaks. */
|
|
2321
|
+
prettyPrint?: boolean;
|
|
2322
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2323
|
+
quotaUser?: string;
|
|
2324
|
+
/** Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */
|
|
2325
|
+
requestId?: string;
|
|
2326
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2327
|
+
upload_protocol?: string;
|
|
2328
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2329
|
+
uploadType?: string;
|
|
2330
|
+
}): Request<Operation>;
|
|
2331
|
+
/** Gets a specific token auth user for a basic auth enabled cluster. */
|
|
2332
|
+
get(request?: {
|
|
2333
|
+
/** V1 error format. */
|
|
2334
|
+
'$.xgafv'?: '1' | '2';
|
|
2335
|
+
/** OAuth access token. */
|
|
2336
|
+
access_token?: string;
|
|
2337
|
+
/** Data format for response. */
|
|
2338
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2339
|
+
/** JSONP */
|
|
2340
|
+
callback?: string;
|
|
2341
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2342
|
+
fields?: string;
|
|
2343
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2344
|
+
key?: string;
|
|
2345
|
+
/** Required. The name of token auth user for a token based auth enabled cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user} */
|
|
2346
|
+
name: string;
|
|
2347
|
+
/** OAuth 2.0 token for the current user. */
|
|
2348
|
+
oauth_token?: string;
|
|
2349
|
+
/** Returns response with indentations and line breaks. */
|
|
2350
|
+
prettyPrint?: boolean;
|
|
2351
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2352
|
+
quotaUser?: string;
|
|
2353
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2354
|
+
upload_protocol?: string;
|
|
2355
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2356
|
+
uploadType?: string;
|
|
2357
|
+
}): Request<TokenAuthUser>;
|
|
2358
|
+
/** Lists all the token auth users for a token based auth enabled cluster. */
|
|
2359
|
+
list(request?: {
|
|
2360
|
+
/** V1 error format. */
|
|
2361
|
+
'$.xgafv'?: '1' | '2';
|
|
2362
|
+
/** OAuth access token. */
|
|
2363
|
+
access_token?: string;
|
|
2364
|
+
/** Data format for response. */
|
|
2365
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2366
|
+
/** JSONP */
|
|
2367
|
+
callback?: string;
|
|
2368
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2369
|
+
fields?: string;
|
|
2370
|
+
/** Optional. Expression for filtering results. */
|
|
2371
|
+
filter?: string;
|
|
2372
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2373
|
+
key?: string;
|
|
2374
|
+
/** OAuth 2.0 token for the current user. */
|
|
2375
|
+
oauth_token?: string;
|
|
2376
|
+
/** Optional. Sort results by a defined order. */
|
|
2377
|
+
orderBy?: string;
|
|
2378
|
+
/** 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's The maximum value is 1000; values above 1000 will be coerced to 1000. `next_page_token` to determine if there are more clusters left to be queried. */
|
|
2379
|
+
pageSize?: number;
|
|
2380
|
+
/** Optional. The `next_page_token` value returned from a previous [ListTokenAuthUsers] request, if any. */
|
|
2381
|
+
pageToken?: string;
|
|
2382
|
+
/** Required. The parent resource that this token based auth user will be listed for. Format: projects/{project}/locations/{location}/clusters/{cluster} */
|
|
2383
|
+
parent: string;
|
|
2384
|
+
/** Returns response with indentations and line breaks. */
|
|
2385
|
+
prettyPrint?: boolean;
|
|
2386
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2387
|
+
quotaUser?: string;
|
|
2388
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2389
|
+
upload_protocol?: string;
|
|
2390
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2391
|
+
uploadType?: string;
|
|
2392
|
+
}): Request<ListTokenAuthUsersResponse>;
|
|
2393
|
+
authTokens: AuthTokensResource;
|
|
2394
|
+
}
|
|
1823
2395
|
interface ClustersResource {
|
|
2396
|
+
/** Adds a token auth user for a token based auth enabled cluster. */
|
|
2397
|
+
addTokenAuthUser(request: {
|
|
2398
|
+
/** V1 error format. */
|
|
2399
|
+
'$.xgafv'?: '1' | '2';
|
|
2400
|
+
/** OAuth access token. */
|
|
2401
|
+
access_token?: string;
|
|
2402
|
+
/** Data format for response. */
|
|
2403
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2404
|
+
/** JSONP */
|
|
2405
|
+
callback?: string;
|
|
2406
|
+
/** Required. The cluster resource that this token auth user will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster} */
|
|
2407
|
+
cluster: string;
|
|
2408
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2409
|
+
fields?: string;
|
|
2410
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2411
|
+
key?: string;
|
|
2412
|
+
/** OAuth 2.0 token for the current user. */
|
|
2413
|
+
oauth_token?: string;
|
|
2414
|
+
/** Returns response with indentations and line breaks. */
|
|
2415
|
+
prettyPrint?: boolean;
|
|
2416
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2417
|
+
quotaUser?: string;
|
|
2418
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2419
|
+
upload_protocol?: string;
|
|
2420
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2421
|
+
uploadType?: string;
|
|
2422
|
+
/** Request body */
|
|
2423
|
+
resource: AddTokenAuthUserRequest;
|
|
2424
|
+
}): Request<Operation>;
|
|
2425
|
+
addTokenAuthUser(
|
|
2426
|
+
request: {
|
|
2427
|
+
/** V1 error format. */
|
|
2428
|
+
'$.xgafv'?: '1' | '2';
|
|
2429
|
+
/** OAuth access token. */
|
|
2430
|
+
access_token?: string;
|
|
2431
|
+
/** Data format for response. */
|
|
2432
|
+
alt?: 'json' | 'media' | 'proto';
|
|
2433
|
+
/** JSONP */
|
|
2434
|
+
callback?: string;
|
|
2435
|
+
/** Required. The cluster resource that this token auth user will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster} */
|
|
2436
|
+
cluster: string;
|
|
2437
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2438
|
+
fields?: string;
|
|
2439
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2440
|
+
key?: string;
|
|
2441
|
+
/** OAuth 2.0 token for the current user. */
|
|
2442
|
+
oauth_token?: string;
|
|
2443
|
+
/** Returns response with indentations and line breaks. */
|
|
2444
|
+
prettyPrint?: boolean;
|
|
2445
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2446
|
+
quotaUser?: string;
|
|
2447
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2448
|
+
upload_protocol?: string;
|
|
2449
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2450
|
+
uploadType?: string;
|
|
2451
|
+
},
|
|
2452
|
+
body: AddTokenAuthUserRequest,
|
|
2453
|
+
): Request<Operation>;
|
|
1824
2454
|
/** 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'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. */
|
|
1825
2455
|
backup(request: {
|
|
1826
2456
|
/** V1 error format. */
|
|
@@ -2046,7 +2676,7 @@ declare namespace gapi.client {
|
|
|
2046
2676
|
oauth_token?: string;
|
|
2047
2677
|
/** 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. */
|
|
2048
2678
|
pageSize?: number;
|
|
2049
|
-
/** The `next_page_token` value returned from a previous ListClusters request, if any. */
|
|
2679
|
+
/** The `next_page_token` value returned from a previous `ListClusters` request, if any. */
|
|
2050
2680
|
pageToken?: string;
|
|
2051
2681
|
/** 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. */
|
|
2052
2682
|
parent: string;
|
|
@@ -2183,6 +2813,7 @@ declare namespace gapi.client {
|
|
|
2183
2813
|
},
|
|
2184
2814
|
body: RescheduleClusterMaintenanceRequest,
|
|
2185
2815
|
): Request<Operation>;
|
|
2816
|
+
tokenAuthUsers: TokenAuthUsersResource;
|
|
2186
2817
|
}
|
|
2187
2818
|
interface InstancesResource {
|
|
2188
2819
|
/** 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. */
|
|
@@ -2885,7 +3516,7 @@ declare namespace gapi.client {
|
|
|
2885
3516
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2886
3517
|
uploadType?: string;
|
|
2887
3518
|
}): Request<SharedRegionalCertificateAuthority>;
|
|
2888
|
-
/** Lists information about the supported locations for this service. This method
|
|
3519
|
+
/** Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. */
|
|
2889
3520
|
list(request?: {
|
|
2890
3521
|
/** V1 error format. */
|
|
2891
3522
|
'$.xgafv'?: '1' | '2';
|
|
@@ -2895,7 +3526,7 @@ declare namespace gapi.client {
|
|
|
2895
3526
|
alt?: 'json' | 'media' | 'proto';
|
|
2896
3527
|
/** JSONP */
|
|
2897
3528
|
callback?: string;
|
|
2898
|
-
/** Optional. Do not use this field
|
|
3529
|
+
/** Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */
|
|
2899
3530
|
extraLocationTypes?: string | string[];
|
|
2900
3531
|
/** Selector specifying which fields to include in a partial response. */
|
|
2901
3532
|
fields?: string;
|
|
@@ -2920,6 +3551,7 @@ declare namespace gapi.client {
|
|
|
2920
3551
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2921
3552
|
uploadType?: string;
|
|
2922
3553
|
}): Request<ListLocationsResponse>;
|
|
3554
|
+
aclPolicies: AclPoliciesResource;
|
|
2923
3555
|
backupCollections: BackupCollectionsResource;
|
|
2924
3556
|
clusters: ClustersResource;
|
|
2925
3557
|
instances: InstancesResource;
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -11,6 +11,18 @@ Install typings for Google Cloud Memorystore for Redis API:
|
|
|
11
11
|
npm install @types/gapi.client.redis-v1 --save-dev
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
+
## TypeScript 6.0+
|
|
15
|
+
|
|
16
|
+
TypeScript 6.0 changed `types` to default to `[]`. You must now explicitly list type packages in `tsconfig.json`:
|
|
17
|
+
|
|
18
|
+
```json
|
|
19
|
+
{
|
|
20
|
+
"compilerOptions": {
|
|
21
|
+
"types": ["gapi", "gapi.auth2", "gapi.client", "gapi.client.redis-v1"]
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
```
|
|
25
|
+
|
|
14
26
|
## Usage
|
|
15
27
|
|
|
16
28
|
You need to initialize Google API client in your code:
|
|
@@ -50,6 +62,12 @@ var client_id = '',
|
|
|
50
62
|
scope = [
|
|
51
63
|
// See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
|
|
52
64
|
'https://www.googleapis.com/auth/cloud-platform',
|
|
65
|
+
|
|
66
|
+
// See your Google Cloud Memorystore for Redis data and the email address of your Google Account
|
|
67
|
+
'https://www.googleapis.com/auth/redis.read-only',
|
|
68
|
+
|
|
69
|
+
// See, edit, configure, and delete your Google Cloud Memorystore for Redis data and see the email address for your Google Account
|
|
70
|
+
'https://www.googleapis.com/auth/redis.read-write',
|
|
53
71
|
],
|
|
54
72
|
immediate = true;
|
|
55
73
|
// ...
|