Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Sdk

Information about the SDK.

Properties

apiId

apiId: string

The OCID of API resource

Optional artifactUrl

artifactUrl: undefined | string

File location for generated SDK.

Optional compartmentId

compartmentId: undefined | string

The OCID of the compartment in which the resource is created.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

displayName

displayName: string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Example: {@code My new resource}

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {@code {\"Department\": \"Finance\"}}

id

id: string

The OCID of the resource.

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 a Failed state.

Optional lifecycleState

lifecycleState: LifecycleState

The current state of the SDK.

  • The SDK will be in CREATING state if the SDK creation is in progress.
  • The SDK will be in ACTIVE state if create is successful.
  • The SDK will be in FAILED state if the create, or delete fails.
  • The SDK will be in DELETING state if the deletion in in progress.
  • The SDK will be in DELETED state if the delete is successful.

Optional parameters

parameters: undefined | object

Additional optional configurations passed. The applicable config keys are listed under "parameters" when "/sdkLanguageTypes" is called.

Example: {@code {\"configName\": \"configValue\"}}

targetLanguage

targetLanguage: string

The string representing the target programming language for generating the SDK.

Optional timeArtifactUrlExpiresAt

timeArtifactUrlExpiresAt: Date

Expiry of artifact url.

Optional timeCreated

timeCreated: Date

The time this resource was created. An RFC3339 formatted datetime string.

Optional timeUpdated

timeUpdated: Date

The time this resource was last updated. An RFC3339 formatted datetime string.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Sdk): object

getJsonObj

  • getJsonObj(obj: Sdk): object