File (stripe-java 11.4.0 API)

java.lang.Object
- com.stripe.model.StripeObject
- - com.stripe.net.ApiResource
  - - com.stripe.model.File

All Implemented Interfaces:: HasId

public class File
extends ApiResource
implements HasId

Nested Class Summary
- Nested classes/interfaces inherited from class com.stripe.net.ApiResource
  ApiResource.RequestMethod, ApiResource.RequestType

Field Summary
- Fields inherited from class com.stripe.net.ApiResource
  CHARSET, GSON
- Fields inherited from class com.stripe.model.StripeObject
  PRETTY_PRINT_GSON

Constructor Summary

Constructors
Constructor and Description

File()

Constructors
Constructor and Description
`File()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`canEqual(java.lang.Object other)`
`static File`	`create(FileCreateParams params)` To upload a file to Stripe, you’ll need to send a request of type `multipart/form-data`.
`static File`	`create(FileCreateParams params, RequestOptions options)` To upload a file to Stripe, you’ll need to send a request of type `multipart/form-data`.
`static File`	`create(java.util.Map<java.lang.String,java.lang.Object> params)` To upload a file to Stripe, you’ll need to send a request of type `multipart/form-data`.
`static File`	`create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` To upload a file to Stripe, you’ll need to send a request of type `multipart/form-data`.
`boolean`	`equals(java.lang.Object o)`
`java.lang.Long`	`getCreated()` Time at which the object was created.
`java.lang.String`	`getFilename()` A filename for the file, suitable for saving to a filesystem.
`java.lang.String`	`getId()` Unique identifier for the object.
`FileLinkCollection`	`getLinks()`
`java.lang.String`	`getObject()` String representing the object's type.
`java.lang.String`	`getPurpose()` The purpose of the file.
`java.lang.Long`	`getSize()` The size in bytes of the file object.
`java.lang.String`	`getTitle()` A user friendly title for the document.
`java.lang.String`	`getType()` The type of the file returned (e.g., `csv`, `pdf`, `jpg`, or `png`).
`java.lang.String`	`getUrl()` The URL from which the file can be downloaded using your live secret API key.
`int`	`hashCode()`
`static FileCollection`	`list(FileListParams params)` Returns a list of the files that your account has access to.
`static FileCollection`	`list(FileListParams params, RequestOptions options)` Returns a list of the files that your account has access to.
`static FileCollection`	`list(java.util.Map<java.lang.String,java.lang.Object> params)` Returns a list of the files that your account has access to.
`static FileCollection`	`list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Returns a list of the files that your account has access to.
`static File`	`retrieve(java.lang.String id)` Retrieves the details of an existing file object.
`static File`	`retrieve(java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Retrieves the details of an existing file object.
`static File`	`retrieve(java.lang.String id, RequestOptions options)` Retrieves the details of an existing file object.
`void`	`setCreated(java.lang.Long created)` Time at which the object was created.
`void`	`setFilename(java.lang.String filename)` A filename for the file, suitable for saving to a filesystem.
`void`	`setId(java.lang.String id)` Unique identifier for the object.
`void`	`setLinks(FileLinkCollection links)`
`void`	`setObject(java.lang.String object)` String representing the object's type.
`void`	`setPurpose(java.lang.String purpose)` The purpose of the file.
`void`	`setSize(java.lang.Long size)` The size in bytes of the file object.
`void`	`setTitle(java.lang.String title)` A user friendly title for the document.
`void`	`setType(java.lang.String type)` The type of the file returned (e.g., `csv`, `pdf`, `jpg`, or `png`).
`void`	`setUrl(java.lang.String url)` The URL from which the file can be downloaded using your live secret API key.

Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, multipartRequest, request, request, requestCollection, requestCollection, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject
equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - File
```
public File()
```
- Method Detail
  - create
```
public static File create(java.util.Map<java.lang.String,java.lang.Object> params)
                   throws StripeException
```
    To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.
    
    Throws:
    
    StripeException
  - create
```
public static File create(FileCreateParams params)
                   throws StripeException
```
    To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.
    
    Throws:
    
    StripeException
  - create
```
public static File create(FileCreateParams params,
                          RequestOptions options)
                   throws StripeException
```
    To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.
    
    Throws:
    
    StripeException
  - create
```
public static File create(java.util.Map<java.lang.String,java.lang.Object> params,
                          RequestOptions options)
                   throws StripeException
```
    To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.
    
    Throws:
    
    StripeException
  - list
```
public static FileCollection list(java.util.Map<java.lang.String,java.lang.Object> params)
                           throws StripeException
