DatabaseResourceMetadata

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

Common model for database resource instance metadata.

interface DatabaseResourceMetadata {

availabilityConfiguration?: AvailabilityConfiguration;

backupConfiguration?: BackupConfiguration;

backupRun?: BackupRun;

creationTime?: Date;

currentState?:

| "STATE_UNSPECIFIED"

| "HEALTHY"

| "UNHEALTHY"

| "SUSPENDED"

| "DELETED"

| "STATE_OTHER";

customMetadata?: CustomMetadataData;

entitlements?: Entitlement[];

expectedState?:

| "STATE_UNSPECIFIED"

| "HEALTHY"

| "UNHEALTHY"

| "SUSPENDED"

| "DELETED"

| "STATE_OTHER";

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_OTHER";

location?: string;

primaryResourceId?: DatabaseResourceId;

product?: Product;

resourceContainer?: string;

resourceName?: string;

updationTime?: Date;

userLabels?: {

[key: string]: string;

};

userLabelSet?: UserLabels;

}

§Properties

availabilityConfiguration?: AvailabilityConfiguration

[src]

Availability configuration for this instance

backupConfiguration?: BackupConfiguration

[src]

Backup configuration for this instance

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

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.

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

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.

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

updationTime?: Date

[src]

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

userLabels?: {

[key: string]: string;

}

[src]

User-provided labels, represented as a dictionary where each label is a single key value pair.

userLabelSet?: UserLabels

[src]

User-provided labels associated with the resource