CreateRoverClusterDetails

class oci.rover.models.CreateRoverClusterDetails(**kwargs)

Bases: object

The information required to create a RoverCluster.

Attributes:

CLUSTER_TYPE_STANDALONE

A constant which can be used with the cluster_type property of a CreateRoverClusterDetails.

CLUSTER_TYPE_STATION

A constant which can be used with the cluster_type property of a CreateRoverClusterDetails.

ENCLOSURE_TYPE_NON_RUGGADIZED

A constant which can be used with the enclosure_type property of a CreateRoverClusterDetails.

ENCLOSURE_TYPE_RUGGADIZED

A constant which can be used with the enclosure_type property of a CreateRoverClusterDetails.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a CreateRoverClusterDetails.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a CreateRoverClusterDetails.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a CreateRoverClusterDetails.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a CreateRoverClusterDetails.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a CreateRoverClusterDetails.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a CreateRoverClusterDetails.

SHIPPING_PREFERENCE_CUSTOMER_PICKUP

A constant which can be used with the shipping_preference property of a CreateRoverClusterDetails.

SHIPPING_PREFERENCE_ORACLE_SHIPPED

A constant which can be used with the shipping_preference property of a CreateRoverClusterDetails.

cluster_size

[Required] Gets the cluster_size of this CreateRoverClusterDetails.

cluster_type

Gets the cluster_type of this CreateRoverClusterDetails.

cluster_workloads

Gets the cluster_workloads of this CreateRoverClusterDetails.

compartment_id

[Required] Gets the compartment_id of this CreateRoverClusterDetails.

customer_shipping_address

Gets the customer_shipping_address of this CreateRoverClusterDetails.

data_validation_code

Gets the data_validation_code of this CreateRoverClusterDetails.

defined_tags

Gets the defined_tags of this CreateRoverClusterDetails.

display_name

[Required] Gets the display_name of this CreateRoverClusterDetails.

enclosure_type

Gets the enclosure_type of this CreateRoverClusterDetails.

freeform_tags

Gets the freeform_tags of this CreateRoverClusterDetails.

import_compartment_id

Gets the import_compartment_id of this CreateRoverClusterDetails.

import_file_bucket

Gets the import_file_bucket of this CreateRoverClusterDetails.

is_import_requested

Gets the is_import_requested of this CreateRoverClusterDetails.

lifecycle_state

Gets the lifecycle_state of this CreateRoverClusterDetails.

lifecycle_state_details

Gets the lifecycle_state_details of this CreateRoverClusterDetails.

master_key_id

Gets the master_key_id of this CreateRoverClusterDetails.

oracle_shipping_tracking_url

Gets the oracle_shipping_tracking_url of this CreateRoverClusterDetails.

point_of_contact

Gets the point_of_contact of this CreateRoverClusterDetails.

point_of_contact_phone_number

Gets the point_of_contact_phone_number of this CreateRoverClusterDetails.

shipping_preference

Gets the shipping_preference of this CreateRoverClusterDetails.

shipping_vendor

Gets the shipping_vendor of this CreateRoverClusterDetails.

subscription_id

Gets the subscription_id of this CreateRoverClusterDetails.

super_user_password

Gets the super_user_password of this CreateRoverClusterDetails.

system_tags

Gets the system_tags of this CreateRoverClusterDetails.

time_pickup_expected

Gets the time_pickup_expected of this CreateRoverClusterDetails.

unlock_passphrase

Gets the unlock_passphrase of this CreateRoverClusterDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateRoverClusterDetails object with values from keyword arguments.

CLUSTER_TYPE_STANDALONE = 'STANDALONE'

A constant which can be used with the cluster_type property of a CreateRoverClusterDetails. This constant has a value of “STANDALONE”

CLUSTER_TYPE_STATION = 'STATION'

A constant which can be used with the cluster_type property of a CreateRoverClusterDetails. This constant has a value of “STATION”

ENCLOSURE_TYPE_NON_RUGGADIZED = 'NON_RUGGADIZED'

A constant which can be used with the enclosure_type property of a CreateRoverClusterDetails. This constant has a value of “NON_RUGGADIZED”

ENCLOSURE_TYPE_RUGGADIZED = 'RUGGADIZED'

A constant which can be used with the enclosure_type property of a CreateRoverClusterDetails. This constant has a value of “RUGGADIZED”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a CreateRoverClusterDetails. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a CreateRoverClusterDetails. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a CreateRoverClusterDetails. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a CreateRoverClusterDetails. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a CreateRoverClusterDetails. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a CreateRoverClusterDetails. This constant has a value of “UPDATING”

SHIPPING_PREFERENCE_CUSTOMER_PICKUP = 'CUSTOMER_PICKUP'

