Class RoverCluster

Description of RoverCluster.

Inheritance

object

RoverCluster

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.RoverService.Models

Assembly: OCI.DotNetSDK.Rover.dll

Syntax

public class RoverCluster

Properties

ClusterSize

Declaration

[Required(ErrorMessage = "ClusterSize is required.")]
[JsonProperty(PropertyName = "clusterSize")]
public int? ClusterSize { get; set; }

Property Value

Type	Description
int?	Size of the cluster.

Remarks

Required

ClusterType

Declaration

[JsonProperty(PropertyName = "clusterType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ClusterType? ClusterType { get; set; }

Property Value

Type	Description
ClusterType?	Type of cluster.

ClusterWorkloads

Declaration

[JsonProperty(PropertyName = "clusterWorkloads")]
public List<RoverWorkload> ClusterWorkloads { get; set; }

Property Value

Type	Description
List<RoverWorkload>	List of existing workloads that should be provisioned on the nodes.

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment containing the RoverCluster.

Remarks

Required

CustomerShippingAddress

Declaration

[JsonProperty(PropertyName = "customerShippingAddress")]
public ShippingAddress CustomerShippingAddress { get; set; }

Property Value

Type	Description
ShippingAddress

DataValidationCode

Declaration

[JsonProperty(PropertyName = "dataValidationCode")]
public string DataValidationCode { get; set; }

Property Value

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

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, 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: {"Operations": {"CostCenter": "42"}}

DeliveryTrackingInfo

Declaration

[JsonProperty(PropertyName = "deliveryTrackingInfo")]
public string DeliveryTrackingInfo { get; set; }

Property Value

Type	Description
string	Tracking information for device shipping.

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

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

Remarks

Required

EnclosureType

Declaration

[JsonProperty(PropertyName = "enclosureType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public EnclosureType? EnclosureType { get; set; }

Property Value

Type	Description
EnclosureType?	The type of enclosure rover nodes in this cluster are shipped in.

ExteriorDoorCode

Declaration

[JsonProperty(PropertyName = "exteriorDoorCode")]
public string ExteriorDoorCode { get; set; }

Property Value

Type	Description
string	Service generated code for the exterior trailer door of the trailer.

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	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"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of RoverCluster.

Remarks

Required

ImageExportPar

Declaration

[JsonProperty(PropertyName = "imageExportPar")]
public string ImageExportPar { get; set; }

Property Value

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

ImportCompartmentId

Declaration

[JsonProperty(PropertyName = "importCompartmentId")]
public string ImportCompartmentId { get; set; }

Property Value

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

ImportFileBucket

Declaration

[JsonProperty(PropertyName = "importFileBucket")]
public string ImportFileBucket { get; set; }

Property Value

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

InteriorAlarmDisarmCode

Declaration

[JsonProperty(PropertyName = "interiorAlarmDisarmCode")]
public string InteriorAlarmDisarmCode { get; set; }

Property Value

Type	Description
string	Service generated code to disarm the interior alarm of the trailer.

IsImportRequested

Declaration

[JsonProperty(PropertyName = "isImportRequested")]
public bool? IsImportRequested { get; set; }

Property Value

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

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleState? LifecycleState { get; set; }

Property Value

Type	Description
LifecycleState?	The current state of the RoverCluster.

Remarks

Required

LifecycleStateDetails

Declaration

[JsonProperty(PropertyName = "lifecycleStateDetails")]
public string LifecycleStateDetails { get; set; }

Property Value

Type	Description
string	A property that can contain details on the lifecycle.

MasterKeyId

Declaration

[JsonProperty(PropertyName = "masterKeyId")]
public string MasterKeyId { get; set; }

Property Value

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

Nodes

Declaration

[JsonProperty(PropertyName = "nodes")]
public List<RoverNodeSummary> Nodes { get; set; }

Property Value

Type	Description
List<RoverNodeSummary>	The summary of nodes that are part of this cluster.

OracleShippingTrackingUrl

Declaration

[JsonProperty(PropertyName = "oracleShippingTrackingUrl")]
public string OracleShippingTrackingUrl { get; set; }

Property Value

Type	Description
string	Tracking Url for the shipped Rover Cluster.

PointOfContact

Declaration

[JsonProperty(PropertyName = "pointOfContact")]
public string PointOfContact { get; set; }

Property Value

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

PointOfContactPhoneNumber

Declaration

[JsonProperty(PropertyName = "pointOfContactPhoneNumber")]
public string PointOfContactPhoneNumber { get; set; }

Property Value

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

ReturnShippingLabelUri

Declaration

[JsonProperty(PropertyName = "returnShippingLabelUri")]
public string ReturnShippingLabelUri { get; set; }

Property Value

Type	Description
string	Uri to download return shipping label.

ShippingPreference

Declaration

[JsonProperty(PropertyName = "shippingPreference")]
[JsonConverter(typeof(ResponseEnumConverter))]
public RoverCluster.ShippingPreferenceEnum? ShippingPreference { get; set; }

Property Value

Type	Description
RoverCluster.ShippingPreferenceEnum?	Preference for device delivery.

ShippingVendor

Declaration

[JsonProperty(PropertyName = "shippingVendor")]
public string ShippingVendor { get; set; }

Property Value

Type	Description
string	Shipping vendor of choice for orace to customer shipping.

SubscriptionId

Declaration

[JsonProperty(PropertyName = "subscriptionId")]
public string SubscriptionId { get; set; }

Property Value

Type	Description
string	ID provided to customer after successful subscription to Rover Stations.

SuperUserPassword

Declaration

[JsonProperty(PropertyName = "superUserPassword")]
public string SuperUserPassword { get; set; }

Property Value

Type	Description
string	Root password for the rover cluster.

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, 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: {orcl-cloud: {free-tier-retain: true}}

Type	Description
string	The tags associated with tagSlug.

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The time the the RoverCluster was created. An RFC3339 formatted datetime string

TimeCustomerReceived

Declaration

[JsonProperty(PropertyName = "timeCustomerReceived")]
public DateTime? TimeCustomerReceived { get; set; }

Property Value

Type	Description
DateTime?	Time when customer received the cluster.

TimeCustomerReturned

Declaration

[JsonProperty(PropertyName = "timeCustomerReturned")]
public DateTime? TimeCustomerReturned { get; set; }

Property Value

Type	Description
DateTime?	Time when customer returned the cluster.

TimePickupExpected

Declaration

[JsonProperty(PropertyName = "timePickupExpected")]
public DateTime? TimePickupExpected { get; set; }

Property Value

Type	Description
DateTime?	Expected date when customer wants to pickup the device if they chose customer pickup.

TimeReturnWindowEnds

Declaration

[JsonProperty(PropertyName = "timeReturnWindowEnds")]
public DateTime? TimeReturnWindowEnds { get; set; }

Property Value

Type	Description
DateTime?	End time for the window to pickup the device from customer.

TimeReturnWindowStarts

Declaration

[JsonProperty(PropertyName = "timeReturnWindowStarts")]
public DateTime? TimeReturnWindowStarts { get; set; }

Property Value

Type	Description
DateTime?	Start time for the window to pickup the device from customer.

UnlockPassphrase

Declaration

[JsonProperty(PropertyName = "unlockPassphrase")]
public string UnlockPassphrase { get; set; }

Property Value

Type	Description
string	Password to unlock the rover cluster.