Package com.oracle.bmc.datalabelingservicedataplane.requests

Class ListRecordsRequest

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

    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.1/datalabelingservicedataplane/ListRecordsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListRecordsRequest.

    • 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.

      • builder

        public static ListRecordsRequest.Builder builder()
        Return a new builder for this request object.
        Returns:
        builder for the request 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>