public static class ListReportDefinitionsRequest.Builder extends Object implements BmcRequest.Builder<ListReportDefinitionsRequest,Void>
Constructor and Description |
---|
Builder() |
Modifier and Type | Method and 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).
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
body$
public ListReportDefinitionsRequest.Builder compartmentId(String compartmentId)
A filter to return only resources that match the specified compartment OCID.
compartmentId
- the value to setpublic 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.
compartmentIdInSubtree
- the value to setpublic 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.
accessLevel
- the value to setpublic ListReportDefinitionsRequest.Builder displayName(String displayName)
The name of the report definition to query.
displayName
- the value to setpublic 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.
limit
- the value to setpublic 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.
page
- the value to setpublic ListReportDefinitionsRequest.Builder sortOrder(ListReportDefinitionsRequest.SortOrder sortOrder)
The sort order to use, either ascending (ASC) or descending (DESC).
sortOrder
- the value to setpublic 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.
sortBy
- the value to setpublic ListReportDefinitionsRequest.Builder opcRequestId(String opcRequestId)
Unique identifier for the request.
opcRequestId
- the value to setpublic ListReportDefinitionsRequest.Builder isSeeded(Boolean isSeeded)
A boolean flag indicating to list seeded report definitions. Set this parameter to get list of seeded report definitions.
isSeeded
- the value to setpublic ListReportDefinitionsRequest.Builder dataSource(ReportDefinitionDataSource dataSource)
Specifies the name of a resource that provides data for the report. For example alerts, events.
dataSource
- the value to setpublic ListReportDefinitionsRequest.Builder lifecycleState(ReportDefinitionLifecycleState lifecycleState)
An optional filter to return only resources that match the specified lifecycle state.
lifecycleState
- the value to setpublic ListReportDefinitionsRequest.Builder category(ListReportDefinitionsRequest.Category category)
An optional filter to return only resources that match the specified category.
category
- the value to setpublic ListReportDefinitionsRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.
invocationCallback
- the invocation callback to be set for the requestpublic ListReportDefinitionsRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.
retryConfiguration
- the retry configuration to be used for the requestpublic ListReportDefinitionsRequest.Builder copy(ListReportDefinitionsRequest o)
Copy method to populate the builder with values from the given instance.
copy
in interface BmcRequest.Builder<ListReportDefinitionsRequest,Void>
o
- other request from which to copy valuespublic 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.
build
in interface BmcRequest.Builder<ListReportDefinitionsRequest,Void>
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
Copyright © 2016–2024. All rights reserved.