com.files.models

Class Snapshot

java.lang.Object

com.files.models.Snapshot

All Implemented Interfaces:

ModelInterface

public class Snapshot
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
Long	bundleId The bundle using this snapshot, if applicable.
Date	expiresAt When the snapshot expires.
Date	finalizedAt When the snapshot was finalized.
Long	id The snapshot's unique ID.
String	name A name for the snapshot.
String[]	paths An array of paths to add to the snapshot.
Long	userId The user that created this snapshot, if applicable.

Constructor Summary

Constructors

Constructor and Description
Snapshot()
Snapshot(HashMap<String,Object> parameters)
Snapshot(HashMap<String,Object> parameters, HashMap<String,Object> options)

Method Summary

Modifier and Type	Method and Description
static ListIterator<Snapshot>	all()
static ListIterator<Snapshot>	all(HashMap<String,Object> parameters, HashMap<String,Object> options)
static Snapshot	create(HashMap<String,Object> parameters) Parameters: expires_at - string - When the snapshot expires.
static Snapshot	create(HashMap<String,Object> parameters, HashMap<String,Object> options)
void	delete()
static void	delete(HashMap<String,Object> parameters, HashMap<String,Object> options)
static void	delete(Long id, HashMap<String,Object> parameters)
static void	delete(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static void	destroy()
void	destroy(HashMap<String,Object> parameters)
static void	destroy(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static Snapshot	find(HashMap<String,Object> parameters, HashMap<String,Object> options)
static Snapshot	find(Long id, HashMap<String,Object> parameters) Parameters: id (required) - int64 - Snapshot ID.
static Snapshot	find(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static Snapshot	get()
static Snapshot	get(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<Snapshot>	list() Parameters: cursor - string - Used for pagination.
static ListIterator<Snapshot>	list(HashMap<String,Object> parameters)
static ListIterator<Snapshot>	list(HashMap<String,Object> parameters, HashMap<String,Object> options)
void	performFinalize() Finalize Snapshot
static void	performFinalize(HashMap<String,Object> parameters, HashMap<String,Object> options)
static void	performFinalize(Long id, HashMap<String,Object> parameters) Finalize Snapshot
static void	performFinalize(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
void	save()
Snapshot	update() Parameters: expires_at - string - When the snapshot expires.
static Snapshot	update(HashMap<String,Object> parameters, HashMap<String,Object> options)
static Snapshot	update(Long id, HashMap<String,Object> parameters) Parameters: expires_at - string - When the snapshot expires.
static Snapshot	update(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.files.models.ModelInterface

setOptions

Field Detail

id

public Long id

The snapshot's unique ID.

expiresAt

public Date expiresAt

When the snapshot expires.

finalizedAt

public Date finalizedAt

When the snapshot was finalized.

name

public String name

A name for the snapshot.

userId

public Long userId

The user that created this snapshot, if applicable.

bundleId

public Long bundleId

The bundle using this snapshot, if applicable.

paths

public String[] paths

An array of paths to add to the snapshot.

Constructor Detail

Snapshot

public Snapshot()

Snapshot

public Snapshot(HashMap<String,Object> parameters)

Snapshot

public Snapshot(HashMap<String,Object> parameters,
                HashMap<String,Object> options)

Method Detail

performFinalize

public void performFinalize()
                     throws IOException

Finalize Snapshot

Throws:

IOException

update

public Snapshot update()
                throws IOException

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.

Throws:

IOException

delete

public void delete()
            throws IOException

Throws:

IOException

destroy

public void destroy(HashMap<String,Object> parameters)
             throws IOException

Throws:

IOException

save

public void save()
          throws IOException

Throws:

IOException

list

public static ListIterator<Snapshot> list()
                                   throws RuntimeException

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).

Throws:

RuntimeException

list

public static ListIterator<Snapshot> list(HashMap<String,Object> parameters)
                                   throws RuntimeException

Throws:

RuntimeException

list

public static ListIterator<Snapshot> list(HashMap<String,Object> parameters,
                                          HashMap<String,Object> options)
                                   throws RuntimeException

Throws:

RuntimeException

all

public static ListIterator<Snapshot> all()
                                  throws RuntimeException

Throws:

RuntimeException

all

public static ListIterator<Snapshot> all(HashMap<String,Object> parameters,
                                         HashMap<String,Object> options)
                                  throws RuntimeException

Throws:

RuntimeException

find

public static Snapshot find(Long id,
                            HashMap<String,Object> parameters)
                     throws RuntimeException

Parameters: id (required) - int64 - Snapshot ID.

Throws:

RuntimeException

find

public static Snapshot find(HashMap<String,Object> parameters,
                            HashMap<String,Object> options)
                     throws RuntimeException

Throws:

RuntimeException

find

public static Snapshot find(Long id,
                            HashMap<String,Object> parameters,
                            HashMap<String,Object> options)
                     throws RuntimeException

Throws:

RuntimeException

get

public static Snapshot get()
                    throws RuntimeException

Throws:

RuntimeException

get

public static Snapshot get(Long id,
                           HashMap<String,Object> parameters,
                           HashMap<String,Object> options)
                    throws RuntimeException

Throws:

RuntimeException

create

public static Snapshot create(HashMap<String,Object> parameters)
                       throws RuntimeException

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.

Throws:

RuntimeException

create

public static Snapshot create(HashMap<String,Object> parameters,
                              HashMap<String,Object> options)
                       throws RuntimeException

Throws:

RuntimeException

performFinalize

public static void performFinalize(Long id,
                                   HashMap<String,Object> parameters)
                            throws RuntimeException

Finalize Snapshot

Throws:

RuntimeException

performFinalize

public static void performFinalize(HashMap<String,Object> parameters,
                                   HashMap<String,Object> options)
                            throws RuntimeException

Throws:

RuntimeException

performFinalize

public static void performFinalize(Long id,
                                   HashMap<String,Object> parameters,
                                   HashMap<String,Object> options)
                            throws RuntimeException

Throws:

RuntimeException

update

public static Snapshot update(Long id,
                              HashMap<String,Object> parameters)
                       throws RuntimeException

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.

Throws:

RuntimeException

update

public static Snapshot update(HashMap<String,Object> parameters,
                              HashMap<String,Object> options)
                       throws RuntimeException

Throws:

RuntimeException

update

public static Snapshot update(Long id,
                              HashMap<String,Object> parameters,
                              HashMap<String,Object> options)
                       throws RuntimeException

Throws:

RuntimeException

delete

public static void delete(Long id,
                          HashMap<String,Object> parameters)
                   throws RuntimeException

Throws:

RuntimeException

delete

public static void delete(HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException

Throws:

RuntimeException

delete

public static void delete(Long id,
                          HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException

Throws:

RuntimeException

destroy

public static void destroy()
                    throws RuntimeException

Throws:

RuntimeException

destroy

public static void destroy(Long id,
                           HashMap<String,Object> parameters,
                           HashMap<String,Object> options)
                    throws RuntimeException

Throws:

RuntimeException