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
- (::Integer) — Output only. Capacity of the source file share when the backup was created.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. The time when the backup was created.
#description
def description() -> ::String
- (::String) — A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
#description=
def description=(value) -> ::String
- value (::String) — A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
- (::String) — A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
#download_bytes
def download_bytes() -> ::Integer
- (::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
- (::Google::Cloud::Filestore::V1::Instance::FileProtocol) — Output only. The file system protocol of the source Filestore instance that this backup is created from.
#kms_key
def kms_key() -> ::String
- (::String) — Immutable. KMS key name used for data encryption.
#kms_key=
def kms_key=(value) -> ::String
- value (::String) — Immutable. KMS key name used for data encryption.
- (::String) — Immutable. KMS key name used for data encryption.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
- (::Google::Protobuf::Map{::String => ::String}) — Resource labels to represent user provided metadata.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
- value (::Google::Protobuf::Map{::String => ::String}) — Resource labels to represent user provided metadata.
- (::Google::Protobuf::Map{::String => ::String}) — Resource labels to represent user provided metadata.
#name
def name() -> ::String
-
(::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
- (::Boolean) — Output only. Reserved for future use.
#satisfies_pzs
def satisfies_pzs() -> ::Google::Protobuf::BoolValue
- (::Google::Protobuf::BoolValue) — Output only. Reserved for future use.
#source_file_share
def source_file_share() -> ::String
- (::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
- value (::String) — Name of the file share in the source Filestore instance that the backup is created from.
- (::String) — Name of the file share in the source Filestore instance that the backup is created from.
#source_instance
def source_instance() -> ::String
-
(::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
-
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.
-
(::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
- (::Google::Cloud::Filestore::V1::Instance::Tier) — Output only. The service tier of the source Filestore instance that this backup is created from.
#state
def state() -> ::Google::Cloud::Filestore::V1::Backup::State
- (::Google::Cloud::Filestore::V1::Backup::State) — Output only. The backup state.
#storage_bytes
def storage_bytes() -> ::Integer
- (::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}
-
(::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}
-
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
-
(::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