com.oracle.bmc.datalabelingservicedataplane.requests

Class ListRecordsRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.datalabelingservicedataplane.requests.ListRecordsRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20211001")
public class ListRecordsRequest
extends BmcRequest<Void>

Example: Click here to see how to use ListRecordsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListRecordsRequest.Builder
static class	ListRecordsRequest.SortBy The field to sort by.

Constructor Summary

Constructors

Constructor and Description
ListRecordsRequest()

Method Summary

Modifier and Type	Method and Description
static ListRecordsRequest.Builder	builder() Return a new builder for this request object.
boolean	equals(Object o) Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
List<String>	getAnnotationLabelsContains() Lets the user filter records based on the related annotations.
String	getCompartmentId() The ID of the compartment in which to list resources.
String	getDatasetId() Filter the results by the OCID of the dataset.
String	getId() The unique OCID identifier.
Boolean	getIsLabeled() Whether the record has been labeled and has associated annotations.
Record.LifecycleState	getLifecycleState() A filter to return only resources whose lifecycleState matches the given lifecycleState.
Integer	getLimit() The maximum number of items to return.
String	getName() The name of the record.
String	getOpcRequestId() The client request ID for tracing.
String	getPage() The page token representing the page at which to start retrieving results.
ListRecordsRequest.SortBy	getSortBy() The field to sort by.
SortOrders	getSortOrder() The sort order to use, either ‘asc’ or ‘desc’.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListRecordsRequest.Builder	toBuilder() Return an instance of ListRecordsRequest.Builder that allows you to modify request properties.
String	toString()

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListRecordsRequest

public ListRecordsRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The ID of the compartment in which to list resources.

getDatasetId

public String getDatasetId()

Filter the results by the OCID of the dataset.

getLifecycleState

public Record.LifecycleState getLifecycleState()

A filter to return only resources whose lifecycleState matches the given lifecycleState.

getName

public String getName()

The name of the record.

getId

public String getId()

The unique OCID identifier.

getIsLabeled

public Boolean getIsLabeled()

Whether the record has been labeled and has associated annotations.

getAnnotationLabelsContains

public List<String> getAnnotationLabelsContains()

Lets the user filter records based on the related annotations.

getLimit

public Integer getLimit()

The maximum number of items to return.

getPage

public String getPage()

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

getSortOrder

public SortOrders getSortOrder()

The sort order to use, either ‘asc’ or ‘desc’.

getSortBy

public ListRecordsRequest.SortBy getSortBy()

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.

getOpcRequestId

public String getOpcRequestId()

The client request ID for tracing.

toBuilder

public ListRecordsRequest.Builder toBuilder()

Return an instance of ListRecordsRequest.Builder that allows you to modify request properties.

Returns:

instance of ListRecordsRequest.Builder that allows you to modify request properties.

builder

public static ListRecordsRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<Void>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>