Class InventoryClient

Service client instance for Inventory.

Inheritance

object

ClientBase

RegionalClientBase

InventoryClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.CloudbridgeService

Assembly: OCI.DotNetSDK.Cloudbridge.dll

Syntax

public class InventoryClient : RegionalClientBase, IDisposable

Constructors

InventoryClient(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 InventoryClient(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 InventoryPaginators Paginators { get; }

Property Value

Type	Description
InventoryPaginators

Waiters

Declaration

public InventoryWaiters Waiters { get; }

Property Value

Type	Description
InventoryWaiters

Methods

AnalyzeAssets(AnalyzeAssetsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns an aggregation of assets. Aggregation groups are sorted by groupBy property. Default sort order is ascending, but can be overridden by the sortOrder parameter.

Declaration

public Task<AnalyzeAssetsResponse> AnalyzeAssets(AnalyzeAssetsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
AnalyzeAssetsRequest	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<AnalyzeAssetsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use AnalyzeAssets API.

ChangeAssetCompartment(ChangeAssetCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves an asset resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Declaration

public Task<ChangeAssetCompartmentResponse> ChangeAssetCompartment(ChangeAssetCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeAssetCompartmentRequest	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<ChangeAssetCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeAssetCompartment API.

ChangeAssetTags(ChangeAssetTagsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Change an asset's tag.

Declaration

public Task<ChangeAssetTagsResponse> ChangeAssetTags(ChangeAssetTagsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeAssetTagsRequest	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<ChangeAssetTagsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeAssetTags API.

CreateAsset(CreateAssetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates an asset.

Declaration

public Task<CreateAssetResponse> CreateAsset(CreateAssetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateAssetRequest	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<CreateAssetResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateAsset API.

CreateInventory(CreateInventoryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates an inventory.

Declaration

public Task<CreateInventoryResponse> CreateInventory(CreateInventoryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateInventoryRequest	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<CreateInventoryResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateInventory API.

DeleteAsset(DeleteAssetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes an asset resource by identifier.

Declaration

public Task<DeleteAssetResponse> DeleteAsset(DeleteAssetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteAssetRequest	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<DeleteAssetResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteAsset API.

DeleteInventory(DeleteInventoryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes an inventory resource by identifier.

Declaration

public Task<DeleteInventoryResponse> DeleteInventory(DeleteInventoryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteInventoryRequest	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<DeleteInventoryResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteInventory API.

GetAsset(GetAssetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets an asset by identifier.

Declaration

public Task<GetAssetResponse> GetAsset(GetAssetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetAssetRequest	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<GetAssetResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetAsset API.

GetInventory(GetInventoryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets an inventory by identifier.

Declaration

public Task<GetInventoryResponse> GetInventory(GetInventoryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetInventoryRequest	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<GetInventoryResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetInventory API.

ImportInventory(ImportInventoryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Import resources in inventory.

Declaration

public Task<ImportInventoryResponse> ImportInventory(ImportInventoryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ImportInventoryRequest	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<ImportInventoryResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ImportInventory API.

ListAssets(ListAssetsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of assets.

Declaration

public Task<ListAssetsResponse> ListAssets(ListAssetsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAssetsRequest	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<ListAssetsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAssets API.

ListHistoricalMetrics(ListHistoricalMetricsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List asset historical metrics.

Declaration

public Task<ListHistoricalMetricsResponse> ListHistoricalMetrics(ListHistoricalMetricsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListHistoricalMetricsRequest	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<ListHistoricalMetricsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListHistoricalMetrics API.

ListInventories(ListInventoriesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of inventories.

Declaration

public Task<ListInventoriesResponse> ListInventories(ListInventoriesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListInventoriesRequest	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<ListInventoriesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListInventories API.

SubmitHistoricalMetrics(SubmitHistoricalMetricsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates or updates all metrics related to the asset.

Declaration

public Task<SubmitHistoricalMetricsResponse> SubmitHistoricalMetrics(SubmitHistoricalMetricsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SubmitHistoricalMetricsRequest	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<SubmitHistoricalMetricsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SubmitHistoricalMetrics API.

UpdateAsset(UpdateAssetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the asset.

Declaration

public Task<UpdateAssetResponse> UpdateAsset(UpdateAssetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateAssetRequest	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<UpdateAssetResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateAsset API.

UpdateInventory(UpdateInventoryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates an inventory.

Declaration

public Task<UpdateInventoryResponse> UpdateInventory(UpdateInventoryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateInventoryRequest	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<UpdateInventoryResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateInventory API.

Implements

IDisposable