Show / Hide Table of Contents

Class ListDashboardGroupsRequest

Inheritance
object
ListDashboardGroupsRequest
Implements
IOciRequest
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.DashboardService.Requests
Assembly: OCI.DotNetSDK.Dashboardservice.dll
Syntax
public class ListDashboardGroupsRequest : IOciRequest
Examples

Click here to see an example of how to use ListDashboardGroups request.

Properties

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment in which to list resources.

Remarks

Required

DisplayName

Declaration
[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

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

Id

Declaration
[HttpConverter(TargetEnum.Query, "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of the dashboard group.

LifecycleState

Declaration
[HttpConverter(TargetEnum.Query, "lifecycleState")]
public DashboardGroup.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
DashboardGroup.LifecycleStateEnum?

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

Limit

Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }
Property Value
Type Description
int?

The maximum number of items to return.

OpcCrossRegion

Declaration
[HttpConverter(TargetEnum.Header, "opc-cross-region")]
public string OpcCrossRegion { get; set; }
Property Value
Type Description
string

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.

OpcRequestId

Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }
Property Value
Type Description
string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Page

Declaration
[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }
Property Value
Type Description
string

The page token representing the page at which to start retrieving results. This value is usually retrieved from a previous list call.

SortBy

Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListDashboardGroupsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type Description
ListDashboardGroupsRequest.SortByEnum?

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.

SortOrder

Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public SortOrder? SortOrder { get; set; }
Property Value
Type Description
SortOrder?

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

Implements

IOciRequest
In this article
Back to top