Class: module:api/ObjectsApi

module:api/ObjectsApi(apiClient)

new module:api/ObjectsApi(apiClient)

Constructs a new ObjectsApi.

Parameters:
Name Type Description
apiClient module:ApiClient

Optional API client implementation to use, default to module:ApiClient#instance if unspecified.
Source:

Methods

(async) calculateSHA1(strorbuffer) → {Promise.<String>}

Calc SHA1

Parameters:
Name Type Description
strorbuffer String | Buffer | Stream

Content to calc SHA1 for
Source:
Returns:
Type
Promise.<String>

(async) completeS3Upload(bucketKey, objectKey, body, credentials, optsopt, oauth2client, credentials) → {Promise.<any>}

Instructs OSS to complete the object creation process after the bytes have been uploaded directly to S3.

Parameters:
Name Type Attributes Description
bucketKey String

bucket key (will be URL-encoded automatically)
objectKey String

object key (will be URL-encoded automatically)
body Object
Properties
Name Type Attributes Description
uploadKey String

The identifier of the upload session, which was provided by OSS in the response to the Get Upload URL/s request.
size Integer <optional>

The expected size of the uploaded object. If provided, OSS will check this against the blob in S3 and return an error if the size does not match.
credentials
opts Object <optional>

Optional parameters

Properties
Name Type Attributes Description
xAdsMetaContentType String <optional>

(x-ads-meta-Content-Type) The Content-Type value that OSS will store in the record for the uploaded object.
xAdsMetaContentDisposition String <optional>

(x-ads-meta-Content-Disposition) The Content-Disposition value that OSS will store in the record for the uploaded object.
xAdsMetaContentEncoding String <optional>

(x-ads-meta-Content-Encoding) The Content-Encoding value that OSS will store in the record for the uploaded object.
xAdsMetaCacheControl String <optional>

(x-ads-meta-Cache-Control) The Cache-Control value that OSS will store in the record for the uploaded object.
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:
Returns:
Type
Promise.<any>

(async) completeS3Uploads(bucketKey, body, optsopt, oauth2client, credentials) → {Promise.<any>}

Instructs OSS to complete the object creation process for numerous objects after their bytes have been uploaded directly to S3.

Parameters:
Name Type Attributes Description
bucketKey String

bucket key (will be URL-encoded automatically)
body Object

body parameter

Properties
Name Type Description
requests Array.<Object>

An array of objects representing each request to get an S3 URL to download from.

Properties
Name Type Attributes Description
objectKey String

The key/name of the object for which to complete an upload.
uploadKey String

The identifier of the upload session, which was provided by OSS in the response to the Get Upload URL/s request.
size Integer <optional>

The expected size of the uploaded object. If provided, OSS will check this against the blob in S3 and return an error if the size does not match.
body.requests[].xAdsMetaContentType String <optional>

(x-ads-meta-Content-Type) The Content-Type value that OSS will store in the record for the uploaded object.
body.requests[].xAdsMetaContentDisposition String <optional>

(x-ads-meta-Content-Disposition) The Content-Disposition value that OSS will store in the record for the uploaded object.
body.requests[].xAdsMetaContentEncoding String <optional>

(x-ads-meta-Content-Encoding) The Content-Encoding value that OSS will store in the record for the uploaded object.
body.requests[].xAdsMetaCacheControl String <optional>

(x-ads-meta-Cache-Control) The Cache-Control value that OSS will store in the record for the uploaded object.
opts Object <optional>

Optional parameters
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:
Returns:
Type
Promise.<any>

(async) copyTo(bucketKey, objectKey, newObjectKey, oauth2client, credentials) → {Promise.<ObjectDetails>}

Copies an object to another object name in the same bucket.

Parameters:
Name Type Description
bucketKey String

bucket key (will be URL-encoded automatically)
objectKey String

object key (will be URL-encoded automatically)
newObjectKey String

bject key to use as the destination (will be URL-encoded automatically) data is of type: {module:model/ObjectDetails}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:
Returns:
Type
Promise.<ObjectDetails>

(async) createSignedResource(bucketKey, objectKey, postBucketsSigned, optsopt, oauth2client, credentials) → {Promise.<PostObjectSigned>}

