Package com.atlan.api

Class ImagesEndpoint

java.lang.Object

com.atlan.api.AbstractEndpoint

com.atlan.api.HeraclesEndpoint

com.atlan.api.ImagesEndpoint

public class ImagesEndpoint
extends HeraclesEndpoint

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

Nested Class Summary

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

AbstractEndpoint.RawResponse

Field Summary

Fields inherited from class com.atlan.api.AbstractEndpoint

client

Constructor Summary

Constructors

Constructor	Description
ImagesEndpoint(AtlanClient client)

Method Summary

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

Methods inherited from class com.atlan.api.HeraclesEndpoint

getBaseUrl

Methods inherited from class com.atlan.api.AbstractEndpoint

getBaseUrl

Methods inherited from class java.lang.Object

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

Constructor Details

ImagesEndpoint

public ImagesEndpoint(AtlanClient client)

Method Details

upload

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

Upload an image from a given URL.

Parameters:

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

Returns:

details of the uploaded image

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 AtlanImage upload(String fromUrl,
 RequestOptions options)
                  throws AtlanException,
MalformedURLException,
IOException

Upload an image from a given URL.

Parameters:

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

options - to override default client settings

Returns:

details of the uploaded image

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 AtlanImage upload(File file)
                  throws AtlanException,
IOException

Upload an image from a local file.

Parameters:

file - local file containing the image

Returns:

details of the uploaded image

Throws:

AtlanException - on any API communication issues

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

upload

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

Upload an image from a local file.

Parameters:

file - local file containing the image

options - to override default client settings

Returns:

details of the uploaded image

Throws:

AtlanException - on any API communication issues

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

upload

public AtlanImage upload(InputStream imageSrc,
 String filename)
                  throws AtlanException

Upload an image from a given input stream.

Parameters:

imageSrc - source of the image, as an input stream

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

Returns:

details of the uploaded image

Throws:

AtlanException - on any API communication issues

upload

public AtlanImage upload(InputStream imageSrc,
 String filename,
 RequestOptions options)
                  throws AtlanException

Upload an image from a given input stream.

Parameters:

imageSrc - source of the image, as an input stream

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

options - to override default client settings

Returns:

details of the uploaded image

Throws:

AtlanException - on any API communication issues