Package com.oracle.bmc.resourcemanager.requests

Class ListJobsRequest.Builder

java.lang.Object

com.oracle.bmc.resourcemanager.requests.ListJobsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListJobsRequest,Void>

Enclosing class:

ListJobsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListJobsRequest	build()	Build the instance of ListJobsRequest as configured by this builder
ListJobsRequest	buildWithoutInvocationCallback()	Build the instance of ListJobsRequest as configured by this builder
ListJobsRequest.Builder	compartmentId(String compartmentId)	A filter to return only resources that exist in the compartment, identified by OCID.
ListJobsRequest.Builder	copy(ListJobsRequest o)	Copy method to populate the builder with values from the given instance.
ListJobsRequest.Builder	displayName(String displayName)	A filter to return only resources that match the given display name exactly.
ListJobsRequest.Builder	id(String id)	The OCID on which to query for jobs.
ListJobsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListJobsRequest.Builder	lifecycleState(Job.LifecycleState lifecycleState)	A filter that returns all resources that match the specified lifecycle state.
ListJobsRequest.Builder	limit(Integer limit)	The number of items returned in a paginated List call.
ListJobsRequest.Builder	opcRequestId(String opcRequestId)	Unique Oracle-assigned identifier for the request.
ListJobsRequest.Builder	page(String page)	The value of the opc-next-page response header from the preceding List call.
ListJobsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListJobsRequest.Builder	sortBy(ListJobsRequest.SortBy sortBy)	The field to use when sorting returned resources.
ListJobsRequest.Builder	sortOrder(ListJobsRequest.SortOrder sortOrder)	The sort order to use when sorting returned resources.
ListJobsRequest.Builder	stackId(String stackId)	The stack OCID on which to filter.

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

opcRequestId

public ListJobsRequest.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.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

compartmentId

public ListJobsRequest.Builder compartmentId(String compartmentId)

A filter to return only resources that exist in the compartment, identified by OCID.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

stackId

public ListJobsRequest.Builder stackId(String stackId)

The stack OCID on which to filter.

Parameters:

stackId - the value to set

Returns:

this builder instance

id

public ListJobsRequest.Builder id(String id)

The OCID on which to query for jobs.

Parameters:

id - the value to set

Returns:

this builder instance

lifecycleState

public ListJobsRequest.Builder lifecycleState(Job.LifecycleState lifecycleState)

A filter that returns all resources that match the specified lifecycle state.

The state value is case-insensitive.

Allowable values: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

displayName

public ListJobsRequest.Builder displayName(String displayName)

A filter to return only resources that match the given display name exactly.

Use this filter to list a resource by name. Requires sortBy set to DISPLAYNAME. Alternatively, when you know the resource OCID, use the related Get operation.

Parameters:

displayName - the value to set

Returns:

this builder instance

sortBy

public ListJobsRequest.Builder sortBy(ListJobsRequest.SortBy sortBy)

The field to use when sorting returned resources.

By default, TIMECREATED is ordered descending. By default, DISPLAYNAME is ordered ascending. Note that you can sort only on one field.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListJobsRequest.Builder sortOrder(ListJobsRequest.SortOrder sortOrder)

The sort order to use when sorting returned resources.

Ascending (ASC) or descending (DESC).

Parameters:

sortOrder - the value to set

Returns:

this builder instance

limit

public ListJobsRequest.Builder limit(Integer limit)

The number of items returned in a paginated List call.

For information about pagination, see List Pagination.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListJobsRequest.Builder page(String page)

The value of the opc-next-page response header from the preceding List call.

For information about pagination, see List Pagination.

Parameters:

page - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListJobsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListJobsRequest build()

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

Returns:

instance of ListJobsRequest

buildWithoutInvocationCallback

public ListJobsRequest buildWithoutInvocationCallback()

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