RoverCluster¶

class oci.rover.models.RoverCluster(**kwargs)¶

Bases: object

Description of RoverCluster.

Attributes

`CLUSTER_TYPE_STANDALONE`	A constant which can be used with the cluster_type property of a RoverCluster.
`CLUSTER_TYPE_STATION`	A constant which can be used with the cluster_type property of a RoverCluster.
`ENCLOSURE_TYPE_NON_RUGGADIZED`	A constant which can be used with the enclosure_type property of a RoverCluster.
`ENCLOSURE_TYPE_RUGGADIZED`	A constant which can be used with the enclosure_type property of a RoverCluster.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a RoverCluster.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a RoverCluster.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a RoverCluster.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a RoverCluster.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a RoverCluster.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a RoverCluster.
`SHIPPING_PREFERENCE_CUSTOMER_PICKUP`	A constant which can be used with the shipping_preference property of a RoverCluster.
`SHIPPING_PREFERENCE_ORACLE_SHIPPED`	A constant which can be used with the shipping_preference property of a RoverCluster.
`cluster_size`	[Required] Gets the cluster_size of this RoverCluster.
`cluster_type`	Gets the cluster_type of this RoverCluster.
`cluster_workloads`	Gets the cluster_workloads of this RoverCluster.
`compartment_id`	[Required] Gets the compartment_id of this RoverCluster.
`customer_shipping_address`	Gets the customer_shipping_address of this RoverCluster.
`data_validation_code`	Gets the data_validation_code of this RoverCluster.
`defined_tags`	Gets the defined_tags of this RoverCluster.
`delivery_tracking_info`	Gets the delivery_tracking_info of this RoverCluster.
`display_name`	[Required] Gets the display_name of this RoverCluster.
`enclosure_type`	Gets the enclosure_type of this RoverCluster.
`exterior_door_code`	Gets the exterior_door_code of this RoverCluster.
`freeform_tags`	Gets the freeform_tags of this RoverCluster.
`id`	[Required] Gets the id of this RoverCluster.
`image_export_par`	Gets the image_export_par of this RoverCluster.
`import_compartment_id`	Gets the import_compartment_id of this RoverCluster.
`import_file_bucket`	Gets the import_file_bucket of this RoverCluster.
`interior_alarm_disarm_code`	Gets the interior_alarm_disarm_code of this RoverCluster.
`is_import_requested`	Gets the is_import_requested of this RoverCluster.
`lifecycle_state`	[Required] Gets the lifecycle_state of this RoverCluster.
`lifecycle_state_details`	Gets the lifecycle_state_details of this RoverCluster.
`master_key_id`	Gets the master_key_id of this RoverCluster.
`nodes`	Gets the nodes of this RoverCluster.
`oracle_shipping_tracking_url`	Gets the oracle_shipping_tracking_url of this RoverCluster.
`point_of_contact`	Gets the point_of_contact of this RoverCluster.
`point_of_contact_phone_number`	Gets the point_of_contact_phone_number of this RoverCluster.
`return_shipping_label_uri`	Gets the return_shipping_label_uri of this RoverCluster.
`shipping_preference`	Gets the shipping_preference of this RoverCluster.
`shipping_vendor`	Gets the shipping_vendor of this RoverCluster.
`subscription_id`	Gets the subscription_id of this RoverCluster.
`super_user_password`	Gets the super_user_password of this RoverCluster.
`system_tags`	Gets the system_tags of this RoverCluster.
`tags`	Gets the tags of this RoverCluster.
`time_created`	Gets the time_created of this RoverCluster.
`time_customer_received`	Gets the time_customer_received of this RoverCluster.
`time_customer_returned`	Gets the time_customer_returned of this RoverCluster.
`time_pickup_expected`	Gets the time_pickup_expected of this RoverCluster.
`time_return_window_ends`	Gets the time_return_window_ends of this RoverCluster.
`time_return_window_starts`	Gets the time_return_window_starts of this RoverCluster.
`unlock_passphrase`	Gets the unlock_passphrase of this RoverCluster.

Methods

__init__(**kwargs) Initializes a new RoverCluster object with values from keyword arguments.

CLUSTER_TYPE_STANDALONE = 'STANDALONE'¶: A constant which can be used with the cluster_type property of a RoverCluster. This constant has a value of “STANDALONE”

CLUSTER_TYPE_STATION = 'STATION'¶: A constant which can be used with the cluster_type property of a RoverCluster. 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 RoverCluster. 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 RoverCluster. This constant has a value of “RUGGADIZED”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a RoverCluster. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a RoverCluster. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a RoverCluster. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a RoverCluster. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a RoverCluster. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a RoverCluster. 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 RoverCluster. 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 RoverCluster. This constant has a value of “ORACLE_SHIPPED”

