Package com.oracle.bmc.dashboardservice.requests

Class 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/3.63.0/dashboardservice/ListDashboardsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDashboardsRequest.

    • 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.

      • builder

        public static ListDashboardsRequest.Builder builder()
        Return a new builder for this request object.
        Returns:
        builder for the request 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>