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

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

A BackupChannel imposes constraints on where clusters can be backed up.

The BackupChannel should be in the same project and region as the cluster being backed up. The backup can be created only in destination_project.

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

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 BackupChannel. projects/*/locations/*/backupChannels/*
↳ destination_project string

Required. Immutable. The project where Backups are allowed to be stored. The format is projects/{projectId} or projects/{projectNumber}.
↳ uid string

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

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

Output only. The timestamp when this BackupChannel resource was last updated.
↳ labels array|Google\Protobuf\Internal\MapField

Optional. A set of custom labels supplied by user.
↳ description string

Optional. User specified descriptive string for this BackupChannel.
↳ etag string

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

Output only. The project_id where Backups are allowed to be stored. Example Project ID: "my-project-id". This will be an OUTPUT_ONLY field to return the project_id of the destination project.

getName

Identifier. The fully qualified name of the BackupChannel.

projects/*/locations/*/backupChannels/*

Returns
Type Description
string

setName

Identifier. The fully qualified name of the BackupChannel.

projects/*/locations/*/backupChannels/*

Parameter
Name Description
var string
Returns
Type Description
$this

getDestinationProject

Required. Immutable. The project where Backups are allowed to be stored.

The format is projects/{projectId} or projects/{projectNumber}.

Returns
Type Description
string

setDestinationProject

Required. Immutable. The project where Backups are allowed to be stored.

The format is projects/{projectId} or projects/{projectNumber}.

Parameter
Name Description
var string
Returns
Type Description
$this

getUid

Output only. Server generated global unique identifier of UUID format.

Returns
Type Description
string

setUid

Output only. Server generated global unique identifier of UUID format.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The timestamp when this BackupChannel resource was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The timestamp when this BackupChannel resource was created.

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

getUpdateTime

Output only. The timestamp when this BackupChannel resource was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The timestamp when this BackupChannel resource was last updated.

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

getLabels

Optional. A set of custom labels supplied by user.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Optional. A set of custom labels supplied by user.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getDescription

Optional. User specified descriptive string for this BackupChannel.

Returns
Type Description
string

setDescription

Optional. User specified descriptive string for this BackupChannel.

Parameter
Name Description
var string
Returns
Type Description
$this

getEtag

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

Parameter
Name Description
var string
Returns
Type Description
$this

getDestinationProjectId

Output only. The project_id where Backups are allowed to be stored.

Example Project ID: "my-project-id". This will be an OUTPUT_ONLY field to return the project_id of the destination project.

Returns
Type Description
string

setDestinationProjectId

Output only. The project_id where Backups are allowed to be stored.

Example Project ID: "my-project-id". This will be an OUTPUT_ONLY field to return the project_id of the destination project.

Parameter
Name Description
var string
Returns
Type Description
$this