__init__(**kwargs)¶

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

Parameters:

id (str) – The value to assign to the id property of this RoverCluster.
compartment_id (str) – The value to assign to the compartment_id property of this RoverCluster.
display_name (str) – The value to assign to the display_name property of this RoverCluster.
cluster_size (int) – The value to assign to the cluster_size property of this RoverCluster.
time_created (datetime) – The value to assign to the time_created property of this RoverCluster.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this RoverCluster. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state_details (str) – The value to assign to the lifecycle_state_details property of this RoverCluster.
customer_shipping_address (oci.rover.models.ShippingAddress) – The value to assign to the customer_shipping_address property of this RoverCluster.
nodes (list[oci.rover.models.RoverNodeSummary]) – The value to assign to the nodes property of this RoverCluster.
enclosure_type (str) – The value to assign to the enclosure_type property of this RoverCluster. Allowed values for this property are: “RUGGADIZED”, “NON_RUGGADIZED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_customer_received (datetime) – The value to assign to the time_customer_received property of this RoverCluster.
time_customer_returned (datetime) – The value to assign to the time_customer_returned property of this RoverCluster.
delivery_tracking_info (str) – The value to assign to the delivery_tracking_info property of this RoverCluster.
cluster_workloads (list[oci.rover.models.RoverWorkload]) – The value to assign to the cluster_workloads property of this RoverCluster.
cluster_type (str) – The value to assign to the cluster_type property of this RoverCluster. Allowed values for this property are: “STANDALONE”, “STATION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
subscription_id (str) – The value to assign to the subscription_id property of this RoverCluster.
exterior_door_code (str) – The value to assign to the exterior_door_code property of this RoverCluster.
interior_alarm_disarm_code (str) – The value to assign to the interior_alarm_disarm_code property of this RoverCluster.
super_user_password (str) – The value to assign to the super_user_password property of this RoverCluster.
unlock_passphrase (str) – The value to assign to the unlock_passphrase property of this RoverCluster.
point_of_contact (str) – The value to assign to the point_of_contact property of this RoverCluster.
point_of_contact_phone_number (str) – The value to assign to the point_of_contact_phone_number property of this RoverCluster.
shipping_preference (str) – The value to assign to the shipping_preference property of this RoverCluster. Allowed values for this property are: “ORACLE_SHIPPED”, “CUSTOMER_PICKUP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
oracle_shipping_tracking_url (str) – The value to assign to the oracle_shipping_tracking_url property of this RoverCluster.
shipping_vendor (str) – The value to assign to the shipping_vendor property of this RoverCluster.
time_pickup_expected (datetime) – The value to assign to the time_pickup_expected property of this RoverCluster.
time_return_window_starts (datetime) – The value to assign to the time_return_window_starts property of this RoverCluster.
time_return_window_ends (datetime) – The value to assign to the time_return_window_ends property of this RoverCluster.
return_shipping_label_uri (str) – The value to assign to the return_shipping_label_uri property of this RoverCluster.
is_import_requested (bool) – The value to assign to the is_import_requested property of this RoverCluster.
import_compartment_id (str) – The value to assign to the import_compartment_id property of this RoverCluster.
import_file_bucket (str) – The value to assign to the import_file_bucket property of this RoverCluster.
data_validation_code (str) – The value to assign to the data_validation_code property of this RoverCluster.
image_export_par (str) – The value to assign to the image_export_par property of this RoverCluster.
master_key_id (str) – The value to assign to the master_key_id property of this RoverCluster.
tags (str) – The value to assign to the tags property of this RoverCluster.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this RoverCluster.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this RoverCluster.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this RoverCluster.

cluster_size¶

[Required] Gets the cluster_size of this RoverCluster. Size of the cluster.

Returns:	The cluster_size of this RoverCluster.
Return type:	int

cluster_type¶

Gets the cluster_type of this RoverCluster. Type of cluster.

Allowed values for this property are: “STANDALONE”, “STATION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The cluster_type of this RoverCluster.
Return type:	str

cluster_workloads¶

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

Returns:	The cluster_workloads of this RoverCluster.
Return type:	list[oci.rover.models.RoverWorkload]

compartment_id¶

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

Returns:	The compartment_id of this RoverCluster.
Return type:	str

customer_shipping_address¶

Gets the customer_shipping_address of this RoverCluster.

Returns:	The customer_shipping_address of this RoverCluster.
Return type:	oci.rover.models.ShippingAddress

data_validation_code¶

Gets the data_validation_code of this RoverCluster. 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 RoverCluster.
Return type:	str

defined_tags¶

Gets the defined_tags of this RoverCluster. 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 RoverCluster.
Return type:	dict(str, dict(str, object))

