Show / Hide Table of Contents

Class ListBudgetsRequest

Inheritance
object
ListBudgetsRequest
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.BudgetService.Requests
Assembly: OCI.DotNetSDK.Budget.dll
Syntax
public class ListBudgetsRequest : IOciRequest
Examples

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

Properties

CompartmentId

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

The ID 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 user-friendly name. This does not have to be unique, and it's changeable.
Example: My new resource

LifecycleState

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

The current state of the resource to filter by.

Limit

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

The maximum number of items to return.

OpcRequestId

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

The client request ID for tracing.

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 is usually retrieved from a previous list call.

SortBy

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

The field to sort by. If not specified, the default is timeCreated. The default sort order for timeCreated is DESC. The default sort order for displayName is ASC in alphanumeric order.

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

TargetType

Declaration
[HttpConverter(TargetEnum.Query, "targetType")]
public ListBudgetsRequest.TargetTypeEnum? TargetType { get; set; }
Property Value
Type Description
ListBudgetsRequest.TargetTypeEnum?

The type of target to filter by:

  • ALL - List all budgets
  • COMPARTMENT - List all budgets with targetType == "COMPARTMENT"
  • TAG - List all budgets with targetType == "TAG"

Implements

IOciRequest
In this article
Back to top