Package com.oracle.bmc.datalabelingservicedataplane.requests

Class ListAnnotationsRequest.Builder

java.lang.Object

com.oracle.bmc.datalabelingservicedataplane.requests.ListAnnotationsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListAnnotationsRequest,Void>

Enclosing class:

ListAnnotationsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListAnnotationsRequest	build()	Build the instance of ListAnnotationsRequest as configured by this builder
ListAnnotationsRequest	buildWithoutInvocationCallback()	Build the instance of ListAnnotationsRequest as configured by this builder
ListAnnotationsRequest.Builder	compartmentId(String compartmentId)	The ID of the compartment in which to list resources.
ListAnnotationsRequest.Builder	copy(ListAnnotationsRequest o)	Copy method to populate the builder with values from the given instance.
ListAnnotationsRequest.Builder	datasetId(String datasetId)	Filter the results by the OCID of the dataset.
ListAnnotationsRequest.Builder	id(String id)	The unique OCID identifier.
ListAnnotationsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListAnnotationsRequest.Builder	lifecycleState(Annotation.LifecycleState lifecycleState)	A filter to return only resources whose lifecycleState matches the given lifecycleState.
ListAnnotationsRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListAnnotationsRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListAnnotationsRequest.Builder	page(String page)	The page token representing the page at which to start retrieving results.
ListAnnotationsRequest.Builder	recordId(String recordId)	The OCID of the record annotated.
ListAnnotationsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListAnnotationsRequest.Builder	sortBy(ListAnnotationsRequest.SortBy sortBy)	The field to sort by.
ListAnnotationsRequest.Builder	sortOrder(SortOrders sortOrder)	The sort order to use, either ‘asc’ or ‘desc’.
ListAnnotationsRequest.Builder	timeCreatedGreaterThanOrEqualTo(Date timeCreatedGreaterThanOrEqualTo)	The date and time the resource was created, in the timestamp format defined by RFC3339.
ListAnnotationsRequest.Builder	timeCreatedLessThanOrEqualTo(Date timeCreatedLessThanOrEqualTo)	The date and time the resource was created, in the timestamp format defined by RFC3339.
ListAnnotationsRequest.Builder	updatedBy(String updatedBy)	The OCID of the principal which updated the annotation.

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 ListAnnotationsRequest.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 ListAnnotationsRequest.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 ListAnnotationsRequest.Builder lifecycleState(Annotation.LifecycleState lifecycleState)

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

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

id

public ListAnnotationsRequest.Builder id(String id)

The unique OCID identifier.

Parameters:

id - the value to set

Returns:

this builder instance

updatedBy

public ListAnnotationsRequest.Builder updatedBy(String updatedBy)

The OCID of the principal which updated the annotation.

Parameters:

updatedBy - the value to set

Returns:

this builder instance

recordId

public ListAnnotationsRequest.Builder recordId(String recordId)

The OCID of the record annotated.

Parameters:

recordId - the value to set

Returns:

this builder instance

timeCreatedGreaterThanOrEqualTo

public ListAnnotationsRequest.Builder timeCreatedGreaterThanOrEqualTo(Date timeCreatedGreaterThanOrEqualTo)

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

Parameters:

timeCreatedGreaterThanOrEqualTo - the value to set

Returns:

this builder instance

timeCreatedLessThanOrEqualTo

public ListAnnotationsRequest.Builder timeCreatedLessThanOrEqualTo(Date timeCreatedLessThanOrEqualTo)

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

Parameters:

timeCreatedLessThanOrEqualTo - the value to set

Returns:

this builder instance

limit

public ListAnnotationsRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListAnnotationsRequest.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 ListAnnotationsRequest.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 ListAnnotationsRequest.Builder sortBy(ListAnnotationsRequest.SortBy sortBy)

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.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListAnnotationsRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

public ListAnnotationsRequest.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 ListAnnotationsRequest.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 ListAnnotationsRequest.Builder copy(ListAnnotationsRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListAnnotationsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListAnnotationsRequest build()

Build the instance of ListAnnotationsRequest 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<ListAnnotationsRequest,Void>

Returns:

instance of ListAnnotationsRequest

buildWithoutInvocationCallback

public ListAnnotationsRequest buildWithoutInvocationCallback()

Build the instance of ListAnnotationsRequest 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 ListAnnotationsRequest