Package com.oracle.bmc.optimizer.requests

Class ListHistoriesRequest.Builder

java.lang.Object

com.oracle.bmc.optimizer.requests.ListHistoriesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListHistoriesRequest,Void>

Enclosing class:

ListHistoriesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListHistoriesRequest	build()	Build the instance of ListHistoriesRequest as configured by this builder
ListHistoriesRequest	buildWithoutInvocationCallback()	Build the instance of ListHistoriesRequest as configured by this builder
ListHistoriesRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment.
ListHistoriesRequest.Builder	compartmentIdInSubtree(Boolean compartmentIdInSubtree)	When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of accessLevel.
ListHistoriesRequest.Builder	copy(ListHistoriesRequest o)	Copy method to populate the builder with values from the given instance.
ListHistoriesRequest.Builder	includeResourceMetadata(Boolean includeResourceMetadata)	Supplement additional resource information in extended metadata response.
ListHistoriesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListHistoriesRequest.Builder	lifecycleState(LifecycleState lifecycleState)	A filter that returns results that match the lifecycle state specified.
ListHistoriesRequest.Builder	limit(Integer limit)	The maximum number of items to return in a paginated “List” call.
ListHistoriesRequest.Builder	name(String name)	Optional.
ListHistoriesRequest.Builder	opcRequestId(String opcRequestId)	Unique Oracle-assigned identifier for the request.
ListHistoriesRequest.Builder	page(String page)	The value of the opc-next-page response header from the previous “List” call.
ListHistoriesRequest.Builder	recommendationId(String recommendationId)	The unique OCID associated with the recommendation.
ListHistoriesRequest.Builder	recommendationName(String recommendationName)	Optional.
ListHistoriesRequest.Builder	resourceType(String resourceType)	Optional.
ListHistoriesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListHistoriesRequest.Builder	sortBy(ListHistoriesRequest.SortBy sortBy)	The field to sort by.
ListHistoriesRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order to use, either ascending (ASC) or descending (DESC).
ListHistoriesRequest.Builder	status(Status status)	A filter that returns recommendations that match the status specified.

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

The OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

compartmentIdInSubtree

public ListHistoriesRequest.Builder compartmentIdInSubtree(Boolean compartmentIdInSubtree)

When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of accessLevel.

Can only be set to true when performing ListCompartments on the tenancy (root compartment).

Parameters:

compartmentIdInSubtree - the value to set

Returns:

this builder instance

name

public ListHistoriesRequest.Builder name(String name)

Optional.

A filter that returns results that match the name specified.

Parameters:

name - the value to set

Returns:

this builder instance

recommendationName

public ListHistoriesRequest.Builder recommendationName(String recommendationName)

Optional.

A filter that returns results that match the recommendation name specified.

Parameters:

recommendationName - the value to set

Returns:

this builder instance

recommendationId

public ListHistoriesRequest.Builder recommendationId(String recommendationId)

The unique OCID associated with the recommendation.

Parameters:

recommendationId - the value to set

Returns:

this builder instance

resourceType

public ListHistoriesRequest.Builder resourceType(String resourceType)

Optional.

A filter that returns results that match the resource type specified.

Parameters:

resourceType - the value to set

Returns:

this builder instance

limit

public ListHistoriesRequest.Builder limit(Integer limit)

The maximum number of items to return in a paginated “List” call.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListHistoriesRequest.Builder page(String page)

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

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

public ListHistoriesRequest.Builder sortOrder(SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListHistoriesRequest.Builder sortBy(ListHistoriesRequest.SortBy sortBy)

The field to sort by.

You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.

Parameters:

sortBy - the value to set

Returns:

this builder instance

lifecycleState

public ListHistoriesRequest.Builder lifecycleState(LifecycleState lifecycleState)

A filter that returns results that match the lifecycle state specified.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

status

public ListHistoriesRequest.Builder status(Status status)

A filter that returns recommendations that match the status specified.

Parameters:

status - the value to set

Returns:

this builder instance

includeResourceMetadata

public ListHistoriesRequest.Builder includeResourceMetadata(Boolean includeResourceMetadata)

Supplement additional resource information in extended metadata response.

Parameters:

includeResourceMetadata - the value to set

Returns:

this builder instance

opcRequestId

public ListHistoriesRequest.Builder opcRequestId(String opcRequestId)

Unique Oracle-assigned identifier for the request.

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

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListHistoriesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListHistoriesRequest build()

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

Returns:

instance of ListHistoriesRequest

buildWithoutInvocationCallback

public ListHistoriesRequest buildWithoutInvocationCallback()

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