Jump to Content

SchemaDetailsRequest | @here/olp-sdk-ts

SchemaDetailsRequest | @here/olp-sdk-ts

Class SchemaDetailsRequest

Prepares information for calls to the platform Artifact Service.

Hierarchy

SchemaDetailsRequest

Index

Constructors

constructor

Methods

Constructors

constructor

new SchemaDetailsRequest(): SchemaDetailsRequest

Returns SchemaDetailsRequest

Methods

getBillingTag

getBillingTag(): undefined | string

- Defined in @here/olp-sdk-dataservice-read/lib/client/SchemaDetailsRequest.ts:71
Gets a billing tag to group billing records together.

Returns undefined | string
The BillingTag string.

getSchema

getSchema(): undefined | HRN

- Defined in @here/olp-sdk-dataservice-read/lib/client/SchemaDetailsRequest.ts:36
Gets schema metadata for the request.

Returns undefined | HRN
An object with the schema metadata.

withBillingTag

withBillingTag(tag: string): SchemaDetailsRequest

- Defined in @here/olp-sdk-dataservice-read/lib/client/SchemaDetailsRequest.ts:61
An optional 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].

Parameters
- tag: string
  
  The BillingTag string.
Returns SchemaDetailsRequest
The updated SchemaDetailsRequest instance that you can use to chain methods.

withSchema

withSchema(schemaHrn: HRN): SchemaDetailsRequest

- Defined in @here/olp-sdk-dataservice-read/lib/client/SchemaDetailsRequest.ts:48
Sets a value of a schema HERE Resource Name (HRN) that is used in the getSchema and getSchemaDetails methods of ArtifactClient.

Parameters
- schemaHrn: HRN
  
  The layer schema HRN.
Returns SchemaDetailsRequest
The updated SchemaDetailsRequest instance that you can use to chain methods.

Generated using TypeDoc