Google Cloud Native v0.28.0, Feb 2 23

google-native.sqladmin/v1beta4.getBackupRun

Retrieves a resource containing information about a backup run.

Using getBackupRun

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getBackupRun(args: GetBackupRunArgs, opts?: InvokeOptions): Promise<GetBackupRunResult>
function getBackupRunOutput(args: GetBackupRunOutputArgs, opts?: InvokeOptions): Output<GetBackupRunResult>

def get_backup_run(id: Optional[str] = None,
                   instance: Optional[str] = None,
                   project: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetBackupRunResult
def get_backup_run_output(id: Optional[pulumi.Input[str]] = None,
                   instance: Optional[pulumi.Input[str]] = None,
                   project: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetBackupRunResult]

func LookupBackupRun(ctx *Context, args *LookupBackupRunArgs, opts ...InvokeOption) (*LookupBackupRunResult, error)
func LookupBackupRunOutput(ctx *Context, args *LookupBackupRunOutputArgs, opts ...InvokeOption) LookupBackupRunResultOutput

> Note: This function is named LookupBackupRun in the Go SDK.

public static class GetBackupRun 
{
    public static Task<GetBackupRunResult> InvokeAsync(GetBackupRunArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupRunResult> Invoke(GetBackupRunInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetBackupRunResult> getBackupRun(GetBackupRunArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:sqladmin/v1beta4:getBackupRun
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string
Instance string
Project string

Id string
Instance string
Project string

id String
instance String
project String

id string
instance string
project string

id str
instance str
project str

id String
instance String
project String

getBackupRun Result

The following output properties are available:

BackupKind string: Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
Description string: The description of this run, only applicable to on-demand backups.
DiskEncryptionConfiguration Pulumi.GoogleNative.SQLAdmin.V1Beta4.Outputs.DiskEncryptionConfigurationResponse: Encryption configuration specific to a backup.
DiskEncryptionStatus Pulumi.GoogleNative.SQLAdmin.V1Beta4.Outputs.DiskEncryptionStatusResponse: Encryption status specific to a backup.
EndTime string: The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
EnqueuedTime string: The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
Error Pulumi.GoogleNative.SQLAdmin.V1Beta4.Outputs.OperationErrorResponse: Information about why the backup operation failed. This is only present if the run has the FAILED status.
Instance string: Name of the database instance.
Kind string: This is always sql#backupRun.
Location string: Location of the backups.
SelfLink string: The URI of this resource.
StartTime string: The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
Status string: The status of this run.
TimeZone string: Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.
Type string: The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests.
WindowStartTime string: The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

BackupKind string: Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
Description string: The description of this run, only applicable to on-demand backups.
DiskEncryptionConfiguration DiskEncryptionConfigurationResponse: Encryption configuration specific to a backup.
DiskEncryptionStatus DiskEncryptionStatusResponse: Encryption status specific to a backup.
EndTime string: The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
EnqueuedTime string: The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
Error OperationErrorResponse: Information about why the backup operation failed. This is only present if the run has the FAILED status.
Instance string: Name of the database instance.
Kind string: This is always sql#backupRun.
Location string: Location of the backups.
SelfLink string: The URI of this resource.
StartTime string: The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
Status string: The status of this run.
TimeZone string: Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.
Type string: The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests.
WindowStartTime string: The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

backupKind String: Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
description String: The description of this run, only applicable to on-demand backups.
diskEncryptionConfiguration DiskEncryptionConfigurationResponse: Encryption configuration specific to a backup.
diskEncryptionStatus DiskEncryptionStatusResponse: Encryption status specific to a backup.
endTime String: The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
enqueuedTime String: The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
error OperationErrorResponse: Information about why the backup operation failed. This is only present if the run has the FAILED status.
instance String: Name of the database instance.
kind String: This is always sql#backupRun.
location String: Location of the backups.
selfLink String: The URI of this resource.
startTime String: The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
status String: The status of this run.
timeZone String: Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.
type String: The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests.
windowStartTime String: The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

backupKind string: Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
description string: The description of this run, only applicable to on-demand backups.
diskEncryptionConfiguration DiskEncryptionConfigurationResponse: Encryption configuration specific to a backup.
diskEncryptionStatus DiskEncryptionStatusResponse: Encryption status specific to a backup.
endTime string: The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
enqueuedTime string: The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
error OperationErrorResponse: Information about why the backup operation failed. This is only present if the run has the FAILED status.
instance string: Name of the database instance.
kind string: This is always sql#backupRun.
location string: Location of the backups.
selfLink string: The URI of this resource.
startTime string: The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
status string: The status of this run.
timeZone string: Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.
type string: The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests.
windowStartTime string: The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

backup_kind str: Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
description str: The description of this run, only applicable to on-demand backups.
disk_encryption_configuration DiskEncryptionConfigurationResponse: Encryption configuration specific to a backup.
disk_encryption_status DiskEncryptionStatusResponse: Encryption status specific to a backup.
end_time str: The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
enqueued_time str: The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
error OperationErrorResponse: Information about why the backup operation failed. This is only present if the run has the FAILED status.
instance str: Name of the database instance.
kind str: This is always sql#backupRun.
location str: Location of the backups.
self_link str: The URI of this resource.
start_time str: The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
status str: The status of this run.
time_zone str: Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.
type str: The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests.
window_start_time str: The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

backupKind String: Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
description String: The description of this run, only applicable to on-demand backups.
diskEncryptionConfiguration Property Map: Encryption configuration specific to a backup.
diskEncryptionStatus Property Map: Encryption status specific to a backup.
endTime String: The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
enqueuedTime String: The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
error Property Map: Information about why the backup operation failed. This is only present if the run has the FAILED status.
instance String: Name of the database instance.
kind String: This is always sql#backupRun.
location String: Location of the backups.
selfLink String: The URI of this resource.
startTime String: The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
status String: The status of this run.
timeZone String: Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.
type String: The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests.
windowStartTime String: The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

Supporting Types

DiskEncryptionConfigurationResponse

Kind string: This is always sql#diskEncryptionConfiguration.
KmsKeyName string: Resource name of KMS key for disk encryption

Kind string: This is always sql#diskEncryptionConfiguration.
KmsKeyName string: Resource name of KMS key for disk encryption

kind String: This is always sql#diskEncryptionConfiguration.
kmsKeyName String: Resource name of KMS key for disk encryption

kind string: This is always sql#diskEncryptionConfiguration.
kmsKeyName string: Resource name of KMS key for disk encryption

kind str: This is always sql#diskEncryptionConfiguration.
kms_key_name str: Resource name of KMS key for disk encryption

kind String: This is always sql#diskEncryptionConfiguration.
kmsKeyName String: Resource name of KMS key for disk encryption

DiskEncryptionStatusResponse

Kind string: This is always sql#diskEncryptionStatus.
KmsKeyVersionName string: KMS key version used to encrypt the Cloud SQL instance resource

Kind string: This is always sql#diskEncryptionStatus.
KmsKeyVersionName string: KMS key version used to encrypt the Cloud SQL instance resource

kind String: This is always sql#diskEncryptionStatus.
kmsKeyVersionName String: KMS key version used to encrypt the Cloud SQL instance resource

kind string: This is always sql#diskEncryptionStatus.
kmsKeyVersionName string: KMS key version used to encrypt the Cloud SQL instance resource

kind str: This is always sql#diskEncryptionStatus.
kms_key_version_name str: KMS key version used to encrypt the Cloud SQL instance resource

kind String: This is always sql#diskEncryptionStatus.
kmsKeyVersionName String: KMS key version used to encrypt the Cloud SQL instance resource

OperationErrorResponse

Code string: Identifies the specific error that occurred.
Kind string: This is always sql#operationError.
Message string: Additional information about the error encountered.

Code string: Identifies the specific error that occurred.
Kind string: This is always sql#operationError.
Message string: Additional information about the error encountered.

code String: Identifies the specific error that occurred.
kind String: This is always sql#operationError.
message String: Additional information about the error encountered.

code string: Identifies the specific error that occurred.
kind string: This is always sql#operationError.
message string: Additional information about the error encountered.

code str: Identifies the specific error that occurred.
kind str: This is always sql#operationError.
message str: Additional information about the error encountered.

code String: Identifies the specific error that occurred.
kind String: This is always sql#operationError.
message String: Additional information about the error encountered.

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0