Package com.oracle.bmc.datascience.requests

Class ListJobRunsRequest.Builder

java.lang.Object

com.oracle.bmc.datascience.requests.ListJobRunsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListJobRunsRequest,Void>

Enclosing class:

ListJobRunsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListJobRunsRequest	build()	Build the instance of ListJobRunsRequest as configured by this builder
ListJobRunsRequest	buildWithoutInvocationCallback()	Build the instance of ListJobRunsRequest as configured by this builder
ListJobRunsRequest.Builder	compartmentId(String compartmentId)	Filter results by the OCID of the compartment.
ListJobRunsRequest.Builder	copy(ListJobRunsRequest o)	Copy method to populate the builder with values from the given instance.
ListJobRunsRequest.Builder	createdBy(String createdBy)	Filter results by the OCID of the user who created the resource.
ListJobRunsRequest.Builder	displayName(String displayName)	Filter results by its user-friendly name.
ListJobRunsRequest.Builder	id(String id)	Filter results by OCID.
ListJobRunsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListJobRunsRequest.Builder	jobId(String jobId)	The OCID of the job.
ListJobRunsRequest.Builder	lifecycleState(JobRunLifecycleState lifecycleState)	Filter results by the specified lifecycle state.
ListJobRunsRequest.Builder	limit(Integer limit)	For list pagination.
ListJobRunsRequest.Builder	opcRequestId(String opcRequestId)	Unique Oracle assigned identifier for the request.
ListJobRunsRequest.Builder	page(String page)	For list pagination.
ListJobRunsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListJobRunsRequest.Builder	sortBy(ListJobRunsRequest.SortBy sortBy)	Specifies the field to sort by.
ListJobRunsRequest.Builder	sortOrder(ListJobRunsRequest.SortOrder sortOrder)	Specifies sort order to use, either ASC (ascending) or DESC (descending).

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

Filter results by the OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

id

public ListJobRunsRequest.Builder id(String id)

Filter results by OCID.

Must be an OCID of the correct type for the resource type.

Parameters:

id - the value to set

Returns:

this builder instance

jobId

public ListJobRunsRequest.Builder jobId(String jobId)

The OCID of the job.

Parameters:

jobId - the value to set

Returns:

this builder instance

createdBy

public ListJobRunsRequest.Builder createdBy(String createdBy)

Filter results by the OCID of the user who created the resource.

Parameters:

createdBy - the value to set

Returns:

this builder instance

displayName

public ListJobRunsRequest.Builder displayName(String displayName)

Filter results by its user-friendly name.

Parameters:

displayName - the value to set

Returns:

this builder instance

opcRequestId

public ListJobRunsRequest.Builder opcRequestId(String opcRequestId)

Unique Oracle assigned identifier for the request.

If you need to contact Oracle about a particular request, then provide the request ID.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

limit

public ListJobRunsRequest.Builder limit(Integer limit)

For list pagination.

The maximum number of results per page, or items to return in a paginated “List” call. 1 is the minimum, 100 is the maximum. See List Pagination.

Example: 50

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListJobRunsRequest.Builder page(String page)

For list pagination.

The value of the opc-next-page response header from the previous “List” call.

See [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

public ListJobRunsRequest.Builder sortOrder(ListJobRunsRequest.SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListJobRunsRequest.Builder sortBy(ListJobRunsRequest.SortBy sortBy)

Specifies the field to sort by.

Accepts only one field. By default, when you sort by timeCreated, the results are shown in descending order. When you sort by displayName, the results are shown in ascending order. Sort order for the displayName field is case sensitive.

Parameters:

sortBy - the value to set

Returns:

this builder instance

lifecycleState

public ListJobRunsRequest.Builder lifecycleState(JobRunLifecycleState lifecycleState)

Filter results by the specified lifecycle state.

Must be a valid state for the resource type.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListJobRunsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListJobRunsRequest build()

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

Returns:

instance of ListJobRunsRequest

buildWithoutInvocationCallback

public ListJobRunsRequest buildWithoutInvocationCallback()

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