This endpoint creates a signed URL that can be used to download an object within the specified expiration time. Be aware that if the object the signed URL points to is deleted or expires before the signed URL expires, then the signed URL will no longer be valid. A successful call to this endpoint requires bucket owner access.

Parameters:
Name Type Attributes Description
bucketKey String

bucket key (will be URL-encoded automatically)
objectKey String

object key (will be URL-encoded automatically)
postBucketsSigned module:model/PostBucketsSigned

Body Structure
opts Object <optional>

Optional parameters

Properties
Name Type Attributes Default Description
access String <optional>
 read

Access for signed resource Acceptable values: read, write, readwrite. Default value: read (default to read)
useCdn Boolean <optional>
 true

If true, this will generate a CloudFront URL for the S3 object data is of type: {module:model/PostObjectSigned}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:
Returns:
Type
Promise.<PostObjectSigned>

(async) deleteObject(bucketKey, objectKey, oauth2client, credentials) → {Promise.<void>}

Deletes an object from the bucket.

Parameters:
Name Type Description
bucketKey String

bucket key (will be URL-encoded automatically)
objectKey String

object key (will be URL-encoded automatically)
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:
Returns:
Type
Promise.<void>

(async) deleteSignedResource(id, optsopt, oauth2client, credentials) → {Promise.<void>}

Delete a signed URL. A successful call to this endpoint requires bucket owner access.

Parameters:
Name Type Attributes Description
id String

Id of signed resource
opts Object <optional>

Optional parameters

Properties
Name Type Attributes Default Description
region String <optional>
 US

The region where the bucket resides Acceptable values: US, EMEA Default is US (default to US)
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:
Returns:
Type
Promise.<void>

(async) downloadResources(bucketKey, objects, optsopt, oauth2client, credentials) → {Promise.<Array.<any>>}

Download a resource.

Parameters:
Name Type Attributes Description
bucketKey String

bucket key (will be URL-encoded automatically)
objects Object | Array.<Object>

Object or Object array of resource to uplaod with their parameters
object[].objectKey String

object key
object[].responseType String

Resource to upload If String, it is the expected response type (defaults to json) ['arraybuffer', 'document', 'json', 'text', 'stream'] If you 'stream', you need to provide a writable stream ('data'), the method will pipe content into it.
opts Object <optional>

Optional parameters

Properties
Name Type Attributes Default Description
publicResourceFallback Boolean <optional>
 false

Allows fallback to OSS signed URLs in case of unmerged resumable uploads.
useCdn Boolean <optional>
 true

Will generate a CloudFront URL for the S3 object.
minutesExpiration Integer <optional>
 2

The custom expiration time within the 1 to 60 minutes range, if not specified, default is 2 minutes.
onDownloadProgress function <optional>

(progressEvent) => {}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:
Returns:
Type
Promise.<Array.<any>>

(async) getObject(bucketKey, objectKey, optsopt, oauth2client, credentials) → {Promise.<any>}

Download an object.

Parameters:
Name Type Attributes Description
bucketKey String

bucket key (will be URL-encoded automatically)
objectKey String

object key (will be URL-encoded automatically)
opts Object <optional>

Optional parameters

Properties
Name Type Attributes Description
range String <optional>

A range of bytes to download from the specified object.
ifNoneMatch String <optional>

The value of this header is compared to the ETAG of the object. If they match, the body will not be included in the response. Only the object information will be included.
ifModifiedSince Date <optional>

If the requested object has not been modified since the time specified in this field, an entity will not be returned from the server; instead, a 304 (not modified) response will be returned without any message body.
acceptEncoding String <optional>

When gzip is specified, a gzip compressed stream of the object’s bytes will be returned in the response. Cannot use “Accept-Encoding:gzip” with Range header containing an end byte range. End byte range will not be honored if “Accept-Encoding: gzip” header is used.
accepts String <optional>

Optional array of possible Accepts header data is of type: {Object}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Deprecated:
  • Yes
Source:
Returns:
Type
Promise.<any>

(async) getObjectDetails(bucketKey, objectKey, optsopt, oauth2client, credentials) → {Promise.<ObjectFullDetails>}

Returns object details in JSON format.

Parameters:
Name Type Attributes Description
bucketKey String

