Class InventoryClient
- java.lang.Object
- 
- com.oracle.bmc.http.internal.BaseSyncClient
- 
- com.oracle.bmc.cloudbridge.InventoryClient
 
 
- 
- All Implemented Interfaces:
- Inventory,- AutoCloseable
 
 @Generated(value="OracleSDKGenerator", comments="API Version: 20220509") public class InventoryClient extends BaseSyncClient implements Inventory
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classInventoryClient.BuilderBuilder class for this client.
 - 
Field SummaryFields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for Inventory.
 - 
Constructor SummaryConstructors Constructor Description InventoryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.InventoryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.InventoryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.InventoryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.InventoryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.InventoryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.InventoryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.InventoryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AnalyzeAssetsResponseanalyzeAssets(AnalyzeAssetsRequest request)Returns an aggregation of assets.static InventoryClient.Builderbuilder()Create a builder for this client.ChangeAssetCompartmentResponsechangeAssetCompartment(ChangeAssetCompartmentRequest request)Moves an asset resource from one compartment to another.ChangeAssetTagsResponsechangeAssetTags(ChangeAssetTagsRequest request)Change an asset’s tag.voidclose()CreateAssetResponsecreateAsset(CreateAssetRequest request)Creates an asset.CreateInventoryResponsecreateInventory(CreateInventoryRequest request)Creates an inventory.DeleteAssetResponsedeleteAsset(DeleteAssetRequest request)Deletes an asset resource by identifier.DeleteInventoryResponsedeleteInventory(DeleteInventoryRequest request)Deletes an inventory resource by identifier.GetAssetResponsegetAsset(GetAssetRequest request)Gets an asset by identifier.StringgetClientCommonLibraryVersion()protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()GetInventoryResponsegetInventory(GetInventoryRequest request)Gets an inventory by identifier.Optional<String>getMinimumClientCommonLibraryVersionFromClient()InventoryPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.InventoryWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.ImportInventoryResponseimportInventory(ImportInventoryRequest request)Import resources in inventory.ListAssetsResponselistAssets(ListAssetsRequest request)Returns a list of assets.ListHistoricalMetricsResponselistHistoricalMetrics(ListHistoricalMetricsRequest request)List asset historical metrics.ListInventoriesResponselistInventories(ListInventoriesRequest request)Returns a list of inventories.voidpopulateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)Populate the parameters in the endpoint with its corresponding value and update the base endpoint.voidrefreshClient()Rebuild the backingHttpClient.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).SubmitHistoricalMetricsResponsesubmitHistoricalMetrics(SubmitHistoricalMetricsRequest request)Creates or updates all metrics related to the asset.UpdateAssetResponseupdateAsset(UpdateAssetRequest request)Updates the asset.voidupdateBaseEndpoint(String endpoint)This method should be used for parameterized endpoint templates only.UpdateInventoryResponseupdateInventory(UpdateInventoryRequest request)Updates an inventory.voiduseRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)This method should be used to enable or disable the use of realm-specific endpoint template.- 
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClientclientCall
 - 
Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 - 
Methods inherited from interface java.lang.AutoCloseableclose
 - 
Methods inherited from interface com.oracle.bmc.cloudbridge.InventorygetEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
 
- 
 
- 
- 
- 
Constructor Detail- 
InventoryClient@Deprecated public InventoryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- InventoryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
 
 - 
InventoryClient@Deprecated public InventoryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- InventoryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
 
 - 
InventoryClient@Deprecated public InventoryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- InventoryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
 
 - 
InventoryClient@Deprecated public InventoryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- InventoryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
- defaultRequestSignerFactory-- ClientBuilderBase.requestSignerFactory
 
 - 
InventoryClient@Deprecated public InventoryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- InventoryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
- defaultRequestSignerFactory-- ClientBuilderBase.requestSignerFactory
- additionalClientConfigurators-- ClientBuilderBase.additionalClientConfigurators
 
 - 
InventoryClient@Deprecated public InventoryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- InventoryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
- defaultRequestSignerFactory-- ClientBuilderBase.requestSignerFactory
- additionalClientConfigurators-- ClientBuilderBase.additionalClientConfigurators
- endpoint-- ClientBuilderBase.endpoint(java.lang.String)
 
 - 
InventoryClient@Deprecated public InventoryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- InventoryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
- defaultRequestSignerFactory-- ClientBuilderBase.requestSignerFactory
- additionalClientConfigurators-- ClientBuilderBase.additionalClientConfigurators
- endpoint-- ClientBuilderBase.endpoint(java.lang.String)
- signingStrategyRequestSignerFactories-- ClientBuilderBase.signingStrategyRequestSignerFactories
 
 - 
InventoryClient@Deprecated public InventoryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- InventoryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
- defaultRequestSignerFactory-- ClientBuilderBase.requestSignerFactory
- additionalClientConfigurators-- ClientBuilderBase.additionalClientConfigurators
- endpoint-- ClientBuilderBase.endpoint(java.lang.String)
- signingStrategyRequestSignerFactories-- ClientBuilderBase.signingStrategyRequestSignerFactories
- executorService-- InventoryClient.Builder.executorService
 
 
- 
 - 
Method Detail- 
builderpublic static InventoryClient.Builder builder() Create a builder for this client.- Returns:
- builder
 
 - 