```
    Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.
    
    Throws:
    
    StripeException
  - list
```
public static FileCollection list(java.util.Map<java.lang.String,java.lang.Object> params,
                                  RequestOptions options)
                           throws StripeException
```
    Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.
    
    Throws:
    
    StripeException
  - list
```
public static FileCollection list(FileListParams params)
                           throws StripeException
```
    Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.
    
    Throws:
    
    StripeException
  - list
```
public static FileCollection list(FileListParams params,
                                  RequestOptions options)
                           throws StripeException
```
    Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.
    
    Throws:
    
    StripeException
  - retrieve
```
public static File retrieve(java.lang.String id)
                     throws StripeException
```
    Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object.
    
    Throws:
    
    StripeException
  - retrieve
```
public static File retrieve(java.lang.String id,
                            RequestOptions options)
                     throws StripeException
```
    Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object.
    
    Throws:
    
    StripeException
  - retrieve
```
public static File retrieve(java.lang.String id,
                            java.util.Map<java.lang.String,java.lang.Object> params,
                            RequestOptions options)
                     throws StripeException
```
    Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object.
    
    Throws:
    
    StripeException
  - getCreated
```
public java.lang.Long getCreated()
```
    Time at which the object was created. Measured in seconds since the Unix epoch.
  - getFilename
```
public java.lang.String getFilename()
```
    A filename for the file, suitable for saving to a filesystem.
  - getLinks
```
public FileLinkCollection getLinks()
```
  - getObject
```
public java.lang.String getObject()
```
    String representing the object's type. Objects of the same type share the same value.
  - getPurpose
```
public java.lang.String getPurpose()
```
    The purpose of the file. Possible values are business_icon, business_logo, customer_signature, dispute_evidence, finance_report_run, identity_document, pci_document, sigma_scheduled_query, or tax_document_user_upload.
  - getSize
```
public java.lang.Long getSize()
```
    The size in bytes of the file object.
  - getTitle
```
public java.lang.String getTitle()
```
    A user friendly title for the document.
  - getType
```
public java.lang.String getType()
```
    The type of the file returned (e.g., csv, pdf, jpg, or png).
  - getUrl
```
public java.lang.String getUrl()
```
    The URL from which the file can be downloaded using your live secret API key.
  - setCreated
```
public void setCreated(java.lang.Long created)
```
    Time at which the object was created. Measured in seconds since the Unix epoch.
  - setFilename
```
public void setFilename(java.lang.String filename)
```
    A filename for the file, suitable for saving to a filesystem.
  - setId
```
public void setId(java.lang.String id)
```
    Unique identifier for the object.
  - setLinks
```
public void setLinks(FileLinkCollection links)
```
  - setObject
```
public void setObject(java.lang.String object)
```
    String representing the object's type. Objects of the same type share the same value.
  - setPurpose
```
public void setPurpose(java.lang.String purpose)
```
    The purpose of the file. Possible values are business_icon, business_logo, customer_signature, dispute_evidence, finance_report_run, identity_document, pci_document, sigma_scheduled_query, or tax_document_user_upload.
  - setSize
```
public void setSize(java.lang.Long size)
```
    The size in bytes of the file object.
  - setTitle
```
public void setTitle(java.lang.String title)
```
    A user friendly title for the document.
  - setType
```
public void setType(java.lang.String type)
```
    The type of the file returned (e.g., csv, pdf, jpg, or png).
  - setUrl
```
public void setUrl(java.lang.String url)
```
    The URL from which the file can be downloaded using your live secret API key.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - canEqual
```
protected boolean canEqual(java.lang.Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getId
```
public java.lang.String getId()
```
    Unique identifier for the object.
    
    Specified by:
    
    getId in interface HasId

Class File

Nested Class Summary

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

Field Summary

Fields inherited from class com.stripe.net.ApiResource

Fields inherited from class com.stripe.model.StripeObject

Constructor Summary

Method Summary

Methods inherited from class com.stripe.net.ApiResource

Methods inherited from class com.stripe.model.StripeObject

Methods inherited from class java.lang.Object

Constructor Detail

File

Method Detail

create

create

create

create

list

list

list

list

retrieve

retrieve

retrieve

getCreated

getFilename

getLinks

getObject

getPurpose

getSize

getTitle

getType

getUrl

setCreated

setFilename

setId

setLinks

setObject

setPurpose

setSize

setTitle

setType

setUrl

equals

canEqual

hashCode

getId