bucket key (will be URL-encoded automatically)
objectKey String

object key (will be URL-encoded automatically)
opts Object <optional>

Optional parameters

Properties
Name Type Attributes Description
ifModifiedSince Date <optional>

If the requested object has not been modified since the time specified in this field, an entity will not be returned from the server; instead, a 304 (not modified) response will be returned without any message body.
with String | Array.<String> <optional>

Extra information in details; multiple uses are supported Acceptable values: createdDate, lastAccessedDate, lastModifiedDate data is of type: {module:model/ObjectFullDetails}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:
Returns:
Type
Promise.<ObjectFullDetails>

(async) getObjects(bucketKey, optsopt, oauth2client, credentials) → {Promise.<BucketObjects>}

List objects in a bucket. It is only available to the bucket creator.

Parameters:
Name Type Attributes Description
bucketKey String

bucket key (will be URL-encoded automatically)
opts Object <optional>

Optional parameters

Properties
Name Type Attributes Default Description
limit Integer <optional>
 10

Limit to the response size, Acceptable values: 1-100 Default = 10 (default to 10)
beginsWith String <optional>

Provides a way to filter the based on object key name
startAt String <optional>

Key to use as an offset to continue pagination This is typically the last bucket key found in a preceding GET buckets response data is of type: {module:model/BucketObjects}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:
Returns:
Type
Promise.<BucketObjects>

(async) getS3DownloadURL(bucketKey, objectKey, optsopt, oauth2client, credentials) → {Promise.<ObjectS3Download>}

Returns a signed S3 URL.

Parameters:
Name Type Attributes Description
bucketKey String

bucket key (will be URL-encoded automatically)
objectKey String

bucobjectket key (will be URL-encoded automatically)
opts Object <optional>

Optional parameters

Properties
Name Type Attributes Default Description
ifNoneMatch String <optional>

If the value of this header matches the ETag of the object, an entity will not be returned from the server; instead a 304 (not modified) response will be returned without any message-body.
ifModifiedSince Date <optional>

If the requested object has not been modified since the time specified in this field, an entity will not be returned from the server; instead, a 304 (not modified) response will be returned without any message-body.
responseContentType String <optional>

Value of the Content-Type header that the client expects to receive. If this attribute is not provided, it defaults to the value corresponding to the object.
responseContentDisposition String <optional>

Value of the Content Disposition header the client expects to receive. If this attribute is not provided, it defaults to the value corresponding to the object.
responseCacheControl String <optional>

Value of the Cache-Control header that the client expects to receive. If this attribute is not provided, it defaults to the value corresponding to the object.
publicResourceFallback Boolean <optional>
 false

Allows fallback to OSS signed URLs in case of unmerged resumable uploads.
useCdn Boolean <optional>
 true

Will generate a CloudFront URL for the S3 object.
minutesExpiration Integer <optional>
 2

The custom expiration time within the 1 to 60 minutes range, if not specified, default is 2 minutes. data is of type: {module:model/ObjectS3Download}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:
Returns:
Type
Promise.<ObjectS3Download>

(async) getS3DownloadURLs(bucketKey, body, optsopt, oauth2client, credentials) → {Promise.<any>}

Gets one or more signed URLs to objects. The signed URLs can be used to download the objects directly from S3, skipping OSS servers. Be aware that expiration time for the signed URL(s) is just 60 seconds. So, a request to the URL(s) must begin within 60 seconds; the transfer of the data can exceed 60 seconds. A successful call to this endpoint requires bucket owner access. Note that resumable uploads store each chunk individually. After upload completes, an async process merges all the chunks and creates the definitive OSS file. This async process can take time. If you request an S3 download URL before the async process completes, the response returns a map of S3 URLs, one per chunk where the key is the corresponding range bytes. In case you don’t want multiple URLs in the response, you can use OSS signed URL functionality, with the public-resource-fallback query parameter set to true. Note: While this endpoint does not support range headers, the returned URL(s) can be used for ranged downloads. This way, downloads can be parallelized using multiple ranges for maximum speed.

Parameters:
Name Type Attributes Description
bucketKey String

bucket key (will be URL-encoded automatically)
body Object

body parameter

Properties
Name Type Description
requests Array.<Object>