delivery_tracking_info¶

Gets the delivery_tracking_info of this RoverCluster. Tracking information for device shipping.

Returns:	The delivery_tracking_info of this RoverCluster.
Return type:	str

display_name¶

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

Returns:	The display_name of this RoverCluster.
Return type:	str

enclosure_type¶

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

Allowed values for this property are: “RUGGADIZED”, “NON_RUGGADIZED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The enclosure_type of this RoverCluster.
Return type:	str

exterior_door_code¶

Gets the exterior_door_code of this RoverCluster. Service generated code for the exterior trailer door of the trailer.

Returns:	The exterior_door_code of this RoverCluster.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this RoverCluster. 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 RoverCluster.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this RoverCluster. The OCID of RoverCluster.

Returns:	The id of this RoverCluster.
Return type:	str

image_export_par¶

Gets the image_export_par of this RoverCluster. The link to pre-authenticated request for a bucket where image workloads are moved.

Returns:	The image_export_par of this RoverCluster.
Return type:	str

import_compartment_id¶

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

Returns:	The import_compartment_id of this RoverCluster.
Return type:	str

import_file_bucket¶

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

Returns:	The import_file_bucket of this RoverCluster.
Return type:	str

interior_alarm_disarm_code¶

Gets the interior_alarm_disarm_code of this RoverCluster. Service generated code to disarm the interior alarm of the trailer.

Returns:	The interior_alarm_disarm_code of this RoverCluster.
Return type:	str

is_import_requested¶

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

Returns:	The is_import_requested of this RoverCluster.
Return type:	bool

lifecycle_state¶

[Required] Gets the lifecycle_state of this RoverCluster. The current state of the RoverCluster.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this RoverCluster.
Return type:	str

lifecycle_state_details¶

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

Returns:	The lifecycle_state_details of this RoverCluster.
Return type:	str

master_key_id¶

Gets the master_key_id of this RoverCluster. 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 RoverCluster.
Return type:	str

nodes¶

Gets the nodes of this RoverCluster. The summary of nodes that are part of this cluster.

Returns:	The nodes of this RoverCluster.
Return type:	list[oci.rover.models.RoverNodeSummary]

oracle_shipping_tracking_url¶

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

Returns:	The oracle_shipping_tracking_url of this RoverCluster.
Return type:	str

point_of_contact¶

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

Returns:	The point_of_contact of this RoverCluster.
Return type:	str

point_of_contact_phone_number¶

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

Returns:	The point_of_contact_phone_number of this RoverCluster.
Return type:	str

return_shipping_label_uri¶

Gets the return_shipping_label_uri of this RoverCluster. Uri to download return shipping label.

Returns:	The return_shipping_label_uri of this RoverCluster.
Return type:	str

shipping_preference¶

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

Allowed values for this property are: “ORACLE_SHIPPED”, “CUSTOMER_PICKUP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The shipping_preference of this RoverCluster.
Return type:	str

shipping_vendor¶

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

Returns:	The shipping_vendor of this RoverCluster.
Return type:	str

subscription_id¶

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

Returns:	The subscription_id of this RoverCluster.
Return type:	str

super_user_password¶

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

Returns:	The super_user_password of this RoverCluster.
Return type:	str

system_tags¶

Gets the system_tags of this RoverCluster. 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 RoverCluster.
Return type:	dict(str, dict(str, object))

tags¶

Gets the tags of this RoverCluster. The tags associated with tagSlug.

Returns:	The tags of this RoverCluster.
Return type:	str

time_created¶

Gets the time_created of this RoverCluster. The time the the RoverCluster was created. An RFC3339 formatted datetime string

Returns:	The time_created of this RoverCluster.
Return type:	datetime

time_customer_received¶

Gets the time_customer_received of this RoverCluster. Time when customer received the cluster.

Returns:	The time_customer_received of this RoverCluster.
Return type:	datetime

time_customer_returned¶

Gets the time_customer_returned of this RoverCluster. Time when customer returned the cluster.

Returns:	The time_customer_returned of this RoverCluster.
Return type:	datetime

time_pickup_expected¶

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

Returns:	The time_pickup_expected of this RoverCluster.
Return type:	datetime

time_return_window_ends¶

Gets the time_return_window_ends of this RoverCluster. End time for the window to pickup the device from customer.

Returns:	The time_return_window_ends of this RoverCluster.
Return type:	datetime

time_return_window_starts¶

Gets the time_return_window_starts of this RoverCluster. Start time for the window to pickup the device from customer.

Returns:	The time_return_window_starts of this RoverCluster.
Return type:	datetime

unlock_passphrase¶

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

Returns:	The unlock_passphrase of this RoverCluster.
Return type:	str