Package com.oracle.bmc.datacatalog.requests

Class ListJobExecutionsRequest.Builder

java.lang.Object

com.oracle.bmc.datacatalog.requests.ListJobExecutionsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListJobExecutionsRequest,Void>

Enclosing class:

ListJobExecutionsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListJobExecutionsRequest	build()	Build the instance of ListJobExecutionsRequest as configured by this builder
ListJobExecutionsRequest	buildWithoutInvocationCallback()	Build the instance of ListJobExecutionsRequest as configured by this builder
ListJobExecutionsRequest.Builder	catalogId(String catalogId)	Unique catalog identifier.
ListJobExecutionsRequest.Builder	copy(ListJobExecutionsRequest o)	Copy method to populate the builder with values from the given instance.
ListJobExecutionsRequest.Builder	createdById(String createdById)	OCID of the user who created the resource.
ListJobExecutionsRequest.Builder	dataEntityKey(String dataEntityKey)	Unique entity key.
ListJobExecutionsRequest.Builder	errorCode(String errorCode)	Error code returned from the job execution or null if job is still running or didn’t return an error.
ListJobExecutionsRequest.Builder	errorMessage(String errorMessage)	Error message returned from the job execution or null if job is still running or didn’t return an error.
ListJobExecutionsRequest.Builder	eventKey(String eventKey)	Event that triggered the execution of this job or null.
ListJobExecutionsRequest.Builder	externalUrl(String externalUrl)	The a URL of the job for accessing this resource and its status.
ListJobExecutionsRequest.Builder	fields(ListJobExecutionsRequest.Fields singularValue)	Singular setter.
ListJobExecutionsRequest.Builder	fields(List<ListJobExecutionsRequest.Fields> fields)	Specifies the fields to return in a job execution summary response.
ListJobExecutionsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListJobExecutionsRequest.Builder	jobKey(String jobKey)	Unique job key.
ListJobExecutionsRequest.Builder	jobType(JobType jobType)	Job type.
ListJobExecutionsRequest.Builder	lifecycleState(JobExecutionState lifecycleState)	Job execution lifecycle state.
ListJobExecutionsRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListJobExecutionsRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListJobExecutionsRequest.Builder	page(String page)	The page token representing the page at which to start retrieving results.
ListJobExecutionsRequest.Builder	parentKey(String parentKey)	The unique key of the parent execution or null if this job execution has no parent.
ListJobExecutionsRequest.Builder	processKey(String processKey)	Process identifier related to the job execution.
ListJobExecutionsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListJobExecutionsRequest.Builder	sortBy(ListJobExecutionsRequest.SortBy sortBy)	The field to sort by.
ListJobExecutionsRequest.Builder	sortOrder(ListJobExecutionsRequest.SortOrder sortOrder)	The sort order to use, either ‘asc’ or ‘desc’.
ListJobExecutionsRequest.Builder	subType(String subType)	Sub-type of this job execution.
ListJobExecutionsRequest.Builder	timeCreated(Date timeCreated)	Time that the resource was created.
ListJobExecutionsRequest.Builder	timeEnd(Date timeEnd)	Time that the job execution ended or null if the job is still running or hasn’t run yet.
ListJobExecutionsRequest.Builder	timeStart(Date timeStart)	Time that the job execution was started or in the case of a future time, the time when the job will start.
ListJobExecutionsRequest.Builder	timeUpdated(Date timeUpdated)	Time that the resource was updated.
ListJobExecutionsRequest.Builder	updatedById(String updatedById)	OCID of the user who updated the resource.

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

catalogId

public ListJobExecutionsRequest.Builder catalogId(String catalogId)

Unique catalog identifier.

Parameters:

catalogId - the value to set

Returns:

this builder instance

jobKey

public ListJobExecutionsRequest.Builder jobKey(String jobKey)

Unique job key.

Parameters:

jobKey - the value to set

Returns:

this builder instance

lifecycleState

public ListJobExecutionsRequest.Builder lifecycleState(JobExecutionState lifecycleState)

Job execution lifecycle state.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

timeCreated

public ListJobExecutionsRequest.Builder timeCreated(Date timeCreated)

Time that the resource was created.

