Package com.oracle.bmc.cloudguard.requests

Class ListRecommendationsRequest.Builder

java.lang.Object

com.oracle.bmc.cloudguard.requests.ListRecommendationsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListRecommendationsRequest,Void>

Enclosing class:

ListRecommendationsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListRecommendationsRequest.Builder	accessLevel(ListRecommendationsRequest.AccessLevel accessLevel)	Valid values are RESTRICTED and ACCESSIBLE.
ListRecommendationsRequest	build()	Build the instance of ListRecommendationsRequest as configured by this builder
ListRecommendationsRequest	buildWithoutInvocationCallback()	Build the instance of ListRecommendationsRequest as configured by this builder
ListRecommendationsRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment in which to list resources.
ListRecommendationsRequest.Builder	compartmentIdInSubtree(Boolean compartmentIdInSubtree)	Default is false.
ListRecommendationsRequest.Builder	copy(ListRecommendationsRequest o)	Copy method to populate the builder with values from the given instance.
ListRecommendationsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListRecommendationsRequest.Builder	lifecycleDetail(RecommendationLifecycleDetail lifecycleDetail)	The field lifecycle state.
ListRecommendationsRequest.Builder	lifecycleState(LifecycleState lifecycleState)	The field lifecycle state.
ListRecommendationsRequest.Builder	limit(Integer limit)	The maximum number of items to return
ListRecommendationsRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListRecommendationsRequest.Builder	page(String page)	The page token representing the page at which to start retrieving results.
ListRecommendationsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListRecommendationsRequest.Builder	sortBy(ListRecommendationsRequest.SortBy sortBy)	The field to sort by.
ListRecommendationsRequest.Builder	sortOrder(SortOrders sortOrder)	The sort order to use
ListRecommendationsRequest.Builder	targetId(String targetId)	The ID of the target in which to list resources.

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

The OCID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

sortOrder

public ListRecommendationsRequest.Builder sortOrder(SortOrders sortOrder)

The sort order to use

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListRecommendationsRequest.Builder sortBy(ListRecommendationsRequest.SortBy sortBy)

The field to sort by.

Only one sort order may be provided. Default order for riskLevel and timeCreated is descending. If no value is specified riskLevel is default.

Parameters:

sortBy - the value to set

Returns:

this builder instance

targetId

public ListRecommendationsRequest.Builder targetId(String targetId)

The ID of the target in which to list resources.

Parameters:

targetId - the value to set

Returns:

this builder instance

compartmentIdInSubtree

public ListRecommendationsRequest.Builder compartmentIdInSubtree(Boolean compartmentIdInSubtree)

Default is false.

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

Parameters:

compartmentIdInSubtree - the value to set

Returns:

this builder instance

accessLevel

public ListRecommendationsRequest.Builder accessLevel(ListRecommendationsRequest.AccessLevel accessLevel)

Valid values are RESTRICTED and ACCESSIBLE.

Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

Parameters:

accessLevel - the value to set

Returns:

this builder instance

lifecycleState

public ListRecommendationsRequest.Builder lifecycleState(LifecycleState lifecycleState)

The field lifecycle state.

Only one state can be provided. Default value for state is active. If no value is specified state is active.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

lifecycleDetail

public ListRecommendationsRequest.Builder lifecycleDetail(RecommendationLifecycleDetail lifecycleDetail)

The field lifecycle state.

Only one state can be provided. Default value for state is active.

Parameters:

lifecycleDetail - the value to set

Returns:

this builder instance

limit

public ListRecommendationsRequest.Builder limit(Integer limit)

The maximum number of items to return

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListRecommendationsRequest.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 ListRecommendationsRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListRecommendationsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListRecommendationsRequest build()

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

Returns:

instance of ListRecommendationsRequest

buildWithoutInvocationCallback

public ListRecommendationsRequest buildWithoutInvocationCallback()

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