Package com.oracle.bmc.datasafe.requests

Class ListRegistrationPoliciesRequest.Builder

java.lang.Object

com.oracle.bmc.datasafe.requests.ListRegistrationPoliciesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListRegistrationPoliciesRequest,Void>

Enclosing class:

ListRegistrationPoliciesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListRegistrationPoliciesRequest.Builder	accessLevel(ListRegistrationPoliciesRequest.AccessLevel accessLevel)	Valid values are RESTRICTED and ACCESSIBLE.
ListRegistrationPoliciesRequest	build()	Build the instance of ListRegistrationPoliciesRequest as configured by this builder
ListRegistrationPoliciesRequest	buildWithoutInvocationCallback()	Build the instance of ListRegistrationPoliciesRequest as configured by this builder
ListRegistrationPoliciesRequest.Builder	compartmentId(String compartmentId)	A filter to return only resources that match the specified compartment OCID.
ListRegistrationPoliciesRequest.Builder	compartmentIdInSubtree(Boolean compartmentIdInSubtree)	Default is false.
ListRegistrationPoliciesRequest.Builder	connectionId(String connectionId)	Filter to return the registration policies matching the specified connection ID.
ListRegistrationPoliciesRequest.Builder	connectionType(PolicyConnectionOption.ConnectionType connectionType)	Filter to return the registration policies matching the specified connectionType i.e ONPREM_CONNECTOR or PRIVATE_ENDPOINT.
ListRegistrationPoliciesRequest.Builder	copy(ListRegistrationPoliciesRequest o)	Copy method to populate the builder with values from the given instance.
ListRegistrationPoliciesRequest.Builder	displayName(String displayName)	A filter to return only resources that match the specified display name.
ListRegistrationPoliciesRequest.Builder	enablementLevel(RegistrationPolicy.EnablementLevel enablementLevel)	Filter registration policies by resource type.
ListRegistrationPoliciesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListRegistrationPoliciesRequest.Builder	lifecycleState(RegistrationPolicy.LifecycleState lifecycleState)	Filter registration policies by their lifecycle state.
ListRegistrationPoliciesRequest.Builder	limit(Integer limit)	For list pagination.
ListRegistrationPoliciesRequest.Builder	opcRequestId(String opcRequestId)	Unique identifier for the request.
ListRegistrationPoliciesRequest.Builder	page(String page)	For list pagination.
ListRegistrationPoliciesRequest.Builder	registrationPolicyId(String registrationPolicyId)	Filter to return the registration policy matching the specified OCID.
ListRegistrationPoliciesRequest.Builder	resourceId(String resourceId)	Filter to return the registration policy matching the specified resource OCID.
ListRegistrationPoliciesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListRegistrationPoliciesRequest.Builder	sortBy(ListRegistrationPoliciesRequest.SortBy sortBy)	Field to sort the registration policies by.
ListRegistrationPoliciesRequest.Builder	sortOrder(ListRegistrationPoliciesRequest.SortOrder sortOrder)	The sort order to use, either ascending (ASC) or descending (DESC).
ListRegistrationPoliciesRequest.Builder	timeCreatedGreaterThanOrEqualTo(Date timeCreatedGreaterThanOrEqualTo)	A filter to return only the resources that were created after the specified date and time, as defined by RFC3339.
ListRegistrationPoliciesRequest.Builder	timeCreatedLessThan(Date timeCreatedLessThan)	Search for resources that were created before a specific date.

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 ListRegistrationPoliciesRequest.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

displayName

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

sortBy

public ListRegistrationPoliciesRequest.Builder sortBy(ListRegistrationPoliciesRequest.SortBy sortBy)

Field to sort the registration policies by.

Only one sort order (sortOrder) can be specified. Defaults to sorting by timeCreated in descending order

Parameters:

sortBy - the value to set

Returns:

this builder instance

lifecycleState

public ListRegistrationPoliciesRequest.Builder lifecycleState(RegistrationPolicy.LifecycleState lifecycleState)

Filter registration policies by their lifecycle state.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

enablementLevel

public ListRegistrationPoliciesRequest.Builder enablementLevel(RegistrationPolicy.EnablementLevel enablementLevel)

Filter registration policies by resource type.

Parameters:

enablementLevel - the value to set

Returns:

this builder instance

resourceId

public ListRegistrationPoliciesRequest.Builder resourceId(String resourceId)

Filter to return the registration policy matching the specified resource OCID.

Parameters:

resourceId - the value to set

Returns:

this builder instance

compartmentIdInSubtree

public ListRegistrationPoliciesRequest.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 ListRegistrationPoliciesRequest.Builder accessLevel(ListRegistrationPoliciesRequest.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 ListRegistrationPoliciesRequest.Builder sortOrder(ListRegistrationPoliciesRequest.SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

timeCreatedGreaterThanOrEqualTo

public ListRegistrationPoliciesRequest.Builder timeCreatedGreaterThanOrEqualTo(Date timeCreatedGreaterThanOrEqualTo)

A filter to return only the resources that were created after the specified date and time, as defined by RFC3339.

Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

*Example:** 2016-12-19T16:39:57.600Z

Parameters:

timeCreatedGreaterThanOrEqualTo - the value to set

Returns:

this builder instance

timeCreatedLessThan

public ListRegistrationPoliciesRequest.Builder timeCreatedLessThan(Date timeCreatedLessThan)

Search for resources that were created before a specific date.

Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in “YYYY-MM-ddThh:mmZ” format with a Z offset, as defined by RFC 3339.

*Example:** 2016-12-19T16:39:57.600Z

Parameters:

timeCreatedLessThan - the value to set

Returns:

this builder instance

opcRequestId

public ListRegistrationPoliciesRequest.Builder opcRequestId(String opcRequestId)

Unique identifier for the request.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

limit

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

registrationPolicyId

public ListRegistrationPoliciesRequest.Builder registrationPolicyId(String registrationPolicyId)

Filter to return the registration policy matching the specified OCID.

Parameters:

registrationPolicyId - the value to set

Returns:

this builder instance

connectionType

public ListRegistrationPoliciesRequest.Builder connectionType(PolicyConnectionOption.ConnectionType connectionType)

Filter to return the registration policies matching the specified connectionType i.e ONPREM_CONNECTOR or PRIVATE_ENDPOINT.

Parameters:

connectionType - the value to set

Returns:

this builder instance

connectionId

public ListRegistrationPoliciesRequest.Builder connectionId(String connectionId)

Filter to return the registration policies matching the specified connection ID.

Parameters:

connectionId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListRegistrationPoliciesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListRegistrationPoliciesRequest build()

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

Returns:

instance of ListRegistrationPoliciesRequest

buildWithoutInvocationCallback

public ListRegistrationPoliciesRequest buildWithoutInvocationCallback()

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