(::String) — A description of the backup with 2048 characters or less.
Requests with longer descriptions will be rejected.
#description=
defdescription=(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
defdownload_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.
(::String) — Name of the file share in the source Filestore instance that the
backup is created from.
#source_file_share=
defsource_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
defsource_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=
defsource_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.
(::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.
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:
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:
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:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Filestore V1 API - Class Google::Cloud::Filestore::V1::Backup (v2.2.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.2.0 (latest)](/ruby/docs/reference/google-cloud-filestore-v1/latest/Google-Cloud-Filestore-V1-Backup)\n- [2.1.1](/ruby/docs/reference/google-cloud-filestore-v1/2.1.1/Google-Cloud-Filestore-V1-Backup)\n- [2.0.0](/ruby/docs/reference/google-cloud-filestore-v1/2.0.0/Google-Cloud-Filestore-V1-Backup)\n- [1.2.0](/ruby/docs/reference/google-cloud-filestore-v1/1.2.0/Google-Cloud-Filestore-V1-Backup)\n- [1.1.0](/ruby/docs/reference/google-cloud-filestore-v1/1.1.0/Google-Cloud-Filestore-V1-Backup)\n- [1.0.1](/ruby/docs/reference/google-cloud-filestore-v1/1.0.1/Google-Cloud-Filestore-V1-Backup)\n- [0.9.0](/ruby/docs/reference/google-cloud-filestore-v1/0.9.0/Google-Cloud-Filestore-V1-Backup)\n- [0.8.2](/ruby/docs/reference/google-cloud-filestore-v1/0.8.2/Google-Cloud-Filestore-V1-Backup)\n- [0.7.0](/ruby/docs/reference/google-cloud-filestore-v1/0.7.0/Google-Cloud-Filestore-V1-Backup)\n- [0.6.0](/ruby/docs/reference/google-cloud-filestore-v1/0.6.0/Google-Cloud-Filestore-V1-Backup)\n- [0.5.0](/ruby/docs/reference/google-cloud-filestore-v1/0.5.0/Google-Cloud-Filestore-V1-Backup)\n- [0.4.1](/ruby/docs/reference/google-cloud-filestore-v1/0.4.1/Google-Cloud-Filestore-V1-Backup)\n- [0.3.0](/ruby/docs/reference/google-cloud-filestore-v1/0.3.0/Google-Cloud-Filestore-V1-Backup)\n- [0.2.0](/ruby/docs/reference/google-cloud-filestore-v1/0.2.0/Google-Cloud-Filestore-V1-Backup)\n- [0.1.3](/ruby/docs/reference/google-cloud-filestore-v1/0.1.3/Google-Cloud-Filestore-V1-Backup) \nReference documentation and code samples for the Filestore V1 API class Google::Cloud::Filestore::V1::Backup.\n\nA Filestore backup. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #capacity_gb\n\n def capacity_gb() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- Output only. Capacity of the source file share when the backup was created.\n\n### #create_time\n\n def create_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The time when the backup was created.\n\n### #description\n\n def description() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.\n\n### #description=\n\n def description=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. \n**Returns**\n\n- (::String) --- A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.\n\n### #download_bytes\n\n def download_bytes() -\u003e ::Integer\n\n**Returns**\n\n- (::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.\n\n### #file_system_protocol\n\n def file_system_protocol() -\u003e ::Google::Cloud::Filestore::V1::Instance::FileProtocol\n\n**Returns**\n\n- ([::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.\n\n### #kms_key\n\n def kms_key() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Immutable. KMS key name used for data encryption.\n\n### #kms_key=\n\n def kms_key=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Immutable. KMS key name used for data encryption. \n**Returns**\n\n- (::String) --- Immutable. KMS key name used for data encryption.\n\n### #labels\n\n def labels() -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Resource labels to represent user provided metadata.\n\n### #labels=\n\n def labels=(value) -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Parameter**\n\n- **value** (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Resource labels to represent user provided metadata. \n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Resource labels to represent user provided metadata.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. The resource name of the backup, in the format `projects/{project_number}/locations/{location_id}/backups/{backup_id}`.\n\n### #satisfies_pzi\n\n def satisfies_pzi() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Output only. Reserved for future use.\n\n### #satisfies_pzs\n\n def satisfies_pzs() -\u003e ::Google::Protobuf::BoolValue\n\n**Returns**\n\n- ([::Google::Protobuf::BoolValue](./Google-Protobuf-BoolValue)) --- Output only. Reserved for future use.\n\n### #source_file_share\n\n def source_file_share() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Name of the file share in the source Filestore instance that the backup is created from.\n\n### #source_file_share=\n\n def source_file_share=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Name of the file share in the source Filestore instance that the backup is created from. \n**Returns**\n\n- (::String) --- Name of the file share in the source Filestore instance that the backup is created from.\n\n### #source_instance\n\n def source_instance() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n### #source_instance=\n\n def source_instance=(value) -\u003e ::String\n\n**Parameter**\n\n- **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. \n**Returns**\n\n- (::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.\n\n### #source_instance_tier\n\n def source_instance_tier() -\u003e ::Google::Cloud::Filestore::V1::Instance::Tier\n\n**Returns**\n\n- ([::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.\n\n### #state\n\n def state() -\u003e ::Google::Cloud::Filestore::V1::Backup::State\n\n**Returns**\n\n- ([::Google::Cloud::Filestore::V1::Backup::State](./Google-Cloud-Filestore-V1-Backup-State)) --- Output only. The backup state.\n\n### #storage_bytes\n\n def storage_bytes() -\u003e ::Integer\n\n**Returns**\n\n- (::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.\n\n### #tags\n\n def tags() -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Optional. Input only. Immutable. Tag key-value pairs bound to this\n resource. Each key must be a namespaced name and each value a short name.\n Example:\n \"123456789012/environment\" : \"production\",\n \"123456789013/costCenter\" : \"marketing\"\n See the documentation for more information:\n\n - Namespaced name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key\n - Short name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_value\n\n### #tags=\n\n def tags=(value) -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Parameter**\n\n- **value** (::Google::Protobuf::Map{::String =\\\u003e ::String}) ---\n\n Optional. Input only. Immutable. Tag key-value pairs bound to this\n resource. Each key must be a namespaced name and each value a short name.\n Example:\n \"123456789012/environment\" : \"production\",\n \"123456789013/costCenter\" : \"marketing\"\n See the documentation for more information:\n - Namespaced name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key\n- Short name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_value \n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Optional. Input only. Immutable. Tag key-value pairs bound to this\n resource. Each key must be a namespaced name and each value a short name.\n Example:\n \"123456789012/environment\" : \"production\",\n \"123456789013/costCenter\" : \"marketing\"\n See the documentation for more information:\n\n - Namespaced name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key\n - Short name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_value"]]
