Inventory (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

InventoryClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220509")
public interface Inventory
extends AutoCloseable
```
API for Oracle Cloud Bridge service. This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AnalyzeAssetsResponse`	`analyzeAssets(AnalyzeAssetsRequest request)` Returns an aggregation of assets.
`ChangeAssetCompartmentResponse`	`changeAssetCompartment(ChangeAssetCompartmentRequest request)` Moves an asset resource from one compartment to another.
`ChangeAssetTagsResponse`	`changeAssetTags(ChangeAssetTagsRequest request)` Change an asset’s tag.
`CreateAssetResponse`	`createAsset(CreateAssetRequest request)` Creates an asset.
`CreateInventoryResponse`	`createInventory(CreateInventoryRequest request)` Creates an inventory.
`DeleteAssetResponse`	`deleteAsset(DeleteAssetRequest request)` Deletes an asset resource by identifier.
`DeleteInventoryResponse`	`deleteInventory(DeleteInventoryRequest request)` Deletes an inventory resource by identifier.
`GetAssetResponse`	`getAsset(GetAssetRequest request)` Gets an asset by identifier.
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`GetInventoryResponse`	`getInventory(GetInventoryRequest request)` Gets an inventory by identifier.
`InventoryPaginators`	`getPaginators()` Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`InventoryWaiters`	`getWaiters()` Gets the pre-configured waiters available for resources for this service.
`ImportInventoryResponse`	`importInventory(ImportInventoryRequest request)` Import resources in inventory.
`ListAssetsResponse`	`listAssets(ListAssetsRequest request)` Returns a list of assets.
`ListHistoricalMetricsResponse`	`listHistoricalMetrics(ListHistoricalMetricsRequest request)` List asset historical metrics.
`ListInventoriesResponse`	`listInventories(ListInventoriesRequest request)` Returns a list of inventories.
`void`	`refreshClient()` Rebuilds the client from scratch.
`void`	`setEndpoint(String endpoint)` Sets the endpoint to call (ex, https://www.example.com).
`void`	`setRegion(Region region)` Sets the region to call (ex, Region.US_PHOENIX_1).
`void`	`setRegion(String regionId)` Sets the region to call (ex, ‘us-phoenix-1’).
`SubmitHistoricalMetricsResponse`	`submitHistoricalMetrics(SubmitHistoricalMetricsRequest request)` Creates or updates all metrics related to the asset.
`UpdateAssetResponse`	`updateAsset(UpdateAssetRequest request)` Updates the asset.
`UpdateInventoryResponse`	`updateInventory(UpdateInventoryRequest request)` Updates an inventory.
`void`	`useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)` Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable
close

- Method Detail
  - refreshClient
```
void refreshClient()
```
    Rebuilds the client from scratch. Useful to refresh certificates.
  - setEndpoint
```
void setEndpoint(String endpoint)
```
    Sets the endpoint to call (ex, https://www.example.com).
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
String getEndpoint()
```
    Gets the set endpoint for REST call (ex, https://www.example.com)
  - setRegion
```
void setRegion(Region region)
```
    Sets the region to call (ex, Region.US_PHOENIX_1).
    
    Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
void setRegion(String regionId)
```
    Sets the region to call (ex, ‘us-phoenix-1’).
    
    Note, this will first try to map the region ID to a known Region and call setRegion.
    If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.
    
    Parameters:
    
    regionId - The public region ID.
  - useRealmSpecificEndpointTemplate
```
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
```
    Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
    
    Parameters:
    
    realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template
  - analyzeAssets
```
AnalyzeAssetsResponse analyzeAssets(AnalyzeAssetsRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use AnalyzeAssets API.
  - changeAssetCompartment
```
ChangeAssetCompartmentResponse changeAssetCompartment(ChangeAssetCompartmentRequest request)
```
    Moves an asset resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ChangeAssetCompartment API.
  - changeAssetTags
```
ChangeAssetTagsResponse changeAssetTags(ChangeAssetTagsRequest request)
```
    Change an asset’s tag.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ChangeAssetTags API.
  - createAsset
```
CreateAssetResponse createAsset(CreateAssetRequest request)
```
    Creates an asset.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateAsset API.
  - createInventory
```
CreateInventoryResponse createInventory(CreateInventoryRequest request)
```
    Creates an inventory.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateInventory API.
  - deleteAsset
```
DeleteAssetResponse deleteAsset(DeleteAssetRequest request)
```
    Deletes an asset resource by identifier.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteAsset API.
  - deleteInventory
```
DeleteInventoryResponse deleteInventory(DeleteInventoryRequest request)
```
    Deletes an inventory resource by identifier.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteInventory API.
  - getAsset
```
GetAssetResponse getAsset(GetAssetRequest request)
```
    Gets an asset by identifier.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetAsset API.
  - getInventory
```
GetInventoryResponse getInventory(GetInventoryRequest request)
```
    Gets an inventory by identifier.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetInventory API.
  - importInventory
```
ImportInventoryResponse importInventory(ImportInventoryRequest request)
```
    Import resources in inventory.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ImportInventory API.
  - listAssets
```
ListAssetsResponse listAssets(ListAssetsRequest request)
```
    Returns a list of assets.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListAssets API.
  - listHistoricalMetrics
```
ListHistoricalMetricsResponse listHistoricalMetrics(ListHistoricalMetricsRequest request)
```
    List asset historical metrics.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListHistoricalMetrics API.
  - listInventories
```
ListInventoriesResponse listInventories(ListInventoriesRequest request)
```
    Returns a list of inventories.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListInventories API.
  - submitHistoricalMetrics
```
SubmitHistoricalMetricsResponse submitHistoricalMetrics(SubmitHistoricalMetricsRequest request)
```
    Creates or updates all metrics related to the asset.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use SubmitHistoricalMetrics API.
  - updateAsset
```
UpdateAssetResponse updateAsset(UpdateAssetRequest request)
```
    Updates the asset.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateAsset API.
  - updateInventory
```
UpdateInventoryResponse updateInventory(UpdateInventoryRequest request)
```
    Updates an inventory.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateInventory API.
  - getWaiters
```
InventoryWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
InventoryPaginators getPaginators()
```
    Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.
    
    Returns:
    
    The service paginators.

Interface Inventory

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

analyzeAssets

changeAssetCompartment

changeAssetTags

createAsset

createInventory

deleteAsset

deleteInventory

getAsset

getInventory

importInventory

listAssets

listHistoricalMetrics

listInventories

submitHistoricalMetrics

updateAsset

updateInventory

getWaiters

getPaginators