DatabaseResourceMetadata

import type { DatabaseResourceMetadata } from "https://googleapis.deno.dev/v1/redis:v1.ts";

Common model for database resource instance metadata. Next ID: 29

interface DatabaseResourceMetadata {

availabilityConfiguration?: AvailabilityConfiguration;

backupConfiguration?: BackupConfiguration;

backupdrConfiguration?: BackupDRConfiguration;

backupRun?: BackupRun;

creationTime?: Date;

currentState?:

| "STATE_UNSPECIFIED"

| "HEALTHY"

| "UNHEALTHY"

| "SUSPENDED"

| "DELETED"

| "STATE_OTHER";

customMetadata?: CustomMetadataData;

edition?:

| "EDITION_UNSPECIFIED"

| "EDITION_ENTERPRISE"

| "EDITION_ENTERPRISE_PLUS"

| "EDITION_STANDARD";

entitlements?: Entitlement[];

expectedState?:

| "STATE_UNSPECIFIED"

| "HEALTHY"

| "UNHEALTHY"

| "SUSPENDED"

| "DELETED"

| "STATE_OTHER";

gcbdrConfiguration?: GCBDRConfiguration;

id?: DatabaseResourceId;

instanceType?:

| "INSTANCE_TYPE_UNSPECIFIED"

| "SUB_RESOURCE_TYPE_UNSPECIFIED"

| "PRIMARY"

| "SECONDARY"

| "READ_REPLICA"

| "OTHER"

| "SUB_RESOURCE_TYPE_PRIMARY"

| "SUB_RESOURCE_TYPE_SECONDARY"

| "SUB_RESOURCE_TYPE_READ_REPLICA"

| "SUB_RESOURCE_TYPE_EXTERNAL_PRIMARY"

| "SUB_RESOURCE_TYPE_OTHER";

location?: string;

machineConfiguration?: MachineConfiguration;

maintenanceInfo?: ResourceMaintenanceInfo;

primaryResourceId?: DatabaseResourceId;

primaryResourceLocation?: string;

product?: Product;

resourceContainer?: string;

resourceName?: string;

suspensionReason?:

| "SUSPENSION_REASON_UNSPECIFIED"

| "WIPEOUT_HIDE_EVENT"

| "WIPEOUT_PURGE_EVENT"

| "BILLING_DISABLED"

| "ABUSER_DETECTED"

| "ENCRYPTION_KEY_INACCESSIBLE"

| "REPLICATED_CLUSTER_ENCRYPTION_KEY_INACCESSIBLE";

tagsSet?: Tags;

updationTime?: Date;

userLabelSet?: UserLabels;

zone?: string;

}

§Properties

availabilityConfiguration?: AvailabilityConfiguration

[src]

Availability configuration for this instance

backupConfiguration?: BackupConfiguration

[src]

Backup configuration for this instance

backupdrConfiguration?: BackupDRConfiguration

[src]

Optional. BackupDR Configuration for the resource.

backupRun?: BackupRun

[src]

Latest backup run information for this instance

creationTime?: Date

[src]

The creation time of the resource, i.e. the time when resource is created and recorded in partner service.

[src]

Current state of the instance.

customMetadata?: CustomMetadataData

[src]

Any custom metadata associated with the resource

edition?: "EDITION_UNSPECIFIED" | "EDITION_ENTERPRISE" | "EDITION_ENTERPRISE_PLUS" | "EDITION_STANDARD"

[src]

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.

entitlements?: Entitlement[]

[src]

Entitlements associated with the resource

[src]

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.

gcbdrConfiguration?: GCBDRConfiguration

[src]

GCBDR configuration for the resource.

id?: DatabaseResourceId

[src]

Required. Unique identifier for a Database resource

[src]

The type of the instance. Specified at creation time.

location?: string

[src]

The resource location. REQUIRED

machineConfiguration?: MachineConfiguration

[src]

Machine configuration for this resource.

maintenanceInfo?: ResourceMaintenanceInfo

[src]

Optional. Maintenance info for the resource.

primaryResourceId?: DatabaseResourceId

[src]

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.

primaryResourceLocation?: string

[src]

Primary resource location. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional.

product?: Product

[src]

The product this resource represents.

resourceContainer?: string

[src]

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.

resourceName?: string

[src]

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

[src]

Optional. Suspension reason for the resource.

tagsSet?: Tags

[src]

Optional. Tags associated with this resources.

updationTime?: Date

[src]

The time at which the resource was updated and recorded at partner service.

userLabelSet?: UserLabels

[src]

User-provided labels associated with the resource

zone?: string

[src]

The resource zone. This is only applicable for zonal resources and will be empty for regional and multi-regional resources.