Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Fleet

A fleet is a collection or grouping of resources based on criteria.

Properties

compartmentId

compartmentId: string

Compartment OCID

Optional credentials

Credentials associated with the Fleet.

definedTags

definedTags: object

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

Type declaration

  • [key: string]: object
    • [key: string]: any

Optional description

description: undefined | string

A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.

Optional details

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 environmentType

environmentType: undefined | string

Environment Type associated with the Fleet. Applicable for ENVIRONMENT fleet types.

freeformTags

freeformTags: 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"}}

Type declaration

  • [key: string]: string

id

id: string

The OCID of the resource.

Optional isTargetAutoConfirm

isTargetAutoConfirm: undefined | false | true

A value that represents if auto-confirming of the targets can be enabled. This will allow targets to be auto-confirmed in the fleet without manual intervention.

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 lifecycle state of the Fleet.

Optional notificationPreferences

notificationPreferences: Array<NotificationPreference>

Notification Preferences associated with the Fleet.

Optional parentFleetId

parentFleetId: undefined | string

The OCID of the fleet that would be the parent for this fleet.

Optional products

products: Array<string>

Products associated with the Fleet.

Optional properties

Properties associated with the Fleet.

Optional resourceRegion

resourceRegion: undefined | string

Associated region

Optional resourceSelection

Optional resources

Resources associated with the Fleet if resourceSelectionType is MANUAL.

Optional systemTags

systemTags: undefined | object

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

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: Fleet): object

getJsonObj

  • getJsonObj(obj: Fleet): object