An array of objects representing each request to get an S3 URL to download from.

Properties
Name Type Attributes Description
objectKey String

Object name to create a download S3 signed URL for
response-content-type String <optional>

Value of the Content-Type header that the client expects to receive. If this attribute is not provided, it defaults to the value corresponding to the object.
response-content-disposition String <optional>

Value of the Content Disposition header the client expects to receive. If this attribute is not provided, it defaults to the value corresponding to the object.
response-cache-control String <optional>

Value of the Cache-Control header that the client expects to receive. If this attribute is not provided, it defaults to the value corresponding to the object.
If-None-Match String <optional>

The value of this attribute is compared to the ETAG of the object. If they match, the response body will show the status of this item as “skipped” with the reason as “Not modified”.
If-Modified-Since Date <optional>

If the requested object has not been modified since the time specified in this attribute, the response body will show the status of this item as “skipped” with the reason as “Not modified”.
opts Object <optional>

Optional parameters

Properties
Name Type Attributes Default Description
publicResourceFallback Boolean <optional>
 false

(public-resource-fallback) Allows fallback to OSS signed URLs in case of unmerged resumable uploads.
useCdn Boolean <optional>
 true

Will generate a CloudFront URL for the S3 object.
minutesExpiration Integer <optional>
 2

The custom expiration time within the 1 to 60 minutes range, if not specified, default is 2 minutes. data is of type: {Object.module:model/ObjectS3Download}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:
Returns:
Type
Promise.<any>

(async) getS3UploadURL(bucketKey, objectKey, optsopt, oauth2client, credentials) → {Promise.<any>}

Requests an S3 signed URL with which to upload an object, or an array of signed URLs with which to upload an object in multiple parts.

Parameters:
Name Type Attributes Description
bucketKey String

bucket key (will be URL-encoded automatically)
objectKey String

object key (will be URL-encoded automatically)
opts Object <optional>

Optional parameters

Properties
Name Type Attributes Default Description
uploadKey String <optional>

Get a new set of signed urls if the ones that were generated before have already expired and the user still needs to upload some of them.
firstParts Integer <optional>
 1

For a multipart upload, is the starting index when getting upload part URL. If this parameter is not specified the default value is firstPart = 1. Example: To retrieve the parts from 10 to 15 you should pass firstPart = 10 and parts = 6, this will retrieve the parts 10, 11, 12, 13, 14 and 15.
parts Integer <optional>
 1

For a multipart upload, is the starting index when getting upload part URL. If this parameter is not specified the default value is firstPart = 1. Example: To retrieve the parts from 10 to 15 you should pass firstPart = 10 and parts = 6, this will retrieve the parts 10, 11, 12, 13, 14 and 15.
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:
Returns:
Type
Promise.<any>

(async) getS3UploadURLs(bucketKey, body, optsopt, oauth2client, credentials) → {Promise.<any>}

Requests a batch of S3 signed URL with which to upload multiple objects or chunks of multiple objects.

Parameters:
Name Type Attributes Description
bucketKey String

bucket key (will be URL-encoded automatically)
body Object

body parameter

Properties
Name Type Description
requests Array.<Object>

An array of objects representing each request to get an S3 URL to download from.

Properties
Name Type Attributes Default Description
objectKey String

The key/name of the object for which to create an S3 upload URL. If neither the “part” nor “parts” attribute is provided, OSS will return a single upload URL with which to upload the entire object.
uploadKey String <optional>

Get a new set of signed urls if the ones that were generated before have already expired and the user still needs to upload some of them.
firstParts Integer <optional>
 1

For a multipart upload, is the starting index when getting upload part URL. If this parameter is not specified the default value is firstPart = 1. Example: To retrieve the parts from 10 to 15 you should pass firstPart = 10 and parts = 6, this will retrieve the parts 10, 11, 12, 13, 14 and 15.
parts Integer <optional>
 1

For a multipart upload, is the starting index when getting upload part URL. If this parameter is not specified the default value is firstPart = 1. Example: To retrieve the parts from 10 to 15 you should pass firstPart = 10 and parts = 6, this will retrieve the parts 10, 11, 12, 13, 14 and 15.
opts Object <optional>

Optional parameters

