Package com.oracle.bmc.datasafe.requests

Class ListSecurityPoliciesRequest.Builder

java.lang.Object

com.oracle.bmc.datasafe.requests.ListSecurityPoliciesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListSecurityPoliciesRequest,Void>

Enclosing class:

ListSecurityPoliciesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListSecurityPoliciesRequest.Builder	accessLevel(ListSecurityPoliciesRequest.AccessLevel accessLevel)	Valid values are RESTRICTED and ACCESSIBLE.
ListSecurityPoliciesRequest	build()	Build the instance of ListSecurityPoliciesRequest as configured by this builder
ListSecurityPoliciesRequest	buildWithoutInvocationCallback()	Build the instance of ListSecurityPoliciesRequest as configured by this builder
ListSecurityPoliciesRequest.Builder	compartmentId(String compartmentId)	A filter to return only resources that match the specified compartment OCID.
ListSecurityPoliciesRequest.Builder	compartmentIdInSubtree(Boolean compartmentIdInSubtree)	Default is false.
ListSecurityPoliciesRequest.Builder	copy(ListSecurityPoliciesRequest o)	Copy method to populate the builder with values from the given instance.
ListSecurityPoliciesRequest.Builder	displayName(String displayName)	A filter to return only resources that match the specified display name.
ListSecurityPoliciesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListSecurityPoliciesRequest.Builder	lifecycleState(SecurityPolicyLifecycleState lifecycleState)	The current state of the security policy.
ListSecurityPoliciesRequest.Builder	limit(Integer limit)	For list pagination.
ListSecurityPoliciesRequest.Builder	opcRequestId(String opcRequestId)	Unique identifier for the request.
ListSecurityPoliciesRequest.Builder	page(String page)	For list pagination.
ListSecurityPoliciesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListSecurityPoliciesRequest.Builder	securityPolicyId(String securityPolicyId)	An optional filter to return only resources that match the specified OCID of the security policy resource.
ListSecurityPoliciesRequest.Builder	sortBy(ListSecurityPoliciesRequest.SortBy sortBy)	The field used for sorting.
ListSecurityPoliciesRequest.Builder	sortOrder(ListSecurityPoliciesRequest.SortOrder sortOrder)	The sort order to use, either ascending (ASC) or descending (DESC).

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

A filter to return only resources that match the specified compartment OCID.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

compartmentIdInSubtree

public ListSecurityPoliciesRequest.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. Depends on the ‘accessLevel’ setting.

Parameters:

compartmentIdInSubtree - the value to set

Returns:

this builder instance

accessLevel

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

displayName

public ListSecurityPoliciesRequest.Builder displayName(String displayName)

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

Parameters:

displayName - the value to set

Returns:

this builder instance

limit

public ListSecurityPoliciesRequest.Builder limit(Integer limit)

For list pagination.

The maximum number of items to return per page in a paginated “List” call. For details about how pagination works, see List Pagination.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListSecurityPoliciesRequest.Builder page(String page)

For list pagination.

The page token representing the page at which to start retrieving results. It is usually retrieved from a previous “List” call. For details about how pagination works, see List Pagination.

Parameters:

page - the value to set

Returns:

this builder instance

lifecycleState

public ListSecurityPoliciesRequest.Builder lifecycleState(SecurityPolicyLifecycleState lifecycleState)

The current state of the security policy.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

securityPolicyId

public ListSecurityPoliciesRequest.Builder securityPolicyId(String securityPolicyId)

An optional filter to return only resources that match the specified OCID of the security policy resource.

Parameters:

securityPolicyId - the value to set

Returns:

this builder instance

sortOrder

public ListSecurityPoliciesRequest.Builder sortOrder(ListSecurityPoliciesRequest.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 ListSecurityPoliciesRequest.Builder sortBy(ListSecurityPoliciesRequest.SortBy sortBy)

The field used for sorting.

Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListSecurityPoliciesRequest.Builder opcRequestId(String opcRequestId)

Unique identifier for the request.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListSecurityPoliciesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListSecurityPoliciesRequest build()

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

Returns:

instance of ListSecurityPoliciesRequest

buildWithoutInvocationCallback

public ListSecurityPoliciesRequest buildWithoutInvocationCallback()

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