Package com.oracle.bmc.resourcescheduler.requests

Class ListSchedulesRequest.Builder

java.lang.Object

com.oracle.bmc.resourcescheduler.requests.ListSchedulesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListSchedulesRequest,Void>

Enclosing class:

ListSchedulesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListSchedulesRequest	build()	Build the instance of ListSchedulesRequest as configured by this builder
ListSchedulesRequest	buildWithoutInvocationCallback()	Build the instance of ListSchedulesRequest as configured by this builder
ListSchedulesRequest.Builder	compartmentId(String compartmentId)	This is the OCID of the compartment in which to list resources.
ListSchedulesRequest.Builder	copy(ListSchedulesRequest o)	Copy method to populate the builder with values from the given instance.
ListSchedulesRequest.Builder	displayName(String displayName)	This is a filter to return only resources that match the given display name exactly.
ListSchedulesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListSchedulesRequest.Builder	lifecycleState(Schedule.LifecycleState lifecycleState)	This is a filter to return only resources that match the given lifecycle state.
ListSchedulesRequest.Builder	limit(Integer limit)	For list pagination.
ListSchedulesRequest.Builder	opcRequestId(String opcRequestId)	This is a unique Oracle-assigned identifier for the request.
ListSchedulesRequest.Builder	page(String page)	This used for list pagination.
ListSchedulesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListSchedulesRequest.Builder	scheduleId(String scheduleId)	This is the OCID of the schedule.
ListSchedulesRequest.Builder	sortBy(ListSchedulesRequest.SortBy sortBy)	This is the field to sort by.
ListSchedulesRequest.Builder	sortOrder(SortOrder sortOrder)	This is the sort order to use, either ascending (ASC) or descending ( DESC).

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

This is the OCID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

lifecycleState

public ListSchedulesRequest.Builder lifecycleState(Schedule.LifecycleState lifecycleState)

This is a filter to return only resources that match the given lifecycle state.

The state value is case-insensitive.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

displayName

public ListSchedulesRequest.Builder displayName(String displayName)

This is a filter to return only resources that match the given display name exactly.

Parameters:

displayName - the value to set

Returns:

this builder instance

scheduleId

public ListSchedulesRequest.Builder scheduleId(String scheduleId)

This is the OCID of the schedule.

Parameters:

scheduleId - the value to set

Returns:

this builder instance

limit

public ListSchedulesRequest.Builder limit(Integer limit)

For list pagination.

The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListSchedulesRequest.Builder page(String page)

This used for list pagination.

The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

Parameters:

page - the value to set

Returns:

this builder instance

sortBy

public ListSchedulesRequest.Builder sortBy(ListSchedulesRequest.SortBy sortBy)

This is the field to sort by.

You can provide only one sort order. The default order for timeCreated is descending. The default order for displayName is ascending.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListSchedulesRequest.Builder sortOrder(SortOrder sortOrder)

This is the sort order to use, either ascending (ASC) or descending ( DESC).

Parameters:

sortOrder - the value to set

Returns:

this builder instance

opcRequestId

public ListSchedulesRequest.Builder opcRequestId(String opcRequestId)

This is a unique Oracle-assigned identifier for the request.

If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListSchedulesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListSchedulesRequest build()

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

Returns:

instance of ListSchedulesRequest

buildWithoutInvocationCallback

public ListSchedulesRequest buildWithoutInvocationCallback()

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