Class ListOccOverviewsRequest
Implements
Inherited Members
Namespace: Oci.CapacitymanagementService.Requests
Assembly: OCI.DotNetSDK.Capacitymanagement.dll
Syntax
public class ListOccOverviewsRequest : IOciRequest
Examples
Click here to see an example of how to use ListOccOverviews 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 or tenancy in which resources are to be listed. This will also be used for authorization purposes. |
Remarks
Required
From
Declaration
[HttpConverter(TargetEnum.Query, "from")]
public DateTime? From { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The month corresponding to this date would be considered as the starting point of the time period against which we would like to perform an aggregation. |
Limit
Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }
Property Value
Type | Description |
---|---|
int? | The maximum number of items to return. |
Namespace
Declaration
[Required(ErrorMessage = "Namespace is required.")]
[HttpConverter(TargetEnum.Path, "namespace")]
public Namespace? Namespace { get; set; }
Property Value
Type | Description |
---|---|
Namespace? | The namespace by which we would filter the list. |
Remarks
Required
OpcRequestId
Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }
Property Value
Type | Description |
---|---|
string | The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash. |
Page
Declaration
[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }
Property Value
Type | Description |
---|---|
string | A token representing the position at which to start retrieving results. This must come from |
SortBy
Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListOccOverviewsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListOccOverviewsRequest.SortByEnum? | The field to sort by. Only one sort order may be provided. The default order for periodValue is chronological order(latest month item at the end). |
SortOrder
Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public SortOrder? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
SortOrder? | The sort order to use, either 'ASC' or 'DESC'. |
To
Declaration
[HttpConverter(TargetEnum.Query, "to")]
public DateTime? To { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The month corresponding to this date would be considered as the ending point of the time period against which we would like to perform an aggregation. |
WorkloadType
Declaration
[HttpConverter(TargetEnum.Query, "workloadType")]
public string WorkloadType { get; set; }
Property Value
Type | Description |
---|---|
string | Workload type using the resources in an availability catalog can be filtered. |