Class protos.google.cloud.sql.v1beta4.BackupConfiguration (0.14.0)

Represents a BackupConfiguration.

Package

@google-cloud/sql

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.sql.v1beta4.IBackupConfiguration);

Constructs a new BackupConfiguration.

Parameter
Name Description
properties IBackupConfiguration

Properties to set

Properties

_transactionalLogStorageState

public _transactionalLogStorageState?: "transactionalLogStorageState";

BackupConfiguration _transactionalLogStorageState.

backupRetentionSettings

public backupRetentionSettings?: (google.cloud.sql.v1beta4.IBackupRetentionSettings|null);

BackupConfiguration backupRetentionSettings.

binaryLogEnabled

public binaryLogEnabled?: (google.protobuf.IBoolValue|null);

BackupConfiguration binaryLogEnabled.

enabled

public enabled?: (google.protobuf.IBoolValue|null);

BackupConfiguration enabled.

kind

public kind: string;

BackupConfiguration kind.

location

public location: string;

BackupConfiguration location.

pointInTimeRecoveryEnabled

public pointInTimeRecoveryEnabled?: (google.protobuf.IBoolValue|null);

BackupConfiguration pointInTimeRecoveryEnabled.

replicationLogArchivingEnabled

public replicationLogArchivingEnabled?: (google.protobuf.IBoolValue|null);

BackupConfiguration replicationLogArchivingEnabled.

startTime

public startTime: string;

BackupConfiguration startTime.

transactionalLogStorageState

public transactionalLogStorageState?: (google.cloud.sql.v1beta4.BackupConfiguration.TransactionalLogStorageState|keyof typeof google.cloud.sql.v1beta4.BackupConfiguration.TransactionalLogStorageState|null);

BackupConfiguration transactionalLogStorageState.

transactionLogRetentionDays

public transactionLogRetentionDays?: (google.protobuf.IInt32Value|null);

BackupConfiguration transactionLogRetentionDays.

Methods

create(properties)

public static create(properties?: google.cloud.sql.v1beta4.IBackupConfiguration): google.cloud.sql.v1beta4.BackupConfiguration;

Creates a new BackupConfiguration instance using the specified properties.

Parameter
Name Description
properties IBackupConfiguration

Properties to set

Returns
Type Description
BackupConfiguration

BackupConfiguration instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.sql.v1beta4.BackupConfiguration;

Decodes a BackupConfiguration 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
BackupConfiguration

BackupConfiguration

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.sql.v1beta4.BackupConfiguration;

Decodes a BackupConfiguration message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
BackupConfiguration

BackupConfiguration

encode(message, writer)

public static encode(message: google.cloud.sql.v1beta4.IBackupConfiguration, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified BackupConfiguration message. Does not implicitly messages.

Parameters
Name Description
message IBackupConfiguration

BackupConfiguration 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.sql.v1beta4.IBackupConfiguration, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IBackupConfiguration

BackupConfiguration 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.sql.v1beta4.BackupConfiguration;

Creates a BackupConfiguration 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
BackupConfiguration

BackupConfiguration

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for BackupConfiguration

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message BackupConfiguration

BackupConfiguration

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 BackupConfiguration 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