Package com.oracle.bmc.datasafe.requests

Class ListProfileAnalyticsRequest.Builder

java.lang.Object

com.oracle.bmc.datasafe.requests.ListProfileAnalyticsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListProfileAnalyticsRequest,Void>

Enclosing class:

ListProfileAnalyticsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListProfileAnalyticsRequest.Builder	accessLevel(ListProfileAnalyticsRequest.AccessLevel accessLevel)	Valid values are RESTRICTED and ACCESSIBLE.
ListProfileAnalyticsRequest	build()	Build the instance of ListProfileAnalyticsRequest as configured by this builder
ListProfileAnalyticsRequest	buildWithoutInvocationCallback()	Build the instance of ListProfileAnalyticsRequest as configured by this builder
ListProfileAnalyticsRequest.Builder	compartmentId(String compartmentId)	A filter to return only resources that match the specified compartment OCID.
ListProfileAnalyticsRequest.Builder	compartmentIdInSubtree(Boolean compartmentIdInSubtree)	Default is false.
ListProfileAnalyticsRequest.Builder	copy(ListProfileAnalyticsRequest o)	Copy method to populate the builder with values from the given instance.
ListProfileAnalyticsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListProfileAnalyticsRequest.Builder	limit(Integer limit)	For list pagination.
ListProfileAnalyticsRequest.Builder	opcRequestId(String opcRequestId)	Unique identifier for the request.
ListProfileAnalyticsRequest.Builder	page(String page)	For list pagination.
ListProfileAnalyticsRequest.Builder	profileName(String profileName)	A filter to return only items that match the specified profile name.
ListProfileAnalyticsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListProfileAnalyticsRequest.Builder	sortBy(ListProfileAnalyticsRequest.SortBy sortBy)	The field used for sorting.
ListProfileAnalyticsRequest.Builder	sortOrder(ListProfileAnalyticsRequest.SortOrder sortOrder)	The sort order to use, either ascending (ASC) or descending (DESC).
ListProfileAnalyticsRequest.Builder	targetId(String targetId)	A filter to return only items related to a specific target OCID.
ListProfileAnalyticsRequest.Builder	userAssessmentId(String userAssessmentId)	The OCID of the user assessment.

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

userAssessmentId

public ListProfileAnalyticsRequest.Builder userAssessmentId(String userAssessmentId)

The OCID of the user assessment.

Parameters:

userAssessmentId - the value to set

Returns:

this builder instance

compartmentId

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

targetId

public ListProfileAnalyticsRequest.Builder targetId(String targetId)

A filter to return only items related to a specific target OCID.

Parameters:

targetId - the value to set

Returns:

this builder instance

limit

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

profileName

public ListProfileAnalyticsRequest.Builder profileName(String profileName)

A filter to return only items that match the specified profile name.

Parameters:

profileName - the value to set

Returns:

this builder instance

sortBy

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

sortOrder

public ListProfileAnalyticsRequest.Builder sortOrder(ListProfileAnalyticsRequest.SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

opcRequestId

public ListProfileAnalyticsRequest.Builder opcRequestId(String opcRequestId)

Unique identifier for the request.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListProfileAnalyticsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListProfileAnalyticsRequest build()

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

Returns:

instance of ListProfileAnalyticsRequest

buildWithoutInvocationCallback

public ListProfileAnalyticsRequest buildWithoutInvocationCallback()

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