A constant which can be used with the shipping_preference property of a CreateRoverClusterDetails. This constant has a value of “CUSTOMER_PICKUP”

SHIPPING_PREFERENCE_ORACLE_SHIPPED = 'ORACLE_SHIPPED'

A constant which can be used with the shipping_preference property of a CreateRoverClusterDetails. This constant has a value of “ORACLE_SHIPPED”

__init__(**kwargs)

Initializes a new CreateRoverClusterDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • display_name (str) – The value to assign to the display_name property of this CreateRoverClusterDetails.

  • compartment_id (str) – The value to assign to the compartment_id property of this CreateRoverClusterDetails.

  • cluster_size (int) – The value to assign to the cluster_size property of this CreateRoverClusterDetails.

  • customer_shipping_address (oci.rover.models.ShippingAddress) – The value to assign to the customer_shipping_address property of this CreateRoverClusterDetails.

  • cluster_workloads (list[oci.rover.models.RoverWorkload]) – The value to assign to the cluster_workloads property of this CreateRoverClusterDetails.

  • cluster_type (str) – The value to assign to the cluster_type property of this CreateRoverClusterDetails. Allowed values for this property are: “STANDALONE”, “STATION”

  • super_user_password (str) – The value to assign to the super_user_password property of this CreateRoverClusterDetails.

  • enclosure_type (str) – The value to assign to the enclosure_type property of this CreateRoverClusterDetails. Allowed values for this property are: “RUGGADIZED”, “NON_RUGGADIZED”

  • unlock_passphrase (str) – The value to assign to the unlock_passphrase property of this CreateRoverClusterDetails.

  • point_of_contact (str) – The value to assign to the point_of_contact property of this CreateRoverClusterDetails.

  • point_of_contact_phone_number (str) – The value to assign to the point_of_contact_phone_number property of this CreateRoverClusterDetails.

  • shipping_preference (str) – The value to assign to the shipping_preference property of this CreateRoverClusterDetails. Allowed values for this property are: “ORACLE_SHIPPED”, “CUSTOMER_PICKUP”

  • shipping_vendor (str) – The value to assign to the shipping_vendor property of this CreateRoverClusterDetails.

  • time_pickup_expected (datetime) – The value to assign to the time_pickup_expected property of this CreateRoverClusterDetails.

  • oracle_shipping_tracking_url (str) – The value to assign to the oracle_shipping_tracking_url property of this CreateRoverClusterDetails.

  • subscription_id (str) – The value to assign to the subscription_id property of this CreateRoverClusterDetails.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this CreateRoverClusterDetails. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”

  • lifecycle_state_details (str) – The value to assign to the lifecycle_state_details property of this CreateRoverClusterDetails.

  • is_import_requested (bool) – The value to assign to the is_import_requested property of this CreateRoverClusterDetails.

  • import_compartment_id (str) – The value to assign to the import_compartment_id property of this CreateRoverClusterDetails.

  • import_file_bucket (str) – The value to assign to the import_file_bucket property of this CreateRoverClusterDetails.

  • data_validation_code (str) – The value to assign to the data_validation_code property of this CreateRoverClusterDetails.

  • master_key_id (str) – The value to assign to the master_key_id property of this CreateRoverClusterDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateRoverClusterDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateRoverClusterDetails.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this CreateRoverClusterDetails.

property cluster_size

[Required] Gets the cluster_size of this CreateRoverClusterDetails. Number of nodes desired in the cluster, in standalone clusters, between 5 and 15 inclusive. In station clusters, between 15 and 30 inclusive.

Returns

The cluster_size of this CreateRoverClusterDetails.

Return type

int

property cluster_type

Gets the cluster_type of this CreateRoverClusterDetails. Type of cluster.

Allowed values for this property are: “STANDALONE”, “STATION”

Returns

The cluster_type of this CreateRoverClusterDetails.

Return type

str

property cluster_workloads

Gets the cluster_workloads of this CreateRoverClusterDetails. List of existing workloads that should be provisioned on the nodes.

Returns

The cluster_workloads of this CreateRoverClusterDetails.

Return type

list[oci.rover.models.RoverWorkload]

property compartment_id

[Required] Gets the compartment_id of this CreateRoverClusterDetails. The OCID of the compartment containing the RoverCluster.

Returns

The compartment_id of this CreateRoverClusterDetails.

Return type

str

property customer_shipping_address

Gets the customer_shipping_address of this CreateRoverClusterDetails.

Returns

The customer_shipping_address of this CreateRoverClusterDetails.

Return type

oci.rover.models.ShippingAddress

property data_validation_code

Gets the data_validation_code of this CreateRoverClusterDetails. Validation code returned by data validation tool. Required for return shipping label generation if data import was requested.

