Class ListAggregatedPhysicalEntitiesRequest
Implements
Inherited Members
Namespace: Oci.DatacatalogService.Requests
Assembly: OCI.DotNetSDK.Datacatalog.dll
Syntax
public class ListAggregatedPhysicalEntitiesRequest : IOciRequest
Examples
Click here to see an example of how to use ListAggregatedPhysicalEntities 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
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. |
EntityKey
Declaration
[Required(ErrorMessage = "EntityKey is required.")]
[HttpConverter(TargetEnum.Path, "entityKey")]
public string EntityKey { get; set; }
Property Value
Type | Description |
---|---|
string | Unique entity key. |
Remarks
Required
Fields
Declaration
[HttpConverter(TargetEnum.Query, "fields", CollectionFormatType.Multi)]
public List<ListAggregatedPhysicalEntitiesRequest.FieldsEnum> Fields { get; set; }
Property Value
Type | Description |
---|---|
List<ListAggregatedPhysicalEntitiesRequest.FieldsEnum> | Specifies the fields to return in an entity response. |
IsIncludeProperties
Declaration
[HttpConverter(TargetEnum.Query, "isIncludeProperties")]
public bool? IsIncludeProperties { get; set; }
Property Value
Type | Description |
---|---|
bool? | Indicates whether the properties map will be provided in the response. |
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. |
SortBy
Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListAggregatedPhysicalEntitiesRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListAggregatedPhysicalEntitiesRequest.SortByEnum? | The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. |
SortOrder
Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListAggregatedPhysicalEntitiesRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
ListAggregatedPhysicalEntitiesRequest.SortOrderEnum? | The sort order to use, either 'asc' or 'desc'. |