com.oracle.bmc.datasafe.requests

Class ListReportsRequest

java.lang.Object

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

com.oracle.bmc.datasafe.requests.ListReportsRequest

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

Example: Click here to see how to use ListReportsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListReportsRequest.AccessLevel Valid values are RESTRICTED and ACCESSIBLE.
static class	ListReportsRequest.Builder
static class	ListReportsRequest.SortBy The field to sort by.
static class	ListReportsRequest.SortOrder The sort order to use, either ascending (ASC) or descending (DESC).

Constructor Summary

Constructors

Constructor and Description
ListReportsRequest()

Method Summary

Modifier and Type	Method and Description
static ListReportsRequest.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’.
ListReportsRequest.AccessLevel	getAccessLevel() Valid values are RESTRICTED and ACCESSIBLE.
String	getCompartmentId() A filter to return only resources that match the specified compartment OCID.
Boolean	getCompartmentIdInSubtree() Default is false.
String	getDisplayName() The name of the report definition to query.
ReportLifecycleState	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.
String	getReportDefinitionId() The ID of the report definition to filter the list of reports
ListReportsRequest.SortBy	getSortBy() The field to sort by.
ListReportsRequest.SortOrder	getSortOrder() The sort order to use, either ascending (ASC) or descending (DESC).
ReportType	getType() An optional filter to return only resources that match the specified type.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListReportsRequest.Builder	toBuilder() Return an instance of ListReportsRequest.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

ListReportsRequest

public ListReportsRequest()

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 ListReportsRequest.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 ListReportsRequest.SortOrder getSortOrder()

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

getSortBy

public ListReportsRequest.SortBy getSortBy()

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.

getReportDefinitionId

public String getReportDefinitionId()

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

getOpcRequestId

public String getOpcRequestId()

Unique identifier for the request.

getLifecycleState

public ReportLifecycleState getLifecycleState()

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

getType

public ReportType getType()

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

toBuilder

public ListReportsRequest.Builder toBuilder()

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

Returns:

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

builder

public static ListReportsRequest.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>