Class ListTypesRequest
Implements
Inherited Members
Namespace: Oci.DatacatalogService.Requests
Assembly: OCI.DotNetSDK.Datacatalog.dll
Syntax
public class ListTypesRequest : IOciRequest
Examples
Click here to see an example of how to use ListTypes 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
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<ListTypesRequest.FieldsEnum> Fields { get; set; }
Property Value
Type | Description |
---|---|
List<ListTypesRequest.FieldsEnum> | Specifies the fields to return in a type summary response. |
IsApproved
Declaration
[HttpConverter(TargetEnum.Query, "isApproved")]
public string IsApproved { get; set; }
Property Value
Type | Description |
---|---|
string | Indicates whether the type is approved for use as a classifying object. |
IsInternal
Declaration
[HttpConverter(TargetEnum.Query, "isInternal")]
public string IsInternal { get; set; }
Property Value
Type | Description |
---|---|
string | Indicates whether the type is internal, making it unavailable for use by metadata elements. |
IsTag
Declaration
[HttpConverter(TargetEnum.Query, "isTag")]
public string IsTag { get; set; }
Property Value
Type | Description |
---|---|
string | Indicates whether the type can be used for tagging metadata elements. |
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 ListTypesRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListTypesRequest.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 ListTypesRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
ListTypesRequest.SortOrderEnum? | The sort order to use, either 'asc' or 'desc'. |
TypeCategory
Declaration
[HttpConverter(TargetEnum.Query, "typeCategory")]
public string TypeCategory { get; set; }
Property Value
Type | Description |
---|---|
string | Indicates the category of this type . For example, data assets or connections. |