Class: Files::Snapshot

Inherits:
Object
  • Object
show all
Defined in:
lib/files.com/models/snapshot.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}, options = {}) ⇒ Snapshot

Returns a new instance of Snapshot.



7
8
9
10
 
# File 'lib/files.com/models/snapshot.rb', line 7

def initialize(attributes = {}, options = {})
  @attributes = attributes || {}
  @options = options || {}
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



5
6
7
 
# File 'lib/files.com/models/snapshot.rb', line 5

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



5
6
7
 
# File 'lib/files.com/models/snapshot.rb', line 5

def options
  @options
end

Class Method Details

.all(params = {}, options = {}) ⇒ Object 



141
142
143
 
# File 'lib/files.com/models/snapshot.rb', line 141

def self.all(params = {}, options = {})
  list(params, options)
end

.create(params = {}, options = {}) ⇒ Object

Parameters:

expires_at - string - When the snapshot expires.
name - string - A name for the snapshot.
paths - array(string) - An array of paths to add to the snapshot.

Raises:



165
166
167
168
169
170
171
172
 
# File 'lib/files.com/models/snapshot.rb', line 165

def self.create(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params[:expires_at] and !params[:expires_at].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: paths must be an Array") if params[:paths] and !params[:paths].is_a?(Array)

  response, options = Api.send_request("/snapshots", :post, params, options)
  Snapshot.new(response.data, options)
end

.delete(id, params = {}, options = {}) ⇒ Object

Raises:



202
203
204
205
206
207
208
209
210
 
# File 'lib/files.com/models/snapshot.rb', line 202

def self.delete(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  Api.send_request("/snapshots/#{params[:id]}", :delete, params, options)
  nil
end

.destroy(id, params = {}, options = {}) ⇒ Object 



212
213
214
215
 
# File 'lib/files.com/models/snapshot.rb', line 212

def self.destroy(id, params = {}, options = {})
  delete(id, params, options)
  nil
end

.finalize(id, params = {}, options = {}) ⇒ Object

Finalize Snapshot

Raises:



175
176
177
178
179
180
181
182
183
 
# File 'lib/files.com/models/snapshot.rb', line 175

def self.finalize(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  Api.send_request("/snapshots/#{params[:id]}/finalize", :post, params, options)
  nil
end

.find(id, params = {}, options = {}) ⇒ Object

Parameters:

id (required) - int64 - Snapshot ID.

Raises:



147
148
149
150
151
152
153
154
155
 
# File 'lib/files.com/models/snapshot.rb', line 147

def self.find(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  response, options = Api.send_request("/snapshots/#{params[:id]}", :get, params, options)
  Snapshot.new(response.data, options)
end

.get(id, params = {}, options = {}) ⇒ Object 



157
158
159
 
# File 'lib/files.com/models/snapshot.rb', line 157

def self.get(id, params = {}, options = {})
  find(id, params, options)
end

.list(params = {}, options = {}) ⇒ Object

Parameters:

cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).

Raises:



132
133
134
135
136
137
138
139
 
# File 'lib/files.com/models/snapshot.rb', line 132

def self.list(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)

  List.new(Snapshot, params) do
    Api.send_request("/snapshots", :get, params, options)
  end
end

.update(id, params = {}, options = {}) ⇒ Object

Parameters:

expires_at - string - When the snapshot expires.
name - string - A name for the snapshot.
paths - array(string) - An array of paths to add to the snapshot.

Raises:



189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/files.com/models/snapshot.rb', line 189

def self.update(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params[:expires_at] and !params[:expires_at].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: paths must be an Array") if params[:paths] and !params[:paths].is_a?(Array)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  response, options = Api.send_request("/snapshots/#{params[:id]}", :patch, params, options)
  Snapshot.new(response.data, options)
end

Instance Method Details

#bundle_id ⇒ Object

int64 - The bundle using this snapshot, if applicable.



58
59
60
 
# File 'lib/files.com/models/snapshot.rb', line 58

def bundle_id
  @attributes[:bundle_id]
end

#bundle_id=(value) ⇒ Object 



62
63
64
 
# File 'lib/files.com/models/snapshot.rb', line 62

def bundle_id=(value)
  @attributes[:bundle_id] = value
end

#delete(params = {}) ⇒ Object

Raises:



103
104
105
106
107
108
109
110
111
 
# File 'lib/files.com/models/snapshot.rb', line 103

def delete(params = {})
  params ||= {}
  params[:id] = @attributes[:id]
  raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  Api.send_request("/snapshots/#{@attributes[:id]}", :delete, params, @options)
end

#destroy(params = {}) ⇒ Object 



113
114
115
116
 
# File 'lib/files.com/models/snapshot.rb', line 113

def destroy(params = {})
  delete(params)
  nil
end

#expires_at ⇒ Object

date-time - When the snapshot expires.



22
23
24
 
# File 'lib/files.com/models/snapshot.rb', line 22

def expires_at
  @attributes[:expires_at]
end

#expires_at=(value) ⇒ Object 



26
27
28
 
# File 'lib/files.com/models/snapshot.rb', line 26

def expires_at=(value)
  @attributes[:expires_at] = value
end

#finalize(params = {}) ⇒ Object

Finalize Snapshot

Raises:



76
77
78
79
80
81
82
83
84
 
# File 'lib/files.com/models/snapshot.rb', line 76

def finalize(params = {})
  params ||= {}
  params[:id] = @attributes[:id]
  raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  Api.send_request("/snapshots/#{@attributes[:id]}/finalize", :post, params, @options)
end

#finalized_at ⇒ Object

date-time - When the snapshot was finalized.



31
32
33
 
# File 'lib/files.com/models/snapshot.rb', line 31

def finalized_at
  @attributes[:finalized_at]
end

#finalized_at=(value) ⇒ Object 



35
36
37
 
# File 'lib/files.com/models/snapshot.rb', line 35

def finalized_at=(value)
  @attributes[:finalized_at] = value
end

#id ⇒ Object

int64 - The snapshot’s unique ID.



13
14
15
 
# File 'lib/files.com/models/snapshot.rb', line 13

def id
  @attributes[:id]
end

#id=(value) ⇒ Object 



17
18
19
 
# File 'lib/files.com/models/snapshot.rb', line 17

def id=(value)
  @attributes[:id] = value
end

#name ⇒ Object

string - A name for the snapshot.



40
41
42
 
# File 'lib/files.com/models/snapshot.rb', line 40

def name
  @attributes[:name]
end

#name=(value) ⇒ Object 



44
45
46
 
# File 'lib/files.com/models/snapshot.rb', line 44

def name=(value)
  @attributes[:name] = value
end

#paths ⇒ Object

array(string) - An array of paths to add to the snapshot.



67
68
69
 
# File 'lib/files.com/models/snapshot.rb', line 67

def paths
  @attributes[:paths]
end

#paths=(value) ⇒ Object 



71
72
73
 
# File 'lib/files.com/models/snapshot.rb', line 71

def paths=(value)
  @attributes[:paths] = value
end

#save ⇒ Object 



118
119
120
121
122
123
124
125
126
127
 
# File 'lib/files.com/models/snapshot.rb', line 118

def save
  if @attributes[:id]
    new_obj = update(@attributes)
  else
    new_obj = Snapshot.create(@attributes, @options)
  end

  @attributes = new_obj.attributes
  true
end

#update(params = {}) ⇒ Object

Parameters:

expires_at - string - When the snapshot expires.
name - string - A name for the snapshot.
paths - array(string) - An array of paths to add to the snapshot.

Raises:



90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/files.com/models/snapshot.rb', line 90

def update(params = {})
  params ||= {}
  params[:id] = @attributes[:id]
  raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params[:expires_at] and !params[:expires_at].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: paths must be an Array") if params[:paths] and !params[:paths].is_a?(Array)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  Api.send_request("/snapshots/#{@attributes[:id]}", :patch, params, @options)
end

#user_id ⇒ Object

int64 - The user that created this snapshot, if applicable.



49
50
51
 
# File 'lib/files.com/models/snapshot.rb', line 49

def user_id
  @attributes[:user_id]
end

#user_id=(value) ⇒ Object 



53
54
55
 
# File 'lib/files.com/models/snapshot.rb', line 53

def user_id=(value)
  @attributes[:user_id] = value
end