GuidesTypeScript API ReferencePython v2 API Reference

PatchLayer | @here/olp-sdk-ts

PatchLayer | @here/olp-sdk-ts
Options
All
  • Public
  • Public/Protected
  • All
Menu

Describes the modification of the layer configuration.

Hierarchy

  • PatchLayer

Index

Properties

billingTags?: string[]

List of billing tags a free-form tag which is used for grouping billing records together. If supplied, it must be between 4 - 16 characters, contain only alphanumeric ASCII characters [A-Za-z0-9]. Field is optional, Specify a value to replace all list of billing tags. This field is not removable, null value is not allowed.

contentEncoding?: "gzip"
contentType?: string
coverage?: Coverage
crc?: "CRC-32C"
description?: string

A detailed description of the layer and what it contains. This information appears on the 'Overview' tab when you open a layer in the platform portal. Field is optional, Specify a value to modify layer description. This field is not removable, null value is not allowed.

digest?: "MD5" | "SHA-1" | "SHA-256"
indexProperties?: PatchIndexProperties
interactiveMapsProperties?: PatchInteractiveMapsProperties
name?: string

The short name for the layer. Field is optional, Specify a value to modify layer name. This field is not removable, null value is not allowed.

partitioning?: Partitioning
schema?: Schema
streamProperties?: PatchStreamProperties
summary?: string

A one-sentence summary of the layer. You can see this summary when you browse a list of layers on the platform portal. Field is optional, Specify a value to modify layer summary. This field is not removable, null value is not allowed.

tags?: string[]

Some keywords that help to find the layer when searching in the platform portal. Field is optional, Specify a value to replace all list of tags. This field is not removable, null value is not allowed.

ttl?: number

Legend

  • Namespace
  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class
  • Class with type parameter
  • Enumeration

Settings

Theme

Generated using TypeDoc