Class ListInternalOccHandoverResourceBlocksRequest
Implements
Inherited Members
Namespace: Oci.CapacitymanagementService.Requests
Assembly: OCI.DotNetSDK.Capacitymanagement.dll
Syntax
public class ListInternalOccHandoverResourceBlocksRequest : IOciRequest
Examples
Click here to see an example of how to use ListInternalOccHandoverResourceBlocks 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
HandoverDateGreaterThanOrEqualTo
Declaration
[HttpConverter(TargetEnum.Query, "handoverDateGreaterThanOrEqualTo")]
public DateTime? HandoverDateGreaterThanOrEqualTo { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | This filter helps in fetching all handed over resources for which the recordDate is greater than or equal to the startDate. |
HandoverDateLessThanOrEqualTo
Declaration
[HttpConverter(TargetEnum.Query, "handoverDateLessThanOrEqualTo")]
public DateTime? HandoverDateLessThanOrEqualTo { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | This filter helps in fetching all handed over resources for which the recordDate is less than or equal to the endDate. |
HandoverResourceName
Declaration
[HttpConverter(TargetEnum.Query, "handoverResourceName")]
public string HandoverResourceName { get; set; }
Property Value
Type | Description |
---|---|
string | A filter to return only the list of resources that match the name provided in this filter. |
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.Query, "namespace")]
public Namespace? Namespace { get; set; }
Property Value
Type | Description |
---|---|
Namespace? | The namespace enum value that needs to be passed as a required query parameter. |
Remarks
Required
OccCustomerGroupId
Declaration
[Required(ErrorMessage = "OccCustomerGroupId is required.")]
[HttpConverter(TargetEnum.Query, "occCustomerGroupId")]
public string OccCustomerGroupId { get; set; }
Property Value
Type | Description |
---|---|
string | The customer group ocid by which we would filter the list. |
Remarks
Required
OccHandoverResourceBlockId
Declaration
[HttpConverter(TargetEnum.Query, "occHandoverResourceBlockId")]
public string OccHandoverResourceBlockId { get; set; }
Property Value
Type | Description |
---|---|
string | This filter helps in fetching the handed over resource for which the occHandoverResourceId is equal to the one provided here. |
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 ListInternalOccHandoverResourceBlocksRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListInternalOccHandoverResourceBlocksRequest.SortByEnum? | The field to sort by. Only one sort order may be provided. The default order for handoverDate is chronological order(latest date 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'. |