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 Summary
Nested Classes Modifier and Type Class Description static classInventoryClient.BuilderBuilder class for this client.
-
Field Summary
Fields 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 Summary
Constructors 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 Summary
All 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.voidenableDualStackEndpoints(boolean enableDualStackEndpoints)This method should be used to enable or disable the use of dual-stack endpoints.GetAssetResponsegetAsset(GetAssetRequest request)Gets an asset by identifier.StringgetClientCommonLibraryVersion()protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Get the endpoint of the client.GetInventoryResponsegetInventory(GetInventoryRequest request)Gets an inventory by identifier.Optional<String>getMinimumClientCommonLibraryVersionFromClient()Map<String,Boolean>getOptionsMap()Return an immutable snapshot representing the current options set for this client.InventoryPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.StringgetResolvedEndpoint(Map<String,Object> requiredParametersMap)Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.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.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.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.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.cloudbridge.Inventory
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
InventoryClient
@Deprecated public InventoryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeInventoryClient.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 (seeInventoryClient.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 (seeInventoryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 (seeInventoryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 (seeInventoryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-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 (seeInventoryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 (seeInventoryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 (seeInventoryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactoriesexecutorService-InventoryClient.Builder.executorService
-
-
Method Detail
-
builder
public static InventoryClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public 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.
-
setRegion
public 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.
-
analyzeAssets
public 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 interfaceInventory- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeAssetCompartment
public 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 interfaceInventory- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeAssetTags
public ChangeAssetTagsResponse changeAssetTags(ChangeAssetTagsRequest request)
Description copied from interface:InventoryChange an asset’s tag.- Specified by:
changeAssetTagsin interfaceInventory- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createAsset
public CreateAssetResponse createAsset(CreateAssetRequest request)
Description copied from interface:InventoryCreates an asset.- Specified by:
createAssetin interfaceInventory- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createInventory
public CreateInventoryResponse createInventory(CreateInventoryRequest request)
Description copied from interface:InventoryCreates an inventory.- Specified by:
createInventoryin interfaceInventory- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteAsset
public DeleteAssetResponse deleteAsset(DeleteAssetRequest request)
Description copied from interface:InventoryDeletes an asset resource by identifier.- Specified by:
deleteAssetin interfaceInventory- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteInventory
public DeleteInventoryResponse deleteInventory(DeleteInventoryRequest request)
Description copied from interface:InventoryDeletes an inventory resource by identifier.- Specified by:
deleteInventoryin interfaceInventory- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAsset
public GetAssetResponse getAsset(GetAssetRequest request)
Description copied from interface:InventoryGets an asset by identifier.
-
getInventory
public GetInventoryResponse getInventory(GetInventoryRequest request)
Description copied from interface:InventoryGets an inventory by identifier.- Specified by:
getInventoryin interfaceInventory- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
importInventory
public ImportInventoryResponse importInventory(ImportInventoryRequest request)
Description copied from interface:InventoryImport resources in inventory.- Specified by:
importInventoryin interfaceInventory- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAssets
public ListAssetsResponse listAssets(ListAssetsRequest request)
Description copied from interface:InventoryReturns a list of assets.- Specified by:
listAssetsin interfaceInventory- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listHistoricalMetrics
public ListHistoricalMetricsResponse listHistoricalMetrics(ListHistoricalMetricsRequest request)
Description copied from interface:InventoryList asset historical metrics.- Specified by:
listHistoricalMetricsin interfaceInventory- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listInventories
public ListInventoriesResponse listInventories(ListInventoriesRequest request)
Description copied from interface:InventoryReturns a list of inventories.- Specified by:
listInventoriesin interfaceInventory- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
submitHistoricalMetrics
public SubmitHistoricalMetricsResponse submitHistoricalMetrics(SubmitHistoricalMetricsRequest request)
Description copied from interface:InventoryCreates or updates all metrics related to the asset.- Specified by:
submitHistoricalMetricsin interfaceInventory- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateAsset
public UpdateAssetResponse updateAsset(UpdateAssetRequest request)
Description copied from interface:InventoryUpdates the asset.- Specified by:
updateAssetin interfaceInventory- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateInventory
public UpdateInventoryResponse updateInventory(UpdateInventoryRequest request)
Description copied from interface:InventoryUpdates an inventory.- Specified by:
updateInventoryin interfaceInventory- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public InventoryWaiters getWaiters()
Description copied from interface:InventoryGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceInventory- Returns:
- The service waiters.
-
getPaginators
public 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 interfaceInventory- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
enableDualStackEndpoints
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
This method should be used to enable or disable the use of dual-stack endpoints.The default value is false i.e. dual-stack endpoints are disabled by default.
- Parameters:
enableDualStackEndpoints- This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
-
getOptionsMap
public Map<String,Boolean> getOptionsMap()
Return an immutable snapshot representing the current options set for this client.- Returns:
- immutable snapshot representing the current options set for this client
-
getResolvedEndpoint
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.- Parameters:
requiredParametersMap- the map from required parameter name to their values- Returns:
- resolved endpoint, with all options and placeholders filled in
-
useRealmSpecificEndpointTemplate
public 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
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
Get the endpoint of the client.Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a
Region.Examples of endpoints this may return:
- Unparameterized endpoints
https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with placeholders
https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with options
https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com - Parameterized endpoints with placeholders and options
https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
To get the actual endpoint for a parameterized request, you can use
BaseClient.getResolvedEndpoint(Map)orParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).- Returns:
- the endpoint being used by the client
- Unparameterized endpoints
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-