Google Cloud Gke Backup V1 Client - Class BackupPlanBinding (1.2.0)

Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class BackupPlanBinding.

A BackupPlanBinding binds a BackupPlan with a BackupChannel.

This resource is created automatically when a BackupPlan is created using a BackupChannel. This also serves as a holder for cross-project fields that need to be displayed in the current project.

Generated from protobuf message google.cloud.gkebackup.v1.BackupPlanBinding

Namespace

Google \ Cloud \ GkeBackup \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Identifier. The fully qualified name of the BackupPlanBinding. projects/*/locations/*/backupChannels/*/backupPlanBindings/*
↳ uid string

Output only. Server generated global unique identifier of UUID4
↳ create_time Google\Protobuf\Timestamp

Output only. The timestamp when this binding was created.
↳ update_time Google\Protobuf\Timestamp

Output only. The timestamp when this binding was created.
↳ backup_plan string

Output only. Immutable. The fully qualified name of the BackupPlan bound with the parent BackupChannel. projects/*/locations/*/backupPlans/{backup_plan}
↳ cluster string

Output only. Immutable. The fully qualified name of the cluster that is being backed up Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/*
↳ backup_plan_details BackupPlanBinding\BackupPlanDetails

Output only. Contains details about the backup plan/backup.
↳ etag string

Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a BackupPlanBinding from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlanBinding updates in order to avoid race conditions: An etag is returned in the response to GetBackupPlanBinding, and systems are expected to put that etag in the request to UpdateBackupPlanBinding or DeleteBackupPlanBinding to ensure that their change will be applied to the same version of the resource.

getName

Identifier. The fully qualified name of the BackupPlanBinding.

projects/*/locations/*/backupChannels/*/backupPlanBindings/*

Returns
Type Description
string

setName

Identifier. The fully qualified name of the BackupPlanBinding.

projects/*/locations/*/backupChannels/*/backupPlanBindings/*

Parameter
Name Description
var string
Returns
Type Description
$this

getUid

Output only. Server generated global unique identifier of UUID4

Returns
Type Description
string

setUid

Output only. Server generated global unique identifier of UUID4

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The timestamp when this binding was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The timestamp when this binding was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. The timestamp when this binding was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The timestamp when this binding was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getBackupPlan

Output only. Immutable. The fully qualified name of the BackupPlan bound with the parent BackupChannel.

projects/*/locations/*/backupPlans/{backup_plan}

Returns
Type Description
string

setBackupPlan

Output only. Immutable. The fully qualified name of the BackupPlan bound with the parent BackupChannel.

projects/*/locations/*/backupPlans/{backup_plan}

Parameter
Name Description
var string
Returns
Type Description
$this

getCluster

Output only. Immutable. The fully qualified name of the cluster that is being backed up Valid formats:

  • projects/*/locations/*/clusters/*
  • projects/*/zones/*/clusters/*
Returns
Type Description
string

setCluster

Output only. Immutable. The fully qualified name of the cluster that is being backed up Valid formats:

  • projects/*/locations/*/clusters/*
  • projects/*/zones/*/clusters/*
Parameter
Name Description
var string
Returns
Type Description
$this

getBackupPlanDetails

Output only. Contains details about the backup plan/backup.

Returns
Type Description
BackupPlanBinding\BackupPlanDetails|null

hasBackupPlanDetails

clearBackupPlanDetails

setBackupPlanDetails

Output only. Contains details about the backup plan/backup.

Parameter
Name Description
var BackupPlanBinding\BackupPlanDetails
Returns
Type Description
$this

getEtag

Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a BackupPlanBinding from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlanBinding updates in order to avoid race conditions: An etag is returned in the response to GetBackupPlanBinding, and systems are expected to put that etag in the request to UpdateBackupPlanBinding or DeleteBackupPlanBinding to ensure that their change will be applied to the same version of the resource.

Returns
Type Description
string

setEtag

Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a BackupPlanBinding from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlanBinding updates in order to avoid race conditions: An etag is returned in the response to GetBackupPlanBinding, and systems are expected to put that etag in the request to UpdateBackupPlanBinding or DeleteBackupPlanBinding to ensure that their change will be applied to the same version of the resource.

Parameter
Name Description
var string
Returns
Type Description
$this