Class protos.google.cloud.alloydb.v1alpha.AutomatedBackupPolicy (1.10.1)

Represents an AutomatedBackupPolicy.

Package

@google-cloud/alloydb

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.alloydb.v1alpha.IAutomatedBackupPolicy);

Constructs a new AutomatedBackupPolicy.

Parameter
Name Description
properties IAutomatedBackupPolicy

Properties to set

Properties

_enabled

public _enabled?: "enabled";

AutomatedBackupPolicy _enabled.

backupWindow

public backupWindow?: (google.protobuf.IDuration|null);

AutomatedBackupPolicy backupWindow.

enabled

public enabled?: (boolean|null);

AutomatedBackupPolicy enabled.

encryptionConfig

public encryptionConfig?: (google.cloud.alloydb.v1alpha.IEncryptionConfig|null);

AutomatedBackupPolicy encryptionConfig.

labels

public labels: { [k: string]: string };

AutomatedBackupPolicy labels.

location

public location: string;

AutomatedBackupPolicy location.

quantityBasedRetention

public quantityBasedRetention?: (google.cloud.alloydb.v1alpha.AutomatedBackupPolicy.IQuantityBasedRetention|null);

AutomatedBackupPolicy quantityBasedRetention.

retention

public retention?: ("timeBasedRetention"|"quantityBasedRetention");

AutomatedBackupPolicy retention.

schedule

public schedule?: "weeklySchedule";

AutomatedBackupPolicy schedule.

timeBasedRetention

public timeBasedRetention?: (google.cloud.alloydb.v1alpha.AutomatedBackupPolicy.ITimeBasedRetention|null);

AutomatedBackupPolicy timeBasedRetention.

weeklySchedule

public weeklySchedule?: (google.cloud.alloydb.v1alpha.AutomatedBackupPolicy.IWeeklySchedule|null);

AutomatedBackupPolicy weeklySchedule.

Methods

create(properties)

public static create(properties?: google.cloud.alloydb.v1alpha.IAutomatedBackupPolicy): google.cloud.alloydb.v1alpha.AutomatedBackupPolicy;

Creates a new AutomatedBackupPolicy instance using the specified properties.

Parameter
Name Description
properties IAutomatedBackupPolicy

Properties to set

Returns
Type Description
AutomatedBackupPolicy

AutomatedBackupPolicy instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.alloydb.v1alpha.AutomatedBackupPolicy;

Decodes an AutomatedBackupPolicy 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
AutomatedBackupPolicy

AutomatedBackupPolicy

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.alloydb.v1alpha.AutomatedBackupPolicy;

Decodes an AutomatedBackupPolicy message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
AutomatedBackupPolicy

AutomatedBackupPolicy

encode(message, writer)

public static encode(message: google.cloud.alloydb.v1alpha.IAutomatedBackupPolicy, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified AutomatedBackupPolicy message. Does not implicitly messages.

Parameters
Name Description
message IAutomatedBackupPolicy

AutomatedBackupPolicy 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.alloydb.v1alpha.IAutomatedBackupPolicy, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified AutomatedBackupPolicy message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IAutomatedBackupPolicy

AutomatedBackupPolicy 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.alloydb.v1alpha.AutomatedBackupPolicy;

Creates an AutomatedBackupPolicy 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
AutomatedBackupPolicy

AutomatedBackupPolicy

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for AutomatedBackupPolicy

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 AutomatedBackupPolicy to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.alloydb.v1alpha.AutomatedBackupPolicy, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from an AutomatedBackupPolicy message. Also converts values to other types if specified.

Parameters
Name Description
message AutomatedBackupPolicy

AutomatedBackupPolicy

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 an AutomatedBackupPolicy message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not