Package com.oracle.bmc.budget.requests

Class ListBudgetsRequest.Builder

java.lang.Object

com.oracle.bmc.budget.requests.ListBudgetsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListBudgetsRequest,Void>

Enclosing class:

ListBudgetsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListBudgetsRequest	build()	Build the instance of ListBudgetsRequest as configured by this builder
ListBudgetsRequest	buildWithoutInvocationCallback()	Build the instance of ListBudgetsRequest as configured by this builder
ListBudgetsRequest.Builder	compartmentId(String compartmentId)	The ID of the compartment in which to list resources.
ListBudgetsRequest.Builder	copy(ListBudgetsRequest o)	Copy method to populate the builder with values from the given instance.
ListBudgetsRequest.Builder	displayName(String displayName)	A user-friendly name.
ListBudgetsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListBudgetsRequest.Builder	lifecycleState(LifecycleState lifecycleState)	The current state of the resource to filter by.
ListBudgetsRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListBudgetsRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListBudgetsRequest.Builder	page(String page)	The page token representing the page at which to start retrieving results.
ListBudgetsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListBudgetsRequest.Builder	sortBy(SortBy sortBy)	The field to sort by.
ListBudgetsRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order to use, either ‘asc’ or ‘desc’.
ListBudgetsRequest.Builder	targetType(ListBudgetsRequest.TargetType targetType)	The type of target to filter by: * ALL - List all budgets * COMPARTMENT - List all budgets with targetType == “COMPARTMENT” * TAG - List all budgets with targetType == “TAG”

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

The ID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

limit

public ListBudgetsRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

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

sortOrder

public ListBudgetsRequest.Builder sortOrder(SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListBudgetsRequest.Builder sortBy(SortBy sortBy)

The field to sort by.

If not specified, the default is timeCreated. The default sort order for timeCreated is DESC. The default sort order for displayName is ASC in alphanumeric order.

Parameters:

sortBy - the value to set

Returns:

this builder instance

lifecycleState

public ListBudgetsRequest.Builder lifecycleState(LifecycleState lifecycleState)

The current state of the resource to filter by.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

displayName

public ListBudgetsRequest.Builder displayName(String displayName)

A user-friendly name.

This does not have to be unique, and it’s changeable.

Example: My new resource

Parameters:

displayName - the value to set

Returns:

this builder instance

targetType

public ListBudgetsRequest.Builder targetType(ListBudgetsRequest.TargetType targetType)

The type of target to filter by: * ALL - List all budgets * COMPARTMENT - List all budgets with targetType == “COMPARTMENT” * TAG - List all budgets with targetType == “TAG”

Parameters:

targetType - the value to set

Returns:

this builder instance

opcRequestId

public ListBudgetsRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListBudgetsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListBudgetsRequest build()

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

Returns:

instance of ListBudgetsRequest

buildWithoutInvocationCallback

public ListBudgetsRequest buildWithoutInvocationCallback()

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