Properties
Name Type Attributes Default Description
useAcceleration Boolean <optional>
 true

Whether or not to generate an accelerated signed URL (ie: URLs of the form …s3-accelerate.amazonaws.com… vs …s3.amazonaws.com…). When not specified, defaults to true. Providing non-boolean values will result in a 400 error.
minutesExpiration Integer <optional>
 2

The custom expiration time within the 1 to 60 minutes range, if not specified, default is 2 minutes.
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:
Returns:
Type
Promise.<any>

(async) getSignedResource(id, optsopt, oauth2client, credentials) → {Promise.<any>}

Download an object using a signed URL.

Parameters:
Name Type Attributes Description
id String

Id of signed resource
opts Object <optional>

Optional parameters

Properties
Name Type Attributes Default Description
range String <optional>

A range of bytes to download from the specified object.
ifNoneMatch String <optional>

The value of this header is compared to the ETAG of the object. If they match, the body will not be included in the response. Only the object information will be included.
ifModifiedSince Date <optional>

If the requested object has not been modified since the time specified in this field, an entity will not be returned from the server; instead, a 304 (not modified) response will be returned without any message body.
acceptEncoding String <optional>

When gzip is specified, a gzip compressed stream of the object’s bytes will be returned in the response. Cannot use “Accept-Encoding:gzip” with Range header containing an end byte range. End byte range will not be honored if “Accept-Encoding: gzip” header is used.
region String <optional>
 US

The region where the bucket resides Acceptable values: US, EMEA Default is US (default to US)
accepts String <optional>

Optional array of possible Accepts header data is of type: {Object}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Deprecated:
  • Yes
Source:
Returns:
Type
Promise.<any>

(async) getStatusBySessionId(bucketKey, objectKey, sessionId, oauth2client, credentials)

This endpoint returns status information about a resumable upload.

Parameters:
Name Type Description
bucketKey String

bucket key (will be URL-encoded automatically)
objectKey String

object key (will be URL-encoded automatically)
sessionId String

Unique identifier of a session of a file being uploaded
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

(async) uploadChunk(bucketKey, objectKey, contentLength, contentRange, sessionId, body, optsopt, oauth2client, credentials) → {Promise.<ObjectDetails>}

This endpoint allows resumable uploads for large files in chunks.

Parameters:
Name Type Attributes Description
bucketKey String

bucket key (will be URL-encoded automatically)
objectKey String

object key (will be URL-encoded automatically)
contentLength Integer

Indicates the size of the request body.
contentRange String

Byte range of a segment being uploaded
sessionId String

Unique identifier of a session of a file being uploaded
body File
opts Object <optional>

Optional parameters

Properties
Name Type Attributes Description
contentType String <optional>

Optional array of possible Content-Type header
contentDisposition String <optional>

The suggested default filename when downloading this object to a file after it has been uploaded.
ifMatch String <optional>

If-Match header containing a SHA-1 hash of the bytes in the request body can be sent by the calling service or client application with the request. If present, OSS will use the value of If-Match header to verify that a SHA-1 calculated for the uploaded bytes server side matches what was sent in the header. If not, the request is failed with a status 412 Precondition Failed and the data is not written.
xAdsChunkSha1 String <optional>

A SHA-1 checksum of the chunk represented as a hexadecimal string. If the SHA-1 hash in the header does not match the SHA-1 hash computed by the server for the uploaded chunk, the request fails (status code 400). You can try to upload it again. data is of type: {module:model/ObjectDetails}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Deprecated:
  • Yes
Source:
Returns:
Type
Promise.<ObjectDetails>

(async) uploadObject(bucketKey, objectKey, contentLength, body, optsopt, oauth2client, credentials) → {Promise.<ObjectDetails>}

Upload an object. If the specified object name already exists in the bucket, the uploaded content will overwrite the existing content for the bucket name/object name combination.

Parameters:
Name Type Attributes Description
bucketKey String

bucket key (will be URL-encoded automatically)
objectKey String

object key (will be URL-encoded automatically)
contentLength Integer

Indicates the size of the request body.
body File
opts Object <optional>

Optional parameters

Properties
Name Type Attributes Description
contentType Integer <optional>

Optional array of possible Content-Type header
contentDisposition String <optional>

