Class ListFoldersRequest

Inheritance

object

ListFoldersRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatacatalogService.Requests

Assembly: OCI.DotNetSDK.Datacatalog.dll

Syntax

public class ListFoldersRequest : IOciRequest

Examples

Click here to see an example of how to use ListFolders request.

Properties

BusinessName

Declaration

[HttpConverter(TargetEnum.Query, "businessName")]
public string BusinessName { get; set; }

Property Value

Type	Description
string	A filter to return only resources that match the entire business name given. The match is not case sensitive.

CatalogId

Declaration

[Required(ErrorMessage = "CatalogId is required.")]
[HttpConverter(TargetEnum.Path, "catalogId")]
public string CatalogId { get; set; }

Property Value

Type	Description
string	Unique catalog identifier.

Remarks

Required

CreatedById

Declaration

[HttpConverter(TargetEnum.Query, "createdById")]
public string CreatedById { get; set; }

Property Value

Type	Description
string	OCID of the user who created the resource.

DataAssetKey

Declaration

[Required(ErrorMessage = "DataAssetKey is required.")]
[HttpConverter(TargetEnum.Path, "dataAssetKey")]
public string DataAssetKey { get; set; }

Property Value

Type	Description
string	Unique data asset key.

Remarks

Required

DisplayName

Declaration

[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A filter to return only resources that match the entire display name given. The match is not case sensitive.

DisplayNameContains

Declaration

[HttpConverter(TargetEnum.Query, "displayNameContains")]
public string DisplayNameContains { get; set; }

Property Value

Type	Description
string	A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

DisplayOrBusinessNameContains

Declaration

[HttpConverter(TargetEnum.Query, "displayOrBusinessNameContains")]
public string DisplayOrBusinessNameContains { get; set; }

Property Value

Type	Description
string	A filter to return only resources that match display name or business name pattern given. The match is not case sensitive. For Example : /folders?displayOrBusinessNameContains=Cu.* The above would match all folders with display name or business name that starts with "Cu" or has the pattern "Cu" anywhere in between.

ExternalKey

Declaration

[HttpConverter(TargetEnum.Query, "externalKey")]
public string ExternalKey { get; set; }

Property Value

Type	Description
string	Unique external identifier of this resource in the external source system.

Fields

Declaration

[HttpConverter(TargetEnum.Query, "fields", CollectionFormatType.Multi)]
public List<ListFoldersRequest.FieldsEnum> Fields { get; set; }

Property Value

Type	Description
List<ListFoldersRequest.FieldsEnum>	Specifies the fields to return in a folder summary response.

HarvestStatus

Declaration

[HttpConverter(TargetEnum.Query, "harvestStatus")]
public HarvestStatus? HarvestStatus { get; set; }

Property Value

Type	Description
HarvestStatus?	Harvest status of the harvestable resource as updated by the harvest process.

LastJobKey

Declaration

[HttpConverter(TargetEnum.Query, "lastJobKey")]
public string LastJobKey { get; set; }

Property Value

Type	Description
string	Key of the last harvest process to update this resource.

LifecycleState

Declaration

[HttpConverter(TargetEnum.Query, "lifecycleState")]
public LifecycleState? LifecycleState { get; set; }

Property Value

Type	Description
LifecycleState?	A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

Limit

Declaration

[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }

Property Value

Type	Description
int?	The maximum number of items to return.

OpcRequestId

Declaration

[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }

Property Value

Type	Description
string	The client request ID for tracing.

Page

Declaration

[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }

Property Value

Type	Description
string	The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

ParentFolderKey

Declaration

[HttpConverter(TargetEnum.Query, "parentFolderKey")]
public string ParentFolderKey { get; set; }

Property Value

Type	Description
string	Unique folder key.

Path

Declaration

[HttpConverter(TargetEnum.Query, "path")]
public string Path { get; set; }

Property Value

Type	Description
string	Full path of the resource for resources that support paths.

SortBy

Declaration

[HttpConverter(TargetEnum.Query, "sortBy")]
public ListFoldersRequest.SortByEnum? SortBy { get; set; }

Property Value

Type	Description
ListFoldersRequest.SortByEnum?	The field to sort by. Only one sort order may be provided. DISPLAYORBUSINESSNAME considers businessName of a given object if set, else its displayName is used. Default sort order for TIMECREATED is descending and default sort order for DISPLAYNAME and DISPLAYORBUSINESSNAME is ascending. If no order is specified, TIMECREATED is the default.

SortOrder

Declaration

[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListFoldersRequest.SortOrderEnum? SortOrder { get; set; }

Property Value

Type	Description
ListFoldersRequest.SortOrderEnum?	The sort order to use, either 'asc' or 'desc'.

TimeCreated

Declaration

[HttpConverter(TargetEnum.Query, "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	Time that the resource was created. An RFC3339 formatted datetime string.

TimeUpdated

Declaration

[HttpConverter(TargetEnum.Query, "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	Time that the resource was updated. An RFC3339 formatted datetime string.

TypeKey

Declaration

[HttpConverter(TargetEnum.Query, "typeKey")]
public string TypeKey { get; set; }

Property Value

Type	Description
string	The key of the object type.

UpdatedById

Declaration

[HttpConverter(TargetEnum.Query, "updatedById")]
public string UpdatedById { get; set; }

Property Value

Type	Description
string	OCID of the user who updated the resource.

Implements

IOciRequest