Package com.oracle.bmc.dashboardservice.requests

Class ListDashboardsRequest.Builder

java.lang.Object

com.oracle.bmc.dashboardservice.requests.ListDashboardsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListDashboardsRequest,Void>

Enclosing class:

ListDashboardsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListDashboardsRequest	build()	Build the instance of ListDashboardsRequest as configured by this builder
ListDashboardsRequest	buildWithoutInvocationCallback()	Build the instance of ListDashboardsRequest as configured by this builder
ListDashboardsRequest.Builder	copy(ListDashboardsRequest o)	Copy method to populate the builder with values from the given instance.
ListDashboardsRequest.Builder	dashboardGroupId(String dashboardGroupId)	The OCID of the dashboard group that the dashboard belongs to.
ListDashboardsRequest.Builder	displayName(String displayName)	A case-sensitive filter that returns resources that match the entire display name specified.
ListDashboardsRequest.Builder	id(String id)	The OCID of the dashboard.
ListDashboardsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListDashboardsRequest.Builder	lifecycleState(Dashboard.LifecycleState lifecycleState)	A filter that returns dashboard resources that match the lifecycle state specified.
ListDashboardsRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListDashboardsRequest.Builder	opcCrossRegion(String opcCrossRegion)	To identify if the call is cross-regional.
ListDashboardsRequest.Builder	opcRequestId(String opcRequestId)	Unique Oracle-assigned identifier for the request.
ListDashboardsRequest.Builder	page(String page)	The page token representing the page at which to start retrieving results.
ListDashboardsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListDashboardsRequest.Builder	sortBy(ListDashboardsRequest.SortBy sortBy)	The field to sort by.
ListDashboardsRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order to use, either ascending (ASC) or descending (DESC).

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

dashboardGroupId

public ListDashboardsRequest.Builder dashboardGroupId(String dashboardGroupId)

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

Parameters:

dashboardGroupId - the value to set

Returns:

this builder instance

lifecycleState

public ListDashboardsRequest.Builder lifecycleState(Dashboard.LifecycleState lifecycleState)

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

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

displayName

public ListDashboardsRequest.Builder displayName(String displayName)

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

Parameters:

displayName - the value to set

Returns:

this builder instance

id

public ListDashboardsRequest.Builder id(String id)

The OCID of the dashboard.

Parameters:

id - the value to set

Returns:

this builder instance

limit

public ListDashboardsRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListDashboardsRequest.Builder page(String page)

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

This value is usually retrieved from a previous list call.

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

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

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.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListDashboardsRequest.Builder opcRequestId(String opcRequestId)

Unique Oracle-assigned identifier for the request.

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

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

opcCrossRegion

public ListDashboardsRequest.Builder opcCrossRegion(String opcCrossRegion)

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.

Parameters:

opcCrossRegion - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListDashboardsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListDashboardsRequest build()

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

Returns:

instance of ListDashboardsRequest

buildWithoutInvocationCallback

public ListDashboardsRequest buildWithoutInvocationCallback()

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