Class ListAttributesRequest
Implements
Inherited Members
Namespace: Oci.DatacatalogService.Requests
Assembly: OCI.DotNetSDK.Datacatalog.dll
Syntax
public class ListAttributesRequest : IOciRequest
Examples
Click here to see an example of how to use ListAttributes 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. |
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
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. |
ExternalTypeName
Declaration
[HttpConverter(TargetEnum.Query, "externalTypeName")]
public string ExternalTypeName { get; set; }
Property Value
Type | Description |
---|---|
string | Data type as defined in an external system. |
Fields
Declaration
[HttpConverter(TargetEnum.Query, "fields", CollectionFormatType.Multi)]
public List<ListAttributesRequest.FieldsEnum> Fields { get; set; }
Property Value
Type | Description |
---|---|
List<ListAttributesRequest.FieldsEnum> | Specifies the fields to return in an entity attribute summary response. |
IsIncrementalData
Declaration
[HttpConverter(TargetEnum.Query, "isIncrementalData")]
public bool? IsIncrementalData { get; set; }
Property Value
Type | Description |
---|---|
bool? | Identifies whether this attribute can be used as a watermark to extract incremental data. |
IsNullable
Declaration
[HttpConverter(TargetEnum.Query, "isNullable")]
public bool? IsNullable { get; set; }
Property Value
Type | Description |
---|---|
bool? | Identifies whether this attribute can be assigned null value. |
Length
Declaration
[HttpConverter(TargetEnum.Query, "length")]
public long? Length { get; set; }
Property Value
Type | Description |
---|---|
long? | Max allowed length of the attribute value. |
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. |
Position
Declaration
[HttpConverter(TargetEnum.Query, "position")]
public int? Position { get; set; }
Property Value
Type | Description |
---|---|
int? | Position of the attribute in the record definition. |
Precision
Declaration
[HttpConverter(TargetEnum.Query, "precision")]
public int? Precision { get; set; }
Property Value
Type | Description |
---|---|
int? | Precision of the attribute value usually applies to float data type. |
Scale
Declaration
[HttpConverter(TargetEnum.Query, "scale")]
public int? Scale { get; set; }
Property Value
Type | Description |
---|---|
int? | Scale of the attribute value usually applies to float data type. |
SortBy
Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListAttributesRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListAttributesRequest.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, POSITION and DISPLAYORBUSINESSNAME is ascending. If no order is specified, POSITION is the default. |
SortOrder
Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListAttributesRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
ListAttributesRequest.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. |
TimeExternal
Declaration
[HttpConverter(TargetEnum.Query, "timeExternal")]
public DateTime? TimeExternal { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | Last modified timestamp of this object in the external system. |
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. |
UpdatedById
Declaration
[HttpConverter(TargetEnum.Query, "updatedById")]
public string UpdatedById { get; set; }
Property Value
Type | Description |
---|---|
string | OCID of the user who updated the resource. |