setRegionpublic void setRegion(Region region) Description copied from interface:InventorySets the region to call (ex, Region.US_PHOENIX_1).Note, this will call setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
 - 
setRegionpublic void setRegion(String regionId) Description copied from interface:InventorySets 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 callsetEndpoint.
 - 
analyzeAssetspublic AnalyzeAssetsResponse analyzeAssets(AnalyzeAssetsRequest request) Description copied from interface:InventoryReturns an aggregation of assets.Aggregation groups are sorted by groupBy property. Default sort order is ascending, but can be overridden by the sortOrder parameter. - Specified by:
- analyzeAssetsin interface- Inventory
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
changeAssetCompartmentpublic ChangeAssetCompartmentResponse changeAssetCompartment(ChangeAssetCompartmentRequest request) Description copied from interface:InventoryMoves an asset resource from one compartment to another.When provided, If-Match is checked against ETag values of the resource. - Specified by:
- changeAssetCompartmentin interface- Inventory
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
changeAssetTagspublic ChangeAssetTagsResponse changeAssetTags(ChangeAssetTagsRequest request) Description copied from interface:InventoryChange an asset’s tag.- Specified by:
- changeAssetTagsin interface- Inventory
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createAssetpublic CreateAssetResponse createAsset(CreateAssetRequest request) Description copied from interface:InventoryCreates an asset.- Specified by:
- createAssetin interface- Inventory
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createInventorypublic CreateInventoryResponse createInventory(CreateInventoryRequest request) Description copied from interface:InventoryCreates an inventory.- Specified by:
- createInventoryin interface- Inventory
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteAssetpublic DeleteAssetResponse deleteAsset(DeleteAssetRequest request) Description copied from interface:InventoryDeletes an asset resource by identifier.- Specified by:
- deleteAssetin interface- Inventory
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteInventorypublic DeleteInventoryResponse deleteInventory(DeleteInventoryRequest request) Description copied from interface:InventoryDeletes an inventory resource by identifier.- Specified by:
- deleteInventoryin interface- Inventory
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getAssetpublic GetAssetResponse getAsset(GetAssetRequest request) Description copied from interface:InventoryGets an asset by identifier.
 - 
getInventorypublic GetInventoryResponse getInventory(GetInventoryRequest request) Description copied from interface:InventoryGets an inventory by identifier.- Specified by:
- getInventoryin interface- Inventory
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
importInventorypublic ImportInventoryResponse importInventory(ImportInventoryRequest request) Description copied from interface:InventoryImport resources in inventory.- Specified by:
- importInventoryin interface- Inventory
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listAssetspublic ListAssetsResponse listAssets(ListAssetsRequest request) Description copied from interface:InventoryReturns a list of assets.- Specified by:
- listAssetsin interface- Inventory
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listHistoricalMetricspublic ListHistoricalMetricsResponse listHistoricalMetrics(ListHistoricalMetricsRequest request) Description copied from interface:InventoryList asset historical metrics.- Specified by:
- listHistoricalMetricsin interface- Inventory
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listInventoriespublic ListInventoriesResponse listInventories(ListInventoriesRequest request) Description copied from interface:InventoryReturns a list of inventories.- Specified by:
- listInventoriesin interface- Inventory
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
submitHistoricalMetricspublic SubmitHistoricalMetricsResponse submitHistoricalMetrics(SubmitHistoricalMetricsRequest request) Description copied from interface:InventoryCreates or updates all metrics related to the asset.- Specified by:
- submitHistoricalMetricsin interface- Inventory
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateAssetpublic UpdateAssetResponse updateAsset(UpdateAssetRequest request) Description copied from interface:InventoryUpdates the asset.- Specified by:
- updateAssetin interface- Inventory
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateInventorypublic UpdateInventoryResponse updateInventory(UpdateInventoryRequest request) Description copied from interface:InventoryUpdates an inventory.- Specified by:
- updateInventoryin interface- Inventory
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getWaiterspublic InventoryWaiters getWaiters() Description copied from interface:InventoryGets the pre-configured waiters available for resources for this service.- Specified by:
- getWaitersin interface- Inventory
- Returns:
- The service waiters.
 
 - 
getPaginatorspublic InventoryPaginators getPaginators() Description copied from interface:InventoryGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
- getPaginatorsin interface- Inventory
- Returns:
- The service paginators.
 
 - 
getDefaultConfiguratorprotected ClientConfigurator getDefaultConfigurator() 
 - 
useRealmSpecificEndpointTemplatepublic void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false - Parameters:
- useOfRealmSpecificEndpointTemplateEnabled- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
 
 - 
populateServiceParametersInEndpointpublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank. - Parameters:
- endpoint- The endpoint template in use
- requiredParametersMap- Map of parameter name as key and value set in request path or query parameter as value
 
 - 
updateBaseEndpointpublic final void updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.This does not include {region} and {secondLevelDomain} parameters. - Parameters:
- endpoint- The updated endpoint to use
 
 - 
setEndpointpublic final void setEndpoint(String endpoint) 
 - 
getEndpointpublic final String getEndpoint() 
 - 
refreshClientpublic final void refreshClient() Rebuild the backingHttpClient.This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
 - 
closepublic final void close() - Specified by:
- closein interface- AutoCloseable
 
 - 
getClientCommonLibraryVersionpublic String getClientCommonLibraryVersion() 
 
- 
 
-