Package com.chrt.api.resources.taskartifacts.s3object

Class AsyncS3ObjectClient

java.lang.Object

com.chrt.api.resources.taskartifacts.s3object.AsyncS3ObjectClient

public class AsyncS3ObjectClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
AsyncS3ObjectClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<java.lang.Boolean>	addV1(java.lang.String taskArtifactId, java.io.File image, BodyPostTaskArtifactsS3ObjectAddV1OortTaskArtifactsS3ObjectAddV1TaskArtifactIdPost request)	Uploads an image file to a task artifact with automatic blurhash generation.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	addV1(java.lang.String taskArtifactId, java.io.File image, BodyPostTaskArtifactsS3ObjectAddV1OortTaskArtifactsS3ObjectAddV1TaskArtifactIdPost request, RequestOptions requestOptions)	Uploads an image file to a task artifact with automatic blurhash generation.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	deleteV1(java.lang.String taskArtifactS3ObjectMetadataId)	Deletes an S3 object metadata and the associated S3 object from a task artifact.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	deleteV1(java.lang.String taskArtifactS3ObjectMetadataId, RequestOptions requestOptions)	Deletes an S3 object metadata and the associated S3 object from a task artifact.
java.util.concurrent.CompletableFuture<TaskArtifactS3ObjectMetadata1>	getS3ObjectMetadataV1(java.lang.String taskArtifactS3ObjectMetadataId)	Retrieves the metadata for a task artifact S3 object, including blurhash for placeholder loading.
java.util.concurrent.CompletableFuture<TaskArtifactS3ObjectMetadata1>	getS3ObjectMetadataV1(java.lang.String taskArtifactS3ObjectMetadataId, RequestOptions requestOptions)	Retrieves the metadata for a task artifact S3 object, including blurhash for placeholder loading.
java.util.concurrent.CompletableFuture<java.io.InputStream>	getV1(java.lang.String taskArtifactS3ObjectMetadataId)	Streams a task artifact S3 object file from storage.
java.util.concurrent.CompletableFuture<java.io.InputStream>	getV1(java.lang.String taskArtifactS3ObjectMetadataId, RequestOptions requestOptions)	Streams a task artifact S3 object file from storage.
AsyncRawS3ObjectClient	withRawResponse()	Get responses with HTTP metadata like headers

Methods inherited from class java.lang.Object

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

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

AsyncS3ObjectClient

public AsyncS3ObjectClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public AsyncRawS3ObjectClient withRawResponse()

Get responses with HTTP metadata like headers

getS3ObjectMetadataV1

public java.util.concurrent.CompletableFuture<TaskArtifactS3ObjectMetadata1> getS3ObjectMetadataV1(java.lang.String taskArtifactS3ObjectMetadataId)

Retrieves the metadata for a task artifact S3 object, including blurhash for placeholder loading. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (TaskArtifactS3ObjectMetadata1)

getS3ObjectMetadataV1

public java.util.concurrent.CompletableFuture<TaskArtifactS3ObjectMetadata1> getS3ObjectMetadataV1(java.lang.String taskArtifactS3ObjectMetadataId,
                                                                                                   RequestOptions requestOptions)

Retrieves the metadata for a task artifact S3 object, including blurhash for placeholder loading. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (TaskArtifactS3ObjectMetadata1)

getV1

public java.util.concurrent.CompletableFuture<java.io.InputStream> getV1(java.lang.String taskArtifactS3ObjectMetadataId)

Streams a task artifact S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (binary)

getV1

public java.util.concurrent.CompletableFuture<java.io.InputStream> getV1(java.lang.String taskArtifactS3ObjectMetadataId,
                                                                         RequestOptions requestOptions)

Streams a task artifact S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (binary)

addV1

public java.util.concurrent.CompletableFuture<java.lang.Boolean> addV1(java.lang.String taskArtifactId,
                                                                       java.io.File image,
                                                                       BodyPostTaskArtifactsS3ObjectAddV1OortTaskArtifactsS3ObjectAddV1TaskArtifactIdPost request)

Uploads an image file to a task artifact with automatic blurhash generation. | authz_personas=[courier_driver, forwarder_org_operators, courier_org_operators, shipper_org_operators] | (UploadFile) -> (bool)

addV1

public java.util.concurrent.CompletableFuture<java.lang.Boolean> addV1(java.lang.String taskArtifactId,
                                                                       java.io.File image,
                                                                       BodyPostTaskArtifactsS3ObjectAddV1OortTaskArtifactsS3ObjectAddV1TaskArtifactIdPost request,
                                                                       RequestOptions requestOptions)

Uploads an image file to a task artifact with automatic blurhash generation. | authz_personas=[courier_driver, forwarder_org_operators, courier_org_operators, shipper_org_operators] | (UploadFile) -> (bool)

deleteV1

public java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteV1(java.lang.String taskArtifactS3ObjectMetadataId)

Deletes an S3 object metadata and the associated S3 object from a task artifact. Only the uploader or an operator from the uploading org can delete. | () -> (bool)

deleteV1

public java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteV1(java.lang.String taskArtifactS3ObjectMetadataId,
                                                                          RequestOptions requestOptions)

Deletes an S3 object metadata and the associated S3 object from a task artifact. Only the uploader or an operator from the uploading org can delete. | () -> (bool)