Class ListEntityTagsRequest
Implements
Inherited Members
Namespace: Oci.DatacatalogService.Requests
Assembly: OCI.DotNetSDK.Datacatalog.dll
Syntax
public class ListEntityTagsRequest : IOciRequest
Examples
Click here to see an example of how to use ListEntityTags 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
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
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<ListEntityTagsRequest.FieldsEnum> Fields { get; set; }
Property Value
Type | Description |
---|---|
List<ListEntityTagsRequest.FieldsEnum> | Specifies the fields to return in an entity tag summary response. |
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. |
Name
Declaration
[HttpConverter(TargetEnum.Query, "name")]
public string Name { get; set; }
Property Value
Type | Description |
---|---|
string | Immutable resource name. |
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 ListEntityTagsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListEntityTagsRequest.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 ListEntityTagsRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
ListEntityTagsRequest.SortOrderEnum? | The sort order to use, either 'asc' or 'desc'. |
TermKey
Declaration
[HttpConverter(TargetEnum.Query, "termKey")]
public string TermKey { get; set; }
Property Value
Type | Description |
---|---|
string | Unique key of the related term. |
TermPath
Declaration
[HttpConverter(TargetEnum.Query, "termPath")]
public string TermPath { get; set; }
Property Value
Type | Description |
---|---|
string | Path of the related term. |
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. |