Filestore V1 API - Class Google::Cloud::Filestore::V1::Backup (v2.3.0)

Reference documentation and code samples for the Filestore V1 API class Google::Cloud::Filestore::V1::Backup.

A Filestore backup.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#capacity_gb

def capacity_gb() -> ::Integer
Returns
  • (::Integer) — Output only. Capacity of the source file share when the backup was created.

#create_time

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

#description

def description() -> ::String
Returns
  • (::String) — A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
Returns
  • (::String) — A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.

#download_bytes

def download_bytes() -> ::Integer
Returns
  • (::Integer) — Output only. Amount of bytes that will be downloaded if the backup is restored. This may be different than storage bytes, since sequential backups of the same disk will share storage.

#file_system_protocol

def file_system_protocol() -> ::Google::Cloud::Filestore::V1::Instance::FileProtocol
Returns

#kms_key

def kms_key() -> ::String
Returns
  • (::String) — Immutable. KMS key name used for data encryption.

#kms_key=

def kms_key=(value) -> ::String
Parameter
  • value (::String) — Immutable. KMS key name used for data encryption.
Returns
  • (::String) — Immutable. KMS key name used for data encryption.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Resource labels to represent user provided metadata.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Resource labels to represent user provided metadata.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Resource labels to represent user provided metadata.

#name

def name() -> ::String
Returns
  • (::String) — Output only. The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}.

#satisfies_pzi

def satisfies_pzi() -> ::Boolean
Returns
  • (::Boolean) — Output only. Reserved for future use.

#satisfies_pzs

def satisfies_pzs() -> ::Google::Protobuf::BoolValue
Returns

#source_file_share

def source_file_share() -> ::String
Returns
  • (::String) — Name of the file share in the source Filestore instance that the backup is created from.

#source_file_share=

def source_file_share=(value) -> ::String
Parameter
  • value (::String) — Name of the file share in the source Filestore instance that the backup is created from.
Returns
  • (::String) — Name of the file share in the source Filestore instance that the backup is created from.

#source_instance

def source_instance() -> ::String
Returns
  • (::String) — The resource name of the source Filestore instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}, used to create this backup.

#source_instance=

def source_instance=(value) -> ::String
Parameter
  • value (::String) — The resource name of the source Filestore instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}, used to create this backup.
Returns
  • (::String) — The resource name of the source Filestore instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}, used to create this backup.

#source_instance_tier

def source_instance_tier() -> ::Google::Cloud::Filestore::V1::Instance::Tier
Returns

#state

def state() -> ::Google::Cloud::Filestore::V1::Backup::State
Returns

#storage_bytes

def storage_bytes() -> ::Integer
Returns
  • (::Integer) — Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.

#tags

def tags() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. Input only. Immutable. Tag key-value pairs bound to this resource. Each key must be a namespaced name and each value a short name. Example: "123456789012/environment" : "production", "123456789013/costCenter" : "marketing" See the documentation for more information:

    • Namespaced name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key
    • Short name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_value

#tags=

def tags=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) —

    Optional. Input only. Immutable. Tag key-value pairs bound to this resource. Each key must be a namespaced name and each value a short name. Example: "123456789012/environment" : "production", "123456789013/costCenter" : "marketing" See the documentation for more information:

    • Namespaced name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key
    • Short name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_value
Returns
  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. Input only. Immutable. Tag key-value pairs bound to this resource. Each key must be a namespaced name and each value a short name. Example: "123456789012/environment" : "production", "123456789013/costCenter" : "marketing" See the documentation for more information:

    • Namespaced name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key
    • Short name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_value