{ "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "baseUrl": "https://redis.googleapis.com/", "protocol": "rest", "servicePath": "", "ownerDomain": "google.com", "version_module": true, "title": "Google Cloud Memorystore for Redis API", "schemas": { "ListOperationsResponse": { "id": "ListOperationsResponse", "description": "The response message for Operations.ListOperations.", "type": "object", "properties": { "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Operation" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } } }, "Operation": { "id": "Operation", "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "properties": { "name": { "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}`.", "type": "string" }, "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. }", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "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" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "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`.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "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).", "type": "object", "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" }, "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" }, "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." } } } } }, "Empty": { "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); }", "type": "object", "properties": {} }, "ListLocationsResponse": { "id": "ListLocationsResponse", "description": "The response message for Locations.ListLocations.", "type": "object", "properties": { "locations": { "description": "A list of locations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Location" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } } }, "Location": { "id": "Location", "description": "A resource that represents a Google Cloud location.", "type": "object", "properties": { "name": { "description": "Full resource name for the region. For example: \"projects/example-project/locations/us-east1\".", "type": "string" }, "locationId": { "description": "Resource ID for the region. For example: \"us-east1\".", "type": "string" }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object", "additionalProperties": { "type": "string" } }, "metadata": { "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.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "ListClustersResponse": { "id": "ListClustersResponse", "description": "Response for ListClusters.", "type": "object", "properties": { "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" } }, "nextPageToken": { "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "Cluster": { "id": "Cluster", "description": "A cluster instance.", "type": "object", "properties": { "name": { "description": "Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`", "type": "string" }, "createTime": { "description": "Output only. The timestamp associated with the cluster creation request.", "readOnly": true, "type": "string", "format": "google-datetime" }, "state": { "description": "Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED", "readOnly": true, "type": "string", "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." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "UPDATING", "DELETING" ] }, "uid": { "description": "Output only. System assigned, unique identifier for the cluster.", "readOnly": true, "type": "string" }, "replicaCount": { "description": "Optional. The number of replica nodes per shard.", "type": "integer", "format": "int32" }, "authorizationMode": { "description": "Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.", "type": "string", "enumDescriptions": [ "Not set.", "IAM basic authorization mode", "Authorization disabled mode" ], "enum": [ "AUTH_MODE_UNSPECIFIED", "AUTH_MODE_IAM_AUTH", "AUTH_MODE_DISABLED" ] }, "transitEncryptionMode": { "description": "Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster.", "type": "string", "enumDescriptions": [ "In-transit encryption not set.", "In-transit encryption disabled.", "Use server managed encryption for in-transit encryption." ], "enum": [ "TRANSIT_ENCRYPTION_MODE_UNSPECIFIED", "TRANSIT_ENCRYPTION_MODE_DISABLED", "TRANSIT_ENCRYPTION_MODE_SERVER_AUTHENTICATION" ] }, "sizeGb": { "description": "Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.", "readOnly": true, "type": "integer", "format": "int32" }, "shardCount": { "description": "Required. Number of shards for the Redis cluster.", "type": "integer", "format": "int32" }, "pscConfigs": { "description": "Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.", "type": "array", "items": { "$ref": "PscConfig" } }, "discoveryEndpoints": { "description": "Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.", "readOnly": true, "type": "array", "items": { "$ref": "DiscoveryEndpoint" } }, "pscConnections": { "description": "Output only. PSC connections for discovery of the cluster topology and accessing the cluster.", "readOnly": true, "type": "array", "items": { "$ref": "PscConnection" } }, "stateInfo": { "description": "Output only. Additional information about the current state of the cluster.", "readOnly": true, "$ref": "StateInfo" }, "nodeType": { "description": "Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node.", "type": "string", "enumDescriptions": [ "", "Redis shared core nano node_type.", "Redis highmem medium node_type.", "Redis highmem xlarge node_type.", "Redis standard small node_type." ], "enum": [ "NODE_TYPE_UNSPECIFIED", "REDIS_SHARED_CORE_NANO", "REDIS_HIGHMEM_MEDIUM", "REDIS_HIGHMEM_XLARGE", "REDIS_STANDARD_SMALL" ] }, "persistenceConfig": { "description": "Optional. Persistence config (RDB, AOF) for the cluster.", "$ref": "ClusterPersistenceConfig" }, "redisConfigs": { "description": "Optional. Key/Value pairs of customer overrides for mutable Redis Configs", "type": "object", "additionalProperties": { "type": "string" } }, "preciseSizeGb": { "description": "Output only. Precise value of redis memory size in GB for the entire cluster.", "readOnly": true, "type": "number", "format": "double" }, "deletionProtectionEnabled": { "description": "Optional. The delete operation will fail when the value is set to true.", "type": "boolean" } } }, "PscConfig": { "id": "PscConfig", "type": "object", "properties": { "network": { "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}.", "type": "string" } } }, "DiscoveryEndpoint": { "id": "DiscoveryEndpoint", "description": "Endpoints on each network, for Redis clients to connect to the cluster.", "type": "object", "properties": { "address": { "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.", "readOnly": true, "type": "string" }, "port": { "description": "Output only. The port number of the exposed Redis endpoint.", "readOnly": true, "type": "integer", "format": "int32" }, "pscConfig": { "description": "Output only. Customer configuration for where the endpoint is created and accessed from.", "readOnly": true, "$ref": "PscConfig" } } }, "PscConnection": { "id": "PscConnection", "description": "Details of consumer resources in a PSC connection.", "type": "object", "properties": { "pscConnectionId": { "description": "Output only. The PSC connection id of the forwarding rule connected to the service attachment.", "readOnly": true, "type": "string" }, "address": { "description": "Output only. The IP allocated on the consumer network for the PSC forwarding rule.", "readOnly": true, "type": "string" }, "forwardingRule": { "description": "Output only. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}.", "readOnly": true, "type": "string" }, "projectId": { "description": "Output only. The consumer project_id where the forwarding rule is created from.", "readOnly": true, "type": "string" }, "network": { "description": "The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}.", "type": "string" } } }, "StateInfo": { "id": "StateInfo", "description": "Represents additional information about the state of the cluster.", "type": "object", "properties": { "updateInfo": { "description": "Describes ongoing update on the cluster when cluster state is UPDATING.", "$ref": "UpdateInfo" } } }, "UpdateInfo": { "id": "UpdateInfo", "description": "Represents information about an updating cluster.", "type": "object", "properties": { "targetShardCount": { "description": "Target number of shards for redis cluster", "type": "integer", "format": "int32" }, "targetReplicaCount": { "description": "Target number of replica nodes per shard.", "type": "integer", "format": "int32" } } }, "ClusterPersistenceConfig": { "id": "ClusterPersistenceConfig", "description": "Configuration of the persistence functionality.", "type": "object", "properties": { "mode": { "description": "Optional. The mode of persistence.", "type": "string", "enumDescriptions": [ "Not set.", "Persistence is disabled, and any snapshot data is deleted.", "RDB based persistence is enabled.", "AOF based persistence is enabled." ], "enum": [ "PERSISTENCE_MODE_UNSPECIFIED", "DISABLED", "RDB", "AOF" ] }, "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" } } }, "RDBConfig": { "id": "RDBConfig", "description": "Configuration of the RDB based persistence.", "type": "object", "properties": { "rdbSnapshotPeriod": { "description": "Optional. Period between RDB snapshots.", "type": "string", "enumDescriptions": [ "Not set.", "One hour.", "Six hours.", "Twelve hours.", "Twenty four hours." ], "enum": [ "SNAPSHOT_PERIOD_UNSPECIFIED", "ONE_HOUR", "SIX_HOURS", "TWELVE_HOURS", "TWENTY_FOUR_HOURS" ] }, "rdbSnapshotStartTime": { "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.", "type": "string", "format": "google-datetime" } } }, "AOFConfig": { "id": "AOFConfig", "description": "Configuration of the AOF based persistence.", "type": "object", "properties": { "appendFsync": { "description": "Optional. fsync configuration.", "type": "string", "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 commands are appended to the AOF. It has the best data loss protection at the cost of performance" ], "enum": [ "APPEND_FSYNC_UNSPECIFIED", "NO", "EVERYSEC", "ALWAYS" ] } } }, "CertificateAuthority": { "id": "CertificateAuthority", "description": "Redis cluster certificate authority", "type": "object", "properties": { "managedServerCa": { "$ref": "ManagedCertificateAuthority" }, "name": { "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`", "type": "string" } } }, "ManagedCertificateAuthority": { "id": "ManagedCertificateAuthority", "type": "object", "properties": { "caCerts": { "description": "The PEM encoded CA certificate chains for redis managed server authentication", "type": "array", "items": { "$ref": "CertChain" } } } }, "CertChain": { "id": "CertChain", "type": "object", "properties": { "certificates": { "description": "The certificates that form the CA chain, from leaf to root order.", "type": "array", "items": { "type": "string" } } } }, "ListInstancesResponse": { "id": "ListInstancesResponse", "description": "Response for ListInstances.", "type": "object", "properties": { "instances": { "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", "items": { "$ref": "Instance" } }, "nextPageToken": { "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "Instance": { "id": "Instance", "description": "A Memorystore for Redis instance.", "type": "object", "properties": { "name": { "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.", "type": "string" }, "displayName": { "description": "An arbitrary and optional user-provided name for the instance.", "type": "string" }, "labels": { "description": "Resource labels to represent user provided metadata", "type": "object", "additionalProperties": { "type": "string" } }, "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" }, "alternativeLocationId": { "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.", "type": "string" }, "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" }, "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" }, "secondaryIpRange": { "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\".", "type": "string" }, "host": { "description": "Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.", "readOnly": true, "type": "string" }, "port": { "description": "Output only. The port number of the exposed Redis endpoint.", "readOnly": true, "type": "integer", "format": "int32" }, "currentLocationId": { "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.", "readOnly": true, "type": "string" }, "createTime": { "description": "Output only. The time the instance was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "state": { "description": "Output only. The current state of this instance.", "readOnly": true, "type": "string", "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)." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "READY", "UPDATING", "DELETING", "REPAIRING", "MAINTENANCE", "IMPORTING", "FAILING_OVER" ] }, "statusMessage": { "description": "Output only. Additional information about the current status of this instance, if available.", "readOnly": true, "type": "string" }, "redisConfigs": { "description": "Optional. Redis configuration parameters, according to http://redis.io/topics/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", "type": "object", "additionalProperties": { "type": "string" } }, "tier": { "description": "Required. The service tier of the instance.", "type": "string", "enumDescriptions": [ "Not set.", "BASIC tier: standalone instance", "STANDARD_HA tier: highly available primary/replica instances" ], "enum": [ "TIER_UNSPECIFIED", "BASIC", "STANDARD_HA" ] }, "memorySizeGb": { "description": "Required. Redis memory size in GiB.", "type": "integer", "format": "int32" }, "authorizedNetwork": { "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.", "type": "string" }, "persistenceIamIdentity": { "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.", "readOnly": true, "type": "string" }, "connectMode": { "description": "Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.", "type": "string", "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." ], "enum": [ "CONNECT_MODE_UNSPECIFIED", "DIRECT_PEERING", "PRIVATE_SERVICE_ACCESS" ] }, "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" }, "serverCaCerts": { "description": "Output only. List of server CA certificates for the instance.", "readOnly": true, "type": "array", "items": { "$ref": "TlsCertificate" } }, "transitEncryptionMode": { "description": "Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.", "type": "string", "enumDescriptions": [ "Not set.", "Client to Server traffic encryption enabled with server authentication.", "TLS is disabled for the instance." ], "enum": [ "TRANSIT_ENCRYPTION_MODE_UNSPECIFIED", "SERVER_AUTHENTICATION", "DISABLED" ] }, "maintenancePolicy": { "description": "Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.", "$ref": "MaintenancePolicy" }, "maintenanceSchedule": { "description": "Output only. Date and time of upcoming maintenance events which have been scheduled.", "readOnly": true, "$ref": "MaintenanceSchedule" }, "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.", "type": "integer", "format": "int32" }, "nodes": { "description": "Output only. Info per node.", "readOnly": true, "type": "array", "items": { "$ref": "NodeInfo" } }, "readEndpoint": { "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'.", "readOnly": true, "type": "string" }, "readEndpointPort": { "description": "Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'.", "readOnly": true, "type": "integer", "format": "int32" }, "readReplicasMode": { "description": "Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.", "type": "string", "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." ], "enum": [ "READ_REPLICAS_MODE_UNSPECIFIED", "READ_REPLICAS_DISABLED", "READ_REPLICAS_ENABLED" ] }, "customerManagedKey": { "description": "Optional. The KMS key reference that the customer provides when trying to create the instance.", "type": "string" }, "persistenceConfig": { "description": "Optional. Persistence configuration parameters", "$ref": "PersistenceConfig" }, "suspensionReasons": { "description": "Optional. reasons that causes instance in \"SUSPENDED\" state.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Not set.", "Something wrong with the CMEK key provided by customer." ], "enum": [ "SUSPENSION_REASON_UNSPECIFIED", "CUSTOMER_MANAGED_KEY_ISSUE" ] } }, "maintenanceVersion": { "description": "Optional. The self service update maintenance version. The version is date based such as \"20210712_00_00\".", "type": "string" }, "availableMaintenanceVersions": { "description": "Optional. The available maintenance versions that an instance could update to.", "type": "array", "items": { "type": "string" } }, "satisfiesPzs": { "description": "Optional. Output only. Reserved for future use.", "readOnly": true, "type": "boolean" }, "satisfiesPzi": { "description": "Optional. Output only. Reserved for future use.", "readOnly": true, "type": "boolean" } } }, "TlsCertificate": { "id": "TlsCertificate", "description": "TlsCertificate Resource", "type": "object", "properties": { "serialNumber": { "description": "Serial number, as extracted from the certificate.", "type": "string" }, "cert": { "description": "PEM representation.", "type": "string" }, "createTime": { "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`.", "readOnly": true, "type": "string", "format": "google-datetime" }, "expireTime": { "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`.", "readOnly": true, "type": "string", "format": "google-datetime" }, "sha1Fingerprint": { "description": "Sha1 Fingerprint of the certificate.", "type": "string" } } }, "MaintenancePolicy": { "id": "MaintenancePolicy", "description": "Maintenance policy for an instance.", "type": "object", "properties": { "createTime": { "description": "Output only. The time when the policy was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. The time when the policy was last updated.", "readOnly": true, "type": "string", "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": { "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.", "type": "array", "items": { "$ref": "WeeklyMaintenanceWindow" } } } }, "WeeklyMaintenanceWindow": { "id": "WeeklyMaintenanceWindow", "description": "Time window in which disruptive maintenance updates occur. Non-disruptive updates can occur inside or outside this window.", "type": "object", "properties": { "day": { "description": "Required. The day of week that maintenance updates occur.", "type": "string", "enumDescriptions": [ "The day of the week is unspecified.", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "enum": [ "DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "startTime": { "description": "Required. Start time of the window in UTC time.", "$ref": "TimeOfDay" }, "duration": { "description": "Output only. Duration of the maintenance window. The current window is fixed at 1 hour.", "readOnly": true, "type": "string", "format": "google-duration" } } }, "TimeOfDay": { "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`.", "type": "object", "properties": { "hours": { "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "type": "integer", "format": "int32" }, "minutes": { "description": "Minutes of hour of day. Must be from 0 to 59.", "type": "integer", "format": "int32" }, "seconds": { "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", "type": "integer", "format": "int32" }, "nanos": { "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", "type": "integer", "format": "int32" } } }, "MaintenanceSchedule": { "id": "MaintenanceSchedule", "description": "Upcoming maintenance schedule. If no maintenance is scheduled, fields are not populated.", "type": "object", "properties": { "startTime": { "description": "Output only. The start time of any upcoming scheduled maintenance for this instance.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. The end time of any upcoming scheduled maintenance for this instance.", "readOnly": true, "type": "string", "format": "google-datetime" }, "canReschedule": { "description": "If the scheduled maintenance can be rescheduled, default is true.", "deprecated": true, "type": "boolean" }, "scheduleDeadlineTime": { "description": "Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "NodeInfo": { "id": "NodeInfo", "description": "Node specific properties.", "type": "object", "properties": { "id": { "description": "Output only. Node identifying string. e.g. 'node-0', 'node-1'", "readOnly": true, "type": "string" }, "zone": { "description": "Output only. Location of the node.", "readOnly": true, "type": "string" } } }, "PersistenceConfig": { "id": "PersistenceConfig", "description": "Configuration of the persistence functionality.", "type": "object", "properties": { "persistenceMode": { "description": "Optional. Controls whether Persistence features are enabled. If not provided, the existing value will be used.", "type": "string", "enumDescriptions": [ "Not set.", "Persistence is disabled for the instance, and any existing snapshots are deleted.", "RDB based Persistence is enabled." ], "enum": [ "PERSISTENCE_MODE_UNSPECIFIED", "DISABLED", "RDB" ] }, "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.", "type": "string", "enumDescriptions": [ "Not set.", "Snapshot every 1 hour.", "Snapshot every 6 hours.", "Snapshot every 12 hours.", "Snapshot every 24 hours." ], "enum": [ "SNAPSHOT_PERIOD_UNSPECIFIED", "ONE_HOUR", "SIX_HOURS", "TWELVE_HOURS", "TWENTY_FOUR_HOURS" ] }, "rdbNextSnapshotTime": { "description": "Output only. The next time that a snapshot attempt is scheduled to occur.", "readOnly": true, "type": "string", "format": "google-datetime" }, "rdbSnapshotStartTime": { "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.", "type": "string", "format": "google-datetime" } } }, "InstanceAuthString": { "id": "InstanceAuthString", "description": "Instance AUTH string details.", "type": "object", "properties": { "authString": { "description": "AUTH string set on the instance.", "type": "string" } } }, "UpgradeInstanceRequest": { "id": "UpgradeInstanceRequest", "description": "Request for UpgradeInstance.", "type": "object", "properties": { "redisVersion": { "description": "Required. Specifies the target version of Redis software to upgrade to.", "type": "string" } } }, "ImportInstanceRequest": { "id": "ImportInstanceRequest", "description": "Request for Import.", "type": "object", "properties": { "inputConfig": { "description": "Required. Specify data to be imported.", "$ref": "InputConfig" } } }, "InputConfig": { "id": "InputConfig", "description": "The input content", "type": "object", "properties": { "gcsSource": { "description": "Google Cloud Storage location where input content is located.", "$ref": "GcsSource" } } }, "GcsSource": { "id": "GcsSource", "description": "The Cloud Storage location for the input content", "type": "object", "properties": { "uri": { "description": "Required. Source data URI. (e.g. 'gs://my_bucket/my_object').", "type": "string" } } }, "ExportInstanceRequest": { "id": "ExportInstanceRequest", "description": "Request for Export.", "type": "object", "properties": { "outputConfig": { "description": "Required. Specify data to be exported.", "$ref": "OutputConfig" } } }, "OutputConfig": { "id": "OutputConfig", "description": "The output content", "type": "object", "properties": { "gcsDestination": { "description": "Google Cloud Storage destination for output content.", "$ref": "GcsDestination" } } }, "GcsDestination": { "id": "GcsDestination", "description": "The Cloud Storage location for the output content", "type": "object", "properties": { "uri": { "description": "Required. Data destination URI (e.g. 'gs://my_bucket/my_object'). Existing files will be overwritten.", "type": "string" } } }, "FailoverInstanceRequest": { "id": "FailoverInstanceRequest", "description": "Request for Failover.", "type": "object", "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.", "type": "string", "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." ], "enum": [ "DATA_PROTECTION_MODE_UNSPECIFIED", "LIMITED_DATA_LOSS", "FORCE_DATA_LOSS" ] } } }, "RescheduleMaintenanceRequest": { "id": "RescheduleMaintenanceRequest", "description": "Request for RescheduleMaintenance.", "type": "object", "properties": { "rescheduleType": { "description": "Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.", "type": "string", "enumDescriptions": [ "Not set.", "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." ], "enum": [ "RESCHEDULE_TYPE_UNSPECIFIED", "IMMEDIATE", "NEXT_AVAILABLE_WINDOW", "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`.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudCommonOperationMetadata": { "id": "GoogleCloudCommonOperationMetadata", "description": "Represents the metadata of the long-running operation.", "type": "object", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "target": { "description": "Output only. Server-defined resource path for the target of the operation.", "readOnly": true, "type": "string" }, "verb": { "description": "Output only. Name of the verb executed by the operation.", "readOnly": true, "type": "string" }, "statusDetail": { "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true, "type": "string" }, "cancelRequested": { "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "readOnly": true, "type": "boolean" }, "apiVersion": { "description": "Output only. API version used to start the operation.", "readOnly": true, "type": "string" } } }, "ReconciliationOperationMetadata": { "id": "ReconciliationOperationMetadata", "description": "Operation metadata returned by the CLH during resource state reconciliation.", "type": "object", "properties": { "deleteResource": { "description": "DEPRECATED. Use exclusive_action instead.", "deprecated": true, "type": "boolean" }, "exclusiveAction": { "description": "Excluisive action returned by the CLH.", "type": "string", "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 ], "enum": [ "UNKNOWN_REPAIR_ACTION", "DELETE", "RETRY" ] } } }, "DatabaseResourceFeed": { "id": "DatabaseResourceFeed", "description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.", "type": "object", "properties": { "resourceId": { "description": "Primary key associated with the Resource. resource_id is available in individual feed level as well.", "deprecated": true, "$ref": "DatabaseResourceId" }, "feedTimestamp": { "description": "Required. Timestamp when feed is generated.", "type": "string", "format": "google-datetime" }, "feedType": { "description": "Required. Type feed to be ingested into condor", "type": "string", "enumDescriptions": [ "", "Database resource metadata feed from control plane", "Database resource monitoring data", "Database resource security health signal data", "Database resource recommendation signal data" ], "enum": [ "FEEDTYPE_UNSPECIFIED", "RESOURCE_METADATA", "OBSERVABILITY_DATA", "SECURITY_FINDING_DATA", "RECOMMENDATION_SIGNAL_DATA" ] }, "resourceMetadata": { "$ref": "DatabaseResourceMetadata" }, "resourceHealthSignalData": { "$ref": "DatabaseResourceHealthSignalData" }, "recommendationSignalData": { "description": "More feed data would be added in subsequent CLs", "$ref": "DatabaseResourceRecommendationSignalData" } } }, "DatabaseResourceId": { "id": "DatabaseResourceId", "description": "DatabaseResourceId will serve as primary key for any resource ingestion event.", "type": "object", "properties": { "provider": { "description": "Required. Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged", "type": "string", "enumDescriptions": [ "", "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." ], "enum": [ "PROVIDER_UNSPECIFIED", "GCP", "AWS", "AZURE", "ONPREM", "SELFMANAGED", "PROVIDER_OTHER" ] }, "providerDescription": { "description": "Optional. Needs to be used only when the provider is PROVIDER_OTHER.", "type": "string" }, "uniqueId": { "description": "Required. A service-local token that distinguishes this resource from other resources within the same service.", "type": "string" }, "resourceType": { "description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel", "type": "string" } } }, "DatabaseResourceMetadata": { "id": "DatabaseResourceMetadata", "description": "Common model for database resource instance metadata.", "type": "object", "properties": { "id": { "description": "Required. Unique identifier for a Database resource", "$ref": "DatabaseResourceId" }, "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" }, "primaryResourceId": { "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.", "$ref": "DatabaseResourceId" }, "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" }, "location": { "description": "The resource location. REQUIRED", "type": "string" }, "creationTime": { "description": "The creation time of the resource, i.e. the time when resource is created and recorded in partner service.", "type": "string", "format": "google-datetime" }, "updationTime": { "description": "The time at which the resource was updated and recorded at partner service.", "type": "string", "format": "google-datetime" }, "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.", "type": "string", "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" ], "enum": [ "STATE_UNSPECIFIED", "HEALTHY", "UNHEALTHY", "SUSPENDED", "DELETED", "STATE_OTHER" ] }, "currentState": { "description": "Current state of the instance.", "type": "string", "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" ], "enum": [ "STATE_UNSPECIFIED", "HEALTHY", "UNHEALTHY", "SUSPENDED", "DELETED", "STATE_OTHER" ] }, "instanceType": { "description": "The type of the instance. Specified at creation time.", "type": "string", "enumDescriptions": [ "", "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.", "For rest of the other categories." ], "enumDeprecated": [ true, false, true, true, true, true, false, false, false, false ], "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_OTHER" ] }, "product": { "description": "The product this resource represents.", "$ref": "Product" }, "userLabels": { "description": "User-provided labels, represented as a dictionary where each label is a single key value pair.", "deprecated": true, "type": "object", "additionalProperties": { "type": "string" } }, "availabilityConfiguration": { "description": "Availability configuration for this instance", "$ref": "AvailabilityConfiguration" }, "backupConfiguration": { "description": "Backup configuration for this instance", "$ref": "BackupConfiguration" }, "backupRun": { "description": "Latest backup run information for this instance", "$ref": "BackupRun" }, "customMetadata": { "description": "Any custom metadata associated with the resource", "$ref": "CustomMetadataData" }, "entitlements": { "description": "Entitlements associated with the resource", "type": "array", "items": { "$ref": "Entitlement" } }, "userLabelSet": { "description": "User-provided labels associated with the resource", "$ref": "UserLabels" } } }, "Product": { "id": "Product", "description": "Product specification for Condor resources.", "type": "object", "properties": { "type": { "description": "Type of specific database product. It could be CloudSQL, AlloyDB etc..", "type": "string", "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", "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 ], "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_OTHER" ] }, "engine": { "description": "The specific engine that the underlying database is running.", "type": "string", "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.", "Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum." ], "enumDeprecated": [ false, false, true, false, true, false, true, false, true, false, false, false, false, false ], "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_OTHER" ] }, "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" } } }, "AvailabilityConfiguration": { "id": "AvailabilityConfiguration", "description": "Configuration for availability of database instance", "type": "object", "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).", "type": "string", "enumDescriptions": [ "", "Zonal available instance.", "Regional available instance.", "Multi regional instance", "For rest of the other category" ], "enum": [ "AVAILABILITY_TYPE_UNSPECIFIED", "ZONAL", "REGIONAL", "MULTI_REGIONAL", "AVAILABILITY_TYPE_OTHER" ] }, "externalReplicaConfigured": { "type": "boolean" }, "promotableReplicaConfigured": { "type": "boolean" } } }, "BackupConfiguration": { "id": "BackupConfiguration", "description": "Configuration for automatic backups", "type": "object", "properties": { "automatedBackupEnabled": { "description": "Whether customer visible automated backups are enabled on the instance.", "type": "boolean" }, "backupRetentionSettings": { "description": "Backup retention settings.", "$ref": "RetentionSettings" }, "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" } } }, "RetentionSettings": { "id": "RetentionSettings", "type": "object", "properties": { "retentionUnit": { "description": "The unit that 'retained_backups' represents.", "type": "string", "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 the last 7 days backups\".", "For rest of the other category" ], "enum": [ "RETENTION_UNIT_UNSPECIFIED", "COUNT", "TIME", "RETENTION_UNIT_OTHER" ] }, "timeBasedRetention": { "type": "string", "format": "google-duration" }, "quantityBasedRetention": { "type": "integer", "format": "int32" } } }, "BackupRun": { "id": "BackupRun", "description": "A backup run.", "type": "object", "properties": { "startTime": { "description": "The time the backup operation started. REQUIRED", "type": "string", "format": "google-datetime" }, "endTime": { "description": "The time the backup operation completed. REQUIRED", "type": "string", "format": "google-datetime" }, "status": { "description": "The status of this run. REQUIRED", "type": "string", "enumDescriptions": [ "", "The backup was successful.", "The backup was unsuccessful." ], "enum": [ "STATUS_UNSPECIFIED", "SUCCESSFUL", "FAILED" ] }, "error": { "description": "Information about why the backup operation failed. This is only present if the run has the FAILED status. OPTIONAL", "$ref": "OperationError" } } }, "OperationError": { "id": "OperationError", "description": "An error that occurred during a backup creation operation.", "type": "object", "properties": { "code": { "description": "Identifies the specific error that occurred. REQUIRED", "type": "string" }, "message": { "description": "Additional information about the error encountered. REQUIRED", "type": "string" }, "errorType": { "type": "string", "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." ], "enum": [ "OPERATION_ERROR_TYPE_UNSPECIFIED", "KMS_KEY_ERROR", "DATABASE_ERROR", "STOCKOUT_ERROR", "CANCELLATION_ERROR", "SQLSERVER_ERROR", "INTERNAL_ERROR" ] } } }, "CustomMetadataData": { "id": "CustomMetadataData", "description": "Any custom metadata associated with the resource. i.e. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data", "type": "object", "properties": { "databaseMetadata": { "type": "array", "items": { "$ref": "DatabaseMetadata" } } } }, "DatabaseMetadata": { "id": "DatabaseMetadata", "description": "Metadata for individual databases created in an instance. i.e. spanner instance can have multiple databases with unique configuration settings.", "type": "object", "properties": { "resourceId": { "$ref": "DatabaseResourceId" }, "resourceName": { "description": "Required. Database name. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", "type": "string" }, "product": { "$ref": "Product" }, "backupConfiguration": { "description": "Backup configuration for this database", "$ref": "BackupConfiguration" }, "backupRun": { "description": "Information about the last backup attempt for this database", "$ref": "BackupRun" } } }, "Entitlement": { "id": "Entitlement", "description": "Proto representing the access that a user has to a specific feature/service. NextId: 3.", "type": "object", "properties": { "type": { "description": "An enum that represents the type of this entitlement.", "type": "string", "enumDescriptions": [ "", "The root entitlement representing Duet AI package ownership.", "The root entitlement representing Gemini package ownership." ], "enumDeprecated": [ false, true, false ], "enum": [ "ENTITLEMENT_TYPE_UNSPECIFIED", "DUET_AI", "GEMINI" ] }, "entitlementState": { "description": "The current state of user's accessibility to a feature/benefit.", "type": "string", "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." ], "enum": [ "ENTITLEMENT_STATE_UNSPECIFIED", "ENTITLED", "REVOKED" ] } } }, "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.", "type": "object", "properties": { "labels": { "type": "object", "additionalProperties": { "type": "string" } } } }, "DatabaseResourceHealthSignalData": { "id": "DatabaseResourceHealthSignalData", "description": "Common model for database resource health signal data.", "type": "object", "properties": { "signalId": { "description": "Required. Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal.", "type": "string" }, "name": { "description": "Required. The name of the signal, ex: PUBLIC_SQL_INSTANCE, SQL_LOG_ERROR_VERBOSITY etc.", "type": "string" }, "externalUri": { "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.", "type": "string" }, "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" }, "provider": { "description": "Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged", "type": "string", "enumDescriptions": [ "", "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." ], "enum": [ "PROVIDER_UNSPECIFIED", "GCP", "AWS", "AZURE", "ONPREM", "SELFMANAGED", "PROVIDER_OTHER" ] }, "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" }, "description": { "description": "Description associated with signal", "type": "string" }, "eventTime": { "description": "Required. The last time at which the event described by this signal took place", "type": "string", "format": "google-datetime" }, "state": { "type": "string", "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." ], "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "RESOLVED", "MUTED" ] }, "signalClass": { "description": "Required. The class of the signal, such as if it's a THREAT or VULNERABILITY.", "type": "string", "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." ], "enum": [ "CLASS_UNSPECIFIED", "THREAT", "VULNERABILITY", "MISCONFIGURATION", "OBSERVATION", "ERROR" ] }, "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" } }, "additionalMetadata": { "description": "Any other additional metadata", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "signalType": { "description": "Required. Type of signal, for example, `AVAILABLE_IN_MULTIPLE_ZONES`, `LOGGING_MOST_ERRORS`, etc.", "type": "string", "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 NIST 800-53.", "Represents if a resource violates ISO-27001.", "Represents if a resource violates PCI-DSS v3.2.1.", "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" ], "enumDeprecated": [ false, false, false, 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, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false ], "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_NIST_800_53", "SIGNAL_TYPE_VIOLATES_ISO_27001", "SIGNAL_TYPE_VIOLATES_PCI_DSS_V3_2_1", "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" ] } } }, "Compliance": { "id": "Compliance", "description": "Contains compliance information about a security standard indicating unmet recommendations.", "type": "object", "properties": { "standard": { "description": "Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP.", "type": "string" }, "version": { "description": "Version of the standard or benchmark, for example, 1.1", "type": "string" } } }, "DatabaseResourceRecommendationSignalData": { "id": "DatabaseResourceRecommendationSignalData", "description": "Common model for database resource recommendation signal data.", "type": "object", "properties": { "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" }, "signalType": { "description": "Required. Type of signal, for example, `SIGNAL_TYPE_IDLE`, `SIGNAL_TYPE_HIGH_NUMBER_OF_TABLES`, etc.", "type": "string", "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 NIST 800-53.", "Represents if a resource violates ISO-27001.", "Represents if a resource violates PCI-DSS v3.2.1.", "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" ], "enumDeprecated": [ false, false, false, 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, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false ], "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_NIST_800_53", "SIGNAL_TYPE_VIOLATES_ISO_27001", "SIGNAL_TYPE_VIOLATES_PCI_DSS_V3_2_1", "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" ] }, "lastRefreshTime": { "description": "Required. last time recommendationw as refreshed", "type": "string", "format": "google-datetime" }, "recommendationState": { "description": "Required. Recommendation state", "type": "string", "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." ], "enum": [ "UNSPECIFIED", "ACTIVE", "CLAIMED", "SUCCEEDED", "FAILED", "DISMISSED" ] }, "recommender": { "description": "Required. Name of recommendation. Examples: organizations/1234/locations/us-central1/recommenders/google.cloudsql.instance.PerformanceRecommender/recommendations/9876", "type": "string" }, "recommenderId": { "description": "Required. ID of recommender. Examples: \"google.cloudsql.instance.PerformanceRecommender\"", "type": "string" }, "recommenderSubtype": { "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\"", "type": "string" }, "additionalMetadata": { "description": "Optional. Any other additional metadata specific to recommendation", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "OperationMetadata": { "id": "OperationMetadata", "description": "Pre-defined metadata fields.", "type": "object", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "target": { "description": "Output only. Server-defined resource path for the target of the operation.", "readOnly": true, "type": "string" }, "verb": { "description": "Output only. Name of the verb executed by the operation.", "readOnly": true, "type": "string" }, "statusMessage": { "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true, "type": "string" }, "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`.", "readOnly": true, "type": "boolean" }, "apiVersion": { "description": "Output only. API version used to start the operation.", "readOnly": true, "type": "string" } } }, "GoogleCloudRedisV1beta1LocationMetadata": { "id": "GoogleCloudRedisV1beta1LocationMetadata", "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.", "type": "object", "properties": { "availableZones": { "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 GCE. These keys can be specified in `location_id` or `alternative_location_id` fields when creating a Redis instance.", "readOnly": true, "type": "object", "additionalProperties": { "$ref": "GoogleCloudRedisV1beta1ZoneMetadata" } } } }, "GoogleCloudRedisV1beta1ZoneMetadata": { "id": "GoogleCloudRedisV1beta1ZoneMetadata", "description": "Defines specific information for a particular zone. Currently empty and reserved for future use only.", "type": "object", "properties": {} } }, "basePath": "", "kind": "discovery#restDescription", "mtlsRootUrl": "https://redis.mtls.googleapis.com/", "batchPath": "batch", "canonicalName": "Cloud Redis", "revision": "20240411", "auth": { "oauth2": { "scopes": { "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." } } } }, "ownerName": "Google", "rootUrl": "https://redis.googleapis.com/", "resources": { "projects": { "resources": { "locations": { "methods": { "list": { "id": "redis.projects.locations.list", "path": "v1beta1/{+name}/locations", "flatPath": "v1beta1/projects/{projectsId}/locations", "httpMethod": "GET", "parameters": { "name": { "description": "The resource that owns the locations collection, if applicable.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" }, "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" }, "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListLocationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists information about the supported locations for this service." }, "get": { "id": "redis.projects.locations.get", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Resource name for the location.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Location" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets information about a location." } }, "resources": { "operations": { "methods": { "list": { "id": "redis.projects.locations.operations.list", "path": "v1beta1/{+name}/operations", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "redis.projects.locations.operations.get", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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." }, "delete": { "id": "redis.projects.locations.operations.delete", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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`." }, "cancel": { "id": "redis.projects.locations.operations.cancel", "path": "v1beta1/{+name}:cancel", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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`." } } }, "clusters": { "methods": { "list": { "id": "redis.projects.locations.clusters.list", "path": "v1beta1/{+parent}/clusters", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The resource name of the cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "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.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The `next_page_token` value returned from a previous ListClusters request, if any.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListClustersResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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." }, "get": { "id": "redis.projects.locations.clusters.get", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", "httpMethod": "GET", "parameters": { "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 GCP region.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Cluster" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the details of a specific Redis cluster." }, "patch": { "id": "redis.projects.locations.clusters.patch", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "location": "path", "required": true, "type": "string" }, "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`", "location": "query", "type": "string", "format": "google-fieldmask" }, "requestId": { "description": "Idempotent request UUID.", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "Cluster" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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." }, "delete": { "id": "redis.projects.locations.clusters.delete", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", "httpMethod": "DELETE", "parameters": { "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 GCP region.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "Idempotent request UUID.", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a specific Redis cluster. Cluster stops serving and data is deleted." }, "create": { "id": "redis.projects.locations.clusters.create", "path": "v1beta1/{+parent}/clusters", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The resource name of the cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "clusterId": { "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", "location": "query", "type": "string" }, "requestId": { "description": "Idempotent request UUID.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "Cluster" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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." }, "getCertificateAuthority": { "id": "redis.projects.locations.clusters.getCertificateAuthority", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/certificateAuthority", "httpMethod": "GET", "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 GCP region.", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/certificateAuthority$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "CertificateAuthority" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the details of certificate authority information for Redis cluster." } } }, "instances": { "methods": { "list": { "id": "redis.projects.locations.instances.list", "path": "v1beta1/{+parent}/instances", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances", "httpMethod": "GET", "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/[^/]+$", "location": "path", "required": true, "type": "string" }, "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.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The `next_page_token` value returned from a previous ListInstances request, if any.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListInstancesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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." }, "get": { "id": "redis.projects.locations.instances.get", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", "httpMethod": "GET", "parameters": { "name": { "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/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Instance" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the details of a specific Redis instance." }, "getAuthString": { "id": "redis.projects.locations.instances.getAuthString", "path": "v1beta1/{+name}/authString", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/authString", "httpMethod": "GET", "parameters": { "name": { "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/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "InstanceAuthString" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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." }, "create": { "id": "redis.projects.locations.instances.create", "path": "v1beta1/{+parent}/instances", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances", "httpMethod": "POST", "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/[^/]+$", "location": "path", "required": true, "type": "string" }, "instanceId": { "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", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "Instance" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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." }, "patch": { "id": "redis.projects.locations.instances.patch", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", "httpMethod": "PATCH", "parameters": { "name": { "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/[^/]+$", "location": "path", "required": true, "type": "string" }, "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 Instance: * `displayName` * `labels` * `memorySizeGb` * `redisConfig` * `replica_count`", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "Instance" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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." }, "upgrade": { "id": "redis.projects.locations.instances.upgrade", "path": "v1beta1/{+name}:upgrade", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:upgrade", "httpMethod": "POST", "parameters": { "name": { "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/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "UpgradeInstanceRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Upgrades Redis instance to the newer Redis version specified in the request." }, "import": { "id": "redis.projects.locations.instances.import", "path": "v1beta1/{+name}:import", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:import", "httpMethod": "POST", "parameters": { "name": { "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/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "ImportInstanceRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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." }, "export": { "id": "redis.projects.locations.instances.export", "path": "v1beta1/{+name}:export", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:export", "httpMethod": "POST", "parameters": { "name": { "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/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "ExportInstanceRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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." }, "failover": { "id": "redis.projects.locations.instances.failover", "path": "v1beta1/{+name}:failover", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:failover", "httpMethod": "POST", "parameters": { "name": { "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/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "FailoverInstanceRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance." }, "delete": { "id": "redis.projects.locations.instances.delete", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", "httpMethod": "DELETE", "parameters": { "name": { "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/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a specific Redis instance. Instance stops serving and data is deleted." }, "rescheduleMaintenance": { "id": "redis.projects.locations.instances.rescheduleMaintenance", "path": "v1beta1/{+name}:rescheduleMaintenance", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:rescheduleMaintenance", "httpMethod": "POST", "parameters": { "name": { "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/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "RescheduleMaintenanceRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Reschedule maintenance for a given instance in a given project and location." } } } } } } } }, "parameters": { "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "alt": { "type": "string", "description": "Data format for response.", "default": "json", "enum": [ "json", "media", "proto" ], "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" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "key": { "type": "string", "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.", "location": "query" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "quotaUser": { "type": "string", "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.", "location": "query" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query" } }, "fullyEncodeReservedExpansion": true, "documentationLink": "https://cloud.google.com/memorystore/docs/redis/", "version": "v1beta1", "description": "Creates and manages Redis instances on the Google Cloud Platform.", "id": "redis:v1beta1", "name": "redis", "discoveryVersion": "v1" }