Package com.stripe.model

Class FileLink

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.FileLink

All Implemented Interfaces:

HasId, MetadataStore<FileLink>, StripeActiveObject, StripeObjectInterface

public class FileLink
extends ApiResource
implements HasId, MetadataStore<FileLink>

To share the contents of a File object with non-Stripe users, you can create a FileLink. FileLinks contain a URL that you can use to retrieve the contents of the file without authentication.

Nested Class Summary

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON, INTERNAL_GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
FileLink()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
static FileLink	create(FileLinkCreateParams params)	Creates a new file link object.
static FileLink	create(FileLinkCreateParams params, RequestOptions options)	Creates a new file link object.
static FileLink	create(Map<String,Object> params)	Creates a new file link object.
static FileLink	create(Map<String,Object> params, RequestOptions options)	Creates a new file link object.
boolean	equals(Object o)
Long	getCreated()	Time at which the object was created.
Boolean	getExpired()	Returns if the link is already expired.
Long	getExpiresAt()	Time that the link expires.
String	getFile()	Get ID of expandable file object.
File	getFileObject()	Get expanded file.
String	getId()	Unique identifier for the object.
Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
String	getObject()	String representing the object's type.
String	getUrl()	The publicly accessible URL to download the file.
int	hashCode()
static FileLinkCollection	list(FileLinkListParams params)	Returns a list of file links.
static FileLinkCollection	list(FileLinkListParams params, RequestOptions options)	Returns a list of file links.
static FileLinkCollection	list(Map<String,Object> params)	Returns a list of file links.
static FileLinkCollection	list(Map<String,Object> params, RequestOptions options)	Returns a list of file links.
static FileLink	retrieve(String link)	Retrieves the file link with the given ID.
static FileLink	retrieve(String link, RequestOptions options)	Retrieves the file link with the given ID.
static FileLink	retrieve(String link, FileLinkRetrieveParams params, RequestOptions options)	Retrieves the file link with the given ID.
static FileLink	retrieve(String link, Map<String,Object> params, RequestOptions options)	Retrieves the file link with the given ID.
void	setCreated(Long created)	Time at which the object was created.
void	setExpired(Boolean expired)	Returns if the link is already expired.
void	setExpiresAt(Long expiresAt)	Time that the link expires.
void	setFile(String id)
void	setFileObject(File expandableObject)
void	setId(String id)	Unique identifier for the object.
void	setLivemode(Boolean livemode)	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
void	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
void	setObject(String object)	String representing the object's type.
void	setResponseGetter(StripeResponseGetter responseGetter)	Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
void	setUrl(String url)	The publicly accessible URL to download the file.
FileLink	update(FileLinkUpdateParams params)	Updates an existing file link object.
FileLink	update(FileLinkUpdateParams params, RequestOptions options)	Updates an existing file link object.
FileLink	update(Map<String,Object> params)	Updates an existing file link object.
FileLink	update(Map<String,Object> params, RequestOptions options)	Updates an existing file link object.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setGlobalResponseGetter, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.stripe.model.StripeActiveObject

trySetResponseGetter

Constructor Details

FileLink

public FileLink()

Method Details

getFile

public String getFile()

Get ID of expandable file object.

setFile

public void setFile(String id)

getFileObject

public File getFileObject()

Get expanded file.

setFileObject

public void setFileObject(File expandableObject)

create

public static FileLink create(Map<String,Object> params)
                       throws StripeException

Creates a new file link object.

Throws:

StripeException

create

public static FileLink create(Map<String,Object> params,
 RequestOptions options)
                       throws StripeException

Creates a new file link object.

Throws:

StripeException

create

public static FileLink create(FileLinkCreateParams params)
                       throws StripeException

Creates a new file link object.

Throws:

StripeException

create

public static FileLink create(FileLinkCreateParams params,
 RequestOptions options)
                       throws StripeException

Creates a new file link object.

Throws:

StripeException

list

public static FileLinkCollection list(Map<String,Object> params)
                               throws StripeException

Returns a list of file links.

Throws:

StripeException

list

public static FileLinkCollection list(Map<String,Object> params,
 RequestOptions options)
                               throws StripeException

Returns a list of file links.

Throws:

StripeException

list

public static FileLinkCollection list(FileLinkListParams params)
                               throws StripeException

Returns a list of file links.

Throws:

StripeException

list

public static FileLinkCollection list(FileLinkListParams params,
 RequestOptions options)
                               throws StripeException

Returns a list of file links.

Throws:

StripeException

retrieve

public static FileLink retrieve(String link)
                         throws StripeException

Retrieves the file link with the given ID.

Throws:

StripeException

retrieve

public static FileLink retrieve(String link,
 RequestOptions options)
                         throws StripeException

Retrieves the file link with the given ID.

Throws:

StripeException

retrieve

public static FileLink retrieve(String link,
 Map<String,Object> params,
 RequestOptions options)
                         throws StripeException

Retrieves the file link with the given ID.

Throws:

StripeException

retrieve

public static FileLink retrieve(String link,
 FileLinkRetrieveParams params,
 RequestOptions options)
                         throws StripeException

Retrieves the file link with the given ID.

Throws:

StripeException

update

public FileLink update(Map<String,Object> params)
                throws StripeException

Updates an existing file link object. Expired links can no longer be updated.

Specified by:

update in interface MetadataStore<FileLink>

Throws:

StripeException

update

public FileLink update(Map<String,Object> params,
 RequestOptions options)
                throws StripeException

Updates an existing file link object. Expired links can no longer be updated.

Specified by:

update in interface MetadataStore<FileLink>

Throws:

StripeException

update

public FileLink update(FileLinkUpdateParams params)
                throws StripeException

Updates an existing file link object. Expired links can no longer be updated.

Throws:

StripeException

update

public FileLink update(FileLinkUpdateParams params,
 RequestOptions options)
                throws StripeException

Updates an existing file link object. Expired links can no longer be updated.

Throws:

StripeException

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

Description copied from interface: StripeActiveObject

Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

responseGetter - the StripeResponseGetter instance to use for making further requests.

getCreated

public Long getCreated()

Time at which the object was created. Measured in seconds since the Unix epoch.

getExpired

public Boolean getExpired()

Returns if the link is already expired.

getExpiresAt

public Long getExpiresAt()

Time that the link expires.

getLivemode

public Boolean getLivemode()

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

getObject

public String getObject()

String representing the object's type. Objects of the same type share the same value.

Equal to file_link.

getUrl

public String getUrl()

The publicly accessible URL to download the file.

setCreated

public void setCreated(Long created)

Time at which the object was created. Measured in seconds since the Unix epoch.

setExpired

public void setExpired(Boolean expired)

Returns if the link is already expired.

setExpiresAt

public void setExpiresAt(Long expiresAt)

Time that the link expires.

setId

public void setId(String id)

Unique identifier for the object.

setLivemode

public void setLivemode(Boolean livemode)

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

setMetadata

public void setMetadata(Map<String,String> metadata)

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

setObject

public void setObject(String object)

String representing the object's type. Objects of the same type share the same value.

Equal to file_link.

setUrl

public void setUrl(String url)

The publicly accessible URL to download the file.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getId

public String getId()

Unique identifier for the object.

Specified by:

getId in interface HasId

getMetadata

public Map<String,String> getMetadata()

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

Specified by:

getMetadata in interface MetadataStore<FileLink>