Package com.oracle.bmc.batch.requests

Class ListBatchTasksRequest.Builder

java.lang.Object

com.oracle.bmc.batch.requests.ListBatchTasksRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListBatchTasksRequest,Void>

Enclosing class:

ListBatchTasksRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListBatchTasksRequest.Builder	batchJobId(String batchJobId)	The OCID of the batch job.
ListBatchTasksRequest	build()	Build the instance of ListBatchTasksRequest as configured by this builder
ListBatchTasksRequest	buildWithoutInvocationCallback()	Build the instance of ListBatchTasksRequest as configured by this builder
ListBatchTasksRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment in which to list resources.
ListBatchTasksRequest.Builder	copy(ListBatchTasksRequest o)	Copy method to populate the builder with values from the given instance.
ListBatchTasksRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListBatchTasksRequest.Builder	lifecycleState(BatchTask.LifecycleState lifecycleState)	A filter to return only resources that match the given lifecycle state.
ListBatchTasksRequest.Builder	limit(Integer limit)	For list pagination.
ListBatchTasksRequest.Builder	name(String name)	The hierarchical name of the batch task.
ListBatchTasksRequest.Builder	opcRequestId(String opcRequestId)	Unique Oracle-assigned identifier for the request.
ListBatchTasksRequest.Builder	page(String page)	For list pagination.
ListBatchTasksRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListBatchTasksRequest.Builder	sortBy(BatchTaskSortBy sortBy)	The field to sort by.
ListBatchTasksRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order to use, either ascending (ASC) or descending (DESC).
ListBatchTasksRequest.Builder	taskId(String taskId)	The UUID of the batch task.

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 ListBatchTasksRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

batchJobId

public ListBatchTasksRequest.Builder batchJobId(String batchJobId)

The OCID of the batch job.

Parameters:

batchJobId - the value to set

Returns:

this builder instance

lifecycleState

public ListBatchTasksRequest.Builder lifecycleState(BatchTask.LifecycleState lifecycleState)

A filter to return only resources that match the given lifecycle state.

The state value is case-insensitive.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

name

public ListBatchTasksRequest.Builder name(String name)

The hierarchical name of the batch task.

Mutually exclusive with the task id query parameter: you can’t pass both.

Parameters:

name - the value to set

Returns:

this builder instance

taskId

public ListBatchTasksRequest.Builder taskId(String taskId)

The UUID of the batch task.

Mutually exclusive with the task name and group task name query parameters: you can’t pass both.

Parameters:

taskId - the value to set

Returns:

this builder instance

limit

public ListBatchTasksRequest.Builder limit(Integer limit)

For list pagination.

The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListBatchTasksRequest.Builder page(String page)

For list pagination.

The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

public ListBatchTasksRequest.Builder sortOrder(SortOrder sortOrder)

The sort order to use, either ascending (ASC) or descending (DESC).

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListBatchTasksRequest.Builder sortBy(BatchTaskSortBy sortBy)

The field to sort by.

You can provide only one sort order. Default order for name is ascending.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListBatchTasksRequest.Builder opcRequestId(String opcRequestId)

Unique Oracle-assigned identifier for the request.

If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListBatchTasksRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListBatchTasksRequest build()

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

Returns:

instance of ListBatchTasksRequest

buildWithoutInvocationCallback

public ListBatchTasksRequest buildWithoutInvocationCallback()

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