StartBatchRequest | @here/olp-sdk-ts
Class StartBatchRequest
Hierarchy
- StartBatchRequest
Index
Constructors
constructor
Returns StartBatchRequest
Methods
get
Gets the billing tag (if it was set).
Returns undefined | string
The billing tag or
undefinedif it was not set.
get
Gets the layers used in this batch operation.
Returns undefined | string[]
The array of layer IDs or
undefined.
get
Gets the version dependencies of this batch operation.
Returns undefined | PublishApi.VersionDependency[]
The array of the version dependencies or
undefined.
with
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 StartBatchRequest
A reference to this object.
with
Sets the layers to use in this batch operation.
Parameters
layers: string[]
The IDs of the layers to use in this batch operation.
Returns StartBatchRequest
A reference to this object.
with
Sets the version dependencies used in this batch operation.
Parameters
versionDependencies: PublishApi.VersionDependency[]
The array of version dependencies.
Returns StartBatchRequest
A reference to this object.
Generated using TypeDoc
Starts a batch operation for a versioned layer.