com.oracle.bmc.datasafe.requests

Class ListReportDefinitionsRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.datasafe.requests.ListReportDefinitionsRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public class ListReportDefinitionsRequest
extends BmcRequest<Void>

Example: Click here to see how to use ListReportDefinitionsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListReportDefinitionsRequest.AccessLevel Valid values are RESTRICTED and ACCESSIBLE.
static class	ListReportDefinitionsRequest.Builder
static class	ListReportDefinitionsRequest.Category An optional filter to return only resources that match the specified category.
static class	ListReportDefinitionsRequest.SortBy The field used for sorting.
static class	ListReportDefinitionsRequest.SortOrder The sort order to use, either ascending (ASC) or descending (DESC).

Constructor Summary

Constructors

Constructor and Description
ListReportDefinitionsRequest()

Method Summary

Modifier and Type	Method and Description
static ListReportDefinitionsRequest.Builder	builder() Return a new builder for this request object.
boolean	equals(Object o) Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
ListReportDefinitionsRequest.AccessLevel	getAccessLevel() Valid values are RESTRICTED and ACCESSIBLE.
ListReportDefinitionsRequest.Category	getCategory() An optional filter to return only resources that match the specified category.
String	getCompartmentId() A filter to return only resources that match the specified compartment OCID.
Boolean	getCompartmentIdInSubtree() Default is false.
ReportDefinitionDataSource	getDataSource() Specifies the name of a resource that provides data for the report.
String	getDisplayName() The name of the report definition to query.
Boolean	getIsSeeded() A boolean flag indicating to list seeded report definitions.
ReportDefinitionLifecycleState	getLifecycleState() An optional filter to return only resources that match the specified lifecycle state.
Integer	getLimit() For list pagination.
String	getOpcRequestId() Unique identifier for the request.
String	getPage() For list pagination.
ListReportDefinitionsRequest.SortBy	getSortBy() The field used for sorting.
ListReportDefinitionsRequest.SortOrder	getSortOrder() The sort order to use, either ascending (ASC) or descending (DESC).
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListReportDefinitionsRequest.Builder	toBuilder() Return an instance of ListReportDefinitionsRequest.Builder that allows you to modify request properties.
String	toString()

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListReportDefinitionsRequest

public ListReportDefinitionsRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

A filter to return only resources that match the specified compartment OCID.

getCompartmentIdInSubtree

public Boolean getCompartmentIdInSubtree()

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.

getAccessLevel

public ListReportDefinitionsRequest.AccessLevel getAccessLevel()

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.

getDisplayName

public String getDisplayName()

The name of the report definition to query.

getLimit

public Integer getLimit()

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.

getPage

public String getPage()

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.

getSortOrder

public ListReportDefinitionsRequest.SortOrder getSortOrder()

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

getSortBy

public ListReportDefinitionsRequest.SortBy getSortBy()

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.

getOpcRequestId

public String getOpcRequestId()

Unique identifier for the request.

getIsSeeded

public Boolean getIsSeeded()

A boolean flag indicating to list seeded report definitions. Set this parameter to get list of seeded report definitions.

getDataSource

public ReportDefinitionDataSource getDataSource()

Specifies the name of a resource that provides data for the report. For example alerts, events.

getLifecycleState

public ReportDefinitionLifecycleState getLifecycleState()

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

getCategory

public ListReportDefinitionsRequest.Category getCategory()

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

toBuilder

public ListReportDefinitionsRequest.Builder toBuilder()

Return an instance of ListReportDefinitionsRequest.Builder that allows you to modify request properties.

Returns:

instance of ListReportDefinitionsRequest.Builder that allows you to modify request properties.

builder

public static ListReportDefinitionsRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<Void>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>