Package com.oracle.bmc.datasafe.requests

Class ListReportDefinitionsRequest.Builder

java.lang.Object

com.oracle.bmc.datasafe.requests.ListReportDefinitionsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListReportDefinitionsRequest,Void>

Enclosing class:

ListReportDefinitionsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListReportDefinitionsRequest.Builder	accessLevel(ListReportDefinitionsRequest.AccessLevel accessLevel)	Valid values are RESTRICTED and ACCESSIBLE.
ListReportDefinitionsRequest	build()	Build the instance of ListReportDefinitionsRequest as configured by this builder
ListReportDefinitionsRequest	buildWithoutInvocationCallback()	Build the instance of ListReportDefinitionsRequest as configured by this builder
ListReportDefinitionsRequest.Builder	category(ListReportDefinitionsRequest.Category category)	An optional filter to return only resources that match the specified category.
ListReportDefinitionsRequest.Builder	compartmentId(String compartmentId)	A filter to return only resources that match the specified compartment OCID.
ListReportDefinitionsRequest.Builder	compartmentIdInSubtree(Boolean compartmentIdInSubtree)	Default is false.
ListReportDefinitionsRequest.Builder	copy(ListReportDefinitionsRequest o)	Copy method to populate the builder with values from the given instance.
ListReportDefinitionsRequest.Builder	dataSource(ReportDefinitionDataSource dataSource)	Specifies the name of a resource that provides data for the report.
ListReportDefinitionsRequest.Builder	displayName(String displayName)	The name of the report definition to query.
ListReportDefinitionsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListReportDefinitionsRequest.Builder	isSeeded(Boolean isSeeded)	A boolean flag indicating to list seeded report definitions.
ListReportDefinitionsRequest.Builder	lifecycleState(ReportDefinitionLifecycleState lifecycleState)	An optional filter to return only resources that match the specified lifecycle state.
ListReportDefinitionsRequest.Builder	limit(Integer limit)	For list pagination.
ListReportDefinitionsRequest.Builder	opcRequestId(String opcRequestId)	Unique identifier for the request.
ListReportDefinitionsRequest.Builder	page(String page)	For list pagination.
ListReportDefinitionsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListReportDefinitionsRequest.Builder	sortBy(ListReportDefinitionsRequest.SortBy sortBy)	The field used for sorting.
ListReportDefinitionsRequest.Builder	sortOrder(ListReportDefinitionsRequest.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 ListReportDefinitionsRequest.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 ListReportDefinitionsRequest.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 ListReportDefinitionsRequest.Builder accessLevel(ListReportDefinitionsRequest.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 ListReportDefinitionsRequest.Builder displayName(String displayName)

The name of the report definition to query.

Parameters:

displayName - the value to set

Returns:

this builder instance

limit

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

sortOrder

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

The field used for sorting.

Only one sorting parameter 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 ListReportDefinitionsRequest.Builder opcRequestId(String opcRequestId)

Unique identifier for the request.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

isSeeded

public ListReportDefinitionsRequest.Builder isSeeded(Boolean isSeeded)

A boolean flag indicating to list seeded report definitions.

Set this parameter to get list of seeded report definitions.

Parameters:

isSeeded - the value to set

Returns:

this builder instance

dataSource

public ListReportDefinitionsRequest.Builder dataSource(ReportDefinitionDataSource dataSource)

Specifies the name of a resource that provides data for the report.

For example alerts, events.

Parameters:

dataSource - the value to set

Returns:

this builder instance

lifecycleState

public ListReportDefinitionsRequest.Builder lifecycleState(ReportDefinitionLifecycleState lifecycleState)

An optional filter to return only resources that match the specified lifecycle state.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

category

public ListReportDefinitionsRequest.Builder category(ListReportDefinitionsRequest.Category category)

An optional filter to return only resources that match the specified category.

Parameters:

category - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListReportDefinitionsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListReportDefinitionsRequest build()

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

Returns:

instance of ListReportDefinitionsRequest

buildWithoutInvocationCallback

public ListReportDefinitionsRequest buildWithoutInvocationCallback()

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