Package com.oracle.bmc.cloudguard.requests

Class ListTargetsRequest.Builder

java.lang.Object

com.oracle.bmc.cloudguard.requests.ListTargetsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListTargetsRequest,Void>

Enclosing class:

ListTargetsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

isNonSecurityZoneTargetsOnlyQuery

public ListTargetsRequest.Builder isNonSecurityZoneTargetsOnlyQuery(Boolean isNonSecurityZoneTargetsOnlyQuery)

Default is false.

When set to true, only the targets that would be deleted as part of security zone creation will be returned.

Parameters:

isNonSecurityZoneTargetsOnlyQuery - the value to set

Returns:

this builder instance

lifecycleState

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

compartmentIdInSubtree

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

limit

public ListTargetsRequest.Builder limit(Integer limit)

The maximum number of items to return

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListTargetsRequest.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 ListTargetsRequest.Builder sortOrder(SortOrders sortOrder)

The sort order to use

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

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

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListTargetsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListTargetsRequest build()

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

Returns:

instance of ListTargetsRequest

buildWithoutInvocationCallback

public ListTargetsRequest buildWithoutInvocationCallback()

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