Package com.oracle.bmc.dashboardservice.requests

Class ListDashboardsRequest

java.lang.Object

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

com.oracle.bmc.dashboardservice.requests.ListDashboardsRequest

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

Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/dashboardservice/ListDashboardsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDashboardsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListDashboardsRequest.Builder
static class	ListDashboardsRequest.SortBy	The field to sort by.

Constructor Summary

Constructors

Constructor	Description
ListDashboardsRequest()

Method Summary

Modifier and Type	Method	Description
static ListDashboardsRequest.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’.
String	getDashboardGroupId()	The OCID of the dashboard group that the dashboard belongs to.
String	getDisplayName()	A case-sensitive filter that returns resources that match the entire display name specified.
String	getId()	The OCID of the dashboard.
Dashboard.LifecycleState	getLifecycleState()	A filter that returns dashboard resources that match the lifecycle state specified.
Integer	getLimit()	The maximum number of items to return.
String	getOpcCrossRegion()	To identify if the call is cross-regional.
String	getOpcRequestId()	Unique Oracle-assigned identifier for the request.
String	getPage()	The page token representing the page at which to start retrieving results.
ListDashboardsRequest.SortBy	getSortBy()	The field to sort by.
SortOrder	getSortOrder()	The sort order to use, either ascending (ASC) or descending (DESC).
int	hashCode()	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListDashboardsRequest.Builder	toBuilder()	Return an instance of ListDashboardsRequest.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

ListDashboardsRequest

public ListDashboardsRequest()

Method Detail

getDashboardGroupId

public String getDashboardGroupId()

The OCID of the dashboard group that the dashboard belongs to.

getLifecycleState

public Dashboard.LifecycleState getLifecycleState()

A filter that returns dashboard resources that match the lifecycle state specified.

getDisplayName

public String getDisplayName()

A case-sensitive filter that returns resources that match the entire display name specified.

getId

public String getId()

The OCID of the dashboard.

getLimit

public Integer getLimit()

The maximum number of items to return.

getPage

public String getPage()

The page token representing the page at which to start retrieving results.

This value is usually retrieved from a previous list call.

getSortOrder

public SortOrder getSortOrder()

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

getSortBy

public ListDashboardsRequest.SortBy getSortBy()

The field to sort by.

You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

getOpcRequestId

public String getOpcRequestId()

Unique Oracle-assigned identifier for the request.

If you need to contact Oracle about a particular request, please provide the request ID.

getOpcCrossRegion

public String getOpcCrossRegion()

To identify if the call is cross-regional.

In CRUD calls for a resource, to identify that the call originates from different region, set the CrossRegionIdentifierHeader parameter to a region name (ex - US-ASHBURN-1) The call will be served from a Replicated bucket. For same-region calls, the value is unassigned.

toBuilder

public ListDashboardsRequest.Builder toBuilder()

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

Returns:

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

builder

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