{ "version_module": true, "baseUrl": "https://redis.googleapis.com/", "name": "redis", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/redis.read-only": { "description": "See your Google Cloud Memorystore for Redis data and the email address of your Google Account" }, "https://www.googleapis.com/auth/redis.read-write": { "description": "See, edit, configure, and delete your Google Cloud Memorystore for Redis data and see the email address for your Google Account" }, "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "id": "redis:v1alpha1", "endpoints": [ { "endpointUrl": "https://redis.africa-south1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "africa-south1" }, { "endpointUrl": "https://redis.asia-east1.rep.googleapis.com/", "location": "asia-east1", "description": "Regional Endpoint" }, { "endpointUrl": "https://redis.asia-east2.rep.googleapis.com/", "location": "asia-east2", "description": "Regional Endpoint" }, { "location": "asia-northeast1", "description": "Regional Endpoint", "endpointUrl": "https://redis.asia-northeast1.rep.googleapis.com/" }, { "endpointUrl": "https://redis.asia-northeast2.rep.googleapis.com/", "location": "asia-northeast2", "description": "Regional Endpoint" }, { "endpointUrl": "https://redis.asia-northeast3.rep.googleapis.com/", "location": "asia-northeast3", "description": "Regional Endpoint" }, { "endpointUrl": "https://redis.asia-south1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "asia-south1" }, { "endpointUrl": "https://redis.asia-south2.rep.googleapis.com/", "description": "Regional Endpoint", "location": "asia-south2" }, { "endpointUrl": "https://redis.asia-southeast1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "asia-southeast1" }, { "endpointUrl": "https://redis.asia-southeast2.rep.googleapis.com/", "description": "Regional Endpoint", "location": "asia-southeast2" }, { "endpointUrl": "https://redis.asia-southeast3.rep.googleapis.com/", "description": "Regional Endpoint", "location": "asia-southeast3" }, { "endpointUrl": "https://redis.australia-southeast1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "australia-southeast1" }, { "endpointUrl": "https://redis.australia-southeast2.rep.googleapis.com/", "description": "Regional Endpoint", "location": "australia-southeast2" }, { "endpointUrl": "https://redis.europe-central2.rep.googleapis.com/", "location": "europe-central2", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "location": "europe-north1", "endpointUrl": "https://redis.europe-north1.rep.googleapis.com/" }, { "location": "europe-north2", "description": "Regional Endpoint", "endpointUrl": "https://redis.europe-north2.rep.googleapis.com/" }, { "description": "Regional Endpoint", "location": "europe-southwest1", "endpointUrl": "https://redis.europe-southwest1.rep.googleapis.com/" }, { "endpointUrl": "https://redis.europe-west1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-west1" }, { "endpointUrl": "https://redis.europe-west10.rep.googleapis.com/", "location": "europe-west10", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "location": "europe-west12", "endpointUrl": "https://redis.europe-west12.rep.googleapis.com/" }, { "location": "europe-west15", "description": "Regional Endpoint", "endpointUrl": "https://redis.europe-west15.rep.googleapis.com/" }, { "endpointUrl": "https://redis.europe-west2.rep.googleapis.com/", "description": "Regional Endpoint", "location": "europe-west2" }, { "description": "Regional Endpoint", "location": "europe-west3", "endpointUrl": "https://redis.europe-west3.rep.googleapis.com/" }, { "description": "Regional Endpoint", "location": "europe-west4", "endpointUrl": "https://redis.europe-west4.rep.googleapis.com/" }, { "description": "Regional Endpoint", "location": "europe-west6", "endpointUrl": "https://redis.europe-west6.rep.googleapis.com/" }, { "description": "Regional Endpoint", "location": "europe-west8", "endpointUrl": "https://redis.europe-west8.rep.googleapis.com/" }, { "location": "europe-west9", "description": "Regional Endpoint", "endpointUrl": "https://redis.europe-west9.rep.googleapis.com/" }, { "location": "me-central1", "description": "Regional Endpoint", "endpointUrl": "https://redis.me-central1.rep.googleapis.com/" }, { "description": "Regional Endpoint", "location": "me-central2", "endpointUrl": "https://redis.me-central2.rep.googleapis.com/" }, { "description": "Regional Endpoint", "location": "me-west1", "endpointUrl": "https://redis.me-west1.rep.googleapis.com/" }, { "endpointUrl": "https://redis.northamerica-northeast1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "northamerica-northeast1" }, { "location": "northamerica-northeast2", "description": "Regional Endpoint", "endpointUrl": "https://redis.northamerica-northeast2.rep.googleapis.com/" }, { "endpointUrl": "https://redis.northamerica-south1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "northamerica-south1" }, { "endpointUrl": "https://redis.southamerica-east1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "southamerica-east1" }, { "endpointUrl": "https://redis.southamerica-west1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "southamerica-west1" }, { "description": "Regional Endpoint", "location": "us-central1", "endpointUrl": "https://redis.us-central1.rep.googleapis.com/" }, { "description": "Regional Endpoint", "location": "us-central2", "endpointUrl": "https://redis.us-central2.rep.googleapis.com/" }, { "endpointUrl": "https://redis.us-east1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-east1" }, { "description": "Regional Endpoint", "location": "us-east4", "endpointUrl": "https://redis.us-east4.rep.googleapis.com/" }, { "location": "us-east5", "description": "Regional Endpoint", "endpointUrl": "https://redis.us-east5.rep.googleapis.com/" }, { "description": "Regional Endpoint", "location": "us-east7", "endpointUrl": "https://redis.us-east7.rep.googleapis.com/" }, { "location": "us-south1", "description": "Regional Endpoint", "endpointUrl": "https://redis.us-south1.rep.googleapis.com/" }, { "description": "Regional Endpoint", "location": "us-west1", "endpointUrl": "https://redis.us-west1.rep.googleapis.com/" }, { "description": "Regional Endpoint", "location": "us-west2", "endpointUrl": "https://redis.us-west2.rep.googleapis.com/" }, { "endpointUrl": "https://redis.us-west3.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-west3" }, { "description": "Regional Endpoint", "location": "us-west4", "endpointUrl": "https://redis.us-west4.rep.googleapis.com/" }, { "endpointUrl": "https://redis.us-west8.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-west8" } ], "documentationLink": "https://cloud.google.com/memorystore/docs/redis/", "servicePath": "", "batchPath": "batch", "title": "Google Cloud Memorystore for Redis API", "mtlsRootUrl": "https://redis.mtls.googleapis.com/", "ownerName": "Google", "kind": "discovery#restDescription", "version": "v1alpha1", "basePath": "", "fullyEncodeReservedExpansion": true, "resources": { "projects": { "resources": { "locations": { "methods": { "list": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "response": { "$ref": "ListLocationsResponse" }, "description": "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.", "parameterOrder": [ "name" ], "id": "redis.projects.locations.list", "flatPath": "v1alpha1/projects/{projectsId}/locations", "path": "v1alpha1/{+name}/locations", "parameters": { "pageSize": { "location": "query", "type": "integer", "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32" }, "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "name": { "location": "path", "type": "string", "description": "The resource that owns the locations collection, if applicable.", "pattern": "^projects/[^/]+$", "required": true }, "pageToken": { "location": "query", "type": "string", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page." }, "extraLocationTypes": { "repeated": true, "location": "query", "type": "string", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage." } } }, "get": { "id": "redis.projects.locations.get", "parameterOrder": [ "name" ], "response": { "$ref": "Location" }, "description": "Gets information about a location.", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "parameters": { "name": { "location": "path", "type": "string", "description": "Resource name for the location.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true } }, "path": "v1alpha1/{+name}", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}" }, "getSharedRegionalCertificateAuthority": { "description": "Gets the details of regional certificate authority information for Redis cluster.", "response": { "$ref": "SharedRegionalCertificateAuthority" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "id": "redis.projects.locations.getSharedRegionalCertificateAuthority", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sharedRegionalCertificateAuthority", "parameters": { "name": { "type": "string", "description": "Required. Regional certificate authority resource name using the form: `projects/{project_id}/locations/{location_id}/sharedRegionalCertificateAuthority` where `location_id` refers to a Google Cloud region.", "pattern": "^projects/[^/]+/locations/[^/]+/sharedRegionalCertificateAuthority$", "required": true, "location": "path" } } } }, "resources": { "clusters": { "methods": { "backup": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:backup", "path": "v1alpha1/{+name}:backup", "parameters": { "name": { "location": "path", "description": "Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a Google Cloud region.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, "type": "string" } }, "request": { "$ref": "BackupClusterRequest" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "description": "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.", "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "id": "redis.projects.locations.clusters.backup" }, "create": { "response": { "$ref": "Operation" }, "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.", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "id": "redis.projects.locations.clusters.create", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/clusters", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters", "parameters": { "clusterId": { "location": "query", "type": "string", "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" }, "requestId": { "description": "Optional. Idempotent request UUID.", "location": "query", "type": "string" }, "parent": { "location": "path", "description": "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.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, "request": { "$ref": "Cluster" } }, "rescheduleClusterMaintenance": { "description": "Reschedules upcoming maintenance event.", "response": { "$ref": "Operation" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "id": "redis.projects.locations.clusters.rescheduleClusterMaintenance", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}:rescheduleClusterMaintenance", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:rescheduleClusterMaintenance", "parameters": { "name": { "type": "string", "description": "Required. Redis Cluster instance resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a Google Cloud region.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, "location": "path" } }, "request": { "$ref": "RescheduleClusterMaintenanceRequest" } }, "list": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters", "path": "v1alpha1/{+parent}/clusters", "parameters": { "parent": { "type": "string", "description": "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.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path" }, "pageSize": { "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.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { "description": "The `next_page_token` value returned from a previous `ListClusters` request, if any.", "location": "query", "type": "string" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "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.", "response": { "$ref": "ListClustersResponse" }, "parameterOrder": [ "parent" ], "id": "redis.projects.locations.clusters.list" }, "get": { "parameters": { "name": { "type": "string", "description": "Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a Google Cloud region.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, "location": "path" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", "path": "v1alpha1/{+name}", "parameterOrder": [ "name" ], "id": "redis.projects.locations.clusters.get", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "description": "Gets the details of a specific Redis cluster.", "response": { "$ref": "Cluster" } }, "addTokenAuthUser": { "response": { "$ref": "Operation" }, "description": "Adds a token auth user for a token based auth enabled cluster.", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "id": "redis.projects.locations.clusters.addTokenAuthUser", "parameterOrder": [ "cluster" ], "path": "v1alpha1/{+cluster}:addTokenAuthUser", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:addTokenAuthUser", "parameters": { "cluster": { "location": "path", "description": "Required. The cluster resource that this token auth user will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, "type": "string" } }, "request": { "$ref": "AddTokenAuthUserRequest" } }, "patch": { "id": "redis.projects.locations.clusters.patch", "parameterOrder": [ "name" ], "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.", "response": { "$ref": "Operation" }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "parameters": { "name": { "location": "path", "type": "string", "description": "Required. Identifier. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true }, "updateMask": { "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` * `cluster_endpoints`", "format": "google-fieldmask", "location": "query", "type": "string" }, "requestId": { "location": "query", "type": "string", "description": "Optional. Idempotent request UUID." } }, "request": { "$ref": "Cluster" }, "path": "v1alpha1/{+name}", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}" }, "delete": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", "path": "v1alpha1/{+name}", "parameters": { "requestId": { "description": "Optional. Idempotent request UUID.", "location": "query", "type": "string" }, "name": { "description": "Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a Google Cloud region.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, "type": "string", "location": "path" } }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "response": { "$ref": "Operation" }, "description": "Deletes a specific Redis cluster. Cluster stops serving and data is deleted.", "parameterOrder": [ "name" ], "id": "redis.projects.locations.clusters.delete" }, "getCertificateAuthority": { "parameterOrder": [ "name" ], "id": "redis.projects.locations.clusters.getCertificateAuthority", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "response": { "$ref": "CertificateAuthority" }, "description": "Gets the details of certificate authority information for Redis cluster.", "parameters": { "name": { "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 Google Cloud region.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/certificateAuthority$", "required": true, "type": "string", "location": "path" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/certificateAuthority", "path": "v1alpha1/{+name}" } }, "resources": { "tokenAuthUsers": { "resources": { "authTokens": { "methods": { "list": { "id": "redis.projects.locations.clusters.tokenAuthUsers.authTokens.list", "parameterOrder": [ "parent" ], "description": "Lists all the auth tokens for a specific token auth user.", "response": { "$ref": "ListAuthTokensResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "parameters": { "pageSize": { "description": "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.", "format": "int32", "location": "query", "type": "integer" }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Sort results by a defined order." }, "filter": { "description": "Optional. Expression for filtering results.", "location": "query", "type": "string" }, "pageToken": { "description": "Optional. The `next_page_token` value returned from a previous [ListTokenAuthUsers] request, if any.", "location": "query", "type": "string" }, "parent": { "location": "path", "type": "string", "description": "Required. The parent resource that this auth token will be listed for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/tokenAuthUsers/[^/]+$", "required": true } }, "path": "v1alpha1/{+parent}/authTokens", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers/{tokenAuthUsersId}/authTokens" }, "get": { "parameters": { "name": { "type": "string", "description": "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}", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/tokenAuthUsers/[^/]+/authTokens/[^/]+$", "required": true, "location": "path" } }, "path": "v1alpha1/{+name}", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers/{tokenAuthUsersId}/authTokens/{authTokensId}", "id": "redis.projects.locations.clusters.tokenAuthUsers.authTokens.get", "parameterOrder": [ "name" ], "description": "Gets a specific auth token for a specific token auth user.", "response": { "$ref": "AuthToken" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ] }, "delete": { "parameterOrder": [ "name" ], "id": "redis.projects.locations.clusters.tokenAuthUsers.authTokens.delete", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "description": "Removes a auth token for a user of a token based auth enabled instance.", "response": { "$ref": "Operation" }, "parameters": { "name": { "location": "path", "description": "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}", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/tokenAuthUsers/[^/]+/authTokens/[^/]+$", "required": true, "type": "string" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers/{tokenAuthUsersId}/authTokens/{authTokensId}", "path": "v1alpha1/{+name}" } } } }, "methods": { "list": { "path": "v1alpha1/{+parent}/tokenAuthUsers", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers", "parameters": { "filter": { "description": "Optional. Expression for filtering results.", "location": "query", "type": "string" }, "pageSize": { "location": "query", "type": "integer", "description": "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.", "format": "int32" }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Sort results by a defined order." }, "parent": { "location": "path", "type": "string", "description": "Required. The parent resource that this token based auth user will be listed for. Format: projects/{project}/locations/{location}/clusters/{cluster}", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The `next_page_token` value returned from a previous [ListTokenAuthUsers] request, if any." } }, "description": "Lists all the token auth users for a token based auth enabled cluster.", "response": { "$ref": "ListTokenAuthUsersResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "id": "redis.projects.locations.clusters.tokenAuthUsers.list", "parameterOrder": [ "parent" ] }, "get": { "parameters": { "name": { "location": "path", "type": "string", "description": "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}", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/tokenAuthUsers/[^/]+$", "required": true } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers/{tokenAuthUsersId}", "path": "v1alpha1/{+name}", "parameterOrder": [ "name" ], "id": "redis.projects.locations.clusters.tokenAuthUsers.get", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "description": "Gets a specific token auth user for a basic auth enabled cluster.", "response": { "$ref": "TokenAuthUser" } }, "delete": { "parameters": { "requestId": { "description": "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).", "location": "query", "type": "string" }, "name": { "type": "string", "description": "Required. The name of the token auth user to delete. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/tokenAuthUsers/[^/]+$", "required": true, "location": "path" }, "force": { "description": "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.", "location": "query", "type": "boolean" } }, "path": "v1alpha1/{+name}", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers/{tokenAuthUsersId}", "id": "redis.projects.locations.clusters.tokenAuthUsers.delete", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "description": "Deletes a token auth user for a token based auth enabled cluster.", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ] }, "addAuthToken": { "path": "v1alpha1/{+tokenAuthUser}:addAuthToken", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers/{tokenAuthUsersId}:addAuthToken", "parameters": { "tokenAuthUser": { "description": "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}", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/tokenAuthUsers/[^/]+$", "required": true, "type": "string", "location": "path" } }, "request": { "$ref": "AddAuthTokenRequest" }, "description": "Adds a auth token for a user of a token based auth enabled cluster.", "response": { "$ref": "Operation" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "id": "redis.projects.locations.clusters.tokenAuthUsers.addAuthToken", "parameterOrder": [ "tokenAuthUser" ] } } } } }, "aclPolicies": { "methods": { "create": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/aclPolicies", "path": "v1alpha1/{+parent}/aclPolicies", "parameters": { "parent": { "type": "string", "description": "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.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path" }, "aclPolicyId": { "description": "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", "location": "query", "type": "string" }, "requestId": { "location": "query", "type": "string", "description": "Optional. Idempotent request UUID. ." } }, "request": { "$ref": "AclPolicy" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "description": "Creates an ACL policy. The creation is executed synchronously and the policy is available for use immediately after the RPC returns.", "response": { "$ref": "AclPolicy" }, "parameterOrder": [ "parent" ], "id": "redis.projects.locations.aclPolicies.create" }, "patch": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/aclPolicies/{aclPoliciesId}", "path": "v1alpha1/{+name}", "parameters": { "name": { "description": "Identifier. Full resource path of the ACL policy.", "pattern": "^projects/[^/]+/locations/[^/]+/aclPolicies/[^/]+$", "required": true, "type": "string", "location": "path" }, "updateMask": { "location": "query", "type": "string", "description": "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`", "format": "google-fieldmask" }, "requestId": { "location": "query", "type": "string", "description": "Optional. Idempotent request UUID." } }, "request": { "$ref": "AclPolicy" }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "response": { "$ref": "Operation" }, "description": "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.", "parameterOrder": [ "name" ], "id": "redis.projects.locations.aclPolicies.patch" }, "list": { "parameters": { "pageSize": { "description": "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.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { "description": "Optional. The `next_page_token` value returned from a previous `ListAclPolicies` request, if any.", "location": "query", "type": "string" }, "parent": { "location": "path", "type": "string", "description": "Required. The resource name of the ACL policy location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a Google Cloud region.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/aclPolicies", "path": "v1alpha1/{+parent}/aclPolicies", "parameterOrder": [ "parent" ], "id": "redis.projects.locations.aclPolicies.list", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "description": "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.", "response": { "$ref": "ListAclPoliciesResponse" } }, "get": { "description": "Gets the details of a specific Redis Cluster ACL policy.", "response": { "$ref": "AclPolicy" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "id": "redis.projects.locations.aclPolicies.get", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/aclPolicies/{aclPoliciesId}", "parameters": { "name": { "description": "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.", "pattern": "^projects/[^/]+/locations/[^/]+/aclPolicies/[^/]+$", "required": true, "type": "string", "location": "path" } } }, "delete": { "parameters": { "requestId": { "location": "query", "type": "string", "description": "Optional. Idempotent request UUID." }, "name": { "description": "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.", "pattern": "^projects/[^/]+/locations/[^/]+/aclPolicies/[^/]+$", "required": true, "type": "string", "location": "path" }, "etag": { "description": "Optional. Etag of the ACL policy. If this is different from the server's etag, the request will fail with an ABORTED error.", "location": "query", "type": "string" } }, "path": "v1alpha1/{+name}", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/aclPolicies/{aclPoliciesId}", "id": "redis.projects.locations.aclPolicies.delete", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "description": "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.", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ] } } }, "operations": { "methods": { "cancel": { "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path" } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "path": "v1alpha1/{+name}:cancel", "parameterOrder": [ "name" ], "id": "redis.projects.locations.operations.cancel", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "response": { "$ref": "Empty" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." }, "list": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations", "path": "v1alpha1/{+name}/operations", "parameters": { "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "name": { "type": "string", "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "pageSize": { "location": "query", "type": "integer", "description": "The standard list page size.", "format": "int32" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "response": { "$ref": "ListOperationsResponse" }, "parameterOrder": [ "name" ], "id": "redis.projects.locations.operations.list" }, "get": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "path": "v1alpha1/{+name}", "parameters": { "name": { "type": "string", "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "location": "path" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "response": { "$ref": "Operation" }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ], "id": "redis.projects.locations.operations.get" }, "delete": { "path": "v1alpha1/{+name}", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "parameters": { "name": { "location": "path", "description": "The name of the operation resource to be deleted.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "id": "redis.projects.locations.operations.delete", "parameterOrder": [ "name" ] } } }, "instances": { "methods": { "create": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "response": { "$ref": "Operation" }, "description": "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. The 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.", "parameterOrder": [ "parent" ], "id": "redis.projects.locations.instances.create", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/instances", "path": "v1alpha1/{+parent}/instances", "parameters": { "parent": { "description": "Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "location": "path" }, "instanceId": { "location": "query", "type": "string", "description": "Required. The logical name of the Redis instance 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-40 characters. * Must end with a number or a letter. * Must be unique within the customer project / location" } }, "request": { "$ref": "Instance" } }, "list": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/instances", "path": "v1alpha1/{+parent}/instances", "parameters": { "pageSize": { "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 instances left to be queried.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { "location": "query", "type": "string", "description": "The `next_page_token` value returned from a previous ListInstances request, if any." }, "parent": { "location": "path", "type": "string", "description": "Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-only", "https://www.googleapis.com/auth/redis.read-write" ], "response": { "$ref": "ListInstancesResponse" }, "description": "Lists all Redis instances 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.", "parameterOrder": [ "parent" ], "id": "redis.projects.locations.instances.list" }, "get": { "response": { "$ref": "Instance" }, "description": "Gets the details of a specific Redis instance.", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-only", "https://www.googleapis.com/auth/redis.read-write" ], "id": "redis.projects.locations.instances.get", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", "parameters": { "name": { "type": "string", "description": "Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true, "location": "path" } } }, "export": { "parameters": { "name": { "location": "path", "description": "Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true, "type": "string" } }, "request": { "$ref": "ExportInstanceRequest" }, "path": "v1alpha1/{+name}:export", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:export", "id": "redis.projects.locations.instances.export", "parameterOrder": [ "name" ], "description": "Export Redis instance data into a Redis RDB format file in Cloud Storage. Redis will continue serving during this operation. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.", "response": { "$ref": "Operation" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ] }, "rescheduleMaintenance": { "path": "v1alpha1/{+name}:rescheduleMaintenance", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:rescheduleMaintenance", "parameters": { "name": { "location": "path", "type": "string", "description": "Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true } }, "request": { "$ref": "RescheduleMaintenanceRequest" }, "description": "Reschedule maintenance for a given instance in a given project and location.", "response": { "$ref": "Operation" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "id": "redis.projects.locations.instances.rescheduleMaintenance", "parameterOrder": [ "name" ] }, "upgrade": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:upgrade", "path": "v1alpha1/{+name}:upgrade", "parameters": { "name": { "type": "string", "description": "Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true, "location": "path" } }, "request": { "$ref": "UpgradeInstanceRequest" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "description": "Upgrades Redis instance to the newer Redis version specified in the request.", "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "id": "redis.projects.locations.instances.upgrade" }, "failover": { "id": "redis.projects.locations.instances.failover", "parameterOrder": [ "name" ], "description": "Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.", "response": { "$ref": "Operation" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "parameters": { "name": { "type": "string", "description": "Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true, "location": "path" } }, "request": { "$ref": "FailoverInstanceRequest" }, "path": "v1alpha1/{+name}:failover", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:failover" }, "getAuthString": { "id": "redis.projects.locations.instances.getAuthString", "parameterOrder": [ "name" ], "description": "Gets the AUTH string for a Redis instance. If AUTH is not enabled for the instance the response will be empty. This information is not included in the details returned to GetInstance.", "response": { "$ref": "InstanceAuthString" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-only", "https://www.googleapis.com/auth/redis.read-write" ], "parameters": { "name": { "type": "string", "description": "Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true, "location": "path" } }, "path": "v1alpha1/{+name}/authString", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/authString" }, "import": { "parameters": { "name": { "location": "path", "type": "string", "description": "Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true } }, "request": { "$ref": "ImportInstanceRequest" }, "path": "v1alpha1/{+name}:import", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:import", "id": "redis.projects.locations.instances.import", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "description": "Import a Redis RDB snapshot file from Cloud Storage into a Redis instance. Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When complete, the instance will contain only data from the imported file. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ] }, "patch": { "parameterOrder": [ "name" ], "id": "redis.projects.locations.instances.patch", "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "description": "Updates the metadata and configuration of a specific Redis instance. 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.", "response": { "$ref": "Operation" }, "parameters": { "updateMask": { "location": "query", "type": "string", "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 Instance: * `displayName` * `labels` * `memorySizeGb` * `redisConfig` * `replica_count`", "format": "google-fieldmask" }, "name": { "location": "path", "description": "Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true, "type": "string" } }, "request": { "$ref": "Instance" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", "path": "v1alpha1/{+name}" }, "delete": { "response": { "$ref": "Operation" }, "description": "Deletes a specific Redis instance. Instance stops serving and data is deleted.", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "id": "redis.projects.locations.instances.delete", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", "parameters": { "name": { "location": "path", "type": "string", "description": "Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true } } } } }, "backupCollections": { "resources": { "backups": { "methods": { "list": { "parameterOrder": [ "parent" ], "id": "redis.projects.locations.backupCollections.backups.list", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "description": "Lists all backups owned by a backup collection.", "response": { "$ref": "ListBackupsResponse" }, "parameters": { "parent": { "location": "path", "type": "string", "description": "Required. The resource name of the backupCollection using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/backupCollections/[^/]+$", "required": true }, "pageSize": { "location": "query", "type": "integer", "description": "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 clusters left to be queried.", "format": "int32" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The `next_page_token` value returned from a previous [ListBackupCollections] request, if any." } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/backupCollections/{backupCollectionsId}/backups", "path": "v1alpha1/{+parent}/backups" }, "get": { "path": "v1alpha1/{+name}", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/backupCollections/{backupCollectionsId}/backups/{backupsId}", "parameters": { "name": { "type": "string", "description": "Required. Redis backup resource name using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/backupCollections/[^/]+/backups/[^/]+$", "required": true, "location": "path" } }, "response": { "$ref": "Backup" }, "description": "Gets the details of a specific backup.", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "id": "redis.projects.locations.backupCollections.backups.get", "parameterOrder": [ "name" ] }, "delete": { "id": "redis.projects.locations.backupCollections.backups.delete", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "description": "Deletes a specific backup.", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "parameters": { "name": { "location": "path", "type": "string", "description": "Required. Redis backup resource name using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/backupCollections/[^/]+/backups/[^/]+$", "required": true }, "requestId": { "description": "Optional. Idempotent request UUID.", "location": "query", "type": "string" } }, "path": "v1alpha1/{+name}", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/backupCollections/{backupCollectionsId}/backups/{backupsId}" }, "export": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "description": "Exports a specific backup to a customer target Cloud Storage URI.", "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "id": "redis.projects.locations.backupCollections.backups.export", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/backupCollections/{backupCollectionsId}/backups/{backupsId}:export", "path": "v1alpha1/{+name}:export", "parameters": { "name": { "type": "string", "description": "Required. Redis backup resource name using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/backupCollections/[^/]+/backups/[^/]+$", "required": true, "location": "path" } }, "request": { "$ref": "ExportBackupRequest" } } } } }, "methods": { "list": { "parameters": { "parent": { "description": "Required. The resource name of the backupCollection location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a Google Cloud region.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "location": "path" }, "pageSize": { "location": "query", "type": "integer", "description": "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 clusters left to be queried.", "format": "int32" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The `next_page_token` value returned from a previous [ListBackupCollections] request, if any." } }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/backupCollections", "path": "v1alpha1/{+parent}/backupCollections", "parameterOrder": [ "parent" ], "id": "redis.projects.locations.backupCollections.list", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "response": { "$ref": "ListBackupCollectionsResponse" }, "description": "Lists all backup collections owned by a consumer project in either the specified location (region) or all locations. If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated." }, "get": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/backupCollections/{backupCollectionsId}", "path": "v1alpha1/{+name}", "parameters": { "name": { "location": "path", "type": "string", "description": "Required. Redis backupCollection resource name using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}` where `location_id` refers to a Google Cloud region.", "pattern": "^projects/[^/]+/locations/[^/]+/backupCollections/[^/]+$", "required": true } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/redis.read-write" ], "response": { "$ref": "BackupCollection" }, "description": "Get a backup collection.", "parameterOrder": [ "name" ], "id": "redis.projects.locations.backupCollections.get" } } } } } } } }, "discoveryVersion": "v1", "description": "Creates and manages Redis instances on the Google Cloud Platform.", "revision": "20260709", "rootUrl": "https://redis.googleapis.com/", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "parameters": { "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", "location": "query" }, "access_token": { "type": "string", "location": "query", "description": "OAuth access token." }, "fields": { "type": "string", "location": "query", "description": "Selector specifying which fields to include in a partial response." }, "callback": { "type": "string", "location": "query", "description": "JSONP" }, "alt": { "description": "Data format for response.", "type": "string", "enum": [ "json", "media", "proto" ], "default": "json", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query" }, "oauth_token": { "type": "string", "location": "query", "description": "OAuth 2.0 token for the current user." }, "key": { "description": "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.", "type": "string", "location": "query" }, "$.xgafv": { "description": "V1 error format.", "type": "string", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query" }, "quotaUser": { "description": "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.", "type": "string", "location": "query" }, "upload_protocol": { "type": "string", "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "prettyPrint": { "default": "true", "description": "Returns response with indentations and line breaks.", "type": "boolean", "location": "query" } }, "schemas": { "DatabaseResourceSignalData": { "type": "object", "id": "DatabaseResourceSignalData", "description": "Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 10", "properties": { "signalState": { "enumDescriptions": [ "Unspecified signal state.", "Signal is active and requires attention.", "Signal is inactive and does not require attention.", "Signal is dismissed by the user and should not be shown to the user again." ], "readOnly": true, "type": "string", "enum": [ "SIGNAL_STATE_UNSPECIFIED", "ACTIVE", "INACTIVE", "DISMISSED" ], "description": "Required. Output only. Signal state of the signal" }, "signalBoolValue": { "deprecated": true, "description": "Deprecated: Use signal_metadata_list instead.", "type": "boolean" }, "location": { "description": "Required. Resource location.", "type": "string" }, "resourceId": { "description": "Database resource id.", "$ref": "DatabaseResourceId" }, "signalMetadataList": { "type": "array", "description": "This will support array of OneOf signal metadata information for a given signal type.", "items": { "$ref": "SignalMetadata" } }, "backupRun": { "description": "Deprecated: Use signal_metadata_list instead.", "$ref": "BackupRun", "deprecated": true }, "lastRefreshTime": { "type": "string", "description": "Required. Last time signal was refreshed", "format": "google-datetime" }, "signalType": { "description": "Required. Signal type of the signal", "enumDescriptions": [ "Unspecified signal type.", "Outdated Minor Version", "Represents database auditing is disabled.", "Represents if a database has a password configured for the root account or not.", "Represents if a resource is exposed to public access.", "Represents if a resources requires all incoming connections to use SSL or not.", "Represents if a resource version is in extended support.", "Represents if a resource has no automated backup policy.", "Represents if a resource version is nearing end of life.", "Represents if the last backup of a resource is older than 24 hours.", "Represents if a resource is not protected by automatic failover." ], "type": "string", "enum": [ "SIGNAL_TYPE_UNSPECIFIED", "SIGNAL_TYPE_OUTDATED_MINOR_VERSION", "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", "SIGNAL_TYPE_NO_ROOT_PASSWORD", "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", "SIGNAL_TYPE_EXTENDED_SUPPORT", "SIGNAL_TYPE_NO_AUTOMATED_BACKUP_POLICY", "SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE", "SIGNAL_TYPE_LAST_BACKUP_OLD", "SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER" ] }, "fullResourceName": { "description": "Required. Full Resource name of the source resource.", "type": "string" } } }, "CrossClusterReplicationConfig": { "id": "CrossClusterReplicationConfig", "description": "Cross cluster replication config.", "properties": { "secondaryClusters": { "type": "array", "description": "List of secondary clusters that are replicating from this primary cluster. This field is only set for a primary cluster.", "items": { "$ref": "RemoteCluster" } }, "membership": { "readOnly": true, "$ref": "Membership", "description": "Output only. An output only view of all the member clusters participating in the cross cluster replication. This view will be provided by every member cluster irrespective of its cluster role(primary or secondary). A primary cluster can provide information about all the secondary clusters replicating from it. However, a secondary cluster only knows about the primary cluster from which it is replicating. However, for scenarios, where the primary cluster is unavailable(e.g. regional outage), a GetCluster request can be sent to any other member cluster and this field will list all the member clusters participating in cross cluster replication." }, "updateTime": { "readOnly": true, "description": "Output only. The last time cross cluster replication config was updated.", "format": "google-datetime", "type": "string" }, "clusterRole": { "enumDescriptions": [ "Cluster role is not set. The behavior is equivalent to NONE.", "This cluster does not participate in cross cluster replication. It is an independent cluster and does not replicate to or from any other clusters.", "A cluster that allows both reads and writes. Any data written to this cluster is also replicated to the attached secondary clusters.", "A cluster that allows only reads and replicates data from a primary cluster." ], "readOnly": true, "description": "Output only. The role of the cluster in cross cluster replication.", "type": "string", "enum": [ "CLUSTER_ROLE_UNSPECIFIED", "NONE", "PRIMARY", "SECONDARY" ] }, "primaryCluster": { "$ref": "RemoteCluster", "description": "Details of the primary cluster that is used as the replication source for this secondary cluster. This field is only set for a secondary cluster." } }, "type": "object" }, "PscConnection": { "type": "object", "id": "PscConnection", "description": "Details of consumer resources in a PSC connection.", "properties": { "connectionType": { "type": "string", "enum": [ "CONNECTION_TYPE_UNSPECIFIED", "CONNECTION_TYPE_DISCOVERY", "CONNECTION_TYPE_PRIMARY", "CONNECTION_TYPE_READER" ], "description": "Output only. Type of the PSC connection.", "readOnly": true, "enumDescriptions": [ "Cluster endpoint Type is not set", "Cluster endpoint that will be used as for cluster topology discovery.", "Cluster endpoint that will be used as primary endpoint to access primary.", "Cluster endpoint that will be used as reader endpoint to access replicas." ] }, "forwardingRule": { "type": "string", "description": "Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}." }, "pscConnectionId": { "description": "Required. The PSC connection id of the forwarding rule connected to the service attachment.", "type": "string" }, "port": { "type": "integer", "description": "Output only. port will only be set for Primary/Reader or Discovery endpoint.", "format": "int32", "readOnly": true }, "address": { "type": "string", "description": "Required. The IP allocated on the consumer network for the PSC forwarding rule." }, "projectId": { "type": "string", "description": "Optional. Project ID of the consumer project where the forwarding rule is created in." }, "pscConnectionStatus": { "type": "string", "enum": [ "PSC_CONNECTION_STATUS_UNSPECIFIED", "PSC_CONNECTION_STATUS_ACTIVE", "PSC_CONNECTION_STATUS_NOT_FOUND" ], "description": "Output only. The status of the PSC connection. Please note that this value is updated periodically. To get the latest status of a PSC connection, follow https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details.", "enumDescriptions": [ "PSC connection status is not specified.", "The connection is active", "Connection not found" ], "readOnly": true }, "serviceAttachment": { "type": "string", "description": "Required. The service attachment which is the target of the PSC connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}." }, "network": { "type": "string", "description": "Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}." } } }, "ClusterPersistenceConfig": { "type": "object", "id": "ClusterPersistenceConfig", "description": "Configuration of the persistence functionality.", "properties": { "rdbConfig": { "description": "Optional. RDB configuration. This field will be ignored if mode is not RDB.", "$ref": "RDBConfig" }, "aofConfig": { "description": "Optional. AOF configuration. This field will be ignored if mode is not AOF.", "$ref": "AOFConfig" }, "mode": { "description": "Optional. The mode of persistence.", "enumDescriptions": [ "Not set.", "Persistence is disabled, and any snapshot data is deleted.", "RDB based persistence is enabled.", "AOF based persistence is enabled." ], "type": "string", "enum": [ "PERSISTENCE_MODE_UNSPECIFIED", "DISABLED", "RDB", "AOF" ] } } }, "BackupDRConfiguration": { "type": "object", "id": "BackupDRConfiguration", "description": "BackupDRConfiguration to capture the backup and disaster recovery details of database resource.", "properties": { "backupdrManaged": { "description": "Indicates if the resource is managed by BackupDR.", "type": "boolean" } } }, "AutomatedBackupConfig": { "id": "AutomatedBackupConfig", "description": "The automated backup config for a cluster.", "properties": { "automatedBackupMode": { "type": "string", "enum": [ "AUTOMATED_BACKUP_MODE_UNSPECIFIED", "DISABLED", "ENABLED" ], "description": "Optional. The automated backup mode. If the mode is disabled, the other fields will be ignored.", "enumDescriptions": [ "Default value. Automated backup config is not specified.", "Automated backup config disabled.", "Automated backup config enabled." ] }, "retention": { "description": "Optional. How long to keep automated backups before the backups are deleted. The value should be between 1 day and 365 days. If not specified, the default value is 35 days.", "format": "google-duration", "type": "string" }, "fixedFrequencySchedule": { "description": "Optional. Trigger automated backups at a fixed frequency.", "$ref": "FixedFrequencySchedule" } }, "type": "object" }, "AddTokenAuthUserRequest": { "type": "object", "id": "AddTokenAuthUserRequest", "description": "Request message for AddTokenAuthUser.", "properties": { "tokenAuthUser": { "description": "Required. The id of the token auth user to add.", "type": "string" } } }, "ClusterMaintenancePolicy": { "type": "object", "id": "ClusterMaintenancePolicy", "description": "Maintenance policy per cluster.", "properties": { "createTime": { "readOnly": true, "description": "Output only. The time when the policy was created i.e. Maintenance Window or Deny Period was assigned.", "format": "google-datetime", "type": "string" }, "updateTime": { "type": "string", "description": "Output only. The time when the policy was updated i.e. Maintenance Window or Deny Period was updated.", "format": "google-datetime", "readOnly": true }, "weeklyMaintenanceWindow": { "type": "array", "description": "Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_maintenance_window is expected to be one.", "items": { "$ref": "ClusterWeeklyMaintenanceWindow" } } } }, "RemoteCluster": { "id": "RemoteCluster", "description": "Details of the remote cluster associated with this cluster in a cross cluster replication setup.", "properties": { "cluster": { "readOnly": true, "description": "Output only. The full resource path of the remote cluster in the format: projects//locations//clusters/", "type": "string" }, "uid": { "readOnly": true, "type": "string", "description": "Output only. The unique identifier of the remote cluster." } }, "type": "object" }, "PscConfig": { "type": "object", "id": "PscConfig", "properties": { "network": { "type": "string", "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}." } } }, "ListAuthTokensResponse": { "id": "ListAuthTokensResponse", "description": "Response message for ListAuthTokens.", "properties": { "unreachable": { "type": "array", "description": "Unordered list. Auth tokens that could not be reached.", "items": { "type": "string" } }, "authTokens": { "items": { "$ref": "AuthToken" }, "description": "A list of auth tokens in the project.", "type": "array" }, "nextPageToken": { "type": "string", "description": "Token to retrieve the next page of results, or empty if there are no more results in the list." } }, "type": "object" }, "AclPolicy": { "id": "AclPolicy", "description": "The ACL policy resource.", "properties": { "rules": { "description": "Required. The ACL rules within the ACL policy.", "type": "array", "items": { "$ref": "AclRule" } }, "version": { "readOnly": true, "deprecated": true, "format": "int64", "description": "Output only. Deprecated: Used in drift resolution.", "type": "string" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "UPDATING", "DELETING" ], "description": "Output only. The state of the ACL policy.", "readOnly": true, "enumDescriptions": [ "Not set.", "ACL policy has been created and is fully usable. Since ACL policy creation is synchronous and not an LRO, there is no CREATING state.", "ACL policy is being updated.", "ACL policy is being deleted." ] }, "etag": { "readOnly": true, "description": "Output only. Etag for the ACL policy.", "type": "string" }, "name": { "description": "Identifier. Full resource path of the ACL policy.", "type": "string" } }, "type": "object" }, "RescheduleMaintenanceRequest": { "type": "object", "id": "RescheduleMaintenanceRequest", "description": "Request for RescheduleMaintenance.", "properties": { "scheduleTime": { "description": "Optional. The RFC 3339 timestamp for when maintenance will be rescheduled if rescheduleType=SPECIFIC_TIME. For example `2012-11-15T16:19:00.094Z`.", "format": "google-datetime", "type": "string" }, "rescheduleType": { "type": "string", "enum": [ "RESCHEDULE_TYPE_UNSPECIFIED", "IMMEDIATE", "NEXT_AVAILABLE_WINDOW", "SPECIFIC_TIME" ], "description": "Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.", "enumDescriptions": [ "If not set, the rpc will be a no-op.", "If the user wants to schedule the maintenance to happen now.", "If the user wants to use the existing maintenance policy to find the next available window.", "If the user wants to reschedule the maintenance to a specific time." ] } } }, "RegionalManagedCertificateAuthority": { "type": "object", "id": "RegionalManagedCertificateAuthority", "description": "CA certificate chains for redis managed server authentication.", "properties": { "caCerts": { "items": { "$ref": "RegionalCertChain" }, "description": "The PEM encoded CA certificate chains for redis managed server authentication", "type": "array" } } }, "SharedRegionalCertificateAuthority": { "type": "object", "id": "SharedRegionalCertificateAuthority", "description": "Shared regional certificate authority", "properties": { "name": { "description": "Identifier. Unique name of the resource in this scope including project and location using the form: `projects/{project}/locations/{location}/sharedRegionalCertificateAuthority`", "type": "string" }, "managedServerCa": { "$ref": "RegionalManagedCertificateAuthority", "description": "CA certificate chains for redis managed server authentication." } } }, "BackupCollection": { "type": "object", "id": "BackupCollection", "description": "BackupCollection of a cluster.", "properties": { "totalBackupSizeBytes": { "readOnly": true, "type": "string", "description": "Output only. Total size of all backups in the backup collection.", "format": "int64" }, "name": { "type": "string", "description": "Identifier. Full resource path of the backup collection." }, "clusterUid": { "type": "string", "description": "Output only. The cluster uid of the backup collection.", "readOnly": true }, "uid": { "readOnly": true, "description": "Output only. System assigned unique identifier of the backup collection.", "type": "string" }, "createTime": { "description": "Output only. The time when the backup collection was created.", "format": "google-datetime", "type": "string", "readOnly": true }, "lastBackupTime": { "description": "Output only. The last time a backup was created in the backup collection.", "format": "google-datetime", "type": "string", "readOnly": true }, "cluster": { "type": "string", "description": "Output only. The full resource path of the cluster the backup collection belongs to. Example: projects/{project}/locations/{location}/clusters/{cluster}", "readOnly": true }, "kmsKey": { "readOnly": true, "type": "string", "description": "Output only. The KMS key used to encrypt the backups under this backup collection." }, "totalBackupCount": { "type": "string", "description": "Output only. Total number of backups in the backup collection.", "format": "int64", "readOnly": true } } }, "BackupClusterRequest": { "type": "object", "id": "BackupClusterRequest", "description": "Request for `BackupCluster`.", "properties": { "ttl": { "description": "Optional. TTL for the backup to expire. Value range is 1 day to 100 years. If not specified, the default value is 100 years.", "format": "google-duration", "type": "string" }, "backupId": { "description": "Optional. The id of the backup to be created. If not specified, the default value ([YYYYMMDDHHMMSS]_[Shortened Cluster UID] is used.", "type": "string" } } }, "BackupDRMetadata": { "id": "BackupDRMetadata", "description": "BackupDRMetadata contains information about the backup and disaster recovery metadata of a database resource.", "properties": { "backupdrConfiguration": { "description": "BackupDR configuration for this instance.", "$ref": "BackupDRConfiguration" }, "lastRefreshTime": { "description": "Required. Last time backup configuration was refreshed.", "format": "google-datetime", "type": "string" }, "backupConfiguration": { "description": "Backup configuration for this instance.", "$ref": "BackupConfiguration" }, "backupRun": { "$ref": "BackupRun", "description": "Latest backup run information for this instance." }, "fullResourceName": { "type": "string", "description": "Required. Full resource name of this instance." }, "resourceId": { "$ref": "DatabaseResourceId", "description": "Required. Database resource id." } }, "type": "object" }, "WeeklyMaintenanceWindow": { "type": "object", "id": "WeeklyMaintenanceWindow", "description": "Time window in which disruptive maintenance updates occur. Non-disruptive updates can occur inside or outside this window.", "properties": { "day": { "description": "Required. The day of week that maintenance updates occur.", "enumDescriptions": [ "The day of the week is unspecified.", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "type": "string", "enum": [ "DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "duration": { "description": "Output only. Duration of the maintenance window. The current window is fixed at 1 hour.", "format": "google-duration", "type": "string", "readOnly": true }, "startTime": { "description": "Required. Start time of the window in UTC time.", "$ref": "TimeOfDay" } } }, "DatabaseResourceRecommendationSignalData": { "type": "object", "id": "DatabaseResourceRecommendationSignalData", "description": "Common model for database resource recommendation signal data.", "properties": { "recommenderId": { "description": "Required. ID of recommender. Examples: \"google.cloudsql.instance.PerformanceRecommender\"", "type": "string" }, "resourceName": { "type": "string", "description": "Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel" }, "lastRefreshTime": { "type": "string", "description": "Required. last time recommendationw as refreshed", "format": "google-datetime" }, "signalType": { "type": "string", "enum": [ "SIGNAL_TYPE_UNSPECIFIED", "SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER", "SIGNAL_TYPE_GROUP_NOT_REPLICATING_ACROSS_REGIONS", "SIGNAL_TYPE_NOT_AVAILABLE_IN_MULTIPLE_ZONES", "SIGNAL_TYPE_NOT_AVAILABLE_IN_MULTIPLE_REGIONS", "SIGNAL_TYPE_NO_PROMOTABLE_REPLICA", "SIGNAL_TYPE_NO_AUTOMATED_BACKUP_POLICY", "SIGNAL_TYPE_SHORT_BACKUP_RETENTION", "SIGNAL_TYPE_LAST_BACKUP_FAILED", "SIGNAL_TYPE_LAST_BACKUP_OLD", "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_2_0", "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_3", "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_2", "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_1", "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_0", "SIGNAL_TYPE_VIOLATES_CIS_CONTROLS_V8_0", "SIGNAL_TYPE_VIOLATES_NIST_800_53", "SIGNAL_TYPE_VIOLATES_NIST_800_53_R5", "SIGNAL_TYPE_VIOLATES_NIST_CYBERSECURITY_FRAMEWORK_V1_0", "SIGNAL_TYPE_VIOLATES_ISO_27001", "SIGNAL_TYPE_VIOLATES_ISO_27001_V2022", "SIGNAL_TYPE_VIOLATES_PCI_DSS_V3_2_1", "SIGNAL_TYPE_VIOLATES_PCI_DSS_V4_0", "SIGNAL_TYPE_VIOLATES_CLOUD_CONTROLS_MATRIX_V4", "SIGNAL_TYPE_VIOLATES_HIPAA", "SIGNAL_TYPE_VIOLATES_SOC2_V2017", "SIGNAL_TYPE_LOGS_NOT_OPTIMIZED_FOR_TROUBLESHOOTING", "SIGNAL_TYPE_QUERY_DURATIONS_NOT_LOGGED", "SIGNAL_TYPE_VERBOSE_ERROR_LOGGING", "SIGNAL_TYPE_QUERY_LOCK_WAITS_NOT_LOGGED", "SIGNAL_TYPE_LOGGING_MOST_ERRORS", "SIGNAL_TYPE_LOGGING_ONLY_CRITICAL_ERRORS", "SIGNAL_TYPE_MINIMAL_ERROR_LOGGING", "SIGNAL_TYPE_QUERY_STATISTICS_LOGGED", "SIGNAL_TYPE_EXCESSIVE_LOGGING_OF_CLIENT_HOSTNAME", "SIGNAL_TYPE_EXCESSIVE_LOGGING_OF_PARSER_STATISTICS", "SIGNAL_TYPE_EXCESSIVE_LOGGING_OF_PLANNER_STATISTICS", "SIGNAL_TYPE_NOT_LOGGING_ONLY_DDL_STATEMENTS", "SIGNAL_TYPE_LOGGING_QUERY_STATISTICS", "SIGNAL_TYPE_NOT_LOGGING_TEMPORARY_FILES", "SIGNAL_TYPE_CONNECTION_MAX_NOT_CONFIGURED", "SIGNAL_TYPE_USER_OPTIONS_CONFIGURED", "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", "SIGNAL_TYPE_NO_ROOT_PASSWORD", "SIGNAL_TYPE_WEAK_ROOT_PASSWORD", "SIGNAL_TYPE_ENCRYPTION_KEY_NOT_CUSTOMER_MANAGED", "SIGNAL_TYPE_SERVER_AUTHENTICATION_NOT_REQUIRED", "SIGNAL_TYPE_EXPOSED_BY_OWNERSHIP_CHAINING", "SIGNAL_TYPE_EXPOSED_TO_EXTERNAL_SCRIPTS", "SIGNAL_TYPE_EXPOSED_TO_LOCAL_DATA_LOADS", "SIGNAL_TYPE_CONNECTION_ATTEMPTS_NOT_LOGGED", "SIGNAL_TYPE_DISCONNECTIONS_NOT_LOGGED", "SIGNAL_TYPE_LOGGING_EXCESSIVE_STATEMENT_INFO", "SIGNAL_TYPE_EXPOSED_TO_REMOTE_ACCESS", "SIGNAL_TYPE_DATABASE_NAMES_EXPOSED", "SIGNAL_TYPE_SENSITIVE_TRACE_INFO_NOT_MASKED", "SIGNAL_TYPE_PUBLIC_IP_ENABLED", "SIGNAL_TYPE_IDLE", "SIGNAL_TYPE_OVERPROVISIONED", "SIGNAL_TYPE_HIGH_NUMBER_OF_OPEN_TABLES", "SIGNAL_TYPE_HIGH_NUMBER_OF_TABLES", "SIGNAL_TYPE_HIGH_TRANSACTION_ID_UTILIZATION", "SIGNAL_TYPE_UNDERPROVISIONED", "SIGNAL_TYPE_OUT_OF_DISK", "SIGNAL_TYPE_SERVER_CERTIFICATE_NEAR_EXPIRY", "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", "SIGNAL_TYPE_RESTRICT_AUTHORIZED_NETWORKS", "SIGNAL_TYPE_VIOLATE_POLICY_RESTRICT_PUBLIC_IP", "SIGNAL_TYPE_QUOTA_LIMIT", "SIGNAL_TYPE_NO_PASSWORD_POLICY", "SIGNAL_TYPE_CONNECTIONS_PERFORMANCE_IMPACT", "SIGNAL_TYPE_TMP_TABLES_PERFORMANCE_IMPACT", "SIGNAL_TYPE_TRANS_LOGS_PERFORMANCE_IMPACT", "SIGNAL_TYPE_HIGH_JOINS_WITHOUT_INDEXES", "SIGNAL_TYPE_SUPERUSER_WRITING_TO_USER_TABLES", "SIGNAL_TYPE_USER_GRANTED_ALL_PERMISSIONS", "SIGNAL_TYPE_DATA_EXPORT_TO_EXTERNAL_CLOUD_STORAGE_BUCKET", "SIGNAL_TYPE_DATA_EXPORT_TO_PUBLIC_CLOUD_STORAGE_BUCKET", "SIGNAL_TYPE_WEAK_PASSWORD_HASH_ALGORITHM", "SIGNAL_TYPE_NO_USER_PASSWORD_POLICY", "SIGNAL_TYPE_HOT_NODE", "SIGNAL_TYPE_NO_POINT_IN_TIME_RECOVERY", "SIGNAL_TYPE_RESOURCE_SUSPENDED", "SIGNAL_TYPE_EXPENSIVE_COMMANDS", "SIGNAL_TYPE_NO_MAINTENANCE_POLICY_CONFIGURED", "SIGNAL_TYPE_NO_DELETION_PROTECTION", "SIGNAL_TYPE_INEFFICIENT_QUERY", "SIGNAL_TYPE_READ_INTENSIVE_WORKLOAD", "SIGNAL_TYPE_MEMORY_LIMIT", "SIGNAL_TYPE_MAX_SERVER_MEMORY", "SIGNAL_TYPE_LARGE_ROWS", "SIGNAL_TYPE_HIGH_WRITE_PRESSURE", "SIGNAL_TYPE_HIGH_READ_PRESSURE", "SIGNAL_TYPE_ENCRYPTION_ORG_POLICY_NOT_SATISFIED", "SIGNAL_TYPE_LOCATION_ORG_POLICY_NOT_SATISFIED", "SIGNAL_TYPE_OUTDATED_MINOR_VERSION", "SIGNAL_TYPE_SCHEMA_NOT_OPTIMIZED", "SIGNAL_TYPE_MANY_IDLE_CONNECTIONS", "SIGNAL_TYPE_REPLICATION_LAG", "SIGNAL_TYPE_OUTDATED_VERSION", "SIGNAL_TYPE_OUTDATED_CLIENT", "SIGNAL_TYPE_DATABOOST_DISABLED", "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", "SIGNAL_TYPE_EXTENDED_SUPPORT", "SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE", "SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE", "SIGNAL_TYPE_HIGH_MAINTENANCE_DOWNTIME_RISK", "SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME", "SIGNAL_TYPE_MISSING_ENHANCED_PROTECTION" ], "description": "Required. Type of signal, for example, `SIGNAL_TYPE_IDLE`, `SIGNAL_TYPE_HIGH_NUMBER_OF_TABLES`, etc.", "enumDescriptions": [ "Unspecified.", "Represents if a resource is protected by automatic failover. Checks for resources that are configured to have redundancy within a region that enables automatic failover.", "Represents if a group is replicating across regions. Checks for resources that are configured to have redundancy, and ongoing replication, across regions.", "Represents if the resource is available in multiple zones or not.", "Represents if a resource is available in multiple regions.", "Represents if a resource has a promotable replica.", "Represents if a resource has an automated backup policy.", "Represents if a resources has a short backup retention period.", "Represents if the last backup of a resource failed.", "Represents if the last backup of a resource is older than some threshold value.", "Represents if a resource violates CIS GCP Foundation 2.0.", "Represents if a resource violates CIS GCP Foundation 1.3.", "Represents if a resource violates CIS GCP Foundation 1.2.", "Represents if a resource violates CIS GCP Foundation 1.1.", "Represents if a resource violates CIS GCP Foundation 1.0.", "Represents if a resource violates CIS Controls 8.0.", "Represents if a resource violates NIST 800-53.", "Represents if a resource violates NIST 800-53 R5.", "Represents if a resource violates NIST Cybersecurity Framework 1.0.", "Represents if a resource violates ISO-27001.", "Represents if a resource violates ISO 27001 2022.", "Represents if a resource violates PCI-DSS v3.2.1.", "Represents if a resource violates PCI-DSS v4.0.", "Represents if a resource violates Cloud Controls Matrix v4.0.", "Represents if a resource violates HIPAA.", "Represents if a resource violates SOC2 v2017.", "Represents if log_checkpoints database flag for a Cloud SQL for PostgreSQL instance is not set to on.", "Represents if the log_duration database flag for a Cloud SQL for PostgreSQL instance is not set to on.", "Represents if the log_error_verbosity database flag for a Cloud SQL for PostgreSQL instance is not set to default or stricter (default or terse).", "Represents if the log_lock_waits database flag for a Cloud SQL for PostgreSQL instance is not set to on.", "Represents if the log_min_error_statement database flag for a Cloud SQL for PostgreSQL instance is not set appropriately.", "Represents if the log_min_error_statement database flag for a Cloud SQL for PostgreSQL instance does not have an appropriate severity level.", "Represents if the log_min_messages database flag for a Cloud SQL for PostgreSQL instance is not set to warning or another recommended value.", "Represents if the databaseFlags property of instance metadata for the log_executor_status field is set to on.", "Represents if the log_hostname database flag for a Cloud SQL for PostgreSQL instance is not set to off.", "Represents if the log_parser_stats database flag for a Cloud SQL for PostgreSQL instance is not set to off.", "Represents if the log_planner_stats database flag for a Cloud SQL for PostgreSQL instance is not set to off.", "Represents if the log_statement database flag for a Cloud SQL for PostgreSQL instance is not set to DDL (all data definition statements).", "Represents if the log_statement_stats database flag for a Cloud SQL for PostgreSQL instance is not set to off.", "Represents if the log_temp_files database flag for a Cloud SQL for PostgreSQL instance is not set to \"0\". (NOTE: 0 = ON)", "Represents if the user connections database flag for a Cloud SQL for SQL Server instance is configured.", "Represents if the user options database flag for Cloud SQL SQL Server instance is configured or not.", "Represents if a resource is exposed to public access.", "Represents if a resources requires all incoming connections to use SSL or not.", "Represents if a Cloud SQL database has a password configured for the root account or not.", "Represents if a Cloud SQL database has a weak password configured for the root account.", "Represents if a SQL database instance is not encrypted with customer-managed encryption keys (CMEK).", "Represents if The contained database authentication database flag for a Cloud SQL for SQL Server instance is not set to off.", "Represents if the cross_db_ownership_chaining database flag for a Cloud SQL for SQL Server instance is not set to off.", "Represents if he external scripts enabled database flag for a Cloud SQL for SQL Server instance is not set to off.", "Represents if the local_infile database flag for a Cloud SQL for MySQL instance is not set to off.", "Represents if the log_connections database flag for a Cloud SQL for PostgreSQL instance is not set to on.", "Represents if the log_disconnections database flag for a Cloud SQL for PostgreSQL instance is not set to on.", "Represents if the log_min_duration_statement database flag for a Cloud SQL for PostgreSQL instance is not set to -1.", "Represents if the remote access database flag for a Cloud SQL for SQL Server instance is not set to off.", "Represents if the skip_show_database database flag for a Cloud SQL for MySQL instance is not set to on.", "Represents if the 3625 (trace flag) database flag for a Cloud SQL for SQL Server instance is not set to on.", "Represents if public IP is enabled.", "Represents Idle instance helps to reduce costs.", "Represents instances that are unnecessarily large for given workload.", "Represents high number of concurrently opened tables.", "Represents high table count close to SLA limit.", "Represents high number of unvacuumed transactions", "Represents need for more CPU and/or memory", "Represents out of disk.", "Represents server certificate is near expiry.", "Represents database auditing is disabled.", "Represents not restricted to authorized networks.", "Represents violate org policy restrict public ip.", "Cluster nearing quota limit", "No password policy set on resources", "Performance impact of connections settings", "Performance impact of temporary tables settings", "Performance impact of transaction logs settings", "Performance impact of high joins without indexes", "Detects events where a Cloud SQL superuser (postgres for PostgreSQL servers or root for MySQL users) writes to non-system tables.", "Detects events where a database user or role has been granted all privileges to a database, or to all tables, procedures, or functions in a schema.", "Detects if database instance data exported to a Cloud Storage bucket outside of the organization.", "Detects if database instance data exported to a Cloud Storage bucket that is owned by the organization and is publicly accessible.", "Detects if a database instance is using a weak password hash algorithm.", "Detects if a database instance has no user password policy set.", "Detects if a database instance/cluster has a hot node.", "Detects if a database instance has no point in time recovery enabled.", "Detects if a database instance/cluster is suspended.", "Detects that expensive commands are being run on a database instance impacting overall performance.", "Indicates that the instance does not have a maintenance policy configured.", "Deletion Protection Disabled for the resource", "Indicates that the instance has inefficient queries detected.", "Indicates that the instance has read intensive workload.", "Indicates that the instance is nearing memory limit.", "Indicates that the instance's max server memory is configured higher than the recommended value.", "Indicates that the database has large rows beyond the recommended limit.", "Heavy write pressure on the database rows.", "Heavy read pressure on the database rows.", "Encryption org policy not satisfied.", "Location org policy not satisfied.", "Outdated DB minor version.", "Schema not optimized.", "High number of idle connections.", "Replication delay.", "Outdated version.", "Outdated client.", "Databoost is disabled.", "Recommended maintenance policy.", "Resource version is in extended support.", "Change in performance KPIs.", "Database version nearing end of life.", "Indicates a high risk of maintenance downtime.", "Indicates both a low cache hit rate and a risk of maintenance downtime.", "Indicates that the resource is missing enhanced protection." ], "enumDeprecated": [ false, false, false, true, true, true, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, true, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, true, false, false, false, false, false, false, false, false, false, false, false ] }, "recommendationState": { "description": "Required. Recommendation state", "enumDescriptions": [ "", "Recommendation is active and can be applied. ACTIVE recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.", "Recommendation is in claimed state. Recommendations content is immutable and cannot be updated by Google. CLAIMED recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.", "Recommendation is in succeeded state. Recommendations content is immutable and cannot be updated by Google. SUCCEEDED recommendations can be marked as SUCCEEDED, or FAILED.", "Recommendation is in failed state. Recommendations content is immutable and cannot be updated by Google. FAILED recommendations can be marked as SUCCEEDED, or FAILED.", "Recommendation is in dismissed state. Recommendation content can be updated by Google. DISMISSED recommendations can be marked as ACTIVE." ], "type": "string", "enum": [ "UNSPECIFIED", "ACTIVE", "CLAIMED", "SUCCEEDED", "FAILED", "DISMISSED" ] }, "recommenderSubtype": { "type": "string", "description": "Required. Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = \"google.cloudsql.instance.PerformanceRecommender\", recommender_subtype can be \"MYSQL_HIGH_NUMBER_OF_OPEN_TABLES_BEST_PRACTICE\"/\"POSTGRES_HIGH_TRANSACTION_ID_UTILIZATION_BEST_PRACTICE\"" }, "additionalMetadata": { "type": "object", "description": "Optional. Any other additional metadata specific to recommendation", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "recommender": { "type": "string", "description": "Required. Name of recommendation. Examples: organizations/1234/locations/us-central1/recommenders/google.cloudsql.instance.PerformanceRecommender/recommendations/9876" } } }, "ManagedCertificateAuthority": { "type": "object", "id": "ManagedCertificateAuthority", "properties": { "caCerts": { "description": "The PEM encoded CA certificate chains for redis managed server authentication", "type": "array", "items": { "$ref": "CertChain" } } } }, "ClusterWeeklyMaintenanceWindow": { "id": "ClusterWeeklyMaintenanceWindow", "description": "Time window specified for weekly operations.", "properties": { "startTime": { "$ref": "TimeOfDay", "description": "Optional. Start time of the window in UTC." }, "day": { "type": "string", "enum": [ "DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ], "description": "Optional. Allows to define schedule that runs specified day of the week.", "enumDescriptions": [ "The day of the week is unspecified.", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ] } }, "type": "object" }, "BackupRun": { "type": "object", "id": "BackupRun", "description": "A backup run.", "properties": { "startTime": { "type": "string", "description": "The time the backup operation started. REQUIRED", "format": "google-datetime" }, "error": { "description": "Information about why the backup operation failed. This is only present if the run has the FAILED status. OPTIONAL", "$ref": "OperationError" }, "endTime": { "description": "The time the backup operation completed. REQUIRED", "format": "google-datetime", "type": "string" }, "status": { "description": "The status of this run. REQUIRED", "enumDescriptions": [ "Unspecified status.", "The backup was successful.", "The backup was unsuccessful." ], "type": "string", "enum": [ "STATUS_UNSPECIFIED", "SUCCESSFUL", "FAILED" ] } } }, "ListOperationsResponse": { "id": "ListOperationsResponse", "description": "The response message for Operations.ListOperations.", "properties": { "operations": { "items": { "$ref": "Operation" }, "description": "A list of operations that matches the specified filter in the request.", "type": "array" }, "unreachable": { "description": "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.", "type": "array", "items": { "type": "string" } }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." } }, "type": "object" }, "GcsSource": { "type": "object", "id": "GcsSource", "description": "The Cloud Storage location for the input content", "properties": { "uri": { "type": "string", "description": "Required. Source data URI. (e.g. 'gs://my_bucket/my_object')." } } }, "ListAclPoliciesResponse": { "type": "object", "id": "ListAclPoliciesResponse", "description": "Response for `ListAclPolicies`.", "properties": { "aclPolicies": { "items": { "$ref": "AclPolicy" }, "type": "array", "description": "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." }, "unreachable": { "description": "Unordered list. Locations that could not be reached.", "type": "array", "items": { "type": "string" } }, "nextPageToken": { "type": "string", "description": "Token to retrieve the next page of results, or empty if there are no more results in the list." } } }, "AddAuthTokenRequest": { "type": "object", "id": "AddAuthTokenRequest", "description": "Request message for AddAuthToken.", "properties": { "authToken": { "description": "Required. The auth token to add.", "$ref": "AuthToken" } } }, "Product": { "id": "Product", "description": "Product specification for Condor resources.", "properties": { "version": { "description": "Version of the underlying database engine. Example values: For MySQL, it could be \"8.0\", \"5.7\" etc.. For Postgres, it could be \"14\", \"15\" etc..", "type": "string" }, "type": { "enumDescriptions": [ "UNSPECIFIED means product type is not known or available.", "Cloud SQL product area in GCP", "Cloud SQL product area in GCP", "AlloyDB product area in GCP", "AlloyDB product area in GCP", "Spanner product area in GCP", "On premises database product.", "On premises database product.", "Memorystore product area in GCP", "Bigtable product area in GCP", "Firestore product area in GCP.", "Compute Engine self managed databases", "Oracle product area in GCP", "BigQuery product area in GCP", "Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum." ], "enumDeprecated": [ false, false, true, false, true, false, false, true, false, false, false, false, false, false, false ], "description": "Type of specific database product. It could be CloudSQL, AlloyDB etc..", "type": "string", "enum": [ "PRODUCT_TYPE_UNSPECIFIED", "PRODUCT_TYPE_CLOUD_SQL", "CLOUD_SQL", "PRODUCT_TYPE_ALLOYDB", "ALLOYDB", "PRODUCT_TYPE_SPANNER", "PRODUCT_TYPE_ON_PREM", "ON_PREM", "PRODUCT_TYPE_MEMORYSTORE", "PRODUCT_TYPE_BIGTABLE", "PRODUCT_TYPE_FIRESTORE", "PRODUCT_TYPE_COMPUTE_ENGINE", "PRODUCT_TYPE_ORACLE_ON_GCP", "PRODUCT_TYPE_BIGQUERY", "PRODUCT_TYPE_OTHER" ] }, "engine": { "enumDescriptions": [ "UNSPECIFIED means engine type is not known or available.", "MySQL binary running as an engine in the database instance.", "MySQL binary running as engine in database instance.", "Postgres binary running as engine in database instance.", "Postgres binary running as engine in database instance.", "SQLServer binary running as engine in database instance.", "SQLServer binary running as engine in database instance.", "Native database binary running as engine in instance.", "Native database binary running as engine in instance.", "Cloud Spanner with PostgreSQL dialect.", "Cloud Spanner with Google SQL dialect.", "Memorystore with Redis dialect.", "Memorystore with Redis cluster dialect.", "Memorystore with Valkey.", "Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum.", "Firestore with native mode.", "Firestore with datastore mode.", "Firestore with MongoDB compatibility mode.", "Oracle Exadata engine.", "Oracle Autonomous DB Serverless engine." ], "enumDeprecated": [ false, false, true, false, true, false, true, false, true, false, false, false, false, false, false, false, false, false, false, false ], "type": "string", "enum": [ "ENGINE_UNSPECIFIED", "ENGINE_MYSQL", "MYSQL", "ENGINE_POSTGRES", "POSTGRES", "ENGINE_SQL_SERVER", "SQL_SERVER", "ENGINE_NATIVE", "NATIVE", "ENGINE_CLOUD_SPANNER_WITH_POSTGRES_DIALECT", "ENGINE_CLOUD_SPANNER_WITH_GOOGLESQL_DIALECT", "ENGINE_MEMORYSTORE_FOR_REDIS", "ENGINE_MEMORYSTORE_FOR_REDIS_CLUSTER", "ENGINE_MEMORYSTORE_FOR_VALKEY", "ENGINE_OTHER", "ENGINE_FIRESTORE_WITH_NATIVE_MODE", "ENGINE_FIRESTORE_WITH_DATASTORE_MODE", "ENGINE_FIRESTORE_WITH_MONGODB_COMPATIBILITY_MODE", "ENGINE_EXADATA_ORACLE", "ENGINE_ADB_SERVERLESS_ORACLE" ], "description": "The specific engine that the underlying database is running." }, "minorVersion": { "description": "Minor version of the underlying database engine. Example values: For MySQL, it could be \"8.0.32\", \"5.7.32\" etc.. For Postgres, it could be \"14.3\", \"15.3\" etc..", "type": "string" } }, "type": "object" }, "ResourceFlags": { "id": "ResourceFlags", "description": "Message type for storing resource flags.", "properties": { "key": { "description": "Optional. Key of the resource flag.", "type": "string" }, "value": { "type": "string", "description": "Optional. Value of the resource flag." } }, "type": "object" }, "OperationError": { "id": "OperationError", "description": "An error that occurred during a backup creation operation.", "properties": { "errorType": { "enumDescriptions": [ "UNSPECIFIED means product type is not known or available.", "key destroyed, expired, not found, unreachable or permission denied.", "Database is not accessible", "The zone or region does not have sufficient resources to handle the request at the moment", "User initiated cancellation", "SQL server specific error", "Any other internal error." ], "type": "string", "enum": [ "OPERATION_ERROR_TYPE_UNSPECIFIED", "KMS_KEY_ERROR", "DATABASE_ERROR", "STOCKOUT_ERROR", "CANCELLATION_ERROR", "SQLSERVER_ERROR", "INTERNAL_ERROR" ] }, "code": { "type": "string", "description": "Identifies the specific error that occurred. REQUIRED" }, "message": { "description": "Additional information about the error encountered. REQUIRED", "type": "string" } }, "type": "object" }, "ExportBackupRequest": { "type": "object", "id": "ExportBackupRequest", "description": "Request for `ExportBackup`.", "properties": { "gcsBucket": { "description": "Google Cloud Storage bucket, like \"my-bucket\".", "type": "string" } } }, "UpgradeInstanceRequest": { "type": "object", "id": "UpgradeInstanceRequest", "description": "Request for UpgradeInstance.", "properties": { "redisVersion": { "description": "Required. Specifies the target version of Redis software to upgrade to.", "type": "string" } } }, "PersistenceConfig": { "type": "object", "id": "PersistenceConfig", "description": "Configuration of the persistence functionality.", "properties": { "persistenceMode": { "description": "Optional. Controls whether Persistence features are enabled. If not provided, the existing value will be used.", "enumDescriptions": [ "Not set.", "Persistence is disabled for the instance, and any existing snapshots are deleted.", "RDB based Persistence is enabled." ], "type": "string", "enum": [ "PERSISTENCE_MODE_UNSPECIFIED", "DISABLED", "RDB" ] }, "rdbSnapshotStartTime": { "type": "string", "description": "Optional. Date and time that the first snapshot was/will be attempted, and to which future snapshots will be aligned. If not provided, the current time will be used.", "format": "google-datetime" }, "rdbSnapshotPeriod": { "description": "Optional. Period between RDB snapshots. Snapshots will be attempted every period starting from the provided snapshot start time. For example, a start time of 01/01/2033 06:45 and SIX_HOURS snapshot period will do nothing until 01/01/2033, and then trigger snapshots every day at 06:45, 12:45, 18:45, and 00:45 the next day, and so on. If not provided, TWENTY_FOUR_HOURS will be used as default.", "enumDescriptions": [ "Not set.", "Snapshot every 1 hour.", "Snapshot every 6 hours.", "Snapshot every 12 hours.", "Snapshot every 24 hours." ], "type": "string", "enum": [ "SNAPSHOT_PERIOD_UNSPECIFIED", "ONE_HOUR", "SIX_HOURS", "TWELVE_HOURS", "TWENTY_FOUR_HOURS" ] }, "rdbNextSnapshotTime": { "readOnly": true, "type": "string", "description": "Output only. The next time that a snapshot attempt is scheduled to occur.", "format": "google-datetime" } } }, "ConnectionDetail": { "type": "object", "id": "ConnectionDetail", "description": "Detailed information of each PSC connection.", "properties": { "pscAutoConnection": { "description": "Detailed information of a PSC connection that is created through service connectivity automation.", "$ref": "PscAutoConnection" }, "pscConnection": { "description": "Detailed information of a PSC connection that is created by the customer who owns the cluster.", "$ref": "PscConnection" } } }, "GoogleCloudCommonOperationMetadata": { "id": "GoogleCloudCommonOperationMetadata", "description": "Represents the metadata of the long-running operation.", "properties": { "target": { "description": "Output only. Server-defined resource path for the target of the operation.", "type": "string", "readOnly": true }, "cancelRequested": { "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "type": "boolean", "readOnly": true }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. The time the operation was created.", "format": "google-datetime" }, "verb": { "readOnly": true, "description": "Output only. Name of the verb executed by the operation.", "type": "string" }, "statusDetail": { "type": "string", "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true }, "apiVersion": { "readOnly": true, "type": "string", "description": "Output only. API version used to start the operation." }, "endTime": { "readOnly": true, "type": "string", "description": "Output only. The time the operation finished running.", "format": "google-datetime" } }, "type": "object" }, "ResourceMaintenanceDenySchedule": { "id": "ResourceMaintenanceDenySchedule", "description": "Deny maintenance period for the database resource. It specifies the time range during which the maintenance cannot start. This is configured by the customer.", "properties": { "endDate": { "description": "Optional. Deny period end date.", "$ref": "Date" }, "startDate": { "description": "Optional. The start date of the deny maintenance period.", "$ref": "Date" }, "time": { "$ref": "TimeOfDay", "description": "Optional. Time in UTC when the deny period starts on start_date and ends on end_date." } }, "type": "object" }, "SignalMetadata": { "type": "object", "id": "SignalMetadata", "description": "SignalMetadata contains one of the signal metadata proto messages associated with a SignalType. This proto will be mapped to SignalMetadata message in storage.proto. Next ID: 3", "properties": { "signalBoolValue": { "description": "Signal data for boolean signals.", "type": "boolean" }, "backupRun": { "description": "Signal data for backup runs.", "$ref": "BackupRun" } } }, "DatabaseResourceHealthSignalData": { "id": "DatabaseResourceHealthSignalData", "description": "Common model for database resource health signal data.", "properties": { "signalId": { "type": "string", "description": "Required. Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal." }, "compliance": { "description": "Industry standards associated with this signal; if this signal is an issue, that could be a violation of the associated industry standard(s). For example, AUTO_BACKUP_DISABLED signal is associated with CIS GCP 1.1, CIS GCP 1.2, CIS GCP 1.3, NIST 800-53 and ISO-27001 compliance standards. If a database resource does not have automated backup enable, it will violate these following industry standards.", "type": "array", "items": { "$ref": "Compliance" } }, "resourceContainer": { "description": "Closest parent container of this resource. In GCP, 'container' refers to a Cloud Resource Manager project. It must be resource name of a Cloud Resource Manager project with the format of \"provider//\", such as \"projects/123\". For GCP provided resources, number should be project number.", "type": "string" }, "signalSeverity": { "type": "string", "enum": [ "SIGNAL_SEVERITY_UNSPECIFIED", "CRITICAL", "HIGH", "MEDIUM", "LOW" ], "description": "The severity of the signal, such as if it's a HIGH or LOW severity.", "enumDescriptions": [ "This value is used for findings when a source doesn't write a severity value.", "A critical vulnerability is easily discoverable by an external actor, exploitable.", "A high risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities.", "A medium risk vulnerability could be used by an actor to gain access to resources or privileges that enable them to eventually gain access and the ability to execute arbitrary code or exfiltrate data.", "A low risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment." ] }, "resourceName": { "type": "string", "description": "Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel" }, "provider": { "description": "Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged", "enumDescriptions": [ "Unspecified provider.", "Google cloud platform provider", "Amazon web service", "Azure web service", "On-prem database resources.", "Self-managed database provider. These are resources on a cloud platform, e.g., database resource installed in a GCE VM, but not a managed database service.", "For the rest of the other categories. Other refers to the rest of other database service providers, this could be smaller cloud provider. This needs to be provided when the provider is known, but it is not present in the existing set of enum values." ], "type": "string", "enum": [ "PROVIDER_UNSPECIFIED", "GCP", "AWS", "AZURE", "ONPREM", "SELFMANAGED", "PROVIDER_OTHER" ] }, "description": { "description": "Description associated with signal", "type": "string" }, "additionalMetadata": { "type": "object", "description": "Any other additional metadata", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "signalClass": { "type": "string", "enum": [ "CLASS_UNSPECIFIED", "THREAT", "VULNERABILITY", "MISCONFIGURATION", "OBSERVATION", "ERROR" ], "description": "Required. The class of the signal, such as if it's a THREAT or VULNERABILITY.", "enumDescriptions": [ "Unspecified signal class.", "Describes unwanted or malicious activity.", "Describes a potential weakness in software that increases risk to Confidentiality & Integrity & Availability.", "Describes a potential weakness in cloud resource/asset configuration that increases risk.", "Describes a security observation that is for informational purposes.", "Describes an error that prevents some SCC functionality." ] }, "location": { "type": "string", "description": "This is used to identify the location of the resource. Example: \"us-central1\"" }, "eventTime": { "description": "Required. The last time at which the event described by this signal took place", "format": "google-datetime", "type": "string" }, "state": { "description": "Required. The state of the signal, such as if it's ACTIVE or RESOLVED.", "enumDescriptions": [ "Unspecified state.", "The signal requires attention and has not been addressed yet.", "The signal has been fixed, triaged as a non-issue or otherwise addressed and is no longer active.", "The signal has been muted." ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "RESOLVED", "MUTED" ] }, "externalUri": { "type": "string", "description": "The external-uri of the signal, using which more information about this signal can be obtained. In GCP, this will take user to SCC page to get more details about signals." }, "signalType": { "description": "Required. Type of signal, for example, `AVAILABLE_IN_MULTIPLE_ZONES`, `LOGGING_MOST_ERRORS`, etc.", "type": "string", "enum": [ "SIGNAL_TYPE_UNSPECIFIED", "SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER", "SIGNAL_TYPE_GROUP_NOT_REPLICATING_ACROSS_REGIONS", "SIGNAL_TYPE_NOT_AVAILABLE_IN_MULTIPLE_ZONES", "SIGNAL_TYPE_NOT_AVAILABLE_IN_MULTIPLE_REGIONS", "SIGNAL_TYPE_NO_PROMOTABLE_REPLICA", "SIGNAL_TYPE_NO_AUTOMATED_BACKUP_POLICY", "SIGNAL_TYPE_SHORT_BACKUP_RETENTION", "SIGNAL_TYPE_LAST_BACKUP_FAILED", "SIGNAL_TYPE_LAST_BACKUP_OLD", "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_2_0", "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_3", "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_2", "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_1", "SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_0", "SIGNAL_TYPE_VIOLATES_CIS_CONTROLS_V8_0", "SIGNAL_TYPE_VIOLATES_NIST_800_53", "SIGNAL_TYPE_VIOLATES_NIST_800_53_R5", "SIGNAL_TYPE_VIOLATES_NIST_CYBERSECURITY_FRAMEWORK_V1_0", "SIGNAL_TYPE_VIOLATES_ISO_27001", "SIGNAL_TYPE_VIOLATES_ISO_27001_V2022", "SIGNAL_TYPE_VIOLATES_PCI_DSS_V3_2_1", "SIGNAL_TYPE_VIOLATES_PCI_DSS_V4_0", "SIGNAL_TYPE_VIOLATES_CLOUD_CONTROLS_MATRIX_V4", "SIGNAL_TYPE_VIOLATES_HIPAA", "SIGNAL_TYPE_VIOLATES_SOC2_V2017", "SIGNAL_TYPE_LOGS_NOT_OPTIMIZED_FOR_TROUBLESHOOTING", "SIGNAL_TYPE_QUERY_DURATIONS_NOT_LOGGED", "SIGNAL_TYPE_VERBOSE_ERROR_LOGGING", "SIGNAL_TYPE_QUERY_LOCK_WAITS_NOT_LOGGED", "SIGNAL_TYPE_LOGGING_MOST_ERRORS", "SIGNAL_TYPE_LOGGING_ONLY_CRITICAL_ERRORS", "SIGNAL_TYPE_MINIMAL_ERROR_LOGGING", "SIGNAL_TYPE_QUERY_STATISTICS_LOGGED", "SIGNAL_TYPE_EXCESSIVE_LOGGING_OF_CLIENT_HOSTNAME", "SIGNAL_TYPE_EXCESSIVE_LOGGING_OF_PARSER_STATISTICS", "SIGNAL_TYPE_EXCESSIVE_LOGGING_OF_PLANNER_STATISTICS", "SIGNAL_TYPE_NOT_LOGGING_ONLY_DDL_STATEMENTS", "SIGNAL_TYPE_LOGGING_QUERY_STATISTICS", "SIGNAL_TYPE_NOT_LOGGING_TEMPORARY_FILES", "SIGNAL_TYPE_CONNECTION_MAX_NOT_CONFIGURED", "SIGNAL_TYPE_USER_OPTIONS_CONFIGURED", "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", "SIGNAL_TYPE_NO_ROOT_PASSWORD", "SIGNAL_TYPE_WEAK_ROOT_PASSWORD", "SIGNAL_TYPE_ENCRYPTION_KEY_NOT_CUSTOMER_MANAGED", "SIGNAL_TYPE_SERVER_AUTHENTICATION_NOT_REQUIRED", "SIGNAL_TYPE_EXPOSED_BY_OWNERSHIP_CHAINING", "SIGNAL_TYPE_EXPOSED_TO_EXTERNAL_SCRIPTS", "SIGNAL_TYPE_EXPOSED_TO_LOCAL_DATA_LOADS", "SIGNAL_TYPE_CONNECTION_ATTEMPTS_NOT_LOGGED", "SIGNAL_TYPE_DISCONNECTIONS_NOT_LOGGED", "SIGNAL_TYPE_LOGGING_EXCESSIVE_STATEMENT_INFO", "SIGNAL_TYPE_EXPOSED_TO_REMOTE_ACCESS", "SIGNAL_TYPE_DATABASE_NAMES_EXPOSED", "SIGNAL_TYPE_SENSITIVE_TRACE_INFO_NOT_MASKED", "SIGNAL_TYPE_PUBLIC_IP_ENABLED", "SIGNAL_TYPE_IDLE", "SIGNAL_TYPE_OVERPROVISIONED", "SIGNAL_TYPE_HIGH_NUMBER_OF_OPEN_TABLES", "SIGNAL_TYPE_HIGH_NUMBER_OF_TABLES", "SIGNAL_TYPE_HIGH_TRANSACTION_ID_UTILIZATION", "SIGNAL_TYPE_UNDERPROVISIONED", "SIGNAL_TYPE_OUT_OF_DISK", "SIGNAL_TYPE_SERVER_CERTIFICATE_NEAR_EXPIRY", "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", "SIGNAL_TYPE_RESTRICT_AUTHORIZED_NETWORKS", "SIGNAL_TYPE_VIOLATE_POLICY_RESTRICT_PUBLIC_IP", "SIGNAL_TYPE_QUOTA_LIMIT", "SIGNAL_TYPE_NO_PASSWORD_POLICY", "SIGNAL_TYPE_CONNECTIONS_PERFORMANCE_IMPACT", "SIGNAL_TYPE_TMP_TABLES_PERFORMANCE_IMPACT", "SIGNAL_TYPE_TRANS_LOGS_PERFORMANCE_IMPACT", "SIGNAL_TYPE_HIGH_JOINS_WITHOUT_INDEXES", "SIGNAL_TYPE_SUPERUSER_WRITING_TO_USER_TABLES", "SIGNAL_TYPE_USER_GRANTED_ALL_PERMISSIONS", "SIGNAL_TYPE_DATA_EXPORT_TO_EXTERNAL_CLOUD_STORAGE_BUCKET", "SIGNAL_TYPE_DATA_EXPORT_TO_PUBLIC_CLOUD_STORAGE_BUCKET", "SIGNAL_TYPE_WEAK_PASSWORD_HASH_ALGORITHM", "SIGNAL_TYPE_NO_USER_PASSWORD_POLICY", "SIGNAL_TYPE_HOT_NODE", "SIGNAL_TYPE_NO_POINT_IN_TIME_RECOVERY", "SIGNAL_TYPE_RESOURCE_SUSPENDED", "SIGNAL_TYPE_EXPENSIVE_COMMANDS", "SIGNAL_TYPE_NO_MAINTENANCE_POLICY_CONFIGURED", "SIGNAL_TYPE_NO_DELETION_PROTECTION", "SIGNAL_TYPE_INEFFICIENT_QUERY", "SIGNAL_TYPE_READ_INTENSIVE_WORKLOAD", "SIGNAL_TYPE_MEMORY_LIMIT", "SIGNAL_TYPE_MAX_SERVER_MEMORY", "SIGNAL_TYPE_LARGE_ROWS", "SIGNAL_TYPE_HIGH_WRITE_PRESSURE", "SIGNAL_TYPE_HIGH_READ_PRESSURE", "SIGNAL_TYPE_ENCRYPTION_ORG_POLICY_NOT_SATISFIED", "SIGNAL_TYPE_LOCATION_ORG_POLICY_NOT_SATISFIED", "SIGNAL_TYPE_OUTDATED_MINOR_VERSION", "SIGNAL_TYPE_SCHEMA_NOT_OPTIMIZED", "SIGNAL_TYPE_MANY_IDLE_CONNECTIONS", "SIGNAL_TYPE_REPLICATION_LAG", "SIGNAL_TYPE_OUTDATED_VERSION", "SIGNAL_TYPE_OUTDATED_CLIENT", "SIGNAL_TYPE_DATABOOST_DISABLED", "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", "SIGNAL_TYPE_EXTENDED_SUPPORT", "SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE", "SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE", "SIGNAL_TYPE_HIGH_MAINTENANCE_DOWNTIME_RISK", "SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME", "SIGNAL_TYPE_MISSING_ENHANCED_PROTECTION" ], "enumDeprecated": [ false, false, false, true, true, true, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, true, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, true, false, false, false, false, false, false, false, false, false, false, false ], "enumDescriptions": [ "Unspecified.", "Represents if a resource is protected by automatic failover. Checks for resources that are configured to have redundancy within a region that enables automatic failover.", "Represents if a group is replicating across regions. Checks for resources that are configured to have redundancy, and ongoing replication, across regions.", "Represents if the resource is available in multiple zones or not.", "Represents if a resource is available in multiple regions.", "Represents if a resource has a promotable replica.", "Represents if a resource has an automated backup policy.", "Represents if a resources has a short backup retention period.", "Represents if the last backup of a resource failed.", "Represents if the last backup of a resource is older than some threshold value.", "Represents if a resource violates CIS GCP Foundation 2.0.", "Represents if a resource violates CIS GCP Foundation 1.3.", "Represents if a resource violates CIS GCP Foundation 1.2.", "Represents if a resource violates CIS GCP Foundation 1.1.", "Represents if a resource violates CIS GCP Foundation 1.0.", "Represents if a resource violates CIS Controls 8.0.", "Represents if a resource violates NIST 800-53.", "Represents if a resource violates NIST 800-53 R5.", "Represents if a resource violates NIST Cybersecurity Framework 1.0.", "Represents if a resource violates ISO-27001.", "Represents if a resource violates ISO 27001 2022.", "Represents if a resource violates PCI-DSS v3.2.1.", "Represents if a resource violates PCI-DSS v4.0.", "Represents if a resource violates Cloud Controls Matrix v4.0.", "Represents if a resource violates HIPAA.", "Represents if a resource violates SOC2 v2017.", "Represents if log_checkpoints database flag for a Cloud SQL for PostgreSQL instance is not set to on.", "Represents if the log_duration database flag for a Cloud SQL for PostgreSQL instance is not set to on.", "Represents if the log_error_verbosity database flag for a Cloud SQL for PostgreSQL instance is not set to default or stricter (default or terse).", "Represents if the log_lock_waits database flag for a Cloud SQL for PostgreSQL instance is not set to on.", "Represents if the log_min_error_statement database flag for a Cloud SQL for PostgreSQL instance is not set appropriately.", "Represents if the log_min_error_statement database flag for a Cloud SQL for PostgreSQL instance does not have an appropriate severity level.", "Represents if the log_min_messages database flag for a Cloud SQL for PostgreSQL instance is not set to warning or another recommended value.", "Represents if the databaseFlags property of instance metadata for the log_executor_status field is set to on.", "Represents if the log_hostname database flag for a Cloud SQL for PostgreSQL instance is not set to off.", "Represents if the log_parser_stats database flag for a Cloud SQL for PostgreSQL instance is not set to off.", "Represents if the log_planner_stats database flag for a Cloud SQL for PostgreSQL instance is not set to off.", "Represents if the log_statement database flag for a Cloud SQL for PostgreSQL instance is not set to DDL (all data definition statements).", "Represents if the log_statement_stats database flag for a Cloud SQL for PostgreSQL instance is not set to off.", "Represents if the log_temp_files database flag for a Cloud SQL for PostgreSQL instance is not set to \"0\". (NOTE: 0 = ON)", "Represents if the user connections database flag for a Cloud SQL for SQL Server instance is configured.", "Represents if the user options database flag for Cloud SQL SQL Server instance is configured or not.", "Represents if a resource is exposed to public access.", "Represents if a resources requires all incoming connections to use SSL or not.", "Represents if a Cloud SQL database has a password configured for the root account or not.", "Represents if a Cloud SQL database has a weak password configured for the root account.", "Represents if a SQL database instance is not encrypted with customer-managed encryption keys (CMEK).", "Represents if The contained database authentication database flag for a Cloud SQL for SQL Server instance is not set to off.", "Represents if the cross_db_ownership_chaining database flag for a Cloud SQL for SQL Server instance is not set to off.", "Represents if he external scripts enabled database flag for a Cloud SQL for SQL Server instance is not set to off.", "Represents if the local_infile database flag for a Cloud SQL for MySQL instance is not set to off.", "Represents if the log_connections database flag for a Cloud SQL for PostgreSQL instance is not set to on.", "Represents if the log_disconnections database flag for a Cloud SQL for PostgreSQL instance is not set to on.", "Represents if the log_min_duration_statement database flag for a Cloud SQL for PostgreSQL instance is not set to -1.", "Represents if the remote access database flag for a Cloud SQL for SQL Server instance is not set to off.", "Represents if the skip_show_database database flag for a Cloud SQL for MySQL instance is not set to on.", "Represents if the 3625 (trace flag) database flag for a Cloud SQL for SQL Server instance is not set to on.", "Represents if public IP is enabled.", "Represents Idle instance helps to reduce costs.", "Represents instances that are unnecessarily large for given workload.", "Represents high number of concurrently opened tables.", "Represents high table count close to SLA limit.", "Represents high number of unvacuumed transactions", "Represents need for more CPU and/or memory", "Represents out of disk.", "Represents server certificate is near expiry.", "Represents database auditing is disabled.", "Represents not restricted to authorized networks.", "Represents violate org policy restrict public ip.", "Cluster nearing quota limit", "No password policy set on resources", "Performance impact of connections settings", "Performance impact of temporary tables settings", "Performance impact of transaction logs settings", "Performance impact of high joins without indexes", "Detects events where a Cloud SQL superuser (postgres for PostgreSQL servers or root for MySQL users) writes to non-system tables.", "Detects events where a database user or role has been granted all privileges to a database, or to all tables, procedures, or functions in a schema.", "Detects if database instance data exported to a Cloud Storage bucket outside of the organization.", "Detects if database instance data exported to a Cloud Storage bucket that is owned by the organization and is publicly accessible.", "Detects if a database instance is using a weak password hash algorithm.", "Detects if a database instance has no user password policy set.", "Detects if a database instance/cluster has a hot node.", "Detects if a database instance has no point in time recovery enabled.", "Detects if a database instance/cluster is suspended.", "Detects that expensive commands are being run on a database instance impacting overall performance.", "Indicates that the instance does not have a maintenance policy configured.", "Deletion Protection Disabled for the resource", "Indicates that the instance has inefficient queries detected.", "Indicates that the instance has read intensive workload.", "Indicates that the instance is nearing memory limit.", "Indicates that the instance's max server memory is configured higher than the recommended value.", "Indicates that the database has large rows beyond the recommended limit.", "Heavy write pressure on the database rows.", "Heavy read pressure on the database rows.", "Encryption org policy not satisfied.", "Location org policy not satisfied.", "Outdated DB minor version.", "Schema not optimized.", "High number of idle connections.", "Replication delay.", "Outdated version.", "Outdated client.", "Databoost is disabled.", "Recommended maintenance policy.", "Resource version is in extended support.", "Change in performance KPIs.", "Database version nearing end of life.", "Indicates a high risk of maintenance downtime.", "Indicates both a low cache hit rate and a risk of maintenance downtime.", "Indicates that the resource is missing enhanced protection." ] }, "name": { "type": "string", "description": "Required. The name of the signal, ex: PUBLIC_SQL_INSTANCE, SQL_LOG_ERROR_VERBOSITY etc." } }, "type": "object" }, "Membership": { "id": "Membership", "description": "An output only view of all the member clusters participating in the cross cluster replication.", "properties": { "primaryCluster": { "$ref": "RemoteCluster", "description": "Output only. The primary cluster that acts as the source of replication for the secondary clusters.", "readOnly": true }, "secondaryClusters": { "description": "Output only. The list of secondary clusters replicating from the primary cluster.", "type": "array", "readOnly": true, "items": { "$ref": "RemoteCluster" } } }, "type": "object" }, "PscAutoConnection": { "id": "PscAutoConnection", "description": "Details of consumer resources in a PSC connection that is created through Service Connectivity Automation.", "properties": { "address": { "readOnly": true, "type": "string", "description": "Output only. The IP allocated on the consumer network for the PSC forwarding rule." }, "serviceAttachment": { "readOnly": true, "description": "Output only. The service attachment which is the target of the PSC connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}.", "type": "string" }, "projectId": { "description": "Required. The consumer project_id where the forwarding rule is created from.", "type": "string" }, "network": { "type": "string", "description": "Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}." }, "connectionType": { "description": "Output only. Type of the PSC connection.", "type": "string", "enum": [ "CONNECTION_TYPE_UNSPECIFIED", "CONNECTION_TYPE_DISCOVERY", "CONNECTION_TYPE_PRIMARY", "CONNECTION_TYPE_READER" ], "readOnly": true, "enumDescriptions": [ "Cluster endpoint Type is not set", "Cluster endpoint that will be used as for cluster topology discovery.", "Cluster endpoint that will be used as primary endpoint to access primary.", "Cluster endpoint that will be used as reader endpoint to access replicas." ] }, "forwardingRule": { "readOnly": true, "type": "string", "description": "Output only. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}." }, "pscConnectionId": { "readOnly": true, "type": "string", "description": "Output only. The PSC connection id of the forwarding rule connected to the service attachment." }, "pscConnectionStatus": { "readOnly": true, "enumDescriptions": [ "PSC connection status is not specified.", "The connection is active", "Connection not found" ], "type": "string", "enum": [ "PSC_CONNECTION_STATUS_UNSPECIFIED", "PSC_CONNECTION_STATUS_ACTIVE", "PSC_CONNECTION_STATUS_NOT_FOUND" ], "description": "Output only. The status of the PSC connection. Please note that this value is updated periodically. Please use Private Service Connect APIs for the latest status." } }, "type": "object" }, "MaintenancePolicy": { "id": "MaintenancePolicy", "description": "Maintenance policy for an instance.", "properties": { "createTime": { "description": "Output only. The time when the policy was created.", "format": "google-datetime", "type": "string", "readOnly": true }, "updateTime": { "readOnly": true, "type": "string", "description": "Output only. The time when the policy was last updated.", "format": "google-datetime" }, "description": { "description": "Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.", "type": "string" }, "weeklyMaintenanceWindow": { "type": "array", "description": "Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_window is expected to be one.", "items": { "$ref": "WeeklyMaintenanceWindow" } } }, "type": "object" }, "ListBackupCollectionsResponse": { "id": "ListBackupCollectionsResponse", "description": "Response for `ListBackupCollections`.", "properties": { "nextPageToken": { "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" }, "backupCollections": { "items": { "$ref": "BackupCollection" }, "description": "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\".", "type": "array" }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" } }, "type": "object" }, "Instance": { "id": "Instance", "description": "A Memorystore for Redis instance. next id = 47", "properties": { "alternativeLocationId": { "type": "string", "description": "Optional. If specified, at least one node will be provisioned in this zone in addition to the zone specified in location_id. Only applicable to standard tier. If provided, it must be a different zone from the one provided in [location_id]. Additional nodes beyond the first 2 will be placed in zones selected by the service." }, "redisVersion": { "description": "Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * `REDIS_3_2` for Redis 3.2 compatibility * `REDIS_4_0` for Redis 4.0 compatibility (default) * `REDIS_5_0` for Redis 5.0 compatibility * `REDIS_6_X` for Redis 6.x compatibility * `REDIS_7_0` for Redis 7.0 compatibility", "type": "string" }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. The time the instance was created.", "format": "google-datetime" }, "host": { "readOnly": true, "type": "string", "description": "Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service." }, "maintenanceSchedule": { "readOnly": true, "description": "Output only. Date and time of upcoming maintenance events which have been scheduled.", "$ref": "MaintenanceSchedule" }, "suspensionReasons": { "description": "Optional. reasons that causes instance in \"SUSPENDED\" state.", "type": "array", "items": { "type": "string", "enum": [ "SUSPENSION_REASON_UNSPECIFIED", "CUSTOMER_MANAGED_KEY_ISSUE" ], "enumDescriptions": [ "Not set.", "Something wrong with the CMEK key provided by customer." ] } }, "statusMessage": { "type": "string", "description": "Output only. Additional information about the current status of this instance, if available.", "readOnly": true }, "readEndpoint": { "readOnly": true, "description": "Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'.", "type": "string" }, "authEnabled": { "description": "Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to \"true\" AUTH is enabled on the instance. Default value is \"false\" meaning AUTH is disabled.", "type": "boolean" }, "satisfiesPzi": { "readOnly": true, "type": "boolean", "description": "Optional. Output only. Reserved for future use." }, "displayName": { "type": "string", "description": "An arbitrary and optional user-provided name for the instance." }, "customerManagedKey": { "type": "string", "description": "Optional. The KMS key reference that the customer provides when trying to create the instance." }, "locationId": { "description": "Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone from the specified region for the instance. For standard tier, additional nodes will be added across multiple zones for protection against zonal failures. If specified, at least one node will be provisioned in this zone.", "type": "string" }, "labels": { "description": "Resource labels to represent user provided metadata", "additionalProperties": { "type": "string" }, "type": "object" }, "memorySizeGb": { "type": "integer", "description": "Required. Redis memory size in GiB.", "format": "int32" }, "availableMaintenanceVersions": { "items": { "type": "string" }, "description": "Optional. The available maintenance versions that an instance could update to.", "type": "array" }, "reservedIpRange": { "description": "Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses that are reserved for this instance. Range must be unique and non-overlapping with existing subnets in an authorized network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP address ranges associated with this private service access connection. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED the default block size is /28.", "type": "string" }, "persistenceConfig": { "description": "Optional. Persistence configuration parameters", "$ref": "PersistenceConfig" }, "currentLocationId": { "readOnly": true, "type": "string", "description": "Output only. The current zone where the Redis primary node is located. In basic tier, this will always be the same as [location_id]. In standard tier, this can be the zone of any node in the instance." }, "persistenceIamIdentity": { "readOnly": true, "description": "Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is \"serviceAccount:\". The value may change over time for a given instance so should be checked before each import/export operation.", "type": "string" }, "maintenancePolicy": { "description": "Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.", "$ref": "MaintenancePolicy" }, "replicaCount": { "description": "Optional. The number of replica nodes. The valid range for the Standard Tier with read replicas enabled is [1-5] and defaults to 2. If read replicas are not enabled for a Standard Tier instance, the only valid value is 1 and the default is 1. The valid value for basic tier is 0 and the default is also 0.", "format": "int32", "type": "integer" }, "name": { "type": "string", "description": "Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details." }, "state": { "description": "Output only. The current state of this instance.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATING", "READY", "UPDATING", "DELETING", "REPAIRING", "PERFORMING_MAINTENANCE", "IMPORTING", "FAILING_OVER" ], "readOnly": true, "enumDescriptions": [ "Not set.", "Redis instance is being created.", "Redis instance has been created and is fully usable.", "Redis instance configuration is being updated. Certain kinds of updates may cause the instance to become unusable while the update is in progress.", "Redis instance is being deleted.", "Redis instance is being repaired and may be unusable.", "Maintenance is being performed on this Redis instance.", "Redis instance is importing data (availability may be affected).", "Redis instance is failing over (availability may be affected)." ] }, "redisConfigs": { "description": "Optional. Redis configuration parameters, according to [Redis configuration](https://redis.io/docs/latest/operate/oss_and_stack/management/config/). Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries", "additionalProperties": { "type": "string" }, "type": "object" }, "nodes": { "readOnly": true, "items": { "$ref": "NodeInfo" }, "description": "Output only. Info per node.", "type": "array" }, "port": { "readOnly": true, "description": "Output only. The port number of the exposed Redis endpoint.", "format": "int32", "type": "integer" }, "authorizedNetwork": { "type": "string", "description": "Optional. The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used." }, "serverCaCerts": { "readOnly": true, "items": { "$ref": "TlsCertificate" }, "description": "Output only. List of server CA certificates for the instance.", "type": "array" }, "maintenanceVersion": { "type": "string", "description": "Optional. The self service update maintenance version. The version is date based such as \"20210712_00_00\"." }, "connectMode": { "description": "Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.", "enumDescriptions": [ "Not set.", "Connect via direct peering to the Memorystore for Redis hosted service.", "Connect your Memorystore for Redis instance using Private Service Access. Private services access provides an IP address range for multiple Google Cloud services, including Memorystore." ], "type": "string", "enum": [ "CONNECT_MODE_UNSPECIFIED", "DIRECT_PEERING", "PRIVATE_SERVICE_ACCESS" ] }, "readEndpointPort": { "readOnly": true, "description": "Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'.", "format": "int32", "type": "integer" }, "satisfiesPzs": { "readOnly": true, "description": "Optional. Output only. Reserved for future use.", "type": "boolean" }, "secondaryIpRange": { "type": "string", "description": "Optional. Additional IP range for node placement. Required when enabling read replicas on an existing instance. For DIRECT_PEERING mode value must be a CIDR range of size /28, or \"auto\". For PRIVATE_SERVICE_ACCESS mode value must be the name of an allocated address range associated with the private service access connection, or \"auto\"." }, "tags": { "type": "object", "description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", "additionalProperties": { "type": "string" } }, "tier": { "description": "Required. The service tier of the instance.", "enumDescriptions": [ "Not set.", "BASIC tier: standalone instance", "STANDARD_HA tier: highly available primary/replica instances" ], "type": "string", "enum": [ "TIER_UNSPECIFIED", "BASIC", "STANDARD_HA" ] }, "readReplicasMode": { "description": "Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.", "enumDescriptions": [ "If not set, Memorystore Redis backend will default to READ_REPLICAS_DISABLED.", "If disabled, read endpoint will not be provided and the instance cannot scale up or down the number of replicas.", "If enabled, read endpoint will be provided and the instance can scale up and down the number of replicas. Not valid for basic tier." ], "type": "string", "enum": [ "READ_REPLICAS_MODE_UNSPECIFIED", "READ_REPLICAS_DISABLED", "READ_REPLICAS_ENABLED" ] }, "transitEncryptionMode": { "type": "string", "enum": [ "TRANSIT_ENCRYPTION_MODE_UNSPECIFIED", "SERVER_AUTHENTICATION", "DISABLED" ], "description": "Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.", "enumDescriptions": [ "Not set.", "Client to Server traffic encryption enabled with server authentication.", "TLS is disabled for the instance." ] } }, "type": "object" }, "NodeInfo": { "id": "NodeInfo", "description": "Node specific properties.", "properties": { "id": { "readOnly": true, "type": "string", "description": "Output only. Node identifying string. e.g. 'node-0', 'node-1'" }, "zone": { "readOnly": true, "type": "string", "description": "Output only. Location of the node." } }, "type": "object" }, "FixedFrequencySchedule": { "id": "FixedFrequencySchedule", "description": "This schedule allows the backup to be triggered at a fixed frequency (currently only daily is supported).", "properties": { "startTime": { "$ref": "TimeOfDay", "description": "Required. The start time of every automated backup in UTC. It must be set to the start of an hour. This field is required." } }, "type": "object" }, "DatabaseResourceMetadata": { "type": "object", "id": "DatabaseResourceMetadata", "description": "Common model for database resource instance metadata. Next ID: 35", "properties": { "additionalMetadata": { "description": "Field to ingest additional metadata whichd does not support proto format.", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "creationTime": { "type": "string", "description": "The creation time of the resource, i.e. the time when resource is created and recorded in partner service.", "format": "google-datetime" }, "isDeletionProtectionEnabled": { "description": "Optional. Whether deletion protection is enabled for this resource.", "type": "boolean" }, "resourceFlags": { "items": { "$ref": "ResourceFlags" }, "type": "array", "description": "Optional. List of resource flags for the database resource." }, "internalAdditionalMetadata": { "description": "Field to ingest additional metadata which support proto format.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" }, "gcbdrConfiguration": { "deprecated": true, "description": "GCBDR configuration for the resource.", "$ref": "GCBDRConfiguration" }, "entitlements": { "items": { "$ref": "Entitlement" }, "description": "Entitlements associated with the resource", "type": "array" }, "currentState": { "description": "Current state of the instance.", "enumDescriptions": [ "", "The instance is running.", "Instance being created, updated, deleted or under maintenance", "When instance is suspended", "Instance is deleted.", "For rest of the other category", "Instance is in STOPPED state." ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "HEALTHY", "UNHEALTHY", "SUSPENDED", "DELETED", "STATE_OTHER", "STOPPED" ] }, "tagsSet": { "description": "Optional. Tags associated with this resources.", "$ref": "Tags" }, "suspensionReason": { "description": "Optional. Suspension reason for the resource.", "enumDescriptions": [ "Suspension reason is unspecified.", "Wipeout hide event.", "Wipeout purge event.", "Billing disabled for project", "Abuse detected for resource", "Encryption key inaccessible.", "Replicated cluster encryption key inaccessible." ], "type": "string", "enum": [ "SUSPENSION_REASON_UNSPECIFIED", "WIPEOUT_HIDE_EVENT", "WIPEOUT_PURGE_EVENT", "BILLING_DISABLED", "ABUSER_DETECTED", "ENCRYPTION_KEY_INACCESSIBLE", "REPLICATED_CLUSTER_ENCRYPTION_KEY_INACCESSIBLE" ] }, "instanceType": { "type": "string", "enum": [ "INSTANCE_TYPE_UNSPECIFIED", "SUB_RESOURCE_TYPE_UNSPECIFIED", "PRIMARY", "SECONDARY", "READ_REPLICA", "OTHER", "SUB_RESOURCE_TYPE_PRIMARY", "SUB_RESOURCE_TYPE_SECONDARY", "SUB_RESOURCE_TYPE_READ_REPLICA", "SUB_RESOURCE_TYPE_EXTERNAL_PRIMARY", "SUB_RESOURCE_TYPE_READ_POOL", "SUB_RESOURCE_TYPE_RESERVATION", "SUB_RESOURCE_TYPE_DATASET", "SUB_RESOURCE_TYPE_OTHER" ], "description": "The type of the instance. Specified at creation time.", "enumDeprecated": [ true, false, true, true, true, true, false, false, false, false, false, false, false, false ], "enumDescriptions": [ "Unspecified.", "For rest of the other categories.", "A regular primary database instance.", "A cluster or an instance acting as a secondary.", "An instance acting as a read-replica.", "For rest of the other categories.", "A regular primary database instance.", "A cluster or an instance acting as a secondary.", "An instance acting as a read-replica.", "An instance acting as an external primary.", "An instance acting as Read Pool.", "Represents a reservation resource.", "Represents a dataset resource.", "For rest of the other categories." ] }, "maintenanceInfo": { "description": "Optional. Maintenance info for the resource.", "$ref": "ResourceMaintenanceInfo" }, "ipAddress": { "description": "Optional. Private and public IP address of the resource.", "$ref": "IpAddress" }, "zone": { "description": "The resource zone. This is only applicable for zonal resources and will be empty for regional and multi-regional resources.", "type": "string" }, "updationTime": { "type": "string", "description": "The time at which the resource was updated and recorded at partner service.", "format": "google-datetime" }, "modes": { "items": { "enumDescriptions": [ "Default mode.", "Native mode.", "MongoDB compatible mode.", "Datastore mode.", "Memorystore/ValKey: Cluster enabled mode.", "Memorystore/ValKey: Cluster disabled mode." ], "type": "string", "enum": [ "MODE_UNSPECIFIED", "MODE_NATIVE", "MODE_MONGODB_COMPATIBLE", "MODE_DATASTORE", "MODE_CLUSTER_ENABLED", "MODE_CLUSTER_DISABLED" ] }, "type": "array", "description": "Optional. The modes of the database resource." }, "backupdrConfiguration": { "description": "Optional. BackupDR Configuration for the resource.", "$ref": "BackupDRConfiguration" }, "primaryResourceId": { "$ref": "DatabaseResourceId", "description": "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." }, "resourceContainer": { "description": "Closest parent Cloud Resource Manager container of this resource. It must be resource name of a Cloud Resource Manager project with the format of \"/\", such as \"projects/123\". For GCP provided resources, number should be project number.", "type": "string" }, "product": { "description": "The product this resource represents.", "$ref": "Product" }, "backupConfiguration": { "description": "Backup configuration for this instance", "$ref": "BackupConfiguration" }, "resourceName": { "description": "Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named \"ABC\" is deleted, the name \"ABC\" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", "type": "string" }, "edition": { "description": "Optional. Edition represents whether the instance is ENTERPRISE or ENTERPRISE_PLUS. This information is core to Cloud SQL only and is used to identify the edition of the instance.", "enumDescriptions": [ "Default, to make it consistent with instance edition enum.", "Represents the enterprise edition.", "Represents the enterprise plus edition.", "Represents the standard edition." ], "type": "string", "enum": [ "EDITION_UNSPECIFIED", "EDITION_ENTERPRISE", "EDITION_ENTERPRISE_PLUS", "EDITION_STANDARD" ] }, "expectedState": { "description": "The state that the instance is expected to be in. For example, an instance state can transition to UNHEALTHY due to wrong patch update, while the expected state will remain at the HEALTHY.", "enumDescriptions": [ "", "The instance is running.", "Instance being created, updated, deleted or under maintenance", "When instance is suspended", "Instance is deleted.", "For rest of the other category", "Instance is in STOPPED state." ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "HEALTHY", "UNHEALTHY", "SUSPENDED", "DELETED", "STATE_OTHER", "STOPPED" ] }, "userLabelSet": { "$ref": "UserLabels", "description": "User-provided labels associated with the resource" }, "machineConfiguration": { "$ref": "MachineConfiguration", "description": "Machine configuration for this resource." }, "id": { "$ref": "DatabaseResourceId", "description": "Required. Unique identifier for a Database resource" }, "customMetadata": { "$ref": "CustomMetadataData", "description": "Any custom metadata associated with the resource" }, "availabilityConfiguration": { "$ref": "AvailabilityConfiguration", "description": "Availability configuration for this instance" }, "location": { "type": "string", "description": "The resource location. REQUIRED" }, "backupRun": { "description": "Latest backup run information for this instance", "$ref": "BackupRun" }, "primaryResourceLocation": { "description": "Primary resource location. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional.", "type": "string" } } }, "UpcomingMaintenance": { "type": "object", "id": "UpcomingMaintenance", "description": "Upcoming maintenance for the database resource. This is generated by SLM once the upcoming maintenance schedule is published.", "properties": { "startTime": { "type": "string", "description": "Optional. The start time of the upcoming maintenance.", "format": "google-datetime" }, "endTime": { "type": "string", "description": "Optional. The end time of the upcoming maintenance.", "format": "google-datetime" } } }, "DiscoveryEndpoint": { "type": "object", "id": "DiscoveryEndpoint", "description": "Endpoints on each network, for Redis clients to connect to the cluster.", "properties": { "port": { "description": "Output only. The port number of the exposed Redis endpoint.", "format": "int32", "type": "integer", "readOnly": true }, "pscConfig": { "readOnly": true, "description": "Output only. Customer configuration for where the endpoint is created and accessed from.", "$ref": "PscConfig" }, "address": { "readOnly": true, "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.", "type": "string" } } }, "RegionalCertChain": { "id": "RegionalCertChain", "description": "The certificates that form the CA chain, from leaf to root order.", "properties": { "certificates": { "type": "array", "description": "The certificates that form the CA chain, from leaf to root order.", "items": { "type": "string" } } }, "type": "object" }, "ImportInstanceRequest": { "type": "object", "id": "ImportInstanceRequest", "description": "Request for Import.", "properties": { "inputConfig": { "description": "Required. Specify data to be imported.", "$ref": "InputConfig" } } }, "TokenAuthUser": { "id": "TokenAuthUser", "description": "Represents a token based auth user for the cluster.", "properties": { "name": { "description": "Identifier. The resource name of the token based auth user. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}", "type": "string" }, "state": { "description": "Output only. The state of the token based auth user.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "CREATING", "UPDATING", "DELETING" ], "readOnly": true, "enumDescriptions": [ "Not set.", "The auth user is active.", "The auth user is being created.", "The auth user is being updated.", "The auth user is being deleted." ] } }, "type": "object" }, "GcsBackupSource": { "id": "GcsBackupSource", "description": "Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters.", "properties": { "uris": { "description": "Optional. URIs of the Cloud Storage objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2", "type": "array", "items": { "type": "string" } } }, "type": "object" }, "ListTokenAuthUsersResponse": { "type": "object", "id": "ListTokenAuthUsersResponse", "description": "Response message for ListTokenAuthUsers.", "properties": { "unreachable": { "items": { "type": "string" }, "type": "array", "description": "Unordered list. Token auth users that could not be reached." }, "nextPageToken": { "type": "string", "description": "Token to retrieve the next page of results, or empty if there are no more results in the list." }, "tokenAuthUsers": { "items": { "$ref": "TokenAuthUser" }, "type": "array", "description": "A list of token auth users in the project." } } }, "StateInfo": { "id": "StateInfo", "description": "Represents additional information about the state of the cluster.", "properties": { "updateInfo": { "$ref": "UpdateInfo", "description": "Describes ongoing update on the cluster when cluster state is UPDATING." } }, "type": "object" }, "LocationMetadata": { "type": "object", "id": "LocationMetadata", "description": "This location metadata represents additional configuration options for a given location where a Redis instance may be created. All fields are output only. It is returned as content of the `google.cloud.location.Location.metadata` field.", "properties": { "availableZones": { "type": "object", "description": "Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by Compute Engine. These keys can be specified in `location_id` or `alternative_location_id` fields when creating a Redis instance.", "additionalProperties": { "$ref": "ZoneMetadata" }, "readOnly": true } } }, "CertificateAuthority": { "type": "object", "id": "CertificateAuthority", "description": "Redis cluster certificate authority", "properties": { "name": { "type": "string", "description": "Identifier. Unique name of the resource in this scope including project, location and cluster using the form: `projects/{project}/locations/{location}/clusters/{cluster}/certificateAuthority`" }, "managedServerCa": { "$ref": "ManagedCertificateAuthority" } } }, "OperationMetadata": { "id": "OperationMetadata", "description": "Pre-defined metadata fields.", "properties": { "apiVersion": { "description": "Output only. API version used to start the operation.", "type": "string", "readOnly": true }, "endTime": { "readOnly": true, "type": "string", "description": "Output only. The time the operation finished running.", "format": "google-datetime" }, "requestedCancellation": { "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`.", "type": "boolean", "readOnly": true }, "statusMessage": { "type": "string", "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true }, "target": { "readOnly": true, "description": "Output only. Server-defined resource path for the target of the operation.", "type": "string" }, "createTime": { "description": "Output only. The time the operation was created.", "format": "google-datetime", "type": "string", "readOnly": true }, "verb": { "description": "Output only. Name of the verb executed by the operation.", "type": "string", "readOnly": true } }, "type": "object" }, "OutputConfig": { "id": "OutputConfig", "description": "The output content", "properties": { "gcsDestination": { "$ref": "GcsDestination", "description": "Google Cloud Storage destination for output content." } }, "type": "object" }, "FailoverInstanceRequest": { "type": "object", "id": "FailoverInstanceRequest", "description": "Request for Failover.", "properties": { "dataProtectionMode": { "description": "Optional. Available data protection modes that the user can choose. If it's unspecified, data protection mode will be LIMITED_DATA_LOSS by default.", "enumDescriptions": [ "Defaults to LIMITED_DATA_LOSS if a data protection mode is not specified.", "Instance failover will be protected with data loss control. More specifically, the failover will only be performed if the current replication offset diff between primary and replica is under a certain threshold.", "Instance failover will be performed without data loss control." ], "type": "string", "enum": [ "DATA_PROTECTION_MODE_UNSPECIFIED", "LIMITED_DATA_LOSS", "FORCE_DATA_LOSS" ] } } }, "ListInstancesResponse": { "id": "ListInstancesResponse", "description": "Response for ListInstances.", "properties": { "instances": { "items": { "$ref": "Instance" }, "description": "A list of Redis instances 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}/instances/`- and the `status` field set to ERROR and `status_message` field set to \"location not available for ListInstances\".", "type": "array" }, "unreachable": { "type": "array", "description": "Locations that could not be reached.", "items": { "type": "string" } }, "nextPageToken": { "type": "string", "description": "Token to retrieve the next page of results, or empty if there are no more results in the list." } }, "type": "object" }, "UpdateInfo": { "id": "UpdateInfo", "description": "Represents information about an updating cluster.", "properties": { "targetReplicaCount": { "description": "Target number of replica nodes per shard.", "format": "int32", "type": "integer" }, "targetShardCount": { "type": "integer", "description": "Target number of shards for redis cluster", "format": "int32" }, "targetNodeType": { "description": "Target node type for redis cluster.", "enumDescriptions": [ "Node type unspecified", "Redis shared core nano node_type.", "Redis highmem medium node_type.", "Redis highmem xlarge node_type.", "Redis standard small node_type.", "Redis highcpu medium node_type.", "Redis standard large node_type.", "Redis highmem 2xlarge node_type." ], "type": "string", "enum": [ "NODE_TYPE_UNSPECIFIED", "REDIS_SHARED_CORE_NANO", "REDIS_HIGHMEM_MEDIUM", "REDIS_HIGHMEM_XLARGE", "REDIS_STANDARD_SMALL", "REDIS_HIGHCPU_MEDIUM", "REDIS_STANDARD_LARGE", "REDIS_HIGHMEM_2XLARGE" ] } }, "type": "object" }, "AclRule": { "id": "AclRule", "description": "A single ACL rule which defines the policy for a user.", "properties": { "rule": { "type": "string", "description": "Required. The rule to be applied to the username. Ex: \"on \u003epassword123 ~* +@all\" The format of the rule is defined by Redis OSS: https://redis.io/docs/latest/operate/oss_and_stack/management/security/acl/" }, "username": { "type": "string", "description": "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." } }, "type": "object" }, "ClusterMaintenanceSchedule": { "type": "object", "id": "ClusterMaintenanceSchedule", "description": "Upcoming maintenance schedule.", "properties": { "endTime": { "readOnly": true, "description": "Output only. The end time of any upcoming scheduled maintenance for this instance.", "format": "google-datetime", "type": "string" }, "startTime": { "description": "Output only. The start time of any upcoming scheduled maintenance for this instance.", "format": "google-datetime", "type": "string", "readOnly": true } } }, "ObservabilityMetricData": { "type": "object", "id": "ObservabilityMetricData", "properties": { "aggregationType": { "description": "Required. Type of aggregation performed on the metric.", "enumDescriptions": [ "Unspecified aggregation type.", "PEAK aggregation type.", "P99 aggregation type.", "P95 aggregation type.", "current aggregation type." ], "type": "string", "enum": [ "AGGREGATION_TYPE_UNSPECIFIED", "PEAK", "P99", "P95", "CURRENT" ] }, "metricType": { "description": "Required. Type of metric like CPU, Memory, etc.", "enumDescriptions": [ "Unspecified metric type.", "CPU utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).", "Memory utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).", "Number of network connections for a resource.", "Storage utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).", "Sotrage used by a resource.", "Node count for a resource. It represents the number of node units in a bigtable/spanner instance.", "Memory used by a resource (in bytes).", "Processing units used by a resource. It represents the number of processing units in a spanner instance." ], "type": "string", "enum": [ "METRIC_TYPE_UNSPECIFIED", "CPU_UTILIZATION", "MEMORY_UTILIZATION", "NETWORK_CONNECTIONS", "STORAGE_UTILIZATION", "STORAGE_USED_BYTES", "NODE_COUNT", "MEMORY_USED_BYTES", "PROCESSING_UNIT_COUNT" ] }, "value": { "$ref": "TypedValue", "description": "Required. Value of the metric type." }, "resourceName": { "description": "Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", "type": "string" }, "observationTime": { "description": "Required. The time the metric value was observed.", "format": "google-datetime", "type": "string" } } }, "DatabaseResourceFeed": { "id": "DatabaseResourceFeed", "description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 13", "properties": { "skipIngestion": { "description": "Optional. If true, the feed won't be ingested by DB Center. This indicates that the feed is intentionally skipped. For example, BackupDR feeds are only needed for resources integrated with DB Center (e.g., CloudSQL, AlloyDB). Feeds for non-integrated resources (e.g., Compute Engine, Persistent Disk) can be skipped.", "type": "boolean" }, "observabilityMetricData": { "$ref": "ObservabilityMetricData", "description": "Observability metric data." }, "resourceHealthSignalData": { "description": "Database resource health signal data.", "$ref": "DatabaseResourceHealthSignalData" }, "recommendationSignalData": { "description": "Database resource recommendation signal data.", "$ref": "DatabaseResourceRecommendationSignalData" }, "databaseResourceSignalData": { "$ref": "DatabaseResourceSignalData", "description": "Database resource signal data is used to ingest signals from database resource signal feeds." }, "configBasedSignalData": { "$ref": "ConfigBasedSignalData", "description": "Config based signal data is used to ingest signals that are generated based on the configuration of the database resource." }, "feedType": { "description": "Required. Type feed to be ingested into condor", "enumDescriptions": [ "Unspecified feed type. Not expected to be used.", "Database resource metadata feed from control plane", "Database resource monitoring data", "Database resource security health signal data", "Database resource recommendation signal data", "Database config based signal data", "Database resource metadata from BackupDR", "Database resource signal data" ], "type": "string", "enum": [ "FEEDTYPE_UNSPECIFIED", "RESOURCE_METADATA", "OBSERVABILITY_DATA", "SECURITY_FINDING_DATA", "RECOMMENDATION_SIGNAL_DATA", "CONFIG_BASED_SIGNAL_DATA", "BACKUPDR_METADATA", "DATABASE_RESOURCE_SIGNAL_DATA" ] }, "backupdrMetadata": { "$ref": "BackupDRMetadata", "description": "BackupDR metadata is used to ingest metadata from BackupDR." }, "feedTimestamp": { "description": "Required. Timestamp when feed is generated.", "format": "google-datetime", "type": "string" }, "resourceMetadata": { "$ref": "DatabaseResourceMetadata", "description": "Database resource metadata." }, "resourceId": { "$ref": "DatabaseResourceId", "description": "Primary key associated with the Resource. resource_id is available in individual feed level as well.", "deprecated": true } }, "type": "object" }, "AuthToken": { "id": "AuthToken", "description": "Auth token for the cluster.", "properties": { "state": { "description": "Output only. State of the auth token.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "CREATING", "DELETING" ], "readOnly": true, "enumDescriptions": [ "Not set.", "The auth token is active.", "The auth token is being created.", "The auth token is being deleted." ] }, "name": { "description": "Identifier. Name of the auth token. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}", "type": "string" }, "token": { "readOnly": true, "description": "Output only. The service generated authentication token used to connect to the Redis cluster.", "type": "string" }, "createTime": { "readOnly": true, "description": "Output only. Create time of the auth token.", "format": "google-datetime", "type": "string" } }, "type": "object" }, "ZoneDistributionConfig": { "type": "object", "id": "ZoneDistributionConfig", "description": "Zone distribution config for allocation of cluster resources.", "properties": { "mode": { "type": "string", "enum": [ "ZONE_DISTRIBUTION_MODE_UNSPECIFIED", "MULTI_ZONE", "SINGLE_ZONE" ], "description": "Optional. The mode of zone distribution. Defaults to MULTI_ZONE, when not specified.", "enumDescriptions": [ "Not Set. Default: MULTI_ZONE", "Distribute all resources across 3 zones picked at random, within the region.", "Distribute all resources in a single zone. The zone field must be specified, when this mode is selected." ] }, "zones": { "items": { "type": "string" }, "description": "Optional. Specify the zones of a multi-zone cluster where Redis Cluster allocates resources. This flag isn't applicable for single-zone clusters.", "type": "array" }, "zone": { "description": "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.", "type": "string" } } }, "TypedValue": { "id": "TypedValue", "description": "TypedValue represents the value of a metric type. It can either be a double, an int64, a string or a bool.", "properties": { "int64Value": { "type": "string", "description": "For integer value", "format": "int64" }, "doubleValue": { "description": "For double value", "format": "double", "type": "number" }, "stringValue": { "type": "string", "description": "For string value" }, "boolValue": { "description": "For boolean value", "type": "boolean" } }, "type": "object" }, "MachineConfiguration": { "id": "MachineConfiguration", "description": "MachineConfiguration describes the configuration of a machine specific to Database Resource.", "properties": { "shardCount": { "description": "Optional. Number of shards (if applicable).", "format": "int32", "type": "integer" }, "baselineSlots": { "description": "Optional. Baseline slots for BigQuery Reservations. Baseline slots are in increments of 50.", "format": "int64", "type": "string" }, "memorySizeInBytes": { "type": "string", "description": "Memory size in bytes. TODO(b/342344482) add proto validations again after bug fix.", "format": "int64" }, "cpuCount": { "deprecated": true, "type": "integer", "description": "The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482) add proto validations again after bug fix.", "format": "int32" }, "maxReservationSlots": { "type": "string", "description": "Optional. Max slots for BigQuery Reservations. Max slots are in increments of 50.", "format": "int64" }, "vcpuCount": { "type": "number", "description": "Optional. The number of vCPUs. TODO(b/342344482) add proto validations again after bug fix.", "format": "double" } }, "type": "object" }, "Operation": { "type": "object", "id": "Operation", "description": "This resource represents a long-running operation that is the result of a network API call.", "properties": { "response": { "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object" }, "metadata": { "description": "{ `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. }", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object" }, "name": { "type": "string", "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`." }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" } } }, "Status": { "id": "Status", "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).", "properties": { "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "message": { "description": "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.", "type": "string" }, "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32", "type": "integer" } }, "type": "object" }, "TlsCertificate": { "id": "TlsCertificate", "description": "TlsCertificate Resource", "properties": { "expireTime": { "readOnly": true, "type": "string", "description": "Output only. The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2020-05-18T00:00:00.094Z`.", "format": "google-datetime" }, "serialNumber": { "type": "string", "description": "Serial number, as extracted from the certificate." }, "createTime": { "type": "string", "description": "Output only. The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2020-05-18T00:00:00.094Z`.", "format": "google-datetime", "readOnly": true }, "cert": { "type": "string", "description": "PEM representation." }, "sha1Fingerprint": { "type": "string", "description": "Sha1 Fingerprint of the certificate." } }, "type": "object" }, "TimeOfDay": { "type": "object", "id": "TimeOfDay", "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", "properties": { "hours": { "type": "integer", "description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "format": "int32" }, "minutes": { "type": "integer", "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "format": "int32" }, "seconds": { "description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", "format": "int32", "type": "integer" }, "nanos": { "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", "format": "int32", "type": "integer" } } }, "UserLabels": { "id": "UserLabels", "description": "Message type for storing user labels. User labels are used to tag App Engine resources, allowing users to search for resources matching a set of labels and to aggregate usage data by labels.", "properties": { "labels": { "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object" }, "RetentionSettings": { "type": "object", "id": "RetentionSettings", "properties": { "timestampBasedRetentionTime": { "description": "Timestamp based retention period i.e. 2024-05-01T00:00:00Z", "format": "google-datetime", "type": "string" }, "retentionUnit": { "type": "string", "enum": [ "RETENTION_UNIT_UNSPECIFIED", "COUNT", "TIME", "DURATION", "RETENTION_UNIT_OTHER" ], "description": "The unit that 'retained_backups' represents.", "deprecated": true, "enumDescriptions": [ "Backup retention unit is unspecified, will be treated as COUNT.", "Retention will be by count, eg. \"retain the most recent 7 backups\".", "Retention will be by Time, eg. \"retain backups till a specific time\" i.e. till 2024-05-01T00:00:00Z.", "Retention will be by duration, eg. \"retain the backups for 172800 seconds (2 days)\".", "For rest of the other category" ] }, "timeBasedRetention": { "description": "Duration based retention period i.e. 172800 seconds (2 days)", "format": "google-duration", "type": "string", "deprecated": true }, "quantityBasedRetention": { "type": "integer", "description": "Quantity based retention period i.e. 7 backups", "format": "int32" }, "durationBasedRetention": { "type": "string", "description": "Duration based retention period i.e. 172800 seconds (2 days)", "format": "google-duration" } } }, "InstanceAuthString": { "id": "InstanceAuthString", "description": "Instance AUTH string details.", "properties": { "authString": { "description": "AUTH string set on the instance.", "type": "string" } }, "type": "object" }, "Entitlement": { "type": "object", "id": "Entitlement", "description": "Proto representing the access that a user has to a specific feature/service. NextId: 3.", "properties": { "type": { "enumDeprecated": [ false, true, false, false ], "enumDescriptions": [ "The entitlement type is unspecified.", "The root entitlement representing Gemini package ownership.This will no longer be supported in the future.", "The entitlement representing Native Tier, This will be the default Entitlement going forward with GCA Enablement.", "The entitlement representing GCA-Standard Tier." ], "description": "An enum that represents the type of this entitlement.", "type": "string", "enum": [ "ENTITLEMENT_TYPE_UNSPECIFIED", "GEMINI", "NATIVE", "GCA_STANDARD" ] }, "entitlementState": { "description": "The current state of user's accessibility to a feature/benefit.", "enumDescriptions": [ "", "User is entitled to a feature/benefit, but whether it has been successfully provisioned is decided by provisioning state.", "User is entitled to a feature/benefit, but it was requested to be revoked. Whether the revoke has been successful is decided by provisioning state." ], "type": "string", "enum": [ "ENTITLEMENT_STATE_UNSPECIFIED", "ENTITLED", "REVOKED" ] } } }, "AvailabilityConfiguration": { "id": "AvailabilityConfiguration", "description": "Configuration for availability of database instance", "properties": { "availabilityType": { "description": "Availability type. Potential values: * `ZONAL`: The instance serves data from only one zone. Outages in that zone affect data accessibility. * `REGIONAL`: The instance can serve data from more than one zone in a region (it is highly available).", "enumDescriptions": [ "Unspecified availability type.", "Zonal available instance.", "Regional available instance.", "Multi regional instance", "For rest of the other category" ], "type": "string", "enum": [ "AVAILABILITY_TYPE_UNSPECIFIED", "ZONAL", "REGIONAL", "MULTI_REGIONAL", "AVAILABILITY_TYPE_OTHER" ] }, "promotableReplicaConfigured": { "type": "boolean" }, "crossRegionReplicaConfigured": { "description": "Checks for resources that are configured to have redundancy, and ongoing replication across regions", "type": "boolean" }, "automaticFailoverRoutingConfigured": { "type": "boolean", "description": "Checks for existence of (multi-cluster) routing configuration that allows automatic failover to a different zone/region in case of an outage. Applicable to Bigtable resources." }, "externalReplicaConfigured": { "type": "boolean" } }, "type": "object" }, "AOFConfig": { "id": "AOFConfig", "description": "Configuration of the AOF based persistence.", "properties": { "appendFsync": { "description": "Optional. fsync configuration.", "enumDescriptions": [ "Not set. Default: EVERYSEC", "Never fsync. Normally Linux will flush data every 30 seconds with this configuration, but it's up to the kernel's exact tuning.", "fsync every second. Fast enough, and you may lose 1 second of data if there is a disaster", "fsync every time new write commands are appended to the AOF. It has the best data loss protection at the cost of performance" ], "type": "string", "enum": [ "APPEND_FSYNC_UNSPECIFIED", "NO", "EVERYSEC", "ALWAYS" ] } }, "type": "object" }, "GCBDRConfiguration": { "type": "object", "id": "GCBDRConfiguration", "description": "GCBDR Configuration for the resource.", "properties": { "gcbdrManaged": { "type": "boolean", "description": "Whether the resource is managed by GCBDR." } } }, "Cluster": { "id": "Cluster", "description": "A cluster instance.", "properties": { "pscConfigs": { "description": "Optional. 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.", "type": "array", "items": { "$ref": "PscConfig" } }, "crossClusterReplicationConfig": { "$ref": "CrossClusterReplicationConfig", "description": "Optional. Cross cluster replication config." }, "backupCollection": { "type": "string", "description": "Optional. Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}", "readOnly": true }, "satisfiesPzi": { "description": "Optional. Output only. Reserved for future use.", "type": "boolean", "readOnly": true }, "authorizationMode": { "description": "Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.", "enumDescriptions": [ "Not set.", "IAM basic authorization mode", "Authorization disabled mode", "Token based authorization mode" ], "type": "string", "enum": [ "AUTH_MODE_UNSPECIFIED", "AUTH_MODE_IAM_AUTH", "AUTH_MODE_DISABLED", "AUTH_MODE_TOKEN_AUTH" ] }, "gcsSource": { "$ref": "GcsBackupSource", "description": "Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects." }, "createTime": { "description": "Output only. The timestamp associated with the cluster creation request.", "format": "google-datetime", "type": "string", "readOnly": true }, "uid": { "description": "Output only. System assigned, unique identifier for the cluster.", "type": "string", "readOnly": true }, "automatedBackupConfig": { "$ref": "AutomatedBackupConfig", "description": "Optional. The automated backup config for the cluster." }, "encryptionInfo": { "description": "Output only. Encryption information of the data at rest of the cluster.", "$ref": "EncryptionInfo", "readOnly": true }, "simulateMaintenanceEvent": { "type": "boolean", "description": "Optional. Input only. Simulate a maintenance event." }, "asyncClusterEndpointsDeletionEnabled": { "description": "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.", "type": "boolean" }, "maintenanceSchedule": { "description": "Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule.", "$ref": "ClusterMaintenanceSchedule", "readOnly": true }, "availableMaintenanceVersions": { "items": { "type": "string" }, "readOnly": true, "type": "array", "description": "Output only. This field is used to determine the available maintenance versions for the self service update." }, "rotateServerCertificate": { "type": "boolean", "description": "Optional. Input only. Rotate the server certificates." }, "labels": { "type": "object", "description": "Optional. Labels to represent user-provided metadata.", "additionalProperties": { "type": "string" } }, "persistenceConfig": { "$ref": "ClusterPersistenceConfig", "description": "Optional. Persistence config (RDB, AOF) for the cluster." }, "stateInfo": { "readOnly": true, "$ref": "StateInfo", "description": "Output only. Additional information about the current state of the cluster." }, "kmsKey": { "description": "Optional. The KMS key used to encrypt the at-rest data of the cluster.", "type": "string" }, "pscConnections": { "readOnly": true, "items": { "$ref": "PscConnection" }, "description": "Output only. The list of PSC connections that are auto-created through service connectivity automation.", "type": "array" }, "zoneDistributionConfig": { "$ref": "ZoneDistributionConfig", "description": "Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region." }, "allowFewerZonesDeployment": { "type": "boolean", "description": "Optional. Immutable. Deprecated, do not use.", "deprecated": true }, "redisConfigs": { "description": "Optional. Key/Value pairs of customer overrides for mutable Redis Configs", "additionalProperties": { "type": "string" }, "type": "object" }, "serverCaPool": { "description": "Optional. Customer-managed CA pool for the cluster. Only applicable for BYOCA i.e. if server_ca_mode is SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA. Format: \"projects/{project}/locations/{region}/caPools/{ca_pool}\".", "type": "string" }, "aclPolicyInSync": { "readOnly": true, "deprecated": true, "description": "Optional. Output only. Deprecated: Indicates whether the ACL rules applied to the cluster are in sync.", "type": "boolean" }, "aclPolicy": { "description": "Optional. The ACL policy to be applied to the cluster.", "type": "string" }, "name": { "description": "Required. Identifier. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`", "type": "string" }, "replicaCount": { "description": "Optional. The number of replica nodes per shard.", "format": "int32", "type": "integer" }, "nodeType": { "description": "Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node.", "enumDescriptions": [ "Node type unspecified", "Redis shared core nano node_type.", "Redis highmem medium node_type.", "Redis highmem xlarge node_type.", "Redis standard small node_type.", "Redis highcpu medium node_type.", "Redis standard large node_type.", "Redis highmem 2xlarge node_type." ], "type": "string", "enum": [ "NODE_TYPE_UNSPECIFIED", "REDIS_SHARED_CORE_NANO", "REDIS_HIGHMEM_MEDIUM", "REDIS_HIGHMEM_XLARGE", "REDIS_STANDARD_SMALL", "REDIS_HIGHCPU_MEDIUM", "REDIS_STANDARD_LARGE", "REDIS_HIGHMEM_2XLARGE" ] }, "maintenancePolicy": { "description": "Optional. ClusterMaintenancePolicy determines when to allow or deny updates.", "$ref": "ClusterMaintenancePolicy" }, "serverCaMode": { "description": "Optional. Server CA mode for the cluster.", "enumDescriptions": [ "Server CA mode not specified.", "Each cluster has its own Google managed CA.", "The cluster uses Google managed shared CA in the region.", "The cluster uses customer managed CA from CAS." ], "type": "string", "enum": [ "SERVER_CA_MODE_UNSPECIFIED", "SERVER_CA_MODE_GOOGLE_MANAGED_PER_INSTANCE_CA", "SERVER_CA_MODE_GOOGLE_MANAGED_SHARED_CA", "SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA" ] }, "state": { "description": "Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED", "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "UPDATING", "DELETING" ], "readOnly": true, "enumDescriptions": [ "Not set.", "Redis cluster is being created.", "Redis cluster has been created and is fully usable.", "Redis cluster configuration is being updated.", "Redis cluster is being deleted." ] }, "sizeGb": { "readOnly": true, "type": "integer", "description": "Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.", "format": "int32" }, "effectiveMaintenanceVersion": { "description": "Output only. This field represents the actual maintenance version of the cluster.", "type": "string", "readOnly": true }, "managedBackupSource": { "description": "Optional. Backups generated and managed by memorystore service.", "$ref": "ManagedBackupSource" }, "ondemandMaintenance": { "type": "boolean", "description": "Optional. Input only. Ondemand maintenance for the cluster. This field can be used to trigger ondemand critical update on the cluster.", "deprecated": true }, "discoveryEndpoints": { "items": { "$ref": "DiscoveryEndpoint" }, "readOnly": true, "type": "array", "description": "Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported." }, "pscServiceAttachments": { "type": "array", "description": "Output only. Service attachment details to configure Psc connections", "items": { "$ref": "PscServiceAttachment" }, "readOnly": true }, "transitEncryptionMode": { "type": "string", "enum": [ "TRANSIT_ENCRYPTION_MODE_UNSPECIFIED", "TRANSIT_ENCRYPTION_MODE_DISABLED", "TRANSIT_ENCRYPTION_MODE_SERVER_AUTHENTICATION" ], "description": "Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster.", "enumDescriptions": [ "In-transit encryption not set.", "In-transit encryption disabled.", "Use server managed encryption for in-transit encryption." ] }, "maintenanceVersion": { "type": "string", "description": "Optional. This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the available_maintenance_versions field." }, "preciseSizeGb": { "readOnly": true, "description": "Output only. Precise value of redis memory size in GB for the entire cluster.", "format": "double", "type": "number" }, "deletionProtectionEnabled": { "type": "boolean", "description": "Optional. The delete operation will fail when the value is set to true." }, "shardCount": { "description": "Optional. Number of shards for the Redis cluster.", "format": "int32", "type": "integer" }, "clusterEndpoints": { "description": "Optional. A list of cluster endpoints.", "type": "array", "items": { "$ref": "ClusterEndpoint" } }, "satisfiesPzs": { "type": "boolean", "description": "Optional. Output only. Reserved for future use.", "readOnly": true } }, "type": "object" }, "ExportInstanceRequest": { "id": "ExportInstanceRequest", "description": "Request for Export.", "properties": { "outputConfig": { "description": "Required. Specify data to be exported.", "$ref": "OutputConfig" } }, "type": "object" }, "GcsDestination": { "type": "object", "id": "GcsDestination", "description": "The Cloud Storage location for the output content", "properties": { "uri": { "description": "Required. Data destination URI (e.g. 'gs://my_bucket/my_object'). Existing files will be overwritten.", "type": "string" } } }, "RDBConfig": { "id": "RDBConfig", "description": "Configuration of the RDB based persistence.", "properties": { "rdbSnapshotPeriod": { "description": "Optional. Period between RDB snapshots.", "enumDescriptions": [ "Not set.", "One hour.", "Six hours.", "Twelve hours.", "Twenty four hours." ], "type": "string", "enum": [ "SNAPSHOT_PERIOD_UNSPECIFIED", "ONE_HOUR", "SIX_HOURS", "TWELVE_HOURS", "TWENTY_FOUR_HOURS" ] }, "rdbSnapshotStartTime": { "type": "string", "description": "Optional. The time that the first snapshot was/will be attempted, and to which future snapshots will be aligned. If not provided, the current time will be used.", "format": "google-datetime" } }, "type": "object" }, "ReconciliationOperationMetadata": { "type": "object", "id": "ReconciliationOperationMetadata", "description": "Operation metadata returned by the CLH during resource state reconciliation.", "properties": { "exclusiveAction": { "description": "Excluisive action returned by the CLH.", "type": "string", "enum": [ "UNKNOWN_REPAIR_ACTION", "DELETE", "RETRY" ], "enumDescriptions": [ "Unknown repair action.", "The resource has to be deleted. When using this bit, the CLH should fail the operation. DEPRECATED. Instead use DELETE_RESOURCE OperationSignal in SideChannel.", "This resource could not be repaired but the repair should be tried again at a later time. This can happen if there is a dependency that needs to be resolved first- e.g. if a parent resource must be repaired before a child resource." ], "enumDeprecated": [ false, true, false ] }, "deleteResource": { "type": "boolean", "description": "DEPRECATED. Use exclusive_action instead.", "deprecated": true } } }, "RescheduleClusterMaintenanceRequest": { "type": "object", "id": "RescheduleClusterMaintenanceRequest", "description": "Request for rescheduling a cluster maintenance.", "properties": { "rescheduleType": { "description": "Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.", "enumDescriptions": [ "Not set.", "If the user wants to schedule the maintenance to happen now.", "If the user wants to reschedule the maintenance to a specific time." ], "type": "string", "enum": [ "RESCHEDULE_TYPE_UNSPECIFIED", "IMMEDIATE", "SPECIFIC_TIME" ] }, "scheduleTime": { "description": "Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example `2012-11-15T16:19:00.094Z`.", "format": "google-datetime", "type": "string" } } }, "MaintenanceSchedule": { "type": "object", "id": "MaintenanceSchedule", "description": "Upcoming maintenance schedule. If no maintenance is scheduled, fields are not populated.", "properties": { "startTime": { "readOnly": true, "description": "Output only. The start time of any upcoming scheduled maintenance for this instance.", "format": "google-datetime", "type": "string" }, "canReschedule": { "deprecated": true, "type": "boolean", "description": "If the scheduled maintenance can be rescheduled, default is true." }, "scheduleDeadlineTime": { "type": "string", "description": "Output only. The time deadline any schedule start time cannot go beyond, including reschedule.", "format": "google-datetime", "readOnly": true }, "endTime": { "type": "string", "description": "Output only. The end time of any upcoming scheduled maintenance for this instance.", "format": "google-datetime", "readOnly": true } } }, "PscServiceAttachment": { "id": "PscServiceAttachment", "description": "Configuration of a service attachment of the cluster, for creating PSC connections.", "properties": { "serviceAttachment": { "readOnly": true, "description": "Output only. Service attachment URI which your self-created PscConnection should use as target", "type": "string" }, "connectionType": { "type": "string", "enum": [ "CONNECTION_TYPE_UNSPECIFIED", "CONNECTION_TYPE_DISCOVERY", "CONNECTION_TYPE_PRIMARY", "CONNECTION_TYPE_READER" ], "description": "Output only. Type of a PSC connection targeting this service attachment.", "readOnly": true, "enumDescriptions": [ "Cluster endpoint Type is not set", "Cluster endpoint that will be used as for cluster topology discovery.", "Cluster endpoint that will be used as primary endpoint to access primary.", "Cluster endpoint that will be used as reader endpoint to access replicas." ] } }, "type": "object" }, "CustomMetadataData": { "id": "CustomMetadataData", "description": "Any custom metadata associated with the resource. e.g. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data", "properties": { "internalResourceMetadata": { "items": { "$ref": "InternalResourceMetadata" }, "type": "array", "description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration." } }, "type": "object" }, "ListBackupsResponse": { "id": "ListBackupsResponse", "description": "Response for `ListBackups`.", "properties": { "nextPageToken": { "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" }, "backups": { "type": "array", "description": "A list of backups in the project.", "items": { "$ref": "Backup" } }, "unreachable": { "items": { "type": "string" }, "type": "array", "description": "Backups that could not be reached." } }, "type": "object" }, "Empty": { "type": "object", "id": "Empty", "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); }", "properties": {} }, "ZoneMetadata": { "id": "ZoneMetadata", "description": "Defines specific information for a particular zone. Currently empty and reserved for future use only.", "properties": {}, "type": "object" }, "ConfigBasedSignalData": { "id": "ConfigBasedSignalData", "description": "Config based signal data. This is used to send signals to Condor which are based on the DB level configurations. These will be used to send signals for self managed databases.", "properties": { "resourceId": { "$ref": "DatabaseResourceId", "description": "Database resource id." }, "signalBoolValue": { "type": "boolean", "description": "Signal data for boolean signals." }, "fullResourceName": { "description": "Required. Full Resource name of the source resource.", "type": "string" }, "signalType": { "type": "string", "enum": [ "SIGNAL_TYPE_UNSPECIFIED", "SIGNAL_TYPE_OUTDATED_MINOR_VERSION", "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", "SIGNAL_TYPE_NO_ROOT_PASSWORD", "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", "SIGNAL_TYPE_EXTENDED_SUPPORT", "SIGNAL_TYPE_NO_AUTOMATED_BACKUP_POLICY", "SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE", "SIGNAL_TYPE_LAST_BACKUP_OLD", "SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER" ], "description": "Required. Signal type of the signal", "enumDescriptions": [ "Unspecified signal type.", "Outdated Minor Version", "Represents database auditing is disabled.", "Represents if a database has a password configured for the root account or not.", "Represents if a resource is exposed to public access.", "Represents if a resources requires all incoming connections to use SSL or not.", "Represents if a resource version is in extended support.", "Represents if a resource has no automated backup policy.", "Represents if a resource version is nearing end of life.", "Represents if the last backup of a resource is older than 24 hours.", "Represents if a resource is not protected by automatic failover." ] }, "lastRefreshTime": { "type": "string", "description": "Required. Last time signal was refreshed", "format": "google-datetime" } }, "type": "object" }, "InputConfig": { "id": "InputConfig", "description": "The input content", "properties": { "gcsSource": { "$ref": "GcsSource", "description": "Google Cloud Storage location where input content is located." } }, "type": "object" }, "ResourceMaintenanceSchedule": { "type": "object", "id": "ResourceMaintenanceSchedule", "description": "Maintenance window for the database resource. It specifies preferred time and day of the week and phase in some cases, when the maintenance can start. This is configured by the customer.", "properties": { "time": { "description": "Optional. Preferred time to start the maintenance operation on the specified day.", "$ref": "TimeOfDay" }, "day": { "description": "Optional. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.", "enumDescriptions": [ "The day of the week is unspecified.", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "type": "string", "enum": [ "DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "phase": { "type": "string", "enum": [ "PHASE_UNSPECIFIED", "ANY", "WEEK1", "WEEK2", "WEEK5" ], "description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance", "enumDescriptions": [ "Phase is unspecified.", "Any phase.", "Week 1.", "Week 2.", "Week 5." ] } } }, "ListLocationsResponse": { "id": "ListLocationsResponse", "description": "The response message for Locations.ListLocations.", "properties": { "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "locations": { "items": { "$ref": "Location" }, "description": "A list of locations that matches the specified filter in the request.", "type": "array" } }, "type": "object" }, "ListClustersResponse": { "type": "object", "id": "ListClustersResponse", "description": "Response for `ListClusters`.", "properties": { "unreachable": { "type": "array", "description": "Locations that could not be reached.", "items": { "type": "string" } }, "nextPageToken": { "type": "string", "description": "Token to retrieve the next page of results, or empty if there are no more results in the list." }, "clusters": { "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\".", "type": "array", "items": { "$ref": "Cluster" } } } }, "CertChain": { "type": "object", "id": "CertChain", "properties": { "certificates": { "type": "array", "description": "The certificates that form the CA chain, from leaf to root order.", "items": { "type": "string" } } } }, "ManagedBackupSource": { "type": "object", "id": "ManagedBackupSource", "description": "Backups that generated and managed by memorystore.", "properties": { "backup": { "description": "Optional. Example: //redis.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup} A shorter version (without the prefix) of the backup name is also supported, like projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup_id} In this case, it assumes the backup is under redis.googleapis.com.", "type": "string" } } }, "BackupFile": { "type": "object", "id": "BackupFile", "description": "Backup is consisted of multiple backup files.", "properties": { "fileName": { "readOnly": true, "description": "Output only. e.g: .rdb", "type": "string" }, "sizeBytes": { "description": "Output only. Size of the backup file in bytes.", "format": "int64", "type": "string", "readOnly": true }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. The time when the backup file was created.", "format": "google-datetime" } } }, "Backup": { "type": "object", "id": "Backup", "description": "Backup of a cluster.", "properties": { "cluster": { "description": "Output only. Cluster resource path of this backup.", "type": "string", "readOnly": true }, "engineVersion": { "readOnly": true, "description": "Output only. redis-7.2, valkey-7.5", "type": "string" }, "expireTime": { "readOnly": true, "type": "string", "description": "Output only. The time when the backup will expire.", "format": "google-datetime" }, "backupFiles": { "items": { "$ref": "BackupFile" }, "readOnly": true, "type": "array", "description": "Output only. List of backup files of the backup." }, "nodeType": { "enumDescriptions": [ "Node type unspecified", "Redis shared core nano node_type.", "Redis highmem medium node_type.", "Redis highmem xlarge node_type.", "Redis standard small node_type.", "Redis highcpu medium node_type.", "Redis standard large node_type.", "Redis highmem 2xlarge node_type." ], "readOnly": true, "type": "string", "enum": [ "NODE_TYPE_UNSPECIFIED", "REDIS_SHARED_CORE_NANO", "REDIS_HIGHMEM_MEDIUM", "REDIS_HIGHMEM_XLARGE", "REDIS_STANDARD_SMALL", "REDIS_HIGHCPU_MEDIUM", "REDIS_STANDARD_LARGE", "REDIS_HIGHMEM_2XLARGE" ], "description": "Output only. Node type of the cluster." }, "replicaCount": { "description": "Output only. Number of replicas for the cluster.", "format": "int32", "type": "integer", "readOnly": true }, "name": { "type": "string", "description": "Identifier. Full resource path of the backup. the last part of the name is the backup id with the following format: [YYYYMMDDHHMMSS]_[Shorted Cluster UID] OR customer specified while backup cluster. Example: 20240515123000_1234" }, "createTime": { "type": "string", "description": "Output only. The time when the backup was created.", "format": "google-datetime", "readOnly": true }, "clusterUid": { "readOnly": true, "type": "string", "description": "Output only. Cluster uid of this backup." }, "encryptionInfo": { "description": "Output only. Encryption information of the backup.", "$ref": "EncryptionInfo", "readOnly": true }, "uid": { "readOnly": true, "description": "Output only. System assigned unique identifier of the backup.", "type": "string" }, "totalSizeBytes": { "type": "string", "description": "Output only. Total size of the backup in bytes.", "format": "int64", "readOnly": true }, "state": { "readOnly": true, "enumDescriptions": [ "The default value, not set.", "The backup is being created.", "The backup is active to be used.", "The backup is being deleted.", "The backup is currently suspended due to reasons like project deletion, billing account closure, etc." ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "DELETING", "SUSPENDED" ], "description": "Output only. State of the backup." }, "backupType": { "type": "string", "enum": [ "BACKUP_TYPE_UNSPECIFIED", "ON_DEMAND", "AUTOMATED" ], "description": "Output only. Type of the backup.", "enumDescriptions": [ "The default value, not set.", "On-demand backup.", "Automated backup." ], "readOnly": true }, "shardCount": { "type": "integer", "description": "Output only. Number of shards for the cluster.", "format": "int32", "readOnly": true } } }, "Compliance": { "id": "Compliance", "description": "Contains compliance information about a security standard indicating unmet recommendations.", "properties": { "version": { "type": "string", "description": "Version of the standard or benchmark, for example, 1.1" }, "standard": { "description": "Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP.", "type": "string" } }, "type": "object" }, "ClusterEndpoint": { "id": "ClusterEndpoint", "description": "ClusterEndpoint consists of PSC connections that are created as a group in each VPC network for accessing the cluster. In each group, there shall be one connection for each service attachment in the cluster.", "properties": { "connections": { "items": { "$ref": "ConnectionDetail" }, "description": "Required. A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster.", "type": "array" } }, "type": "object" }, "BackupConfiguration": { "type": "object", "id": "BackupConfiguration", "description": "Configuration for automatic backups", "properties": { "automatedBackupEnabled": { "description": "Whether customer visible automated backups are enabled on the instance.", "type": "boolean" }, "backupRetentionSettings": { "$ref": "RetentionSettings", "description": "Backup retention settings." }, "pointInTimeRecoveryEnabled": { "description": "Whether point-in-time recovery is enabled. This is optional field, if the database service does not have this feature or metadata is not available in control plane, this can be omitted.", "type": "boolean" } } }, "EncryptionInfo": { "id": "EncryptionInfo", "description": "EncryptionInfo describes the encryption information of a cluster or a backup.", "properties": { "kmsKeyVersions": { "readOnly": true, "items": { "type": "string" }, "description": "Output only. KMS key versions that are being used to protect the data at-rest.", "type": "array" }, "encryptionType": { "description": "Output only. Type of encryption.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "GOOGLE_DEFAULT_ENCRYPTION", "CUSTOMER_MANAGED_ENCRYPTION" ], "readOnly": true, "enumDescriptions": [ "Encryption type not specified. Defaults to GOOGLE_DEFAULT_ENCRYPTION.", "The data is encrypted at rest with a key that is fully managed by Google. No key version will be populated. This is the default state.", "The data is encrypted at rest with a key that is managed by the customer. KMS key versions will be populated." ] }, "kmsKeyPrimaryState": { "readOnly": true, "enumDescriptions": [ "The default value. This value is unused.", "The KMS key is enabled and correctly configured.", "Permission denied on the KMS key.", "The KMS key is disabled.", "The KMS key is destroyed.", "The KMS key is scheduled to be destroyed.", "The EKM key is unreachable.", "Billing is disabled for the project.", "All other unknown failures." ], "type": "string", "enum": [ "KMS_KEY_STATE_UNSPECIFIED", "ENABLED", "PERMISSION_DENIED", "DISABLED", "DESTROYED", "DESTROY_SCHEDULED", "EKM_KEY_UNREACHABLE_DETECTED", "BILLING_DISABLED", "UNKNOWN_FAILURE" ], "description": "Output only. The state of the primary version of the KMS key perceived by the system. This field is not populated in backups." }, "lastUpdateTime": { "description": "Output only. The most recent time when the encryption info was updated.", "format": "google-datetime", "type": "string", "readOnly": true } }, "type": "object" }, "DatabaseResourceId": { "type": "object", "id": "DatabaseResourceId", "description": "DatabaseResourceId will serve as primary key for any resource ingestion event.", "properties": { "provider": { "description": "Required. Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged", "enumDescriptions": [ "Unspecified provider.", "Google cloud platform provider", "Amazon web service", "Azure web service", "On-prem database resources.", "Self-managed database provider. These are resources on a cloud platform, e.g., database resource installed in a GCE VM, but not a managed database service.", "For the rest of the other categories. Other refers to the rest of other database service providers, this could be smaller cloud provider. This needs to be provided when the provider is known, but it is not present in the existing set of enum values." ], "type": "string", "enum": [ "PROVIDER_UNSPECIFIED", "GCP", "AWS", "AZURE", "ONPREM", "SELFMANAGED", "PROVIDER_OTHER" ] }, "uniqueId": { "description": "Required. A service-local token that distinguishes this resource from other resources within the same service.", "type": "string" }, "providerDescription": { "type": "string", "description": "Optional. Needs to be used only when the provider is PROVIDER_OTHER." }, "resourceType": { "type": "string", "description": "Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, memorystore.googleapis.com/Instance, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/CloudExadataInfrastructure oracledatabase.googleapis.com/CloudVmCluster oracledatabase.googleapis.com/AutonomousDatabase spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel" } } }, "Location": { "id": "Location", "description": "A resource that represents a Google Cloud location.", "properties": { "locationId": { "type": "string", "description": "Resource ID for the region. For example: \"us-east1\"." }, "displayName": { "type": "string", "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\"." }, "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "type": "string", "description": "Full resource name for the region. For example: \"projects/example-project/locations/us-east1\"." }, "metadata": { "type": "object", "description": "Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by Compute Engine. These keys can be specified in `location_id` or `alternative_location_id` fields when creating a Redis instance.", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } } }, "type": "object" }, "ResourceMaintenanceInfo": { "type": "object", "id": "ResourceMaintenanceInfo", "description": "MaintenanceInfo to capture the maintenance details of database resource.", "properties": { "denyMaintenanceSchedules": { "description": "Optional. List of Deny maintenance period for the database resource.", "type": "array", "items": { "$ref": "ResourceMaintenanceDenySchedule" } }, "maintenanceVersion": { "type": "string", "description": "Optional. Current Maintenance version of the database resource. Example: \"MYSQL_8_0_41.R20250531.01_15\"" }, "nextAvailableMaintenanceVersions": { "description": "Optional. List of next available maintenance versions.", "type": "array", "items": { "type": "string" } }, "maintenanceState": { "type": "string", "enum": [ "MAINTENANCE_STATE_UNSPECIFIED", "CREATING", "READY", "UPDATING", "REPAIRING", "DELETING", "ERROR" ], "description": "Output only. Current state of maintenance on the database resource.", "enumDescriptions": [ "Unspecified state.", "Database resource is being created.", "Database resource has been created and is ready to use.", "Database resource is being updated.", "Database resource is unheathy and under repair.", "Database resource is being deleted.", "Database resource encountered an error and is in indeterministic state." ], "readOnly": true }, "currentVersionReleaseDate": { "description": "Optional. The date when the current maintenance version was released.", "$ref": "Date" }, "upcomingMaintenance": { "description": "Optional. Upcoming maintenance for the database resource. This field is populated once SLM generates and publishes upcoming maintenance window.", "$ref": "UpcomingMaintenance" }, "maintenanceSchedule": { "description": "Optional. Maintenance window for the database resource.", "$ref": "ResourceMaintenanceSchedule" }, "isInstanceStopped": { "description": "Optional. Whether the instance is in stopped state. This information is temporarily being captured in maintenanceInfo, till STOPPED state is supported by DB Center.", "type": "boolean" } } }, "IpAddress": { "id": "IpAddress", "description": "Used to send IP address information for a database resource.", "properties": { "publicIp": { "description": "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\").", "type": "string" }, "privateIp": { "description": "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\").", "type": "string" } }, "type": "object" }, "Tags": { "type": "object", "id": "Tags", "description": "Message type for storing tags. Tags provide a way to create annotations for resources, and in some cases conditionally allow or deny policies based on whether a resource has a specific tag.", "properties": { "tags": { "type": "object", "description": "The Tag key/value mappings.", "additionalProperties": { "type": "string" } } } }, "Date": { "type": "object", "id": "Date", "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", "properties": { "year": { "type": "integer", "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "format": "int32" }, "day": { "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "format": "int32", "type": "integer" }, "month": { "type": "integer", "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "format": "int32" } } }, "InternalResourceMetadata": { "type": "object", "id": "InternalResourceMetadata", "description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration settings. Similarly bigtable can have multiple clusters within same bigtable instance.", "properties": { "backupConfiguration": { "description": "Backup configuration for this database", "$ref": "BackupConfiguration" }, "backupRun": { "$ref": "BackupRun", "description": "Information about the last backup attempt for this database" }, "resourceName": { "description": "Required. internal resource name for spanner this will be database name e.g.\"spanner.googleapis.com/projects/123/abc/instances/inst1/databases/db1\"", "type": "string" }, "isDeletionProtectionEnabled": { "type": "boolean", "description": "Whether deletion protection is enabled for this internal resource." }, "resourceId": { "$ref": "DatabaseResourceId" }, "product": { "$ref": "Product", "description": "The product this resource represents." } } } }, "protocol": "rest", "canonicalName": "Cloud Redis", "ownerDomain": "google.com" }