Class ObjectStorageLink

Object Storage links create the relationship between a directory in an File Storage with Lustre file system and a path within an Object Storage bucket. For more information, see Syncing Lustre file systems with Object Storage.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Inheritance

object

ObjectStorageLink

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.LustrefilestorageService.Models

Assembly: OCI.DotNetSDK.Lustrefilestorage.dll

Syntax

public class ObjectStorageLink

Properties

AvailabilityDomain

Declaration

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

Property Value

Type	Description
string	The availability domain the file system is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1

Remarks

Required

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 that contains the Lustre file system.

Remarks

Required

CurrentJobId

Declaration

[JsonProperty(PropertyName = "currentJobId")]
public string CurrentJobId { get; set; }

Property Value

Type	Description
string	The OCID of currently running sync job. If no sync job is running, then this will be empty.

DefinedTags

Declaration

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

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

Remarks

Required

DisplayName

Declaration

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

Property Value

Type	Description
string	A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My Object Storage Link

Remarks

Required

FileSystemPath

Declaration

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

Property Value

Type	Description
string	The path in the Lustre file system used for this Object Storage link. Example: myFileSystem/mount/myDirectory

Remarks

Required

FreeformTags

Declaration

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

Property Value

Type	Description
Dictionary<string, string>	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Remarks

Required

Id

Declaration

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

Property Value

Type	Description
string	The OCID of the ObjectStorageLink.

Remarks

Required

IsOverwrite

Declaration

[Required(ErrorMessage = "IsOverwrite is required.")]
[JsonProperty(PropertyName = "isOverwrite")]
public bool? IsOverwrite { get; set; }

Property Value

Type	Description
bool?	The flag is an identifier to tell whether the job run has overwrite enabled. If `isOverwrite` is false, the file to be imported or exported will be skipped if it already exists. If `isOverwrite` is true, the file to be imported or exported will be overwritten if it already exists.

Remarks

Required

LastJobId

Declaration

[JsonProperty(PropertyName = "lastJobId")]
public string LastJobId { get; set; }

Property Value

Type	Description
string	The OCID of last succeeded sync job. If no sync job has previously run, then this will be empty.

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	A message that describes the current state of the Object Storage link in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

LifecycleState

Declaration

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

Property Value

Type	Description
ObjectStorageLink.LifecycleStateEnum?	The current state of the Object Storage link.

Remarks

Required

LustreFileSystemId

Declaration

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

Property Value

Type	Description
string	The OCID of the associated Lustre file system.

Remarks

Required

ObjectStoragePrefix

Declaration

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

Property Value

Type	Description
string	The Object Storage namespace and bucket name, including optional object prefix string, to use as the source for imports or destination for exports. Example: objectStorageNamespace:/bucketName/optionalFolder/optionalPrefix

Remarks

Required

SystemTags

Declaration

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

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

Remarks

Required

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the Lustre file system was created, expressed in RFC 3339 timestamp format. Example: 2024-04-25T21:10:29.600Z

Remarks

Required

TimeUpdated

Declaration

[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the Object Storage link was updated, in the format defined by RFC 3339. Example: 2024-04-25T21:10:29.600Z

Remarks

Required