com.oracle.bmc.datasafe.requests

Class ListReportsRequest.Builder

java.lang.Object

com.oracle.bmc.datasafe.requests.ListReportsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListReportsRequest,Void>

Enclosing class:

ListReportsRequest

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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

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 ListReportsRequest.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 ListReportsRequest.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 ListReportsRequest.Builder accessLevel(ListReportsRequest.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 ListReportsRequest.Builder displayName(String displayName)

The name of the report definition to query.

Parameters:

displayName - the value to set

Returns:

this builder instance

limit

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

The field to sort by. Only one sort order may be provided. Default order for timeGenerated is descending. Default order for displayName is ascending. If no value is specified timeGenerated is default.

Parameters:

sortBy - the value to set

Returns:

this builder instance

reportDefinitionId

public ListReportsRequest.Builder reportDefinitionId(String reportDefinitionId)

The ID of the report definition to filter the list of reports

Parameters:

reportDefinitionId - the value to set

Returns:

this builder instance

opcRequestId

public ListReportsRequest.Builder opcRequestId(String opcRequestId)

Unique identifier for the request.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

lifecycleState

public ListReportsRequest.Builder lifecycleState(ReportLifecycleState lifecycleState)

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

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

type

public ListReportsRequest.Builder type(ReportType type)

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

Parameters:

type - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListReportsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListReportsRequest build()

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

Returns:

instance of ListReportsRequest

buildWithoutInvocationCallback

public ListReportsRequest buildWithoutInvocationCallback()

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