Returns

The data_validation_code of this CreateRoverClusterDetails.

Return type

str

property defined_tags

Gets the defined_tags of this CreateRoverClusterDetails. The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this CreateRoverClusterDetails.

Return type

dict(str, dict(str, object))

property display_name

[Required] Gets the display_name of this CreateRoverClusterDetails. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns

The display_name of this CreateRoverClusterDetails.

Return type

str

property enclosure_type

Gets the enclosure_type of this CreateRoverClusterDetails. The type of enclosure rover nodes in this cluster are shipped in.

Allowed values for this property are: “RUGGADIZED”, “NON_RUGGADIZED”

Returns

The enclosure_type of this CreateRoverClusterDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this CreateRoverClusterDetails. 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: {“Department”: “Finance”}

Returns

The freeform_tags of this CreateRoverClusterDetails.

Return type

dict(str, str)

property import_compartment_id

Gets the import_compartment_id of this CreateRoverClusterDetails. An OCID of a compartment where data will be imported to upon Rover cluster return.

Returns

The import_compartment_id of this CreateRoverClusterDetails.

Return type

str

property import_file_bucket

Gets the import_file_bucket of this CreateRoverClusterDetails. Name of a bucket where files from NFS share will be imported to upon Rover cluster return.

Returns

The import_file_bucket of this CreateRoverClusterDetails.

Return type

str

property is_import_requested

Gets the is_import_requested of this CreateRoverClusterDetails. The flag indicating that customer requests data to be imported to OCI upon Rover cluster return.

Returns

The is_import_requested of this CreateRoverClusterDetails.

Return type

bool

property lifecycle_state

Gets the lifecycle_state of this CreateRoverClusterDetails. The current state of the RoverCluster.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”

Returns

The lifecycle_state of this CreateRoverClusterDetails.

Return type

str

property lifecycle_state_details

Gets the lifecycle_state_details of this CreateRoverClusterDetails. A property that can contain details on the lifecycle.

Returns

The lifecycle_state_details of this CreateRoverClusterDetails.

Return type

str

property master_key_id

Gets the master_key_id of this CreateRoverClusterDetails. Customer provided master key ID to encrypt secret information. If not provided, Rover’s master key will be used for encryption.

Returns

The master_key_id of this CreateRoverClusterDetails.

Return type

str

property oracle_shipping_tracking_url

Gets the oracle_shipping_tracking_url of this CreateRoverClusterDetails. Tracking Url for the shipped Rover Cluster.

Returns

The oracle_shipping_tracking_url of this CreateRoverClusterDetails.

Return type

str

property point_of_contact

Gets the point_of_contact of this CreateRoverClusterDetails. Name of point of contact for this order if customer is picking up.

Returns

The point_of_contact of this CreateRoverClusterDetails.

Return type

str

property point_of_contact_phone_number

Gets the point_of_contact_phone_number of this CreateRoverClusterDetails. Phone number of point of contact for this order if customer is picking up.

Returns

The point_of_contact_phone_number of this CreateRoverClusterDetails.

Return type

str

property shipping_preference

Gets the shipping_preference of this CreateRoverClusterDetails. Preference for device delivery.

Allowed values for this property are: “ORACLE_SHIPPED”, “CUSTOMER_PICKUP”

Returns

The shipping_preference of this CreateRoverClusterDetails.

Return type

str

property shipping_vendor

Gets the shipping_vendor of this CreateRoverClusterDetails. Shipping vendor of choice for orace to customer shipping.

Returns

The shipping_vendor of this CreateRoverClusterDetails.

Return type

str

property subscription_id

Gets the subscription_id of this CreateRoverClusterDetails. ID provided to customer after successful subscription to Rover Stations.

Returns

The subscription_id of this CreateRoverClusterDetails.

Return type

str

property super_user_password

Gets the super_user_password of this CreateRoverClusterDetails. Root password for the rover cluster.

Returns

The super_user_password of this CreateRoverClusterDetails.

Return type

str

property system_tags

Gets the system_tags of this CreateRoverClusterDetails. 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: {orcl-cloud: {free-tier-retain: true}}

Returns

The system_tags of this CreateRoverClusterDetails.

Return type

dict(str, dict(str, object))

property time_pickup_expected

Gets the time_pickup_expected of this CreateRoverClusterDetails. Expected date when customer wants to pickup the cluster if they chose customer pickup.

Returns

The time_pickup_expected of this CreateRoverClusterDetails.

Return type

datetime

property unlock_passphrase

Gets the unlock_passphrase of this CreateRoverClusterDetails. Password to unlock the rover cluster.

Returns

The unlock_passphrase of this CreateRoverClusterDetails.

Return type

str