Class GetFolderRequest
Implements
Inherited Members
Namespace: Oci.DatacatalogService.Requests
Assembly: OCI.DotNetSDK.Datacatalog.dll
Syntax
public class GetFolderRequest : IOciRequest
Examples
Click here to see an example of how to use GetFolder request.
Properties
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
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
Fields
Declaration
[HttpConverter(TargetEnum.Query, "fields", CollectionFormatType.Multi)]
public List<GetFolderRequest.FieldsEnum> Fields { get; set; }
Property Value
Type | Description |
---|---|
List<GetFolderRequest.FieldsEnum> | Specifies the fields to return in a folder response. |
FolderKey
Declaration
[Required(ErrorMessage = "FolderKey is required.")]
[HttpConverter(TargetEnum.Path, "folderKey")]
public string FolderKey { get; set; }
Property Value
Type | Description |
---|---|
string | Unique folder key. |
Remarks
Required
IsIncludeObjectRelationships
Declaration
[HttpConverter(TargetEnum.Query, "isIncludeObjectRelationships")]
public bool? IsIncludeObjectRelationships { get; set; }
Property Value
Type | Description |
---|---|
bool? | Indicates whether the list of objects and their relationships to this object will be provided in the response. |
OpcRequestId
Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }
Property Value
Type | Description |
---|---|
string | The client request ID for tracing. |