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

Class RawS3ObjectClient

java.lang.Object

com.chrt.api.resources.shipping.taskgroups.s3object.RawS3ObjectClient

public class RawS3ObjectClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
RawS3ObjectClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
ChrtApiHttpResponse<java.lang.Boolean>	addV1(java.lang.String taskGroupId, java.io.File file, BodyPostTaskGroupsS3ObjectAddV1ShippingTaskGroupsS3ObjectAddV1TaskGroupIdPost request)	Uploads a file (image, PDF, etc.) to a task group.
ChrtApiHttpResponse<java.lang.Boolean>	addV1(java.lang.String taskGroupId, java.io.File file, BodyPostTaskGroupsS3ObjectAddV1ShippingTaskGroupsS3ObjectAddV1TaskGroupIdPost request, RequestOptions requestOptions)	Uploads a file (image, PDF, etc.) to a task group.
ChrtApiHttpResponse<java.lang.Boolean>	deleteV1(java.lang.String taskGroupS3ObjectMetadataId)	Deletes an S3 object metadata and the associated S3 object from a task group.
ChrtApiHttpResponse<java.lang.Boolean>	deleteV1(java.lang.String taskGroupS3ObjectMetadataId, RequestOptions requestOptions)	Deletes an S3 object metadata and the associated S3 object from a task group.
ChrtApiHttpResponse<TaskGroupS3ObjectMetadata1>	getS3ObjectMetadataV1(java.lang.String taskGroupS3ObjectMetadataId)	Retrieves the metadata for a task group S3 object, including blurhash for placeholder loading.
ChrtApiHttpResponse<TaskGroupS3ObjectMetadata1>	getS3ObjectMetadataV1(java.lang.String taskGroupS3ObjectMetadataId, RequestOptions requestOptions)	Retrieves the metadata for a task group S3 object, including blurhash for placeholder loading.
ChrtApiHttpResponse<java.io.InputStream>	getV1(java.lang.String taskGroupS3ObjectMetadataId)	Streams a task group S3 object file from storage.
ChrtApiHttpResponse<java.io.InputStream>	getV1(java.lang.String taskGroupS3ObjectMetadataId, RequestOptions requestOptions)	Streams a task group 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

RawS3ObjectClient

public RawS3ObjectClient(ClientOptions clientOptions)

Method Detail

getS3ObjectMetadataV1

public ChrtApiHttpResponse<TaskGroupS3ObjectMetadata1> getS3ObjectMetadataV1(java.lang.String taskGroupS3ObjectMetadataId)

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

getS3ObjectMetadataV1

public ChrtApiHttpResponse<TaskGroupS3ObjectMetadata1> getS3ObjectMetadataV1(java.lang.String taskGroupS3ObjectMetadataId,
                                                                             RequestOptions requestOptions)

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

getV1

public ChrtApiHttpResponse<java.io.InputStream> getV1(java.lang.String taskGroupS3ObjectMetadataId)

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

getV1

public ChrtApiHttpResponse<java.io.InputStream> getV1(java.lang.String taskGroupS3ObjectMetadataId,
                                                      RequestOptions requestOptions)

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

addV1

public ChrtApiHttpResponse<java.lang.Boolean> addV1(java.lang.String taskGroupId,
                                                    java.io.File file,
                                                    BodyPostTaskGroupsS3ObjectAddV1ShippingTaskGroupsS3ObjectAddV1TaskGroupIdPost request)

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

addV1

public ChrtApiHttpResponse<java.lang.Boolean> addV1(java.lang.String taskGroupId,
                                                    java.io.File file,
                                                    BodyPostTaskGroupsS3ObjectAddV1ShippingTaskGroupsS3ObjectAddV1TaskGroupIdPost request,
                                                    RequestOptions requestOptions)

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

deleteV1

public ChrtApiHttpResponse<java.lang.Boolean> deleteV1(java.lang.String taskGroupS3ObjectMetadataId)

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

deleteV1

public ChrtApiHttpResponse<java.lang.Boolean> deleteV1(java.lang.String taskGroupS3ObjectMetadataId,
                                                       RequestOptions requestOptions)

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