Class protos.google.cloud.sql.v1.BackupRun (0.13.0)
Represents a BackupRun.
Package
@google-cloud/sqlConstructors
(constructor)(properties)
constructor(properties?:google.cloud.sql.v1.IBackupRun);Constructs a new BackupRun.
| Parameter | |
|---|---|
| Name | Description |
properties | IBackupRunProperties to set |
Properties
backupKind
publicbackupKind:(google.cloud.sql.v1.SqlBackupKind|keyoftypeofgoogle.cloud.sql.v1.SqlBackupKind);BackupRun backupKind.
description
publicdescription:string;BackupRun description.
diskEncryptionConfiguration
publicdiskEncryptionConfiguration?:(google.cloud.sql.v1.IDiskEncryptionConfiguration|null);BackupRun diskEncryptionConfiguration.
diskEncryptionStatus
publicdiskEncryptionStatus?:(google.cloud.sql.v1.IDiskEncryptionStatus|null);BackupRun diskEncryptionStatus.
endTime
publicendTime?:(google.protobuf.ITimestamp|null);BackupRun endTime.
enqueuedTime
publicenqueuedTime?:(google.protobuf.ITimestamp|null);BackupRun enqueuedTime.
error
publicerror?:(google.cloud.sql.v1.IOperationError|null);BackupRun error.
id
publicid:(number|Long|string);BackupRun id.
instance
publicinstance:string;BackupRun instance.
kind
publickind:string;BackupRun kind.
location
publiclocation:string;BackupRun location.
selfLink
publicselfLink:string;BackupRun selfLink.
startTime
publicstartTime?:(google.protobuf.ITimestamp|null);BackupRun startTime.
status
publicstatus:(google.cloud.sql.v1.SqlBackupRunStatus|keyoftypeofgoogle.cloud.sql.v1.SqlBackupRunStatus);BackupRun status.
timeZone
publictimeZone:string;BackupRun timeZone.
type
publictype:(google.cloud.sql.v1.SqlBackupRunType|keyoftypeofgoogle.cloud.sql.v1.SqlBackupRunType);BackupRun type.
windowStartTime
publicwindowStartTime?:(google.protobuf.ITimestamp|null);BackupRun windowStartTime.
Methods
create(properties)
publicstaticcreate(properties?:google.cloud.sql.v1.IBackupRun):google.cloud.sql.v1.BackupRun;Creates a new BackupRun instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties | IBackupRunProperties to set |
| Returns | |
|---|---|
| Type | Description |
BackupRun | BackupRun instance |
decode(reader, length)
publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.cloud.sql.v1.BackupRun;Decodes a BackupRun message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
length | numberMessage length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
BackupRun | BackupRun |
decodeDelimited(reader)
publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.cloud.sql.v1.BackupRun;Decodes a BackupRun message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
BackupRun | BackupRun |
encode(message, writer)
publicstaticencode(message:google.cloud.sql.v1.IBackupRun,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified BackupRun message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IBackupRunBackupRun message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
publicstaticencodeDelimited(message:google.cloud.sql.v1.IBackupRun,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified BackupRun message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IBackupRunBackupRun message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
publicstaticfromObject(object:{[k:string]:any}):google.cloud.sql.v1.BackupRun;Creates a BackupRun 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 |
BackupRun | BackupRun |
getTypeUrl(typeUrlPrefix)
publicstaticgetTypeUrl(typeUrlPrefix?:string):string;Gets the default type url for BackupRun
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix | stringyour custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
publictoJSON():{[k:string]:any};Converts this BackupRun to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
publicstatictoObject(message:google.cloud.sql.v1.BackupRun,options?:$protobuf.IConversionOptions):{[k:string]:any};Creates a plain object from a BackupRun message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message | BackupRunBackupRun |
options | $protobuf.IConversionOptionsConversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
publicstaticverify(message:{[k:string]:any}):(string|null);Verifies a BackupRun message.
| Parameter | |
|---|---|
| Name | Description |
message | { [k: string]: any }Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-03 UTC.