@google-cloud/redis-cluster
Version:
Google Cloud Memorystore for Redis API client for Node.js
1,021 lines (1,020 loc) • 253 kB
JSON
{
"nested": {
"google": {
"nested": {
"cloud": {
"nested": {
"redis": {
"nested": {
"cluster": {
"nested": {
"v1": {
"options": {
"go_package": "cloud.google.com/go/redis/cluster/apiv1/clusterpb;clusterpb",
"java_multiple_files": true,
"java_outer_classname": "CloudRedisClusterProto",
"java_package": "com.google.cloud.redis.cluster.v1",
"ruby_package": "Google::Cloud::Redis::Cluster::V1",
"(google.api.resource_definition).type": "cloudkms.googleapis.com/CryptoKeyVersion",
"(google.api.resource_definition).pattern": "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}"
},
"nested": {
"CloudRedisCluster": {
"options": {
"(google.api.default_host)": "redis.googleapis.com",
"(google.api.oauth_scopes)": "https://www.googleapis.com/auth/cloud-platform"
},
"methods": {
"ListClusters": {
"requestType": "ListClustersRequest",
"responseType": "ListClustersResponse",
"options": {
"(google.api.http).get": "/v1/{parent=projects/*/locations/*}/clusters",
"(google.api.method_signature)": "parent"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v1/{parent=projects/*/locations/*}/clusters"
}
},
{
"(google.api.method_signature)": "parent"
}
]
},
"GetCluster": {
"requestType": "GetClusterRequest",
"responseType": "Cluster",
"options": {
"(google.api.http).get": "/v1/{name=projects/*/locations/*/clusters/*}",
"(google.api.method_signature)": "name"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v1/{name=projects/*/locations/*/clusters/*}"
}
},
{
"(google.api.method_signature)": "name"
}
]
},
"UpdateCluster": {
"requestType": "UpdateClusterRequest",
"responseType": "google.longrunning.Operation",
"options": {
"(google.api.http).patch": "/v1/{cluster.name=projects/*/locations/*/clusters/*}",
"(google.api.http).body": "cluster",
"(google.api.method_signature)": "cluster,update_mask",
"(google.longrunning.operation_info).response_type": "Cluster",
"(google.longrunning.operation_info).metadata_type": "google.protobuf.Any"
},
"parsedOptions": [
{
"(google.api.http)": {
"patch": "/v1/{cluster.name=projects/*/locations/*/clusters/*}",
"body": "cluster"
}
},
{
"(google.api.method_signature)": "cluster,update_mask"
},
{
"(google.longrunning.operation_info)": {
"response_type": "Cluster",
"metadata_type": "google.protobuf.Any"
}
}
]
},
"DeleteCluster": {
"requestType": "DeleteClusterRequest",
"responseType": "google.longrunning.Operation",
"options": {
"(google.api.http).delete": "/v1/{name=projects/*/locations/*/clusters/*}",
"(google.api.method_signature)": "name",
"(google.longrunning.operation_info).response_type": "google.protobuf.Empty",
"(google.longrunning.operation_info).metadata_type": "google.protobuf.Any"
},
"parsedOptions": [
{
"(google.api.http)": {
"delete": "/v1/{name=projects/*/locations/*/clusters/*}"
}
},
{
"(google.api.method_signature)": "name"
},
{
"(google.longrunning.operation_info)": {
"response_type": "google.protobuf.Empty",
"metadata_type": "google.protobuf.Any"
}
}
]
},
"CreateCluster": {
"requestType": "CreateClusterRequest",
"responseType": "google.longrunning.Operation",
"options": {
"(google.api.http).post": "/v1/{parent=projects/*/locations/*}/clusters",
"(google.api.http).body": "cluster",
"(google.api.method_signature)": "parent,cluster,cluster_id",
"(google.longrunning.operation_info).response_type": "Cluster",
"(google.longrunning.operation_info).metadata_type": "google.protobuf.Any"
},
"parsedOptions": [
{
"(google.api.http)": {
"post": "/v1/{parent=projects/*/locations/*}/clusters",
"body": "cluster"
}
},
{
"(google.api.method_signature)": "parent,cluster,cluster_id"
},
{
"(google.longrunning.operation_info)": {
"response_type": "Cluster",
"metadata_type": "google.protobuf.Any"
}
}
]
},
"GetClusterCertificateAuthority": {
"requestType": "GetClusterCertificateAuthorityRequest",
"responseType": "CertificateAuthority",
"options": {
"(google.api.http).get": "/v1/{name=projects/*/locations/*/clusters/*/certificateAuthority}",
"(google.api.method_signature)": "name"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v1/{name=projects/*/locations/*/clusters/*/certificateAuthority}"
}
},
{
"(google.api.method_signature)": "name"
}
]
},
"RescheduleClusterMaintenance": {
"requestType": "RescheduleClusterMaintenanceRequest",
"responseType": "google.longrunning.Operation",
"options": {
"(google.api.http).post": "/v1/{name=projects/*/locations/*/clusters/*}:rescheduleClusterMaintenance",
"(google.api.http).body": "*",
"(google.api.method_signature)": "name,reschedule_type,schedule_time",
"(google.longrunning.operation_info).response_type": "Cluster",
"(google.longrunning.operation_info).metadata_type": "google.protobuf.Any"
},
"parsedOptions": [
{
"(google.api.http)": {
"post": "/v1/{name=projects/*/locations/*/clusters/*}:rescheduleClusterMaintenance",
"body": "*"
}
},
{
"(google.api.method_signature)": "name,reschedule_type,schedule_time"
},
{
"(google.longrunning.operation_info)": {
"response_type": "Cluster",
"metadata_type": "google.protobuf.Any"
}
}
]
},
"ListBackupCollections": {
"requestType": "ListBackupCollectionsRequest",
"responseType": "ListBackupCollectionsResponse",
"options": {
"(google.api.http).get": "/v1/{parent=projects/*/locations/*}/backupCollections",
"(google.api.method_signature)": "parent"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v1/{parent=projects/*/locations/*}/backupCollections"
}
},
{
"(google.api.method_signature)": "parent"
}
]
},
"GetBackupCollection": {
"requestType": "GetBackupCollectionRequest",
"responseType": "BackupCollection",
"options": {
"(google.api.http).get": "/v1/{name=projects/*/locations/*/backupCollections/*}",
"(google.api.method_signature)": "name"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v1/{name=projects/*/locations/*/backupCollections/*}"
}
},
{
"(google.api.method_signature)": "name"
}
]
},
"ListBackups": {
"requestType": "ListBackupsRequest",
"responseType": "ListBackupsResponse",
"options": {
"(google.api.http).get": "/v1/{parent=projects/*/locations/*/backupCollections/*}/backups",
"(google.api.method_signature)": "parent"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v1/{parent=projects/*/locations/*/backupCollections/*}/backups"
}
},
{
"(google.api.method_signature)": "parent"
}
]
},
"GetBackup": {
"requestType": "GetBackupRequest",
"responseType": "Backup",
"options": {
"(google.api.http).get": "/v1/{name=projects/*/locations/*/backupCollections/*/backups/*}",
"(google.api.method_signature)": "name"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v1/{name=projects/*/locations/*/backupCollections/*/backups/*}"
}
},
{
"(google.api.method_signature)": "name"
}
]
},
"DeleteBackup": {
"requestType": "DeleteBackupRequest",
"responseType": "google.longrunning.Operation",
"options": {
"(google.api.http).delete": "/v1/{name=projects/*/locations/*/backupCollections/*/backups/*}",
"(google.api.method_signature)": "name",
"(google.longrunning.operation_info).response_type": "google.protobuf.Empty",
"(google.longrunning.operation_info).metadata_type": "google.protobuf.Any"
},
"parsedOptions": [
{
"(google.api.http)": {
"delete": "/v1/{name=projects/*/locations/*/backupCollections/*/backups/*}"
}
},
{
"(google.api.method_signature)": "name"
},
{
"(google.longrunning.operation_info)": {
"response_type": "google.protobuf.Empty",
"metadata_type": "google.protobuf.Any"
}
}
]
},
"ExportBackup": {
"requestType": "ExportBackupRequest",
"responseType": "google.longrunning.Operation",
"options": {
"(google.api.http).post": "/v1/{name=projects/*/locations/*/backupCollections/*/backups/*}:export",
"(google.api.http).body": "*",
"(google.longrunning.operation_info).response_type": "Backup",
"(google.longrunning.operation_info).metadata_type": "google.protobuf.Any"
},
"parsedOptions": [
{
"(google.api.http)": {
"post": "/v1/{name=projects/*/locations/*/backupCollections/*/backups/*}:export",
"body": "*"
}
},
{
"(google.longrunning.operation_info)": {
"response_type": "Backup",
"metadata_type": "google.protobuf.Any"
}
}
]
},
"BackupCluster": {
"requestType": "BackupClusterRequest",
"responseType": "google.longrunning.Operation",
"options": {
"(google.api.http).post": "/v1/{name=projects/*/locations/*/clusters/*}:backup",
"(google.api.http).body": "*",
"(google.api.method_signature)": "name",
"(google.longrunning.operation_info).response_type": "Cluster",
"(google.longrunning.operation_info).metadata_type": "google.protobuf.Any"
},
"parsedOptions": [
{
"(google.api.http)": {
"post": "/v1/{name=projects/*/locations/*/clusters/*}:backup",
"body": "*"
}
},
{
"(google.api.method_signature)": "name"
},
{
"(google.longrunning.operation_info)": {
"response_type": "Cluster",
"metadata_type": "google.protobuf.Any"
}
}
]
}
}
},
"PscConnectionStatus": {
"values": {
"PSC_CONNECTION_STATUS_UNSPECIFIED": 0,
"PSC_CONNECTION_STATUS_ACTIVE": 1,
"PSC_CONNECTION_STATUS_NOT_FOUND": 2
}
},
"AuthorizationMode": {
"values": {
"AUTH_MODE_UNSPECIFIED": 0,
"AUTH_MODE_IAM_AUTH": 1,
"AUTH_MODE_DISABLED": 2
}
},
"NodeType": {
"values": {
"NODE_TYPE_UNSPECIFIED": 0,
"REDIS_SHARED_CORE_NANO": 1,
"REDIS_HIGHMEM_MEDIUM": 2,
"REDIS_HIGHMEM_XLARGE": 3,
"REDIS_STANDARD_SMALL": 4
}
},
"TransitEncryptionMode": {
"values": {
"TRANSIT_ENCRYPTION_MODE_UNSPECIFIED": 0,
"TRANSIT_ENCRYPTION_MODE_DISABLED": 1,
"TRANSIT_ENCRYPTION_MODE_SERVER_AUTHENTICATION": 2
}
},
"ConnectionType": {
"values": {
"CONNECTION_TYPE_UNSPECIFIED": 0,
"CONNECTION_TYPE_DISCOVERY": 1,
"CONNECTION_TYPE_PRIMARY": 2,
"CONNECTION_TYPE_READER": 3
}
},
"CreateClusterRequest": {
"fields": {
"parent": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "locations.googleapis.com/Location"
}
},
"clusterId": {
"type": "string",
"id": 2,
"options": {
"(google.api.field_behavior)": "REQUIRED"
}
},
"cluster": {
"type": "Cluster",
"id": 3,
"options": {
"(google.api.field_behavior)": "REQUIRED"
}
},
"requestId": {
"type": "string",
"id": 4
}
}
},
"ListClustersRequest": {
"fields": {
"parent": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "locations.googleapis.com/Location"
}
},
"pageSize": {
"type": "int32",
"id": 2
},
"pageToken": {
"type": "string",
"id": 3
}
}
},
"ListClustersResponse": {
"fields": {
"clusters": {
"rule": "repeated",
"type": "Cluster",
"id": 1
},
"nextPageToken": {
"type": "string",
"id": 2
},
"unreachable": {
"rule": "repeated",
"type": "string",
"id": 3
}
}
},
"UpdateClusterRequest": {
"fields": {
"updateMask": {
"type": "google.protobuf.FieldMask",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED"
}
},
"cluster": {
"type": "Cluster",
"id": 2,
"options": {
"(google.api.field_behavior)": "REQUIRED"
}
},
"requestId": {
"type": "string",
"id": 3
}
}
},
"GetClusterRequest": {
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "redis.googleapis.com/Cluster"
}
}
}
},
"DeleteClusterRequest": {
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "redis.googleapis.com/Cluster"
}
},
"requestId": {
"type": "string",
"id": 2
}
}
},
"GetClusterCertificateAuthorityRequest": {
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "redis.googleapis.com/CertificateAuthority"
}
}
}
},
"ListBackupCollectionsRequest": {
"fields": {
"parent": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).child_type": "redis.googleapis.com/BackupCollection"
}
},
"pageSize": {
"type": "int32",
"id": 2,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"pageToken": {
"type": "string",
"id": 3,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
}
}
},
"ListBackupCollectionsResponse": {
"fields": {
"backupCollections": {
"rule": "repeated",
"type": "BackupCollection",
"id": 1
},
"nextPageToken": {
"type": "string",
"id": 2
},
"unreachable": {
"rule": "repeated",
"type": "string",
"id": 3
}
}
},
"GetBackupCollectionRequest": {
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "redis.googleapis.com/BackupCollection"
}
}
}
},
"ListBackupsRequest": {
"fields": {
"parent": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).child_type": "redis.googleapis.com/Backup"
}
},
"pageSize": {
"type": "int32",
"id": 2,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"pageToken": {
"type": "string",
"id": 3,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
}
}
},
"ListBackupsResponse": {
"fields": {
"backups": {
"rule": "repeated",
"type": "Backup",
"id": 1
},
"nextPageToken": {
"type": "string",
"id": 2
},
"unreachable": {
"rule": "repeated",
"type": "string",
"id": 3
}
}
},
"GetBackupRequest": {
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "redis.googleapis.com/Backup"
}
}
}
},
"DeleteBackupRequest": {
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "redis.googleapis.com/Backup"
}
},
"requestId": {
"type": "string",
"id": 2,
"options": {
"(google.api.field_info).format": "UUID4",
"(google.api.field_behavior)": "OPTIONAL"
}
}
}
},
"ExportBackupRequest": {
"oneofs": {
"destination": {
"oneof": [
"gcsBucket"
]
}
},
"fields": {
"gcsBucket": {
"type": "string",
"id": 3
},
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "redis.googleapis.com/Backup"
}
}
}
},
"BackupClusterRequest": {
"oneofs": {
"_backupId": {
"oneof": [
"backupId"
]
}
},
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "redis.googleapis.com/Cluster"
}
},
"ttl": {
"type": "google.protobuf.Duration",
"id": 2,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"backupId": {
"type": "string",
"id": 3,
"options": {
"(google.api.field_behavior)": "OPTIONAL",
"proto3_optional": true
}
}
}
},
"Cluster": {
"options": {
"(google.api.resource).type": "redis.googleapis.com/Cluster",
"(google.api.resource).pattern": "projects/{project}/locations/{location}/clusters/{cluster}",
"(google.api.resource).plural": "clusters",
"(google.api.resource).singular": "cluster"
},
"oneofs": {
"importSources": {
"oneof": [
"gcsSource",
"managedBackupSource"
]
},
"_replicaCount": {
"oneof": [
"replicaCount"
]
},
"_sizeGb": {
"oneof": [
"sizeGb"
]
},
"_shardCount": {
"oneof": [
"shardCount"
]
},
"_preciseSizeGb": {
"oneof": [
"preciseSizeGb"
]
},
"_deletionProtectionEnabled": {
"oneof": [
"deletionProtectionEnabled"
]
},
"_maintenancePolicy": {
"oneof": [
"maintenancePolicy"
]
},
"_maintenanceSchedule": {
"oneof": [
"maintenanceSchedule"
]
},
"_backupCollection": {
"oneof": [
"backupCollection"
]
},
"_kmsKey": {
"oneof": [
"kmsKey"
]
}
},
"fields": {
"gcsSource": {
"type": "GcsBackupSource",
"id": 34,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"managedBackupSource": {
"type": "ManagedBackupSource",
"id": 35,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "IDENTIFIER"
}
},
"createTime": {
"type": "google.protobuf.Timestamp",
"id": 3,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"state": {
"type": "State",
"id": 4,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"uid": {
"type": "string",
"id": 5,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"replicaCount": {
"type": "int32",
"id": 8,
"options": {
"(google.api.field_behavior)": "OPTIONAL",
"proto3_optional": true
}
},
"authorizationMode": {
"type": "AuthorizationMode",
"id": 11,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"transitEncryptionMode": {
"type": "TransitEncryptionMode",
"id": 12,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"sizeGb": {
"type": "int32",
"id": 13,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY",
"proto3_optional": true
}
},
"shardCount": {
"type": "int32",
"id": 14,
"options": {
"(google.api.field_behavior)": "OPTIONAL",
"proto3_optional": true
}
},
"pscConfigs": {
"rule": "repeated",
"type": "PscConfig",
"id": 15,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"discoveryEndpoints": {
"rule": "repeated",
"type": "DiscoveryEndpoint",
"id": 16,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"pscConnections": {
"rule": "repeated",
"type": "PscConnection",
"id": 17,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"stateInfo": {
"type": "StateInfo",
"id": 18,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"nodeType": {
"type": "NodeType",
"id": 19,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"persistenceConfig": {
"type": "ClusterPersistenceConfig",
"id": 20,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"redisConfigs": {
"keyType": "string",
"type": "string",
"id": 21,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"preciseSizeGb": {
"type": "double",
"id": 22,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY",
"proto3_optional": true
}
},
"zoneDistributionConfig": {
"type": "ZoneDistributionConfig",
"id": 23,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"crossClusterReplicationConfig": {
"type": "CrossClusterReplicationConfig",
"id": 24,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"deletionProtectionEnabled": {
"type": "bool",
"id": 25,
"options": {
"(google.api.field_behavior)": "OPTIONAL",
"proto3_optional": true
}
},
"maintenancePolicy": {
"type": "ClusterMaintenancePolicy",
"id": 26,
"options": {
"(google.api.field_behavior)": "OPTIONAL",
"proto3_optional": true
}
},
"maintenanceSchedule": {
"type": "ClusterMaintenanceSchedule",
"id": 27,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY",
"proto3_optional": true
}
},
"pscServiceAttachments": {
"rule": "repeated",
"type": "PscServiceAttachment",
"id": 30,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"clusterEndpoints": {
"rule": "repeated",
"type": "ClusterEndpoint",
"id": 36,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"backupCollection": {
"type": "string",
"id": 39,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY",
"(google.api.resource_reference).type": "redis.googleapis.com/BackupCollection",
"proto3_optional": true
}
},
"kmsKey": {
"type": "string",
"id": 40,
"options": {
"(google.api.field_behavior)": "OPTIONAL",
"(google.api.resource_reference).type": "cloudkms.googleapis.com/CryptoKey",
"proto3_optional": true
}
},
"automatedBackupConfig": {
"type": "AutomatedBackupConfig",
"id": 42,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"encryptionInfo": {
"type": "EncryptionInfo",
"id": 43,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
}
},
"nested": {
"StateInfo": {
"oneofs": {
"info": {
"oneof": [
"updateInfo"
]
}
},
"fields": {
"updateInfo": {
"type": "UpdateInfo",
"id": 1
}
},
"nested": {
"UpdateInfo": {
"oneofs": {
"_targetShardCount": {
"oneof": [
"targetShardCount"
]
},
"_targetReplicaCount": {
"oneof": [
"targetReplicaCount"
]
}
},
"fields": {
"targetShardCount": {