Package com.chrt.api.resources.shipping.drivers.compliancedocuments.s3object

Class S3ObjectClient

java.lang.Object

com.chrt.api.resources.shipping.drivers.compliancedocuments.s3object.S3ObjectClient

public class S3ObjectClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
S3ObjectClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
boolean	addV1(java.lang.String driverComplianceDocumentId, java.io.File file, BodyPostDriverComplianceDocumentsS3ObjectAddV1ShippingDriversComplianceDocumentsS3ObjectAddV1DriverComplianceDocumentIdPost request)	Uploads a file to a driver compliance document.
boolean	addV1(java.lang.String driverComplianceDocumentId, java.io.File file, BodyPostDriverComplianceDocumentsS3ObjectAddV1ShippingDriversComplianceDocumentsS3ObjectAddV1DriverComplianceDocumentIdPost request, RequestOptions requestOptions)	Uploads a file to a driver compliance document.
boolean	deleteV1(java.lang.String driverComplianceDocumentS3ObjectMetadataId)	Deletes a driver compliance document S3 object and metadata.
boolean	deleteV1(java.lang.String driverComplianceDocumentS3ObjectMetadataId, RequestOptions requestOptions)	Deletes a driver compliance document S3 object and metadata.
DriverComplianceDocumentS3ObjectMetadata1	getS3ObjectMetadataV1(java.lang.String driverComplianceDocumentS3ObjectMetadataId)	Retrieves metadata for a driver compliance document S3 object.
DriverComplianceDocumentS3ObjectMetadata1	getS3ObjectMetadataV1(java.lang.String driverComplianceDocumentS3ObjectMetadataId, RequestOptions requestOptions)	Retrieves metadata for a driver compliance document S3 object.
java.io.InputStream	getV1(java.lang.String driverComplianceDocumentS3ObjectMetadataId)	Streams a driver compliance document S3 object file from storage.
java.io.InputStream	getV1(java.lang.String driverComplianceDocumentS3ObjectMetadataId, RequestOptions requestOptions)	Streams a driver compliance document S3 object file from storage.
RawS3ObjectClient	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

S3ObjectClient

public S3ObjectClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawS3ObjectClient withRawResponse()

Get responses with HTTP metadata like headers

getS3ObjectMetadataV1

public DriverComplianceDocumentS3ObjectMetadata1 getS3ObjectMetadataV1(java.lang.String driverComplianceDocumentS3ObjectMetadataId)

Retrieves metadata for a driver compliance document S3 object. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (DriverComplianceDocumentS3ObjectMetadata1)

getS3ObjectMetadataV1

public DriverComplianceDocumentS3ObjectMetadata1 getS3ObjectMetadataV1(java.lang.String driverComplianceDocumentS3ObjectMetadataId,
                                                                       RequestOptions requestOptions)

Retrieves metadata for a driver compliance document S3 object. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (DriverComplianceDocumentS3ObjectMetadata1)

getV1

public java.io.InputStream getV1(java.lang.String driverComplianceDocumentS3ObjectMetadataId)

Streams a driver compliance document S3 object file from storage. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (binary)

getV1

public java.io.InputStream getV1(java.lang.String driverComplianceDocumentS3ObjectMetadataId,
                                 RequestOptions requestOptions)

Streams a driver compliance document S3 object file from storage. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (binary)

addV1

public boolean addV1(java.lang.String driverComplianceDocumentId,
                     java.io.File file,
                     BodyPostDriverComplianceDocumentsS3ObjectAddV1ShippingDriversComplianceDocumentsS3ObjectAddV1DriverComplianceDocumentIdPost request)

Uploads a file to a driver compliance document. Automatic blurhash generation for images. | authz: allowed_org_types=[provider], min_org_role=administrator | (UploadFile) -> (bool)

addV1

public boolean addV1(java.lang.String driverComplianceDocumentId,
                     java.io.File file,
                     BodyPostDriverComplianceDocumentsS3ObjectAddV1ShippingDriversComplianceDocumentsS3ObjectAddV1DriverComplianceDocumentIdPost request,
                     RequestOptions requestOptions)

Uploads a file to a driver compliance document. Automatic blurhash generation for images. | authz: allowed_org_types=[provider], min_org_role=administrator | (UploadFile) -> (bool)

deleteV1

public boolean deleteV1(java.lang.String driverComplianceDocumentS3ObjectMetadataId)

Deletes a driver compliance document S3 object and metadata. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (bool)

deleteV1

public boolean deleteV1(java.lang.String driverComplianceDocumentS3ObjectMetadataId,
                        RequestOptions requestOptions)

Deletes a driver compliance document S3 object and metadata. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (bool)