com.oracle.bmc.datalabelingservicedataplane.requests

Class ListRecordsRequest.Builder

java.lang.Object

com.oracle.bmc.datalabelingservicedataplane.requests.ListRecordsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListRecordsRequest,Void>

Enclosing class:

ListRecordsRequest

public static class ListRecordsRequest.Builder
extends Object
implements BmcRequest.Builder<ListRecordsRequest,Void>

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ListRecordsRequest.Builder	annotationLabelsContains(List<String> annotationLabelsContains) Lets the user filter records based on the related annotations.
ListRecordsRequest.Builder	annotationLabelsContains(String singularValue) Singular setter.
ListRecordsRequest	build() Build the instance of ListRecordsRequest as configured by this builder
ListRecordsRequest	buildWithoutInvocationCallback() Build the instance of ListRecordsRequest as configured by this builder
ListRecordsRequest.Builder	compartmentId(String compartmentId) The ID of the compartment in which to list resources.
ListRecordsRequest.Builder	copy(ListRecordsRequest o) Copy method to populate the builder with values from the given instance.
ListRecordsRequest.Builder	datasetId(String datasetId) Filter the results by the OCID of the dataset.
ListRecordsRequest.Builder	id(String id) The unique OCID identifier.
ListRecordsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListRecordsRequest.Builder	isLabeled(Boolean isLabeled) Whether the record has been labeled and has associated annotations.
ListRecordsRequest.Builder	lifecycleState(Record.LifecycleState lifecycleState) A filter to return only resources whose lifecycleState matches the given lifecycleState.
ListRecordsRequest.Builder	limit(Integer limit) The maximum number of items to return.
ListRecordsRequest.Builder	name(String name) The name of the record.
ListRecordsRequest.Builder	opcRequestId(String opcRequestId) The client request ID for tracing.
ListRecordsRequest.Builder	page(String page) The page token representing the page at which to start retrieving results.
ListRecordsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListRecordsRequest.Builder	sortBy(ListRecordsRequest.SortBy sortBy) The field to sort by.
ListRecordsRequest.Builder	sortOrder(SortOrders sortOrder) The sort order to use, either ‘asc’ or ‘desc’.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

body$

Constructor Detail

Builder

public Builder()

Method Detail

compartmentId

public ListRecordsRequest.Builder compartmentId(String compartmentId)

The ID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

datasetId

public ListRecordsRequest.Builder datasetId(String datasetId)

Filter the results by the OCID of the dataset.

Parameters:

datasetId - the value to set

Returns:

this builder instance

lifecycleState

public ListRecordsRequest.Builder lifecycleState(Record.LifecycleState lifecycleState)

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

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

name

public ListRecordsRequest.Builder name(String name)

The name of the record.

Parameters:

name - the value to set

Returns:

this builder instance

id

public ListRecordsRequest.Builder id(String id)

The unique OCID identifier.

Parameters:

id - the value to set

Returns:

this builder instance

isLabeled

public ListRecordsRequest.Builder isLabeled(Boolean isLabeled)

Whether the record has been labeled and has associated annotations.

Parameters:

isLabeled - the value to set

Returns:

this builder instance

annotationLabelsContains

public ListRecordsRequest.Builder annotationLabelsContains(List<String> annotationLabelsContains)

Lets the user filter records based on the related annotations.

Parameters:

annotationLabelsContains - the value to set

Returns:

this builder instance

annotationLabelsContains

public ListRecordsRequest.Builder annotationLabelsContains(String singularValue)

Singular setter. Lets the user filter records based on the related annotations.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

limit

public ListRecordsRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListRecordsRequest.Builder page(String page)

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

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

public ListRecordsRequest.Builder sortOrder(SortOrders sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListRecordsRequest.Builder sortBy(ListRecordsRequest.SortBy sortBy)

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.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListRecordsRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

public ListRecordsRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)

Set the invocation callback for the request to be built.

Parameters:

invocationCallback - the invocation callback to be set for the request

Returns:

this builder instance

retryConfiguration

public ListRecordsRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)

Set the retry configuration for the request to be built.

Parameters:

retryConfiguration - the retry configuration to be used for the request

Returns:

this builder instance

copy

public ListRecordsRequest.Builder copy(ListRecordsRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<ListRecordsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListRecordsRequest build()

Build the instance of ListRecordsRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ListRecordsRequest,Void>

Returns:

instance of ListRecordsRequest

buildWithoutInvocationCallback

public ListRecordsRequest buildWithoutInvocationCallback()

Build the instance of ListRecordsRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of ListRecordsRequest