Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Endpoint

Description of the endpoint.

Properties

compartmentId

compartmentId: string

The OCID for the endpoint compartment.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

Optional description

description: undefined | string

A short description of the endpoint.

displayName

displayName: string

A user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

id

id: string

Unique identifier endpoint OCID of an endpoint that is immutable on creation.

Optional inferenceUnits

inferenceUnits: undefined | number

Number of replicas required for this endpoint. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional lifecycleDetails

lifecycleDetails: undefined | string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.

lifecycleState

lifecycleState: LifecycleState

The state of the endpoint.

modelId

modelId: string

The OCID of the model to associate with the endpoint.

projectId

projectId: string

The OCID of the project to associate with the Endpoint.

Optional systemTags

systemTags: undefined | object

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {@code { "orcl-cloud": { "free-tier-retained": "true" } }}

timeCreated

timeCreated: Date

The time the the endpoint was created. An RFC3339 formatted datetime string.

Optional timeUpdated

timeUpdated: Date

The time the endpoint was updated. An RFC3339 formatted datetime string.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Endpoint): object

getJsonObj