GuidesChangelogTypeScript API ReferencePython v2 API Reference

VersionedLayerClient

Describes a versioned layer and provides a possibility to publish data to it.

Hierarchy

  • VersionedLayerClient

Index

Constructors

Methods

Constructors

constructor

Methods

cancelBatch

  • Cancels the publication if it has not been submitted.

    Fails if you attempt to cancel a submitted publication. This allows the specified publication to be abandoned.

    Parameters

    • request: CancelBatchRequest

      The details of the cancel operation.

    • Optional abortSignal: AbortSignal

      The signal object that allows you to communicate with the request and, if required, abort it using the AbortController object. For more information, see the AbortController documentation.

    Returns Promise<Response>

    True if the operation was successful; rejects with an error otherwise.

checkDataExists

  • Checks whether the data handle is not used.

    Data handles must be unique within a layer across all versions. If the data handle exists, generate a new one and check it again to be sure that it is not present in the blob store.

    Parameters

    • request: CheckDataExistsRequest

      CheckDataExistsRequest with the required params.

    • Optional abortSignal: AbortSignal

      The signal object that allows you to communicate with the request and, if required, abort it using the AbortController object. For more information, see the AbortController documentation.

    Returns Promise<Response>

    The Promise void if the data handle exists. If the data handle does not exist, rejects with an HTTP response (404 status) or an HTTP error.

completeBatch

  • Submits the publication (that is a batch) and initiates post-processing if necessary.

    You cannot modify or interrupt the publication process, so double-check the publication details before submitting it.

    The publication state becomes Submitted directly after submission and Succeeded after successful processing. You can only complete a publication that is in the Initialized state.

    Once you trigger to complete a publication, request the status of the publication regularly until the status becomes Succeeded.

    When you submit the publication, the metadata processing starts.

    Parameters

    • request: CompleteBatchRequest

      The details of the publication completion.

    • Optional abortSignal: AbortSignal

      The signal object that allows you to communicate with the request and, if required, abort it using the AbortController object. For more information, see the AbortController documentation.

    Returns Promise<Response>

    The Promise resolves if the operation was successful; rejects otherwise.

getBaseVersion

  • getBaseVersion(billingTag?: string, abortSignal?: AbortSignal): Promise<number>

  • Gets the latest version of the catalog.

    The default value is -1. By convention -1 indicates the virtual initial version before the first publication that has version 0.

    Parameters

    • Optional billingTag: 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].

    • Optional abortSignal: AbortSignal

      The signal object that allows you to communicate with the request and, if required, abort it using the AbortController object. For more information, see the AbortController documentation.

    Returns Promise<number>

    The Promise of the HTTP response that contains the payload with the latest version.

getBatch

publishToBatch

startBatch

  • Starts a new publication.

    Determines the publication type based on the provided layer IDs. A publication can only consist of layer IDs that have the same layer type. For example, you can have a publication for multiple versioned layers, but you cannot have a single publication that publishes data to both versioned and stream layers.

    Also, you can only have one versioned-layer publication in progress at a time. You cannot have multiple active publications to the same catalog for versioned layers. The version dependencies request field is optional and is used for versioned layers to declare version dependencies.

    Parameters

    • request: StartBatchRequest

      The details of the batch operation that you want to start.

    • Optional abortSignal: AbortSignal

      The signal object that allows you to communicate with the request and, if required, abort it using the AbortController object. For more information, see the AbortController documentation.

    Returns Promise<Publication>

uploadBlob

uploadPartitions

  • Uploads metadata to the service.

    When all data is uploaded, you need to generate metadata to represent your data inside the HERE platform. At a minimum, your metadata must consist of a partition ID and the data handle that you used to upload your data. For a complete description of the fields that you can set, @see PublishPartition.

    The maximum number of partitions you can upload and publish in one request is 1,000. If you have more than 1,000 partitions that you want to upload, upload the data for the first 1,000 partitions, and then upload the metadata for these 1,000 partitions. Then, continue with the next set of partitions. Do not wait until all data is uploaded before uploading metadata. Doing so will result in poor performance. Instead, upload data, then metadata, and repeat if needed until all your data and corresponding metadata is uploaded.

    Parameters

    • request: UploadPartitionsRequest

      The details of the metadata upload process.

    • Optional abortSignal: AbortSignal

      The signal object that allows you to communicate with the request and, if required, abort it using the AbortController object. For more information, see the AbortController documentation.

    Returns Promise<Response>

    The Promise resolves with the 204 status code if the upload was successful.

olp- sdk- dataservice- write

Versioned Layer Client