The suggested default filename when downloading this object to a file after it has been uploaded.
ifMatch String <optional>

If-Match header containing a SHA-1 hash of the bytes in the request body can be sent by the calling service or client application with the request. If present, OSS will use the value of If-Match header to verify that a SHA-1 calculated for the uploaded bytes server side matches what was sent in the header. If not, the request is failed with a status 412 Precondition Failed and the data is not written.
xAdsContentSha1 String <optional>

A SHA-1 checksum of the object represented as a hexadecimal string. If the SHA-1 hash in the header does not match the SHA-1 hash computed by the server for the uploaded object, the request fails (status code 400). data is of type: {module:model/ObjectDetails}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Deprecated:
  • Yes
Source:
Returns:
Type
Promise.<ObjectDetails>

(async) uploadResources(bucketKey, objects, credentials, optsopt, oauth2client, credentials) → {Promise.<Array.<any>>}

Upload a resource. If the specified object name already exists in the bucket, the uploaded content will overwrite the existing content for the bucket name/object name combination.

Parameters:
Name Type Attributes Description
bucketKey String

bucket key (will be URL-encoded automatically)
objects Object | Array.<Object>

Object or Object array of resource to uplaod with their parameters
object[].objectKey String

object key
object[].data String | Buffer | Stream

Resource to upload (String| Buffer | Stream)
credentials
object[].xAdsMetaContentType String <optional>

(x-ads-meta-Content-Type) The Content-Type value that OSS will store in the record for the uploaded object.
object[].xAdsMetaContentDisposition String <optional>

(x-ads-meta-Content-Disposition) The Content-Disposition value that OSS will store in the record for the uploaded object.
object[].xAdsMetaContentEncoding String <optional>

(x-ads-meta-Content-Encoding) The Content-Encoding value that OSS will store in the record for the uploaded object.
object[].xAdsMetaCacheControl String <optional>

(x-ads-meta-Cache-Control) The Cache-Control value that OSS will store in the record for the uploaded object.
opts Object <optional>

Optional parameters
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:
Returns:
Type
Promise.<Array.<any>>

(async) uploadSignedResource(id, contentLength, body, optsopt, oauth2client, credentials) → {Promise.<ObjectDetails>}

Overwrite a existing object using a signed URL. Conditions to call this operation: Object is available Expiration period is valid Signed URL should be created with write or readwrite

Parameters:
Name Type Attributes Default Description
id String

Id of signed resource
contentLength Integer

Indicates the size of the request body.
body File
opts Object <optional>

Optional parameters
opt.contentType String <optional>

Optional array of possible Content-Type header
opts.contentDisposition String <optional>

The suggested default filename when downloading this object to a file after it has been uploaded.
opts.xAdsRegion String <optional>
 US

The region where the bucket resides Acceptable values: US, EMEA Default is US (default to US)
opts.ifMatch String

If-Match header containing a SHA-1 hash of the bytes in the request body can be sent by the calling service or client application with the request. If present, OSS will use the value of If-Match header to verify that a SHA-1 calculated for the uploaded bytes server side matches what was sent in the header. If not, the request is failed with a status 412 Precondition Failed and the data is not written. data is of type: {module:model/ObjectDetails}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Deprecated:
  • Yes
Source:
Returns:
Type
Promise.<ObjectDetails>

(async) uploadSignedResourcesChunk(id, contentRange, sessionId, body, optsopt, oauth2client, credentials) → {Promise.<ObjectDetails>}

Resumable upload for signed URLs.

Parameters:
Name Type Attributes Description
id String

Id of signed resource
contentRange String

Byte range of a segment being uploaded
sessionId String

Unique identifier of a session of a file being uploaded
body File
opts Object <optional>

Optional parameters

Properties
Name Type Attributes Default Description
contentType String <optional>

Optional array of possible Content-Type header
contentDisposition String <optional>

The suggested default filename when downloading this object to a file after it has been uploaded.
xAdsRegion String <optional>
 US

The region where the bucket resides Acceptable values: US, EMEA Default is US (default to US) data is of type: {module:model/ObjectDetails}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Deprecated:
  • Yes
Source:
Returns:
Type
Promise.<ObjectDetails>