Reference documentation and code samples for the Backup for GKE V1 API class Google::Cloud::GkeBackup::V1::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
.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The timestamp when this RestoreChannel was created.
#description
def description() -> ::String
Returns
- (::String) — Optional. User specified descriptive string for this RestoreChannel.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Optional. User specified descriptive string for this RestoreChannel.
Returns
- (::String) — Optional. User specified descriptive string for this RestoreChannel.
#destination_project
def destination_project() -> ::String
Returns
-
(::String) — Required. Immutable. The project into which the backups will be restored.
The format is
projects/{project}
. Currently, {project} can only be the project number. Support for project IDs will be added in the future.
#destination_project=
def destination_project=(value) -> ::String
Parameter
-
value (::String) — Required. Immutable. The project into which the backups will be restored.
The format is
projects/{project}
. Currently, {project} can only be the project number. Support for project IDs will be added in the future.
Returns
-
(::String) — Required. Immutable. The project into which the backups will be restored.
The format is
projects/{project}
. Currently, {project} can only be the project number. Support for project IDs will be added in the future.
#destination_project_id
def destination_project_id() -> ::String
Returns
- (::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.
#etag
def etag() -> ::String
Returns
-
(::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: Anetag
is returned in the response toGetRestoreChannel
, and systems are expected to put that etag in the request toUpdateRestoreChannel
orDeleteRestoreChannel
to ensure that their change will be applied to the same version of the resource.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. A set of custom labels supplied by user.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Optional. A set of custom labels supplied by user.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. A set of custom labels supplied by user.
#name
def name() -> ::String
Returns
-
(::String) — Identifier. The fully qualified name of the RestoreChannel.
projects/*/locations/*/restoreChannels/*
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — Identifier. The fully qualified name of the RestoreChannel.
projects/*/locations/*/restoreChannels/*
Returns
-
(::String) — Identifier. The fully qualified name of the RestoreChannel.
projects/*/locations/*/restoreChannels/*
#uid
def uid() -> ::String
Returns
- (::String) — Output only. Server generated global unique identifier of UUID format.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The timestamp when this RestoreChannel was last updated.