Class ListCommitmentsRequest

Inheritance

object

ListCommitmentsRequest

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.OsubsubscriptionService.Requests

Assembly: OCI.DotNetSDK.Osubsubscription.dll

Syntax

public class ListCommitmentsRequest : IOciRequest

Examples

Click here to see an example of how to use ListCommitments 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.

Remarks

Required

Limit

Declaration

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

Property Value

Type	Description
int?	The maximum number of items to return in a paginated "List" call. Default: (50) Example: 500

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 value of the opc-next-page response header from the previous "List" call.

SortBy

Declaration

[HttpConverter(TargetEnum.Query, "sortBy")]
public ListCommitmentsRequest.SortByEnum? SortBy { get; set; }

Property Value

Type	Description
ListCommitmentsRequest.SortByEnum?	The field to sort by. You can provide one sort order (sortOrder).

SortOrder

Declaration

[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListCommitmentsRequest.SortOrderEnum? SortOrder { get; set; }

Property Value

Type	Description
ListCommitmentsRequest.SortOrderEnum?	The sort order to use, either ascending (ASC) or descending (DESC).

SubscribedServiceId

Declaration

[Required(ErrorMessage = "SubscribedServiceId is required.")]
[HttpConverter(TargetEnum.Query, "subscribedServiceId")]
public string SubscribedServiceId { get; set; }

Property Value

Type	Description
string	This param is used to get the commitments for a particular subscribed service

Remarks

Required

XOneGatewaySubscriptionId

Declaration

[HttpConverter(TargetEnum.Header, "x-one-gateway-subscription-id")]
public string XOneGatewaySubscriptionId { get; set; }

Property Value

Type	Description
string	This header is meant to be used only for internal purposes and will be ignored on any public request. The purpose of this header is to help on Gateway to API calls identification.

XOneOriginRegion

Declaration

[HttpConverter(TargetEnum.Header, "x-one-origin-region")]
public string XOneOriginRegion { get; set; }

Property Value

Type	Description
string	The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.

Implements

IOciRequest