@googleapis/redis
Version:
1,328 lines (1,319 loc) • 271 kB
text/typescript
// Copyright 2020 Google LLC
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
/* eslint-disable @typescript-eslint/no-explicit-any */
/* eslint-disable @typescript-eslint/no-unused-vars */
/* eslint-disable @typescript-eslint/no-empty-interface */
/* eslint-disable @typescript-eslint/no-namespace */
/* eslint-disable no-irregular-whitespace */
import {
OAuth2Client,
JWT,
Compute,
UserRefreshClient,
BaseExternalAccountClient,
GaxiosResponseWithHTTP2,
GoogleConfigurable,
createAPIRequest,
MethodOptions,
StreamMethodOptions,
GlobalOptions,
GoogleAuth,
BodyResponseCallback,
APIRequestContext,
} from 'googleapis-common';
import {Readable} from 'stream';
export namespace redis_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?:
| string
| OAuth2Client
| JWT
| Compute
| UserRefreshClient
| BaseExternalAccountClient
| GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* 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.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* 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.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Google Cloud Memorystore for Redis API
*
* Creates and manages Redis instances on the Google Cloud Platform.
*
* @example
* ```js
* const {google} = require('googleapis');
* const redis = google.redis('v1');
* ```
*/
export class Redis {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
this.context = {
_options: options || {},
google,
};
this.projects = new Resource$Projects(this.context);
}
}
/**
* Configuration of the AOF based persistence.
*/
export interface Schema$AOFConfig {
/**
* Optional. fsync configuration.
*/
appendFsync?: string | null;
}
/**
* The automated backup config for a cluster.
*/
export interface Schema$AutomatedBackupConfig {
/**
* Optional. The automated backup mode. If the mode is disabled, the other fields will be ignored.
*/
automatedBackupMode?: string | null;
/**
* Optional. Trigger automated backups at a fixed frequency.
*/
fixedFrequencySchedule?: Schema$FixedFrequencySchedule;
/**
* Optional. How long to keep automated backups before the backups are deleted. The value should be between 1 day and 365 days. If not specified, the default value is 35 days.
*/
retention?: string | null;
}
/**
* Configuration for availability of database instance
*/
export interface Schema$AvailabilityConfiguration {
/**
* Checks for existence of (multi-cluster) routing configuration that allows automatic failover to a different zone/region in case of an outage. Applicable to Bigtable resources.
*/
automaticFailoverRoutingConfigured?: boolean | null;
/**
* 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).
*/
availabilityType?: string | null;
/**
* Checks for resources that are configured to have redundancy, and ongoing replication across regions
*/
crossRegionReplicaConfigured?: boolean | null;
externalReplicaConfigured?: boolean | null;
promotableReplicaConfigured?: boolean | null;
}
/**
* Backup of a cluster.
*/
export interface Schema$Backup {
/**
* Output only. List of backup files of the backup.
*/
backupFiles?: Schema$BackupFile[];
/**
* Output only. Type of the backup.
*/
backupType?: string | null;
/**
* Output only. Cluster resource path of this backup.
*/
cluster?: string | null;
/**
* Output only. Cluster uid of this backup.
*/
clusterUid?: string | null;
/**
* Output only. The time when the backup was created.
*/
createTime?: string | null;
/**
* Output only. Encryption information of the backup.
*/
encryptionInfo?: Schema$EncryptionInfo;
/**
* Output only. redis-7.2, valkey-7.5
*/
engineVersion?: string | null;
/**
* Output only. The time when the backup will expire.
*/
expireTime?: string | null;
/**
* Identifier. Full resource path of the backup. the last part of the name is the backup id with the following format: [YYYYMMDDHHMMSS]_[Shorted Cluster UID] OR customer specified while backup cluster. Example: 20240515123000_1234
*/
name?: string | null;
/**
* Output only. Node type of the cluster.
*/
nodeType?: string | null;
/**
* Output only. Number of replicas for the cluster.
*/
replicaCount?: number | null;
/**
* Output only. Number of shards for the cluster.
*/
shardCount?: number | null;
/**
* Output only. State of the backup.
*/
state?: string | null;
/**
* Output only. Total size of the backup in bytes.
*/
totalSizeBytes?: string | null;
/**
* Output only. System assigned unique identifier of the backup.
*/
uid?: string | null;
}
/**
* Request for [BackupCluster].
*/
export interface Schema$BackupClusterRequest {
/**
* Optional. The id of the backup to be created. If not specified, the default value ([YYYYMMDDHHMMSS]_[Shortened Cluster UID] is used.
*/
backupId?: string | null;
/**
* Optional. TTL for the backup to expire. Value range is 1 day to 100 years. If not specified, the default value is 100 years.
*/
ttl?: string | null;
}
/**
* BackupCollection of a cluster.
*/
export interface Schema$BackupCollection {
/**
* Output only. The full resource path of the cluster the backup collection belongs to. Example: projects/{project\}/locations/{location\}/clusters/{cluster\}
*/
cluster?: string | null;
/**
* Output only. The cluster uid of the backup collection.
*/
clusterUid?: string | null;
/**
* Output only. The time when the backup collection was created.
*/
createTime?: string | null;
/**
* Output only. The KMS key used to encrypt the backups under this backup collection.
*/
kmsKey?: string | null;
/**
* Output only. The last time a backup was created in the backup collection.
*/
lastBackupTime?: string | null;
/**
* Identifier. Full resource path of the backup collection.
*/
name?: string | null;
/**
* Output only. Total number of backups in the backup collection.
*/
totalBackupCount?: string | null;
/**
* Output only. Total size of all backups in the backup collection.
*/
totalBackupSizeBytes?: string | null;
/**
* Output only. System assigned unique identifier of the backup collection.
*/
uid?: string | null;
}
/**
* Configuration for automatic backups
*/
export interface Schema$BackupConfiguration {
/**
* Whether customer visible automated backups are enabled on the instance.
*/
automatedBackupEnabled?: boolean | null;
/**
* Backup retention settings.
*/
backupRetentionSettings?: Schema$RetentionSettings;
/**
* 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.
*/
pointInTimeRecoveryEnabled?: boolean | null;
}
/**
* BackupDRConfiguration to capture the backup and disaster recovery details of database resource.
*/
export interface Schema$BackupDRConfiguration {
/**
* Indicates if the resource is managed by BackupDR.
*/
backupdrManaged?: boolean | null;
}
/**
* BackupDRMetadata contains information about the backup and disaster recovery metadata of a database resource.
*/
export interface Schema$BackupDRMetadata {
/**
* Backup configuration for this instance.
*/
backupConfiguration?: Schema$BackupConfiguration;
/**
* BackupDR configuration for this instance.
*/
backupdrConfiguration?: Schema$BackupDRConfiguration;
/**
* Latest backup run information for this instance.
*/
backupRun?: Schema$BackupRun;
/**
* Required. Full resource name of this instance.
*/
fullResourceName?: string | null;
/**
* Required. Last time backup configuration was refreshed.
*/
lastRefreshTime?: string | null;
/**
* Required. Database resource id.
*/
resourceId?: Schema$DatabaseResourceId;
}
/**
* Backup is consisted of multiple backup files.
*/
export interface Schema$BackupFile {
/**
* Output only. The time when the backup file was created.
*/
createTime?: string | null;
/**
* Output only. e.g: .rdb
*/
fileName?: string | null;
/**
* Output only. Size of the backup file in bytes.
*/
sizeBytes?: string | null;
}
/**
* A backup run.
*/
export interface Schema$BackupRun {
/**
* The time the backup operation completed. REQUIRED
*/
endTime?: string | null;
/**
* Information about why the backup operation failed. This is only present if the run has the FAILED status. OPTIONAL
*/
error?: Schema$OperationError;
/**
* The time the backup operation started. REQUIRED
*/
startTime?: string | null;
/**
* The status of this run. REQUIRED
*/
status?: string | null;
}
export interface Schema$CertChain {
/**
* The certificates that form the CA chain, from leaf to root order.
*/
certificates?: string[] | null;
}
/**
* Redis cluster certificate authority
*/
export interface Schema$CertificateAuthority {
managedServerCa?: Schema$ManagedCertificateAuthority;
/**
* Identifier. Unique name of the resource in this scope including project, location and cluster using the form: `projects/{project\}/locations/{location\}/clusters/{cluster\}/certificateAuthority`
*/
name?: string | null;
}
/**
* A cluster instance.
*/
export interface Schema$Cluster {
/**
* Optional. Immutable. Deprecated, do not use.
*/
allowFewerZonesDeployment?: boolean | null;
/**
* Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted.
*/
asyncClusterEndpointsDeletionEnabled?: boolean | null;
/**
* Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.
*/
authorizationMode?: string | null;
/**
* Optional. The automated backup config for the cluster.
*/
automatedBackupConfig?: Schema$AutomatedBackupConfig;
/**
* Optional. Output only. The backup collection full resource name. Example: projects/{project\}/locations/{location\}/backupCollections/{collection\}
*/
backupCollection?: string | null;
/**
* Optional. A list of cluster endpoints.
*/
clusterEndpoints?: Schema$ClusterEndpoint[];
/**
* Output only. The timestamp associated with the cluster creation request.
*/
createTime?: string | null;
/**
* Optional. Cross cluster replication config.
*/
crossClusterReplicationConfig?: Schema$CrossClusterReplicationConfig;
/**
* Optional. The delete operation will fail when the value is set to true.
*/
deletionProtectionEnabled?: boolean | null;
/**
* Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.
*/
discoveryEndpoints?: Schema$DiscoveryEndpoint[];
/**
* Output only. Encryption information of the data at rest of the cluster.
*/
encryptionInfo?: Schema$EncryptionInfo;
/**
* Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects.
*/
gcsSource?: Schema$GcsBackupSource;
/**
* Optional. The KMS key used to encrypt the at-rest data of the cluster.
*/
kmsKey?: string | null;
/**
* Optional. Labels to represent user-provided metadata.
*/
labels?: {[key: string]: string} | null;
/**
* Optional. ClusterMaintenancePolicy determines when to allow or deny updates.
*/
maintenancePolicy?: Schema$ClusterMaintenancePolicy;
/**
* Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule.
*/
maintenanceSchedule?: Schema$ClusterMaintenanceSchedule;
/**
* Optional. Backups generated and managed by memorystore service.
*/
managedBackupSource?: Schema$ManagedBackupSource;
/**
* Required. Identifier. Unique name of the resource in this scope including project and location using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}`
*/
name?: string | null;
/**
* Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node.
*/
nodeType?: string | null;
/**
* Optional. Input only. Ondemand maintenance for the cluster. This field can be used to trigger ondemand critical update on the cluster.
*/
ondemandMaintenance?: boolean | null;
/**
* Optional. Persistence config (RDB, AOF) for the cluster.
*/
persistenceConfig?: Schema$ClusterPersistenceConfig;
/**
* Output only. Precise value of redis memory size in GB for the entire cluster.
*/
preciseSizeGb?: number | null;
/**
* Optional. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.
*/
pscConfigs?: Schema$PscConfig[];
/**
* Output only. The list of PSC connections that are auto-created through service connectivity automation.
*/
pscConnections?: Schema$PscConnection[];
/**
* Output only. Service attachment details to configure Psc connections
*/
pscServiceAttachments?: Schema$PscServiceAttachment[];
/**
* Optional. Key/Value pairs of customer overrides for mutable Redis Configs
*/
redisConfigs?: {[key: string]: string} | null;
/**
* Optional. The number of replica nodes per shard.
*/
replicaCount?: number | null;
/**
* Optional. Output only. Reserved for future use.
*/
satisfiesPzi?: boolean | null;
/**
* Optional. Output only. Reserved for future use.
*/
satisfiesPzs?: boolean | null;
/**
* Optional. Number of shards for the Redis cluster.
*/
shardCount?: number | null;
/**
* Optional. Input only. Simulate a maintenance event.
*/
simulateMaintenanceEvent?: boolean | null;
/**
* Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.
*/
sizeGb?: number | null;
/**
* Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED
*/
state?: string | null;
/**
* Output only. Additional information about the current state of the cluster.
*/
stateInfo?: Schema$StateInfo;
/**
* Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster.
*/
transitEncryptionMode?: string | null;
/**
* Output only. System assigned, unique identifier for the cluster.
*/
uid?: string | null;
/**
* Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region.
*/
zoneDistributionConfig?: Schema$ZoneDistributionConfig;
}
/**
* ClusterEndpoint consists of PSC connections that are created as a group in each VPC network for accessing the cluster. In each group, there shall be one connection for each service attachment in the cluster.
*/
export interface Schema$ClusterEndpoint {
/**
* Required. A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster.
*/
connections?: Schema$ConnectionDetail[];
}
/**
* Maintenance policy per cluster.
*/
export interface Schema$ClusterMaintenancePolicy {
/**
* Output only. The time when the policy was created i.e. Maintenance Window or Deny Period was assigned.
*/
createTime?: string | null;
/**
* Output only. The time when the policy was updated i.e. Maintenance Window or Deny Period was updated.
*/
updateTime?: string | null;
/**
* Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_maintenance_window is expected to be one.
*/
weeklyMaintenanceWindow?: Schema$ClusterWeeklyMaintenanceWindow[];
}
/**
* Upcoming maintenance schedule.
*/
export interface Schema$ClusterMaintenanceSchedule {
/**
* Output only. The end time of any upcoming scheduled maintenance for this instance.
*/
endTime?: string | null;
/**
* Output only. The start time of any upcoming scheduled maintenance for this instance.
*/
startTime?: string | null;
}
/**
* Configuration of the persistence functionality.
*/
export interface Schema$ClusterPersistenceConfig {
/**
* Optional. AOF configuration. This field will be ignored if mode is not AOF.
*/
aofConfig?: Schema$AOFConfig;
/**
* Optional. The mode of persistence.
*/
mode?: string | null;
/**
* Optional. RDB configuration. This field will be ignored if mode is not RDB.
*/
rdbConfig?: Schema$RDBConfig;
}
/**
* Time window specified for weekly operations.
*/
export interface Schema$ClusterWeeklyMaintenanceWindow {
/**
* Optional. Allows to define schedule that runs specified day of the week.
*/
day?: string | null;
/**
* Optional. Start time of the window in UTC.
*/
startTime?: Schema$TimeOfDay;
}
/**
* Contains compliance information about a security standard indicating unmet recommendations.
*/
export interface Schema$Compliance {
/**
* Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP.
*/
standard?: string | null;
/**
* Version of the standard or benchmark, for example, 1.1
*/
version?: string | null;
}
/**
* Config based signal data. This is used to send signals to Condor which are based on the DB level configurations. These will be used to send signals for self managed databases.
*/
export interface Schema$ConfigBasedSignalData {
/**
* Required. Full Resource name of the source resource.
*/
fullResourceName?: string | null;
/**
* Required. Last time signal was refreshed
*/
lastRefreshTime?: string | null;
/**
* Database resource id.
*/
resourceId?: Schema$DatabaseResourceId;
/**
* Signal data for boolean signals.
*/
signalBoolValue?: boolean | null;
/**
* Required. Signal type of the signal
*/
signalType?: string | null;
}
/**
* Detailed information of each PSC connection.
*/
export interface Schema$ConnectionDetail {
/**
* Detailed information of a PSC connection that is created through service connectivity automation.
*/
pscAutoConnection?: Schema$PscAutoConnection;
/**
* Detailed information of a PSC connection that is created by the customer who owns the cluster.
*/
pscConnection?: Schema$PscConnection;
}
/**
* Cross cluster replication config.
*/
export interface Schema$CrossClusterReplicationConfig {
/**
* Output only. The role of the cluster in cross cluster replication.
*/
clusterRole?: string | null;
/**
* Output only. An output only view of all the member clusters participating in the cross cluster replication. This view will be provided by every member cluster irrespective of its cluster role(primary or secondary). A primary cluster can provide information about all the secondary clusters replicating from it. However, a secondary cluster only knows about the primary cluster from which it is replicating. However, for scenarios, where the primary cluster is unavailable(e.g. regional outage), a GetCluster request can be sent to any other member cluster and this field will list all the member clusters participating in cross cluster replication.
*/
membership?: Schema$Membership;
/**
* Details of the primary cluster that is used as the replication source for this secondary cluster. This field is only set for a secondary cluster.
*/
primaryCluster?: Schema$RemoteCluster;
/**
* List of secondary clusters that are replicating from this primary cluster. This field is only set for a primary cluster.
*/
secondaryClusters?: Schema$RemoteCluster[];
/**
* Output only. The last time cross cluster replication config was updated.
*/
updateTime?: string | null;
}
/**
* Any custom metadata associated with the resource. e.g. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data
*/
export interface Schema$CustomMetadataData {
/**
* Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration.
*/
internalResourceMetadata?: Schema$InternalResourceMetadata[];
}
/**
* DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 13
*/
export interface Schema$DatabaseResourceFeed {
/**
* BackupDR metadata is used to ingest metadata from BackupDR.
*/
backupdrMetadata?: Schema$BackupDRMetadata;
/**
* Config based signal data is used to ingest signals that are generated based on the configuration of the database resource.
*/
configBasedSignalData?: Schema$ConfigBasedSignalData;
/**
* Database resource signal data is used to ingest signals from database resource signal feeds.
*/
databaseResourceSignalData?: Schema$DatabaseResourceSignalData;
/**
* Required. Timestamp when feed is generated.
*/
feedTimestamp?: string | null;
/**
* Required. Type feed to be ingested into condor
*/
feedType?: string | null;
observabilityMetricData?: Schema$ObservabilityMetricData;
recommendationSignalData?: Schema$DatabaseResourceRecommendationSignalData;
resourceHealthSignalData?: Schema$DatabaseResourceHealthSignalData;
/**
* Primary key associated with the Resource. resource_id is available in individual feed level as well.
*/
resourceId?: Schema$DatabaseResourceId;
resourceMetadata?: Schema$DatabaseResourceMetadata;
/**
* Optional. If true, the feed won't be ingested by DB Center. This indicates that the feed is intentionally skipped. For example, BackupDR feeds are only needed for resources integrated with DB Center (e.g., CloudSQL, AlloyDB). Feeds for non-integrated resources (e.g., Compute Engine, Persistent Disk) can be skipped.
*/
skipIngestion?: boolean | null;
}
/**
* Common model for database resource health signal data.
*/
export interface Schema$DatabaseResourceHealthSignalData {
/**
* Any other additional metadata
*/
additionalMetadata?: {[key: string]: any} | null;
/**
* 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.
*/
compliance?: Schema$Compliance[];
/**
* Description associated with signal
*/
description?: string | null;
/**
* Required. The last time at which the event described by this signal took place
*/
eventTime?: string | null;
/**
* 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.
*/
externalUri?: string | null;
/**
* This is used to identify the location of the resource. Example: "us-central1"
*/
location?: string | null;
/**
* Required. The name of the signal, ex: PUBLIC_SQL_INSTANCE, SQL_LOG_ERROR_VERBOSITY etc.
*/
name?: string | null;
/**
* Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged
*/
provider?: string | null;
/**
* 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.
*/
resourceContainer?: string | null;
/**
* Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel
*/
resourceName?: string | null;
/**
* Required. The class of the signal, such as if it's a THREAT or VULNERABILITY.
*/
signalClass?: string | null;
/**
* Required. Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal.
*/
signalId?: string | null;
/**
* The severity of the signal, such as if it's a HIGH or LOW severity.
*/
signalSeverity?: string | null;
/**
* Required. Type of signal, for example, `AVAILABLE_IN_MULTIPLE_ZONES`, `LOGGING_MOST_ERRORS`, etc.
*/
signalType?: string | null;
state?: string | null;
}
/**
* DatabaseResourceId will serve as primary key for any resource ingestion event.
*/
export interface Schema$DatabaseResourceId {
/**
* Required. Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged
*/
provider?: string | null;
/**
* Optional. Needs to be used only when the provider is PROVIDER_OTHER.
*/
providerDescription?: string | null;
/**
* Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/CloudExadataInfrastructure oracledatabase.googleapis.com/CloudVmCluster oracledatabase.googleapis.com/AutonomousDatabase spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel
*/
resourceType?: string | null;
/**
* Required. A service-local token that distinguishes this resource from other resources within the same service.
*/
uniqueId?: string | null;
}
/**
* Common model for database resource instance metadata. Next ID: 27
*/
export interface Schema$DatabaseResourceMetadata {
/**
* Availability configuration for this instance
*/
availabilityConfiguration?: Schema$AvailabilityConfiguration;
/**
* Backup configuration for this instance
*/
backupConfiguration?: Schema$BackupConfiguration;
/**
* Optional. BackupDR Configuration for the resource.
*/
backupdrConfiguration?: Schema$BackupDRConfiguration;
/**
* Latest backup run information for this instance
*/
backupRun?: Schema$BackupRun;
/**
* The creation time of the resource, i.e. the time when resource is created and recorded in partner service.
*/
creationTime?: string | null;
/**
* Current state of the instance.
*/
currentState?: string | null;
/**
* Any custom metadata associated with the resource
*/
customMetadata?: Schema$CustomMetadataData;
/**
* Optional. Edition represents whether the instance is ENTERPRISE or ENTERPRISE_PLUS. This information is core to Cloud SQL only and is used to identify the edition of the instance.
*/
edition?: string | null;
/**
* Entitlements associated with the resource
*/
entitlements?: Schema$Entitlement[];
/**
* 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.
*/
expectedState?: string | null;
/**
* GCBDR configuration for the resource.
*/
gcbdrConfiguration?: Schema$GCBDRConfiguration;
/**
* Required. Unique identifier for a Database resource
*/
id?: Schema$DatabaseResourceId;
/**
* The type of the instance. Specified at creation time.
*/
instanceType?: string | null;
/**
* The resource location. REQUIRED
*/
location?: string | null;
/**
* Machine configuration for this resource.
*/
machineConfiguration?: Schema$MachineConfiguration;
/**
* 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.
*/
primaryResourceId?: Schema$DatabaseResourceId;
/**
* Primary resource location. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional.
*/
primaryResourceLocation?: string | null;
/**
* The product this resource represents.
*/
product?: Schema$Product;
/**
* 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.
*/
resourceContainer?: string | null;
/**
* 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
*/
resourceName?: string | null;
/**
* Optional. Suspension reason for the resource.
*/
suspensionReason?: string | null;
/**
* Optional. Tags associated with this resources.
*/
tagsSet?: Schema$Tags;
/**
* The time at which the resource was updated and recorded at partner service.
*/
updationTime?: string | null;
/**
* User-provided labels associated with the resource
*/
userLabelSet?: Schema$UserLabels;
/**
* The resource zone. This is only applicable for zonal resources and will be empty for regional and multi-regional resources.
*/
zone?: string | null;
}
/**
* Common model for database resource recommendation signal data.
*/
export interface Schema$DatabaseResourceRecommendationSignalData {
/**
* Optional. Any other additional metadata specific to recommendation
*/
additionalMetadata?: {[key: string]: any} | null;
/**
* Required. last time recommendationw as refreshed
*/
lastRefreshTime?: string | null;
/**
* Required. Recommendation state
*/
recommendationState?: string | null;
/**
* Required. Name of recommendation. Examples: organizations/1234/locations/us-central1/recommenders/google.cloudsql.instance.PerformanceRecommender/recommendations/9876
*/
recommender?: string | null;
/**
* Required. ID of recommender. Examples: "google.cloudsql.instance.PerformanceRecommender"
*/
recommenderId?: string | null;
/**
* 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"
*/
recommenderSubtype?: string | null;
/**
* Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel
*/
resourceName?: string | null;
/**
* Required. Type of signal, for example, `SIGNAL_TYPE_IDLE`, `SIGNAL_TYPE_HIGH_NUMBER_OF_TABLES`, etc.
*/
signalType?: string | null;
}
/**
* Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 7
*/
export interface Schema$DatabaseResourceSignalData {
/**
* Required. Full Resource name of the source resource.
*/
fullResourceName?: string | null;
/**
* Required. Last time signal was refreshed
*/
lastRefreshTime?: string | null;
/**
* Database resource id.
*/
resourceId?: Schema$DatabaseResourceId;
/**
* Signal data for boolean signals.
*/
signalBoolValue?: boolean | null;
/**
* Required. Output only. Signal state of the signal
*/
signalState?: string | null;
/**
* Required. Signal type of the signal
*/
signalType?: string | null;
}
/**
* Endpoints on each network, for Redis clients to connect to the cluster.
*/
export interface Schema$DiscoveryEndpoint {
/**
* Output only. Address of the exposed Redis endpoint used by clients to connect to the service. The address could be either IP or hostname.
*/
address?: string | null;
/**
* Output only. The port number of the exposed Redis endpoint.
*/
port?: number | null;
/**
* Output only. Customer configuration for where the endpoint is created and accessed from.
*/
pscConfig?: Schema$PscConfig;
}
/**
* 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); \}
*/
export interface Schema$Empty {}
/**
* EncryptionInfo describes the encryption information of a cluster or a backup.
*/
export interface Schema$EncryptionInfo {
/**
* Output only. Type of encryption.
*/
encryptionType?: string | null;
/**
* Output only. The state of the primary version of the KMS key perceived by the system. This field is not populated in backups.
*/
kmsKeyPrimaryState?: string | null;
/**
* Output only. KMS key versions that are being used to protect the data at-rest.
*/
kmsKeyVersions?: string[] | null;
/**
* Output only. The most recent time when the encryption info was updated.
*/
lastUpdateTime?: string | null;
}
/**
* Proto representing the access that a user has to a specific feature/service. NextId: 3.
*/
export interface Schema$Entitlement {
/**
* The current state of user's accessibility to a feature/benefit.
*/
entitlementState?: string | null;
/**
* An enum that represents the type of this entitlement.
*/
type?: string | null;
}
/**
* Request for [ExportBackup].
*/
export interface Schema$ExportBackupRequest {
/**
* Google Cloud Storage bucket, like "my-bucket".
*/
gcsBucket?: string | null;
}
/**
* Request for Export.
*/
export interface Schema$ExportInstanceRequest {
/**
* Required. Specify data to be exported.
*/
outputConfig?: Schema$OutputConfig;
}
/**
* Request for Failover.
*/
export interface Schema$FailoverInstanceRequest {
/**
* Optional. Available data protection modes that the user can choose. If it's unspecified, data protection mode will be LIMITED_DATA_LOSS by default.
*/
dataProtectionMode?: string | null;
}
/**
* This schedule allows the backup to be triggered at a fixed frequency (currently only daily is supported).
*/
export interface Schema$FixedFrequencySchedule {
/**
* Required. The start time of every automated backup in UTC. It must be set to the start of an hour. This field is required.
*/
startTime?: Schema$TimeOfDay;
}
/**
* GCBDR Configuration for the resource.
*/
export interface Schema$GCBDRConfiguration {
/**
* Whether the resource is managed by GCBDR.
*/
gcbdrManaged?: boolean | null;
}
/**
* Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters.
*/
export interface Schema$GcsBackupSource {
/**
* Optional. URIs of the Cloud Storage objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2
*/
uris?: string[] | null;
}
/**
* The Cloud Storage location for the output content
*/
export interface Schema$GcsDestination {
/**
* Required. Data destination URI (e.g. 'gs://my_bucket/my_object'). Existing files will be overwritten.
*/
uri?: string | null;
}
/**
* The Cloud Storage location for the input content
*/
export interface Schema$GcsSource {
/**
* Required. Source data URI. (e.g. 'gs://my_bucket/my_object').
*/
uri?: string | null;
}
/**
* 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.
*/
export interface Schema$GoogleCloudRedisV1LocationMetadata {
/**
* 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.
*/
availableZones?: {
[key: string]: Schema$GoogleCloudRedisV1ZoneMetadata;
} | null;
}
/**
* Represents the v1 metadata of the long-running operation.
*/
export interface Schema$GoogleCloudRedisV1OperationMetadata {
/**
* API version.
*/
apiVersion?: string | null;
/**
* Specifies if cancellation was requested for the operation.
*/
cancelRequested?: boolean | null;
/**
* Creation timestamp.
*/
createTime?: string | null;
/**
* End timestamp.
*/
endTime?: string | null;
/**
* Operation status details.
*/
statusDetail?: string | null;
/**
* Operation target.
*/
target?: string | null;
/**
* Operation verb.
*/
verb?: string | null;
}
/**
* Defines specific information for a particular zone. Currently empty and reserved for future use only.
*/
export interface Schema$GoogleCloudRedisV1ZoneMetadata {}
/**
* Request for Import.
*/
export interface Schema$ImportInstanceRequest {
/**
* Required. Specify data to be imported.
*/
inputConfig?: Schema$InputConfig;
}
/**
* The input content
*/
export interface Schema$InputConfig {
/**
* Google Cloud Storage location where input content is located.
*/
gcsSource?: Schema$GcsSource;
}
/**
* A Memorystore for Redis instance.
*/
export interface Schema$Instance {
/**
* 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.
*/
alternativeLocationId?: string | null;
/**
* 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.
*/
authEnabled?: boolean | null;
/**
* 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.
*/
authorizedNetwork?: string | null;
/**
* Optional. The available maintenance versions that an instance could update to.
*/
availableMaintenanceVersions?: string[] | null;
/**
* Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.
*/
connectMode?: string | null;
/**
* Output only. The time the instance was created.
*/
createTime?: string | null;
/**
* 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.
*/
currentLocationId?: string | null;
/**
* Optional. The KMS key reference that the customer provides when trying to create the instance.
*/
customerManagedKey?: string | null;
/**
* An arbitrary and optional user-provided name for the instance.
*/
displayName?: string | null;
/**
* Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
*/
host?: string | null;
/**
* Resource labels to represent user provided metadata
*/
labels?: {[key: string]: string} | null;
/**
* 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.
*/
locationId?: string | null;
/**
* Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.
*/
maintenancePolicy?: Schema$MaintenancePolicy;
/**
* Output only. Date and time of upcoming maintenance events which have been scheduled.
*/
maintenanceSchedule?: Schema$MaintenanceSchedule;
/**
* Optional. The self service update maintenance version. The version is date based such as "20210712_00_00".
*/
maintenanceVersion?: string | null;
/**
* Required. Redis memory size in GiB.
*/
memorySizeGb?: number | null;
/**
* 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.
*/
name?: string | null;
/**
* Output only. Info per node.
*/
nodes?: Schema$NodeInfo[];
/**
* Optional. Persistence configuration parameters
*/
persistenceConfig?: Schema$PersistenceConfig;
/**
* 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.
*/
persistenceIamIdentity?: string | null;
/**
* Output only. The port number of the exposed Redis endpoint.
*/
port?: number | null;
/**
* 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'.
*/
readEndpoint?: string | null;
/**
* Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'.
*/
readEndpointPort?: number | null;
/**
* Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.
*/
readReplicasMode?: string | null;
/**
* 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
*/
redisConfigs?: {[key: string]: string} | null;
/**
* Optional. The version of Redis software. If not provided, the default 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 * `REDIS_5_0` for Redis 5.0 compatibility * `REDIS_6_X` for Redis 6.x compatibility * `REDIS_7_0` for Redis 7.0 compatibility (default) * `REDIS_7_2` for Redis 7.2 compatibility
*/
redisVersion?: string | null;
/**
* 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.
*/
replicaCount?: number | null;
/**
* 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.
*/
reservedIpRange?: string | null;
/**
* Optional. Output only. Reserved for future use.
*/
satisfiesPzi?: boolean | null;
/**
* Optional. Output only. Reserved for future use.
*/
satisfiesPzs?: boolean | null;
/**
* 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".
*/
secondaryIpRange?: string | null;
/**
* Output only. List of server CA certificates for the instance.
*/
serverCaCerts?: Schema$TlsCertificate[];
/**
* Output only. The current state of this instance.
*/
state?: string | null;
/**
* Output only. Additio