Class: Google::Cloud::GkeBackup::V1::BackupChannel

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/gkebackup/v1/backup_channel.rb

Overview

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.

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

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

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_channel.rb', line 72

class BackupChannel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#description ⇒ ::String

Returns Optional. User specified descriptive string for this BackupChannel.

Returns:

  • (::String) —

    Optional. User specified descriptive string for this BackupChannel.



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_channel.rb', line 72

class BackupChannel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#destination_project ⇒ ::String

Returns Required. Immutable. The project where Backups are allowed to be stored. 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 where Backups are allowed to be stored. The format is projects/{project}. Currently, {project} can only be the project number. Support for project IDs will be added in the future.



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_channel.rb', line 72

class BackupChannel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#destination_project_id ⇒ ::String (readonly)

Returns 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:

  • (::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.



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_channel.rb', line 72

class BackupChannel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#etag ⇒ ::String (readonly)

Returns 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:

  • (::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.



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_channel.rb', line 72

class BackupChannel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. A set of custom labels supplied by user.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. A set of custom labels supplied by user.



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_channel.rb', line 72

class BackupChannel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Identifier. The fully qualified name of the BackupChannel. projects/*/locations/*/backupChannels/*.

Returns:

  • (::String) —

    Identifier. The fully qualified name of the BackupChannel. projects/*/locations/*/backupChannels/*



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_channel.rb', line 72

class BackupChannel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#uid ⇒ ::String (readonly)

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

Returns:

  • (::String) —

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



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_channel.rb', line 72

class BackupChannel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

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

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_channel.rb', line 72

class BackupChannel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end