Class ListFileSystemsRequest
Implements
Inherited Members
Namespace: Oci.FilestorageService.Requests
Assembly: OCI.DotNetSDK.Filestorage.dll
Syntax
public class ListFileSystemsRequest : IOciRequest
Examples
Click here to see an example of how to use ListFileSystems request.
Properties
AvailabilityDomain
Declaration
[Required(ErrorMessage = "AvailabilityDomain is required.")]
[HttpConverter(TargetEnum.Query, "availabilityDomain")]
public string AvailabilityDomain { get; set; }
Property Value
Type | Description |
---|---|
string | The name of the availability domain.
|
Remarks
Required
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the compartment. |
Remarks
Required
DisplayName
Declaration
[HttpConverter(TargetEnum.Query, "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.
|
FilesystemSnapshotPolicyId
Declaration
[HttpConverter(TargetEnum.Query, "filesystemSnapshotPolicyId")]
public string FilesystemSnapshotPolicyId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the file system snapshot policy that is associated with the file systems. |
Id
Declaration
[HttpConverter(TargetEnum.Query, "id")]
public string Id { get; set; }
Property Value
Type | Description |
---|---|
string | Filter results by OCID. Must be an OCID of the correct type for the resouce type. |
LifecycleState
Declaration
[HttpConverter(TargetEnum.Query, "lifecycleState")]
public ListFileSystemsRequest.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
ListFileSystemsRequest.LifecycleStateEnum? | Filter results by the specified lifecycle state. Must be a valid state for the resource type. |
Limit
Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }
Property Value
Type | Description |
---|---|
int? | For list pagination. The maximum number of results per page,
or items to return in a paginated "List" call.
1 is the minimum, 4096 is the maximum.
|
OpcRequestId
Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }
Property Value
Type | Description |
---|---|
string | Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
Page
Declaration
[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }
Property Value
Type | Description |
---|---|
string | For list pagination. The value of the |
ParentFileSystemId
Declaration
[HttpConverter(TargetEnum.Query, "parentFileSystemId")]
public string ParentFileSystemId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System. |
SortBy
Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListFileSystemsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListFileSystemsRequest.SortByEnum? | The field to sort by. You can provide either value, but not both. By default, when you sort by time created, results are shown in descending order. When you sort by display name, results are shown in ascending order. |
SortOrder
Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListFileSystemsRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
ListFileSystemsRequest.SortOrderEnum? | The sort order to use, either 'asc' or 'desc', where 'asc' is ascending and 'desc' is descending. The default order is 'desc' except for numeric values. |
SourceSnapshotId
Declaration
[HttpConverter(TargetEnum.Query, "sourceSnapshotId")]
public string SourceSnapshotId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the snapshot used to create a cloned file system. See Cloning a File System. |