PublishSinglePartitionRequest | @here/olp-sdk-ts
Class PublishSinglePartitionRequest
Hierarchy
- PublishSinglePartitionRequest
Index
Constructors
constructor
Returns PublishSinglePartitionRequest
Methods
get Billing Tag
Gets the billing tag (if it was set).
Returns undefined | string
The billing tag or
undefinedif it was not set.
get Content Encoding
Returns undefined | string
The content encoding of the data to upload.
get Content Type
Returns undefined | string
The content type of the data to upload.
get Data
Gets the data (if it was set).
Returns undefined | ArrayBuffer | Buffer
The data or
undefinedif it was not set.
get Layer Id
Gets the ID of the layer.
Returns undefined | string
The ID of the layer.
get Metadata
Gets the metadata of the partition.
Returns undefined | PublishPartition
The metadata of the partition.
get Publication Id
Gets the ID of the publication that you want to upload.
Returns undefined | string
The ID of the publication that you want to upload.
with Billing Tag
Sets the billing tag.
Parameters
tag: string
The free-form tag that is used for grouping billing records together. If supplied, it must be 4–16 characters long and contain only alphanumeric ASCII characters [A–Za–z0–9].
Returns PublishSinglePartitionRequest
A reference to this object.
with Content Encoding
Set the content encoding of the data to upload.
Can be
gzipor identity.Parameters
contentEncoding: string
The content encoding of the data to upload.
Returns PublishSinglePartitionRequest
A reference to this object
with Content Type
Parameters
contentType: string
The content type of the data to upload.
Returns PublishSinglePartitionRequest
A reference to this object
with Data
Uses embedded data in the
PublishPartitionoruploadBlob()API.Parameters
data: ArrayBuffer | Buffer
The content published directly to the metadata and encoded in Base64. The size of the content is limited.
Returns PublishSinglePartitionRequest
A reference to this object.
with Layer Id
Sets the ID of the layer.
Parameters
id: string
The layer ID.
Returns PublishSinglePartitionRequest
A reference to this object.
with Meta Data
Sets the metadata of the partition that you want to publish.
Parameters
metaData: PublishPartition
The metadata for the blob data that you want to publish.
Returns PublishSinglePartitionRequest
A reference to this object.
with Publication Id
Sets the ID of the publication that you want to upload.
Parameters
id: string
The ID of the publication that you want to upload.
Returns PublishSinglePartitionRequest
A reference to this object.
Generated using TypeDoc
Uploads a single partition.