Class: Google::Apis::FileV1::Backup

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/file_v1/classes.rb,
lib/google/apis/file_v1/representations.rb,
lib/google/apis/file_v1/representations.rb

Overview

A Filestore backup.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Backup

Returns a new instance of Backup.



117
118
119
 
# File 'lib/google/apis/file_v1/classes.rb', line 117

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#capacity_gb ⇒ Fixnum

Output only. Capacity of the source file share when the backup was created. Corresponds to the JSON property capacityGb

Returns:

  • (Fixnum) 


32
33
34
 
# File 'lib/google/apis/file_v1/classes.rb', line 32

def capacity_gb
  @capacity_gb
end

#create_time ⇒ String

Output only. The time when the backup was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


37
38
39
 
# File 'lib/google/apis/file_v1/classes.rb', line 37

def create_time
  @create_time
end

#description ⇒ String

A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. Corresponds to the JSON property description

Returns:

  • (String) 


43
44
45
 
# File 'lib/google/apis/file_v1/classes.rb', line 43

def description
  @description
end

#download_bytes ⇒ Fixnum

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. Corresponds to the JSON property downloadBytes

Returns:

  • (Fixnum) 


50
51
52
 
# File 'lib/google/apis/file_v1/classes.rb', line 50

def download_bytes
  @download_bytes
end

#kms_key ⇒ String

Immutable. KMS key name used for data encryption. Corresponds to the JSON property kmsKey

Returns:

  • (String) 


55
56
57
 
# File 'lib/google/apis/file_v1/classes.rb', line 55

def kms_key
  @kms_key
end

#labels ⇒ Hash<String,String>

Resource labels to represent user provided metadata. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


60
61
62
 
# File 'lib/google/apis/file_v1/classes.rb', line 60

def labels
  @labels
end

#name ⇒ String

Output only. The resource name of the backup, in the format projects/ project_number/locations/location_id/backups/backup_id`. Corresponds to the JSON propertyname`

Returns:

  • (String) 


66
67
68
 
# File 'lib/google/apis/file_v1/classes.rb', line 66

def name
  @name
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


71
72
73
 
# File 'lib/google/apis/file_v1/classes.rb', line 71

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


77
78
79
 
# File 'lib/google/apis/file_v1/classes.rb', line 77

def satisfies_pzs
  @satisfies_pzs
end

#source_file_share ⇒ String

Name of the file share in the source Filestore instance that the backup is created from. Corresponds to the JSON property sourceFileShare

Returns:

  • (String) 


84
85
86
 
# File 'lib/google/apis/file_v1/classes.rb', line 84

def source_file_share
  @source_file_share
end

#source_instance ⇒ 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. Corresponds to the JSON propertysourceInstance`

Returns:

  • (String) 


91
92
93
 
# File 'lib/google/apis/file_v1/classes.rb', line 91

def source_instance
  @source_instance
end

#source_instance_tier ⇒ String

Output only. The service tier of the source Filestore instance that this backup is created from. Corresponds to the JSON property sourceInstanceTier

Returns:

  • (String) 


97
98
99
 
# File 'lib/google/apis/file_v1/classes.rb', line 97

def source_instance_tier
  @source_instance_tier
end

#state ⇒ String

Output only. The backup state. Corresponds to the JSON property state

Returns:

  • (String) 


102
103
104
 
# File 'lib/google/apis/file_v1/classes.rb', line 102

def state
  @state
end

#storage_bytes ⇒ Fixnum

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. Corresponds to the JSON property storageBytes

Returns:

  • (Fixnum) 


108
109
110
 
# File 'lib/google/apis/file_v1/classes.rb', line 108

def storage_bytes
  @storage_bytes
end

#tags ⇒ Hash<String,String>

Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": " marketing" Corresponds to the JSON property tags

Returns:

  • (Hash<String,String>) 


115
116
117
 
# File 'lib/google/apis/file_v1/classes.rb', line 115

def tags
  @tags
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/google/apis/file_v1/classes.rb', line 122

def update!(**args)
  @capacity_gb = args[:capacity_gb] if args.key?(:capacity_gb)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @download_bytes = args[:download_bytes] if args.key?(:download_bytes)
  @kms_key = args[:kms_key] if args.key?(:kms_key)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @source_file_share = args[:source_file_share] if args.key?(:source_file_share)
  @source_instance = args[:source_instance] if args.key?(:source_instance)
  @source_instance_tier = args[:source_instance_tier] if args.key?(:source_instance_tier)
  @state = args[:state] if args.key?(:state)
  @storage_bytes = args[:storage_bytes] if args.key?(:storage_bytes)
  @tags = args[:tags] if args.key?(:tags)
end