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

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

A RestoreChannel imposes constraints on where backups can be restored.

The RestoreChannel should be in the same project and region as the backups. The backups can only be restored in the destination_project.

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

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

Required. Immutable. The project into which the backups will be restored. 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 RestoreChannel was created.
↳ update_time Google\Protobuf\Timestamp

Output only. The timestamp when this RestoreChannel 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 RestoreChannel.
↳ etag string

Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a RestoreChannel from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform RestoreChannel updates in order to avoid race conditions: An etag is returned in the response to GetRestoreChannel, and systems are expected to put that etag in the request to UpdateRestoreChannel or DeleteRestoreChannel 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 will be restored. 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 RestoreChannel.

projects/*/locations/*/restoreChannels/*

Returns
Type Description
string

setName

Identifier. The fully qualified name of the RestoreChannel.

projects/*/locations/*/restoreChannels/*

Parameter
Name Description
var string
Returns
Type Description
$this

getDestinationProject

Required. Immutable. The project into which the backups will be restored.

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

Returns
Type Description
string

setDestinationProject

Required. Immutable. The project into which the backups will be restored.

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 RestoreChannel was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The timestamp when this RestoreChannel was created.

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

getUpdateTime

Output only. The timestamp when this RestoreChannel was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The timestamp when this RestoreChannel 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 RestoreChannel.

Returns
Type Description
string

setDescription

Optional. User specified descriptive string for this RestoreChannel.

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 RestoreChannel from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform RestoreChannel updates in order to avoid race conditions: An etag is returned in the response to GetRestoreChannel, and systems are expected to put that etag in the request to UpdateRestoreChannel or DeleteRestoreChannel 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 RestoreChannel from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform RestoreChannel updates in order to avoid race conditions: An etag is returned in the response to GetRestoreChannel, and systems are expected to put that etag in the request to UpdateRestoreChannel or DeleteRestoreChannel 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 will be restored.

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 will be restored.

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