Backup for GKE V1 API - Class Google::Cloud::GkeBackup::V1::BackupChannel (v1.3.0)

Reference documentation and code samples for the Backup for GKE V1 API class Google::Cloud::GkeBackup::V1::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — Optional. User specified descriptive string for this BackupChannel.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. User specified descriptive string for this BackupChannel.
Returns
  • (::String) — Optional. User specified descriptive string for this BackupChannel.

#destination_project

def destination_project() -> ::String
Returns
  • (::String) — Required. Immutable. The project where Backups are allowed to be stored. The format is projects/{projectId} or projects/{projectNumber}.

#destination_project=

def destination_project=(value) -> ::String
Parameter
  • value (::String) — Required. Immutable. The project where Backups are allowed to be stored. The format is projects/{projectId} or projects/{projectNumber}.
Returns
  • (::String) — Required. Immutable. The project where Backups are allowed to be stored. The format is projects/{projectId} or projects/{projectNumber}.

#destination_project_id

def destination_project_id() -> ::String
Returns
  • (::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.

#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 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.

#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 BackupChannel. projects/*/locations/*/backupChannels/*

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. The fully qualified name of the BackupChannel. projects/*/locations/*/backupChannels/*
Returns
  • (::String) — Identifier. The fully qualified name of the BackupChannel. projects/*/locations/*/backupChannels/*

#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