Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace RoverCluster

Description of RoverCluster.

Properties

clusterSize

clusterSize: number

Size of the cluster. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional clusterType

clusterType: model.ClusterType

Type of cluster.

Optional clusterWorkloads

clusterWorkloads: Array<RoverWorkload>

List of existing workloads that should be provisioned on the nodes.

compartmentId

compartmentId: string

The OCID of the compartment containing the RoverCluster.

Optional customerShippingAddress

customerShippingAddress: model.ShippingAddress

Optional dataValidationCode

dataValidationCode: undefined | string

Validation code returned by data validation tool. Required for return shipping label generation if data import was requested.

Optional definedTags

definedTags: undefined | object

The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {@code {"Operations": {"CostCenter": "42"}}}

Optional deliveryTrackingInfo

deliveryTrackingInfo: undefined | string

Tracking information for device shipping.

displayName

displayName: string

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

Optional enclosureType

enclosureType: model.EnclosureType

The type of enclosure rover nodes in this cluster are shipped in.

Optional exteriorDoorCode

exteriorDoorCode: undefined | string

Service generated code for the exterior trailer door of the trailer.

Optional freeformTags

freeformTags: undefined | object

The freeform tags associated with this resource, if any. 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 RoverCluster.

Optional imageExportPar

imageExportPar: undefined | string

The link to pre-authenticated request for a bucket where image workloads are moved.

Optional importCompartmentId

importCompartmentId: undefined | string

An OCID of a compartment where data will be imported to upon Rover cluster return.

Optional importFileBucket

importFileBucket: undefined | string

Name of a bucket where files from NFS share will be imported to upon Rover cluster return.

Optional interiorAlarmDisarmCode

interiorAlarmDisarmCode: undefined | string

Service generated code to disarm the interior alarm of the trailer.

Optional isImportRequested

isImportRequested: undefined | false | true

The flag indicating that customer requests data to be imported to OCI upon Rover cluster return.

lifecycleState

lifecycleState: LifecycleState

The current state of the RoverCluster.

Optional lifecycleStateDetails

lifecycleStateDetails: undefined | string

A property that can contain details on the lifecycle.

Optional masterKeyId

masterKeyId: undefined | string

Customer provided master key ID to encrypt secret information. If not provided, Rover's master key will be used for encryption.

Optional nodes

The summary of nodes that are part of this cluster.

Optional oracleShippingTrackingUrl

oracleShippingTrackingUrl: undefined | string

Tracking Url for the shipped Rover Cluster.

Optional pointOfContact

pointOfContact: undefined | string

Name of point of contact for this order if customer is picking up.

Optional pointOfContactPhoneNumber

pointOfContactPhoneNumber: undefined | string

Phone number of point of contact for this order if customer is picking up.

Optional returnShippingLabelUri

returnShippingLabelUri: undefined | string

Uri to download return shipping label.

Optional shippingPreference

shippingPreference: ShippingPreference

Preference for device delivery.

Optional shippingVendor

shippingVendor: undefined | string

Shipping vendor of choice for orace to customer shipping.

Optional subscriptionId

subscriptionId: undefined | string

ID provided to customer after successful subscription to Rover Stations.

Optional superUserPassword

superUserPassword: undefined | string

Root password for the rover cluster.

Optional systemTags

systemTags: undefined | object

The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {@code {orcl-cloud: {free-tier-retain: true}}}

Optional tags

tags: undefined | string

The tags associated with tagSlug.

Optional timeCreated

timeCreated: Date

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

Optional timeCustomerReceived

timeCustomerReceived: Date

Time when customer received the cluster.

Optional timeCustomerReturned

timeCustomerReturned: Date

Time when customer returned the cluster.

Optional timePickupExpected

timePickupExpected: Date

Expected date when customer wants to pickup the device if they chose customer pickup.

Optional timeReturnWindowEnds

timeReturnWindowEnds: Date

End time for the window to pickup the device from customer.

Optional timeReturnWindowStarts

timeReturnWindowStarts: Date

Start time for the window to pickup the device from customer.

Optional unlockPassphrase

unlockPassphrase: undefined | string

Password to unlock the rover cluster.

Functions

getDeserializedJsonObj

getJsonObj