com.oracle.bmc.cloudguard.requests

Class ListManagedListsRequest.Builder

java.lang.Object

com.oracle.bmc.cloudguard.requests.ListManagedListsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListManagedListsRequest,Void>

Enclosing class:

ListManagedListsRequest

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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

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

The OCID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

displayName

public ListManagedListsRequest.Builder displayName(String displayName)

A filter to return only resources that match the entire display name given.

Parameters:

displayName - the value to set

Returns:

this builder instance

resourceMetadataOnly

public ListManagedListsRequest.Builder resourceMetadataOnly(Boolean resourceMetadataOnly)

Default is false. When set to true, the list of all Oracle-managed resources metadata supported by Cloud Guard is returned.

Parameters:

resourceMetadataOnly - the value to set

Returns:

this builder instance

lifecycleState

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

listType

public ListManagedListsRequest.Builder listType(ManagedListType listType)

The type of managed list.

Parameters:

listType - the value to set

Returns:

this builder instance

limit

public ListManagedListsRequest.Builder limit(Integer limit)

The maximum number of items to return

Parameters:

limit - the value to set

Returns:

this builder instance

page

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

compartmentIdInSubtree

public ListManagedListsRequest.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 ListManagedListsRequest.Builder accessLevel(ListManagedListsRequest.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

sortOrder

public ListManagedListsRequest.Builder sortOrder(SortOrders sortOrder)

The sort order to use

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListManagedListsRequest.Builder sortBy(ListManagedListsRequest.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

opcRequestId

public ListManagedListsRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListManagedListsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListManagedListsRequest build()

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

Returns:

instance of ListManagedListsRequest

buildWithoutInvocationCallback

public ListManagedListsRequest buildWithoutInvocationCallback()

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