Class ListRecordsRequest

Inheritance

object

ListRecordsRequest

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.DatalabelingservicedataplaneService.Requests

Assembly: OCI.DotNetSDK.Datalabelingservicedataplane.dll

Syntax

public class ListRecordsRequest : IOciRequest

Examples

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

Properties

AnnotationLabelsContains

Declaration

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

Property Value

Type	Description
List<string>	Lets the user filter records based on the related annotations.

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The ID of the compartment in which to list resources.

Remarks

Required

DatasetId

Declaration

[Required(ErrorMessage = "DatasetId is required.")]
[HttpConverter(TargetEnum.Query, "datasetId")]
public string DatasetId { get; set; }

Property Value

Type	Description
string	Filter the results by the OCID of the dataset.

Remarks

Required

Id

Declaration

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

Property Value

Type	Description
string	The unique OCID identifier.

IsLabeled

Declaration

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

Property Value

Type	Description
bool?	Whether the record has been labeled and has associated annotations.

LifecycleState

Declaration

[HttpConverter(TargetEnum.Query, "lifecycleState")]
public Record.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
Record.LifecycleStateEnum?	A filter to return only resources whose lifecycleState matches the given lifecycleState.

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	The name of the record.

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 ListRecordsRequest.SortByEnum? SortBy { get; set; }

Property Value

Type	Description
ListRecordsRequest.SortByEnum?	The field to sort by. Only one sort order may be provided. The default order for timeCreated is descending. The default order for name is ascending. If no value is specified, timeCreated is used by default.

SortOrder

Declaration

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

Property Value

Type	Description
SortOrders?	The sort order to use, either 'asc' or 'desc'.

Implements

IOciRequest