Package com.atlan.api

Class FilesEndpoint

java.lang.Object

com.atlan.api.AbstractEndpoint

com.atlan.api.HeraclesEndpoint

com.atlan.api.FilesEndpoint

public class FilesEndpoint
extends HeraclesEndpoint

API endpoints for managing files that can be uploaded to Atlan.

Nested Class Summary

Nested classes/interfaces inherited from class com.atlan.api.AbstractEndpoint

AbstractEndpoint.RawResponse, AbstractEndpoint.ThrowingSupplier<T,E extends Exception>

Field Summary

Fields inherited from class com.atlan.api.AbstractEndpoint

client

Constructor Summary

Constructors

Constructor	Description
FilesEndpoint(AtlanClient client)

Method Summary

Modifier and Type	Method	Description
AtlanFile	upload(File file)	Upload a file from a local file.
AtlanFile	upload(File file, RequestOptions options)	Upload a file from a local file.
AtlanFile	upload(InputStream fileSrc, String filename)	Upload a file from a given input stream.
AtlanFile	upload(InputStream fileSrc, String filename, RequestOptions options)	Upload a file from a given input stream.
AtlanFile	upload(String fromUrl)	Upload a file from a given URL.
AtlanFile	upload(String fromUrl, RequestOptions options)	Upload a file from a given URL.

Methods inherited from class com.atlan.api.HeraclesEndpoint

getBaseUrl

Methods inherited from class com.atlan.api.AbstractEndpoint

executeWithRetries, getBaseUrl, getClient

Methods inherited from class java.lang.Object

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

Constructor Details

FilesEndpoint

public FilesEndpoint(AtlanClient client)

Method Details

upload

public AtlanFile upload(String fromUrl)
                 throws AtlanException,
MalformedURLException,
IOException

Upload a file from a given URL.

Parameters:

fromUrl - URL from which to retrieve the file (must be network-accessible from client running the code)

Returns:

details of the uploaded file

Throws:

AtlanException - on any API communication issues

MalformedURLException - if the provided URL is invalid

IOException - on any issues accessing or reading from the provided URL

upload

public AtlanFile upload(String fromUrl,
 RequestOptions options)
                 throws AtlanException,
MalformedURLException,
IOException

Upload a file from a given URL.

Parameters:

fromUrl - URL from which to retrieve the file (must be network-accessible from client running the code)

options - to override default client settings

Returns:

details of the uploaded file

Throws:

AtlanException - on any API communication issues

MalformedURLException - if the provided URL is invalid

IOException - on any issues accessing or reading from the provided URL

upload

public AtlanFile upload(File file)
                 throws AtlanException,
IOException

Upload a file from a local file.

Parameters:

file - local file containing the file

Returns:

details of the uploaded file

Throws:

AtlanException - on any API communication issues

IOException - on any issues accessing or reading from the provided file

upload

public AtlanFile upload(File file,
 RequestOptions options)
                 throws AtlanException,
IOException

Upload a file from a local file.

Parameters:

file - local file containing the file

options - to override default client settings

Returns:

details of the uploaded file

Throws:

AtlanException - on any API communication issues

IOException - on any issues accessing or reading from the provided file

upload

public AtlanFile upload(InputStream fileSrc,
 String filename)
                 throws AtlanException

Upload a file from a given input stream.

Parameters:

fileSrc - source of the file, as an input stream

filename - name of the file the InputStream is reading (must include an extension that accurately represents the type of the file)

Returns:

details of the uploaded file

Throws:

AtlanException - on any API communication issues

upload

public AtlanFile upload(InputStream fileSrc,
 String filename,
 RequestOptions options)
                 throws AtlanException

Upload a file from a given input stream.

Parameters:

fileSrc - source of the file, as an input stream

filename - name of the file the InputStream is reading (must include an extension that accurately represents the type of the file)

options - to override default client settings

Returns:

details of the uploaded file

Throws:

AtlanException - on any API communication issues