Class ListDataEntitiesRequest

Inheritance

object

ListDataEntitiesRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DataintegrationService.Requests

Assembly: OCI.DotNetSDK.Dataintegration.dll

Syntax

public class ListDataEntitiesRequest : IOciRequest

Examples

Click here to see an example of how to use ListDataEntities request.

Properties

ConnectionKey

Declaration

[Required(ErrorMessage = "ConnectionKey is required.")]
[HttpConverter(TargetEnum.Path, "connectionKey")]
public string ConnectionKey { get; set; }

Property Value

Type	Description
string	The connection key.

Remarks

Required

Fields

Declaration

[HttpConverter(TargetEnum.Query, "fields", CollectionFormatType.Multi)]
public List<string> Fields { get; set; }

Property Value

Type	Description
List<string>	Specifies the fields to get for an object.

IncludeTypes

Declaration

[HttpConverter(TargetEnum.Query, "includeTypes", CollectionFormatType.Multi)]
public List<string> IncludeTypes { get; set; }

Property Value

Type	Description
List<string>	Artifact type which needs to be listed while listing Artifacts.

IsPattern

Declaration

[HttpConverter(TargetEnum.Query, "isPattern")]
public bool? IsPattern { get; set; }

Property Value

Type	Description
bool?	This parameter can be used to specify whether entity search type is pattern search or not.

Limit

Declaration

[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }

Property Value

Type	Description
int?	Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination.

Name

Declaration

[HttpConverter(TargetEnum.Query, "name")]
public string Name { get; set; }

Property Value

Type	Description
string	Used to filter by the name of the object.

NameList

Declaration

[HttpConverter(TargetEnum.Query, "nameList", CollectionFormatType.Multi)]
public List<string> NameList { get; set; }

Property Value

Type	Description
List<string>	Used to filter by the name of the object.

OpcRequestId

Declaration

[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }

Property Value

Type	Description
string	Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Page

Declaration

[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }

Property Value

Type	Description
string	For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination.

SchemaResourceName

Declaration

[Required(ErrorMessage = "SchemaResourceName is required.")]
[HttpConverter(TargetEnum.Path, "schemaResourceName")]
public string SchemaResourceName { get; set; }

Property Value

Type	Description
string	The schema resource name used for retrieving schemas.

Remarks

Required

SortBy

Declaration

[HttpConverter(TargetEnum.Query, "sortBy")]
public ListDataEntitiesRequest.SortByEnum? SortBy { get; set; }

Property Value

Type	Description
ListDataEntitiesRequest.SortByEnum?	Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order).

SortOrder

Declaration

[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListDataEntitiesRequest.SortOrderEnum? SortOrder { get; set; }

Property Value

Type	Description
ListDataEntitiesRequest.SortOrderEnum?	Specifies sort order to use, either ASC (ascending) or DESC (descending).

Type

Declaration

[HttpConverter(TargetEnum.Query, "type")]
public string Type { get; set; }

Property Value

Type	Description
string	Type of the object to filter the results with.

WorkspaceId

Declaration

[Required(ErrorMessage = "WorkspaceId is required.")]
[HttpConverter(TargetEnum.Path, "workspaceId")]
public string WorkspaceId { get; set; }

Property Value

Type	Description
string	The workspace ID.

Remarks

Required

Implements

IOciRequest