Class ListAnnotationsRequest

Inheritance

object

ListAnnotationsRequest

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 ListAnnotationsRequest : IOciRequest

Examples

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

Properties

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.

LifecycleState

Declaration

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

Property Value

Type	Description
Annotation.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.

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.

RecordId

Declaration

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

Property Value

Type	Description
string	The OCID of the record annotated.

SortBy

Declaration

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

Property Value

Type	Description
ListAnnotationsRequest.SortByEnum?	The field to sort by. Only one sort order may be provided. The default order for timeCreated is descending. 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'.

TimeCreatedGreaterThanOrEqualTo

Declaration

[HttpConverter(TargetEnum.Query, "timeCreatedGreaterThanOrEqualTo")]
public DateTime? TimeCreatedGreaterThanOrEqualTo { get; set; }

Property Value

Type	Description
DateTime?	The date and time the resource was created, in the timestamp format defined by RFC3339.

TimeCreatedLessThanOrEqualTo

Declaration

[HttpConverter(TargetEnum.Query, "timeCreatedLessThanOrEqualTo")]
public DateTime? TimeCreatedLessThanOrEqualTo { get; set; }

Property Value

Type	Description
DateTime?	The date and time the resource was created, in the timestamp format defined by RFC3339.

UpdatedBy

Declaration

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

Property Value

Type	Description
string	The OCID of the principal which updated the annotation.

Implements

IOciRequest