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

Class AsyncRawS3ObjectClient

java.lang.Object

com.chrt.api.resources.shipping.taskartifacts.s3object.AsyncRawS3ObjectClient

public class AsyncRawS3ObjectClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
AsyncRawS3ObjectClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>	addV1(java.lang.String taskArtifactId, java.io.File file, BodyPostTaskArtifactsS3ObjectAddV1ShippingTaskArtifactsS3ObjectAddV1TaskArtifactIdPost request)	Uploads a file (image, PDF, etc.) to a task artifact.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>>	addV1(java.lang.String taskArtifactId, java.io.File file, BodyPostTaskArtifactsS3ObjectAddV1ShippingTaskArtifactsS3ObjectAddV1TaskArtifactIdPost request, RequestOptions requestOptions)	Uploads a file (image, PDF, etc.) to a task artifact.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<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<ChrtApiHttpResponse<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<ChrtApiHttpResponse<TaskArtifactS3ObjectMetadata1>>	getS3ObjectMetadataV1(java.lang.String taskArtifactS3ObjectMetadataId)	Retrieves the metadata for a task artifact S3 object, including blurhash for placeholder loading.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<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<ChrtApiHttpResponse<java.io.InputStream>>	getV1(java.lang.String taskArtifactS3ObjectMetadataId)	Streams a task artifact S3 object file from storage.
java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.io.InputStream>>	getV1(java.lang.String taskArtifactS3ObjectMetadataId, RequestOptions requestOptions)	Streams a task artifact S3 object file from storage.

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

AsyncRawS3ObjectClient

public AsyncRawS3ObjectClient(ClientOptions clientOptions)

Method Detail

getS3ObjectMetadataV1

public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<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<ChrtApiHttpResponse<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<ChrtApiHttpResponse<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<ChrtApiHttpResponse<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<ChrtApiHttpResponse<java.lang.Boolean>> addV1(java.lang.String taskArtifactId,
                                                                                            java.io.File file,
                                                                                            BodyPostTaskArtifactsS3ObjectAddV1ShippingTaskArtifactsS3ObjectAddV1TaskArtifactIdPost request)

Uploads a file (image, PDF, etc.) to a task artifact. Automatic blurhash generation for images. | authz_personas=[courier_driver, forwarder_org_operators, courier_org_operators, shipper_org_operators] | (UploadFile) -> (bool)

addV1

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

Uploads a file (image, PDF, etc.) to a task artifact. Automatic blurhash generation for images. | authz_personas=[courier_driver, forwarder_org_operators, courier_org_operators, shipper_org_operators] | (UploadFile) -> (bool)

deleteV1

public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<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<ChrtApiHttpResponse<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)