Represents a BackupPlanAssociation.
Package
@google-cloud/backupdrConstructors
(constructor)(properties)
constructor(properties?: google.cloud.backupdr.v1.IBackupPlanAssociation);Constructs a new BackupPlanAssociation.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBackupPlanAssociation
Properties to set |
Properties
backupPlan
public backupPlan: string;BackupPlanAssociation backupPlan.
backupPlanRevisionId
public backupPlanRevisionId: string;BackupPlanAssociation backupPlanRevisionId.
backupPlanRevisionName
public backupPlanRevisionName: string;BackupPlanAssociation backupPlanRevisionName.
cloudSqlInstanceBackupPlanAssociationProperties
public cloudSqlInstanceBackupPlanAssociationProperties?: (google.cloud.backupdr.v1.ICloudSqlInstanceBackupPlanAssociationProperties|null);BackupPlanAssociation cloudSqlInstanceBackupPlanAssociationProperties.
createTime
public createTime?: (google.protobuf.ITimestamp|null);BackupPlanAssociation createTime.
dataSource
public dataSource: string;BackupPlanAssociation dataSource.
name
public name: string;BackupPlanAssociation name.
resource
public resource: string;BackupPlanAssociation resource.
resourceProperties
public resourceProperties?: "cloudSqlInstanceBackupPlanAssociationProperties";BackupPlanAssociation resourceProperties.
resourceType
public resourceType: string;BackupPlanAssociation resourceType.
rulesConfigInfo
public rulesConfigInfo: google.cloud.backupdr.v1.IRuleConfigInfo[];BackupPlanAssociation rulesConfigInfo.
state
public state: (google.cloud.backupdr.v1.BackupPlanAssociation.State|keyof typeof google.cloud.backupdr.v1.BackupPlanAssociation.State);BackupPlanAssociation state.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);BackupPlanAssociation updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.backupdr.v1.IBackupPlanAssociation): google.cloud.backupdr.v1.BackupPlanAssociation;Creates a new BackupPlanAssociation instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBackupPlanAssociation
Properties to set |
| Returns | |
|---|---|
| Type | Description |
BackupPlanAssociation |
BackupPlanAssociation instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.backupdr.v1.BackupPlanAssociation;Decodes a BackupPlanAssociation message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
BackupPlanAssociation |
BackupPlanAssociation |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.backupdr.v1.BackupPlanAssociation;Decodes a BackupPlanAssociation message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
BackupPlanAssociation |
BackupPlanAssociation |
encode(message, writer)
public static encode(message: google.cloud.backupdr.v1.IBackupPlanAssociation, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified BackupPlanAssociation message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBackupPlanAssociation
BackupPlanAssociation message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.backupdr.v1.IBackupPlanAssociation, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified BackupPlanAssociation message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBackupPlanAssociation
BackupPlanAssociation message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.backupdr.v1.BackupPlanAssociation;Creates a BackupPlanAssociation message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
BackupPlanAssociation |
BackupPlanAssociation |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for BackupPlanAssociation
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this BackupPlanAssociation to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.backupdr.v1.BackupPlanAssociation, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a BackupPlanAssociation message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
BackupPlanAssociation
BackupPlanAssociation |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a BackupPlanAssociation message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|