Class CapacityManagementClient
Service client instance for CapacityManagement.
Implements
Inherited Members
Namespace: Oci.CapacitymanagementService
Assembly: OCI.DotNetSDK.Capacitymanagement.dll
Syntax
public class CapacityManagementClient : RegionalClientBase, IDisposable
Constructors
CapacityManagementClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public CapacityManagementClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Properties
Paginators
Declaration
public CapacityManagementPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
CapacityManagementPaginators |
Waiters
Declaration
public CapacityManagementWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
CapacityManagementWaiters |
Methods
CreateOccAvailabilityCatalog(CreateOccAvailabilityCatalogRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Create availability catalog
Declaration
public Task<CreateOccAvailabilityCatalogResponse> CreateOccAvailabilityCatalog(CreateOccAvailabilityCatalogRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateOccAvailabilityCatalogRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateOccAvailabilityCatalogResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateOccAvailabilityCatalog API.
CreateOccCapacityRequest(CreateOccCapacityRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Create Capacity Request.
Declaration
public Task<CreateOccCapacityRequestResponse> CreateOccCapacityRequest(CreateOccCapacityRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateOccCapacityRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateOccCapacityRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateOccCapacityRequest API.
CreateOccCustomer(CreateOccCustomerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Create customer.
Declaration
public Task<CreateOccCustomerResponse> CreateOccCustomer(CreateOccCustomerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateOccCustomerRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateOccCustomerResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateOccCustomer API.
CreateOccCustomerGroup(CreateOccCustomerGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Create customer group.
Declaration
public Task<CreateOccCustomerGroupResponse> CreateOccCustomerGroup(CreateOccCustomerGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateOccCustomerGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateOccCustomerGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateOccCustomerGroup API.
DeleteOccAvailabilityCatalog(DeleteOccAvailabilityCatalogRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the availability catalog resource.
Declaration
public Task<DeleteOccAvailabilityCatalogResponse> DeleteOccAvailabilityCatalog(DeleteOccAvailabilityCatalogRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteOccAvailabilityCatalogRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteOccAvailabilityCatalogResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteOccAvailabilityCatalog API.
DeleteOccCapacityRequest(DeleteOccCapacityRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the capacity request resource.
Declaration
public Task<DeleteOccCapacityRequestResponse> DeleteOccCapacityRequest(DeleteOccCapacityRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteOccCapacityRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteOccCapacityRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteOccCapacityRequest API.
DeleteOccCustomer(DeleteOccCustomerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the customer resource.
Declaration
public Task<DeleteOccCustomerResponse> DeleteOccCustomer(DeleteOccCustomerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteOccCustomerRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteOccCustomerResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteOccCustomer API.
DeleteOccCustomerGroup(DeleteOccCustomerGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the customer group resource.
Declaration
public Task<DeleteOccCustomerGroupResponse> DeleteOccCustomerGroup(DeleteOccCustomerGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteOccCustomerGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteOccCustomerGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteOccCustomerGroup API.
GetOccAvailabilityCatalog(GetOccAvailabilityCatalogRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Get details about availability catalog.
Declaration
public Task<GetOccAvailabilityCatalogResponse> GetOccAvailabilityCatalog(GetOccAvailabilityCatalogRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetOccAvailabilityCatalogRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetOccAvailabilityCatalogResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetOccAvailabilityCatalog API.
GetOccAvailabilityCatalogContent(GetOccAvailabilityCatalogContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the binary contents of the availability catalog. Can be saved as a csv file.
Declaration
public Task<GetOccAvailabilityCatalogContentResponse> GetOccAvailabilityCatalogContent(GetOccAvailabilityCatalogContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetOccAvailabilityCatalogContentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetOccAvailabilityCatalogContentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetOccAvailabilityCatalogContent API.
GetOccCapacityRequest(GetOccCapacityRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Get details about the capacity request.
Declaration
public Task<GetOccCapacityRequestResponse> GetOccCapacityRequest(GetOccCapacityRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetOccCapacityRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetOccCapacityRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetOccCapacityRequest API.
GetOccCustomerGroup(GetOccCustomerGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets information about the specified customer group.
Declaration
public Task<GetOccCustomerGroupResponse> GetOccCustomerGroup(GetOccCustomerGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetOccCustomerGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetOccCustomerGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetOccCustomerGroup API.
ListInternalNamespaceOccOverviews(ListInternalNamespaceOccOverviewsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists an overview of all resources in that namespace in a given time interval.
Declaration
public Task<ListInternalNamespaceOccOverviewsResponse> ListInternalNamespaceOccOverviews(ListInternalNamespaceOccOverviewsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListInternalNamespaceOccOverviewsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListInternalNamespaceOccOverviewsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListInternalNamespaceOccOverviews API.
ListInternalOccHandoverResourceBlockDetails(ListInternalOccHandoverResourceBlockDetailsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List details about a given occHandoverResourceBlock.
Declaration
public Task<ListInternalOccHandoverResourceBlockDetailsResponse> ListInternalOccHandoverResourceBlockDetails(ListInternalOccHandoverResourceBlockDetailsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListInternalOccHandoverResourceBlockDetailsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListInternalOccHandoverResourceBlockDetailsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListInternalOccHandoverResourceBlockDetails API.
ListInternalOccHandoverResourceBlocks(ListInternalOccHandoverResourceBlocksRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List Occ Handover Resource blocks.
Declaration
public Task<ListInternalOccHandoverResourceBlocksResponse> ListInternalOccHandoverResourceBlocks(ListInternalOccHandoverResourceBlocksRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListInternalOccHandoverResourceBlocksRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListInternalOccHandoverResourceBlocksResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListInternalOccHandoverResourceBlocks API.
ListOccAvailabilities(ListOccAvailabilitiesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists availabilities for a particular availability catalog.
Declaration
public Task<ListOccAvailabilitiesResponse> ListOccAvailabilities(ListOccAvailabilitiesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListOccAvailabilitiesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListOccAvailabilitiesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListOccAvailabilities API.
ListOccAvailabilityCatalogs(ListOccAvailabilityCatalogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists all availability catalogs.
Declaration
public Task<ListOccAvailabilityCatalogsResponse> ListOccAvailabilityCatalogs(ListOccAvailabilityCatalogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListOccAvailabilityCatalogsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListOccAvailabilityCatalogsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListOccAvailabilityCatalogs API.
ListOccAvailabilityCatalogsInternal(ListOccAvailabilityCatalogsInternalRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
An internal api to list availability catalogs.
Declaration
public Task<ListOccAvailabilityCatalogsInternalResponse> ListOccAvailabilityCatalogsInternal(ListOccAvailabilityCatalogsInternalRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListOccAvailabilityCatalogsInternalRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListOccAvailabilityCatalogsInternalResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListOccAvailabilityCatalogsInternal API.
ListOccCapacityRequests(ListOccCapacityRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists all capacity requests.
Declaration
public Task<ListOccCapacityRequestsResponse> ListOccCapacityRequests(ListOccCapacityRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListOccCapacityRequestsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListOccCapacityRequestsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListOccCapacityRequests API.
ListOccCapacityRequestsInternal(ListOccCapacityRequestsInternalRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
An internal api to list all capacity requests.
Declaration
public Task<ListOccCapacityRequestsInternalResponse> ListOccCapacityRequestsInternal(ListOccCapacityRequestsInternalRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListOccCapacityRequestsInternalRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListOccCapacityRequestsInternalResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListOccCapacityRequestsInternal API.
ListOccCustomerGroups(ListOccCustomerGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists all the customer groups.
Declaration
public Task<ListOccCustomerGroupsResponse> ListOccCustomerGroups(ListOccCustomerGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListOccCustomerGroupsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListOccCustomerGroupsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListOccCustomerGroups API.
ListOccHandoverResourceBlockDetails(ListOccHandoverResourceBlockDetailsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List details about a given occHandoverResourceBlock.
Declaration
public Task<ListOccHandoverResourceBlockDetailsResponse> ListOccHandoverResourceBlockDetails(ListOccHandoverResourceBlockDetailsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListOccHandoverResourceBlockDetailsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListOccHandoverResourceBlockDetailsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListOccHandoverResourceBlockDetails API.
ListOccHandoverResourceBlocks(ListOccHandoverResourceBlocksRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List Occ Handover Resource blocks.
Declaration
public Task<ListOccHandoverResourceBlocksResponse> ListOccHandoverResourceBlocks(ListOccHandoverResourceBlocksRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListOccHandoverResourceBlocksRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListOccHandoverResourceBlocksResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListOccHandoverResourceBlocks API.
ListOccOverviews(ListOccOverviewsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists an overview of all resources in that namespace in a given time interval.
Declaration
public Task<ListOccOverviewsResponse> ListOccOverviews(ListOccOverviewsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListOccOverviewsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListOccOverviewsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListOccOverviews API.
PatchInternalOccCapacityRequest(PatchInternalOccCapacityRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the OccCapacityRequest by evaluating a sequence of instructions.
Declaration
public Task<PatchInternalOccCapacityRequestResponse> PatchInternalOccCapacityRequest(PatchInternalOccCapacityRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
PatchInternalOccCapacityRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<PatchInternalOccCapacityRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use PatchInternalOccCapacityRequest API.
PatchOccCapacityRequest(PatchOccCapacityRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the OccCapacityRequest by evaluating a sequence of instructions.
Declaration
public Task<PatchOccCapacityRequestResponse> PatchOccCapacityRequest(PatchOccCapacityRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
PatchOccCapacityRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<PatchOccCapacityRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use PatchOccCapacityRequest API.
PublishOccAvailabilityCatalog(PublishOccAvailabilityCatalogRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Publishes the version of availability catalog specified by the operator. This makes that catalog version visible to customers.
Declaration
public Task<PublishOccAvailabilityCatalogResponse> PublishOccAvailabilityCatalog(PublishOccAvailabilityCatalogRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
PublishOccAvailabilityCatalogRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<PublishOccAvailabilityCatalogResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use PublishOccAvailabilityCatalog API.
UpdateInternalOccCapacityRequest(UpdateInternalOccCapacityRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
The internal api to update the capacity request. This api will be used by operators for updating the capacity request to either completed, resubmitted or rejected.
Declaration
public Task<UpdateInternalOccCapacityRequestResponse> UpdateInternalOccCapacityRequest(UpdateInternalOccCapacityRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateInternalOccCapacityRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateInternalOccCapacityRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateInternalOccCapacityRequest API.
UpdateOccAvailabilityCatalog(UpdateOccAvailabilityCatalogRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
The request to update the availability catalog. Currently only freeform tags can be updated via this api.
Declaration
public Task<UpdateOccAvailabilityCatalogResponse> UpdateOccAvailabilityCatalog(UpdateOccAvailabilityCatalogRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateOccAvailabilityCatalogRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateOccAvailabilityCatalogResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateOccAvailabilityCatalog API.
UpdateOccCapacityRequest(UpdateOccCapacityRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
The request to update the capacity request. The user can perform actions like closing a partially completed request so that it doesn't go ahead for full completion.
Declaration
public Task<UpdateOccCapacityRequestResponse> UpdateOccCapacityRequest(UpdateOccCapacityRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateOccCapacityRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateOccCapacityRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateOccCapacityRequest API.
UpdateOccCustomer(UpdateOccCustomerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
The request to update the customer.
Declaration
public Task<UpdateOccCustomerResponse> UpdateOccCustomer(UpdateOccCustomerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateOccCustomerRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateOccCustomerResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateOccCustomer API.
UpdateOccCustomerGroup(UpdateOccCustomerGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
The request to update the customer group.
Declaration
public Task<UpdateOccCustomerGroupResponse> UpdateOccCustomerGroup(UpdateOccCustomerGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateOccCustomerGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateOccCustomerGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateOccCustomerGroup API.