An RFC3339 formatted datetime string.

Parameters:

timeCreated - the value to set

Returns:

this builder instance

timeUpdated

public ListJobExecutionsRequest.Builder timeUpdated(Date timeUpdated)

Time that the resource was updated.

An RFC3339 formatted datetime string.

Parameters:

timeUpdated - the value to set

Returns:

this builder instance

createdById

public ListJobExecutionsRequest.Builder createdById(String createdById)

OCID of the user who created the resource.

Parameters:

createdById - the value to set

Returns:

this builder instance

updatedById

public ListJobExecutionsRequest.Builder updatedById(String updatedById)

OCID of the user who updated the resource.

Parameters:

updatedById - the value to set

Returns:

this builder instance

jobType

public ListJobExecutionsRequest.Builder jobType(JobType jobType)

Job type.

Parameters:

jobType - the value to set

Returns:

this builder instance

subType

public ListJobExecutionsRequest.Builder subType(String subType)

Sub-type of this job execution.

Parameters:

subType - the value to set

Returns:

this builder instance

parentKey

public ListJobExecutionsRequest.Builder parentKey(String parentKey)

The unique key of the parent execution or null if this job execution has no parent.

Parameters:

parentKey - the value to set

Returns:

this builder instance

timeStart

public ListJobExecutionsRequest.Builder timeStart(Date timeStart)

Time that the job execution was started or in the case of a future time, the time when the job will start.

An RFC3339 formatted datetime string.

Parameters:

timeStart - the value to set

Returns:

this builder instance

timeEnd

public ListJobExecutionsRequest.Builder timeEnd(Date timeEnd)

Time that the job execution ended or null if the job is still running or hasn’t run yet.

An RFC3339 formatted datetime string.

Parameters:

timeEnd - the value to set

Returns:

this builder instance

errorCode

public ListJobExecutionsRequest.Builder errorCode(String errorCode)

Error code returned from the job execution or null if job is still running or didn’t return an error.

Parameters:

errorCode - the value to set

Returns:

this builder instance

errorMessage

public ListJobExecutionsRequest.Builder errorMessage(String errorMessage)

Error message returned from the job execution or null if job is still running or didn’t return an error.

Parameters:

errorMessage - the value to set

Returns:

this builder instance

processKey

public ListJobExecutionsRequest.Builder processKey(String processKey)

Process identifier related to the job execution.

Parameters:

processKey - the value to set

Returns:

this builder instance

externalUrl

public ListJobExecutionsRequest.Builder externalUrl(String externalUrl)

The a URL of the job for accessing this resource and its status.

Parameters:

externalUrl - the value to set

Returns:

this builder instance

eventKey

public ListJobExecutionsRequest.Builder eventKey(String eventKey)

Event that triggered the execution of this job or null.

Parameters:

eventKey - the value to set

Returns:

this builder instance

dataEntityKey

public ListJobExecutionsRequest.Builder dataEntityKey(String dataEntityKey)

Unique entity key.

Parameters:

dataEntityKey - the value to set

Returns:

this builder instance

fields

public ListJobExecutionsRequest.Builder fields(List<ListJobExecutionsRequest.Fields> fields)

Specifies the fields to return in a job execution summary response.

Parameters:

fields - the value to set

Returns:

this builder instance

fields

public ListJobExecutionsRequest.Builder fields(ListJobExecutionsRequest.Fields singularValue)

Singular setter.

Specifies the fields to return in a job execution summary response.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

sortBy

public ListJobExecutionsRequest.Builder sortBy(ListJobExecutionsRequest.SortBy sortBy)

The field to sort by.

Only one sort order may be provided; the default is descending. Use sortOrder query param to specify order.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListJobExecutionsRequest.Builder sortOrder(ListJobExecutionsRequest.SortOrder sortOrder)

The sort order to use, either ‘asc’ or ‘desc’.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

limit

public ListJobExecutionsRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

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

opcRequestId

public ListJobExecutionsRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListJobExecutionsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListJobExecutionsRequest build()

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

Returns:

instance of ListJobExecutionsRequest

buildWithoutInvocationCallback

public ListJobExecutionsRequest buildWithoutInvocationCallback()

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