Class ListJobsRequest.Builder
- java.lang.Object
-
- com.oracle.bmc.datacatalog.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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListJobsRequest
build()
Build the instance of ListJobsRequest as configured by this builderListJobsRequest
buildWithoutInvocationCallback()
Build the instance of ListJobsRequest as configured by this builderListJobsRequest.Builder
catalogId(String catalogId)
Unique catalog identifier.ListJobsRequest.Builder
connectionKey(String connectionKey)
Unique connection key.ListJobsRequest.Builder
copy(ListJobsRequest o)
Copy method to populate the builder with values from the given instance.ListJobsRequest.Builder
createdById(String createdById)
OCID of the user who created the resource.ListJobsRequest.Builder
dataAssetKey(String dataAssetKey)
Unique data asset key.ListJobsRequest.Builder
displayName(String displayName)
A filter to return only resources that match the entire display name given.ListJobsRequest.Builder
displayNameContains(String displayNameContains)
A filter to return only resources that match display name pattern given.ListJobsRequest.Builder
executionCount(Integer executionCount)
The total number of executions for this job schedule.ListJobsRequest.Builder
fields(ListJobsRequest.Fields singularValue)
Singular setter.ListJobsRequest.Builder
fields(List<ListJobsRequest.Fields> fields)
Specifies the fields to return in a job summary response.ListJobsRequest.Builder
glossaryKey(String glossaryKey)
Unique glossary key.ListJobsRequest.Builder
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.ListJobsRequest.Builder
jobDefinitionKey(String jobDefinitionKey)
Unique job definition key.ListJobsRequest.Builder
jobType(JobType jobType)
Job type.ListJobsRequest.Builder
lifecycleState(JobLifecycleState lifecycleState)
Job lifecycle state.ListJobsRequest.Builder
limit(Integer limit)
The maximum number of items to return.ListJobsRequest.Builder
opcRequestId(String opcRequestId)
The client request ID for tracing.ListJobsRequest.Builder
page(String page)
The page token representing the page at which to start retrieving results.ListJobsRequest.Builder
retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.ListJobsRequest.Builder
scheduleCronExpression(String scheduleCronExpression)
Interval on which the job will be run.ListJobsRequest.Builder
scheduleType(JobScheduleType scheduleType)
Type of the job schedule.ListJobsRequest.Builder
sortBy(ListJobsRequest.SortBy sortBy)
The field to sort by.ListJobsRequest.Builder
sortOrder(ListJobsRequest.SortOrder sortOrder)
The sort order to use, either ‘asc’ or ‘desc’.ListJobsRequest.Builder
timeCreated(Date timeCreated)
Time that the resource was created.ListJobsRequest.Builder
timeOfLatestExecution(Date timeOfLatestExecution)
The date and time the most recent execution for this job ,in the format defined by RFC3339.ListJobsRequest.Builder
timeScheduleBegin(Date timeScheduleBegin)
Date that the schedule should be operational.ListJobsRequest.Builder
timeScheduleEnd(Date timeScheduleEnd)
Date that the schedule should end from being operational.ListJobsRequest.Builder
timeUpdated(Date timeUpdated)
Time that the resource was updated.ListJobsRequest.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$
-
-
-
-
Method Detail
-
catalogId
public ListJobsRequest.Builder catalogId(String catalogId)
Unique catalog identifier.- Parameters:
catalogId
- the value to set- Returns:
- this builder instance
-
displayName
public ListJobsRequest.Builder displayName(String displayName)
A filter to return only resources that match the entire display name given.The match is not case sensitive.
- Parameters:
displayName
- the value to set- Returns:
- this builder instance
-
displayNameContains
public ListJobsRequest.Builder displayNameContains(String displayNameContains)
A filter to return only resources that match display name pattern given.The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with “Cu” or has the pattern “Cu” anywhere in between.
- Parameters:
displayNameContains
- the value to set- Returns:
- this builder instance
-
lifecycleState
public ListJobsRequest.Builder lifecycleState(JobLifecycleState lifecycleState)
Job lifecycle state.- Parameters:
lifecycleState
- the value to set- Returns:
- this builder instance
-
timeCreated
public ListJobsRequest.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 ListJobsRequest.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 ListJobsRequest.Builder createdById(String createdById)
OCID of the user who created the resource.- Parameters:
createdById
- the value to set- Returns:
- this builder instance
-
updatedById
public ListJobsRequest.Builder updatedById(String updatedById)
OCID of the user who updated the resource.- Parameters:
updatedById
- the value to set- Returns:
- this builder instance
-
jobType
public ListJobsRequest.Builder jobType(JobType jobType)
Job type.- Parameters:
jobType
- the value to set- Returns:
- this builder instance
-
jobDefinitionKey
public ListJobsRequest.Builder jobDefinitionKey(String jobDefinitionKey)
Unique job definition key.- Parameters:
jobDefinitionKey
- the value to set- Returns:
- this builder instance
-
dataAssetKey
public ListJobsRequest.Builder dataAssetKey(String dataAssetKey)
Unique data asset key.- Parameters:
dataAssetKey
- the value to set- Returns:
- this builder instance
-
glossaryKey
public ListJobsRequest.Builder glossaryKey(String glossaryKey)
Unique glossary key.- Parameters:
glossaryKey
- the value to set- Returns:
- this builder instance
-
scheduleCronExpression
public ListJobsRequest.Builder scheduleCronExpression(String scheduleCronExpression)
Interval on which the job will be run.Value is specified as a cron-supported time specification “nickname”. The following subset of those is supported: @monthly, @weekly, @daily, @hourly. For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency.
- Parameters:
scheduleCronExpression
- the value to set- Returns:
- this builder instance
-
timeScheduleBegin
public ListJobsRequest.Builder timeScheduleBegin(Date timeScheduleBegin)
Date that the schedule should be operational.An RFC3339 formatted datetime string.
- Parameters:
timeScheduleBegin
- the value to set- Returns:
- this builder instance
-
timeScheduleEnd
public ListJobsRequest.Builder timeScheduleEnd(Date timeScheduleEnd)
Date that the schedule should end from being operational.An RFC3339 formatted datetime string.
- Parameters:
timeScheduleEnd
- the value to set- Returns:
- this builder instance
-
scheduleType
public ListJobsRequest.Builder scheduleType(JobScheduleType scheduleType)
Type of the job schedule.- Parameters:
scheduleType
- the value to set- Returns:
- this builder instance
-
connectionKey
public ListJobsRequest.Builder connectionKey(String connectionKey)
Unique connection key.- Parameters:
connectionKey
- the value to set- Returns:
- this builder instance
-
fields
public ListJobsRequest.Builder fields(List<ListJobsRequest.Fields> fields)
Specifies the fields to return in a job summary response.- Parameters:
fields
- the value to set- Returns:
- this builder instance
-
fields
public ListJobsRequest.Builder fields(ListJobsRequest.Fields singularValue)
Singular setter.Specifies the fields to return in a job summary response.
- Parameters:
singularValue
- the singular value to set- Returns:
- this builder instance
-
executionCount
public ListJobsRequest.Builder executionCount(Integer executionCount)
The total number of executions for this job schedule.- Parameters:
executionCount
- the value to set- Returns:
- this builder instance
-
timeOfLatestExecution
public ListJobsRequest.Builder timeOfLatestExecution(Date timeOfLatestExecution)
The date and time the most recent execution for this job ,in the format defined by RFC3339.Example: 2019-03-25T21:10:29.600Z
- Parameters:
timeOfLatestExecution
- the value to set- Returns:
- this builder instance
-
sortBy
public ListJobsRequest.Builder sortBy(ListJobsRequest.SortBy sortBy)
The field to sort by.Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
- Parameters:
sortBy
- the value to set- Returns:
- this builder instance
-
sortOrder
public ListJobsRequest.Builder sortOrder(ListJobsRequest.SortOrder sortOrder)
The sort order to use, either ‘asc’ or ‘desc’.- Parameters:
sortOrder
- the value to set- Returns:
- this builder instance
-
limit
public ListJobsRequest.Builder limit(Integer limit)
The maximum number of items to return.- Parameters:
limit
- the value to set- Returns:
- this builder instance
-
page
public ListJobsRequest.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 ListJobsRequest.Builder opcRequestId(String opcRequestId)
The client request ID for tracing.- Parameters:
opcRequestId
- 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 interfaceBmcRequest.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 builderNote that this method takes calls to
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)
into account, while the methodbuildWithoutInvocationCallback()
does not.This is the preferred method to build an instance.
- Specified by:
build
in interfaceBmcRequest.Builder<ListJobsRequest,Void>
- Returns:
- instance of ListJobsRequest
-
buildWithoutInvocationCallback
public ListJobsRequest buildWithoutInvocationCallback()
Build the instance of ListJobsRequest as configured by this builderNote that this method does not take calls to
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)
into account, while the methodbuild()
does- Returns:
- instance of ListJobsRequest
-
-