com.oracle.bmc.databasemanagement.requests

Class ListJobsRequest.Builder

java.lang.Object

com.oracle.bmc.databasemanagement.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>

Method Summary

Modifier and Type	Method and Description
ListJobsRequest	build() Build the instance of ListJobsRequest as configured by this builder
ListJobsRequest	buildWithoutInvocationCallback()
ListJobsRequest.Builder	compartmentId(String compartmentId) The OCID of the compartment.
ListJobsRequest.Builder	copy(ListJobsRequest o) Copy method to populate the builder with values from the given instance.
ListJobsRequest.Builder	id(String id) The identifier of the resource.
ListJobsRequest.Builder	invocationCallback(Consumer<javax.ws.rs.client.Invocation.Builder> invocationCallback) Set the invocation callback for the request to be built.
ListJobsRequest.Builder	lifecycleState(Job.LifecycleState lifecycleState) The lifecycle state of the job.
ListJobsRequest.Builder	limit(Integer limit) The maximum number of records returned in the paginated response.
ListJobsRequest.Builder	managedDatabaseGroupId(String managedDatabaseGroupId) The OCID of the Managed Database Group.
ListJobsRequest.Builder	managedDatabaseId(String managedDatabaseId) The OCID of the Managed Database.
ListJobsRequest.Builder	name(String name) A filter to return only resources that match the entire name.
ListJobsRequest.Builder	opcRequestId(String opcRequestId) The client request ID for tracing.
ListJobsRequest.Builder	page(String page) The page token representing the page from where the next set of paginated results are retrieved.
ListJobsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListJobsRequest.Builder	sortBy(ListJobsRequest.SortBy sortBy) The field to sort information by.
ListJobsRequest.Builder	sortOrder(SortOrders sortOrder) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order.
String	toString()

Methods inherited from class java.lang.Object

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

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

body$

Method Detail

invocationCallback

public ListJobsRequest.Builder invocationCallback(Consumer<javax.ws.rs.client.Invocation.Builder> 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.util.internal.Consumer) 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

compartmentId

public ListJobsRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Returns:

this.

opcRequestId

public ListJobsRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Returns:

this.

id

public ListJobsRequest.Builder id(String id)

The identifier of the resource.

Returns:

this.

managedDatabaseGroupId

public ListJobsRequest.Builder managedDatabaseGroupId(String managedDatabaseGroupId)

The OCID of the Managed Database Group.

Returns:

this.

managedDatabaseId

public ListJobsRequest.Builder managedDatabaseId(String managedDatabaseId)

The OCID of the Managed Database.

Returns:

this.

name

public ListJobsRequest.Builder name(String name)

A filter to return only resources that match the entire name.

Returns:

this.

lifecycleState

public ListJobsRequest.Builder lifecycleState(Job.LifecycleState lifecycleState)

The lifecycle state of the job.

Returns:

this.

limit

public ListJobsRequest.Builder limit(Integer limit)

The maximum number of records returned in the paginated response.

Returns:

this.

page

public ListJobsRequest.Builder page(String page)

The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.

Returns:

this.

sortBy

public ListJobsRequest.Builder sortBy(ListJobsRequest.SortBy sortBy)

The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive.

Returns:

this.

sortOrder

public ListJobsRequest.Builder sortOrder(SortOrders sortOrder)

The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order.

Returns:

this.

buildWithoutInvocationCallback

public ListJobsRequest buildWithoutInvocationCallback()

toString

public String toString()

Overrides:

toString in class Object