Class SummarizeRecordAnalyticsRequest

Inheritance

object

SummarizeRecordAnalyticsRequest

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

Examples

Click here to see an example of how to use SummarizeRecordAnalytics 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

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.

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.

RecordGroupBy

Declaration

[HttpConverter(TargetEnum.Query, "recordGroupBy")]
public SummarizeRecordAnalyticsRequest.RecordGroupByEnum? RecordGroupBy { get; set; }

Property Value

Type	Description
SummarizeRecordAnalyticsRequest.RecordGroupByEnum?	The field to group by. If no value is specified isLabeled is used by default.

SortBy

Declaration

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

Property Value

Type	Description
SummarizeRecordAnalyticsRequest.SortByEnum?	The field to sort by. Only one sort order may be provided. The default order is descending. If no value is specified, count 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