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 class
InventoryClient.Builder
Builder class for this client.
-
Field Summary
Fields Modifier and Type Field Description String
clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.Optional<String>
minimumClientCommonLibraryVersionFromClient
Minimum compatible SDK version, maybe provided by the codegen.static Service
SERVICE
Service instance for Inventory.
-
Constructor Summary
Constructors Constructor Description InventoryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.InventoryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.InventoryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.InventoryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.InventoryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.InventoryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.InventoryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.InventoryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AnalyzeAssetsResponse
analyzeAssets(AnalyzeAssetsRequest request)
Returns an aggregation of assets.static InventoryClient.Builder
builder()
Create a builder for this client.ChangeAssetCompartmentResponse
changeAssetCompartment(ChangeAssetCompartmentRequest request)
Moves an asset resource from one compartment to another.ChangeAssetTagsResponse
changeAssetTags(ChangeAssetTagsRequest request)
Change an asset’s tag.void
close()
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
getClientCommonLibraryVersion()
protected ClientConfigurator
getDefaultConfigurator()
String
getEndpoint()
GetInventoryResponse
getInventory(GetInventoryRequest request)
Gets an inventory by identifier.Optional<String>
getMinimumClientCommonLibraryVersionFromClient()
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
populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.void
refreshClient()
Rebuild the backingHttpClient
.void
setEndpoint(String endpoint)
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.void
updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.UpdateInventoryResponse
updateInventory(UpdateInventoryRequest request)
Updates an inventory.void
useRealmSpecificEndpointTemplate(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 thebuilder
instead.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 thebuilder
instead.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 thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeInventoryClient.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 thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeInventoryClient.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 thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeInventoryClient.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 thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeInventoryClient.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 thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeInventoryClient.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 thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeInventoryClient.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
-
builder
public static InventoryClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:Inventory
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.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:Inventory
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 callsetEndpoint
.
-
analyzeAssets
public AnalyzeAssetsResponse analyzeAssets(AnalyzeAssetsRequest request)
Description copied from interface:Inventory
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.
- Specified by:
analyzeAssets
in 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:Inventory
Moves an asset resource from one compartment to another.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
changeAssetCompartment
in 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:Inventory
Change an asset’s tag.- Specified by:
changeAssetTags
in 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:Inventory
Creates an asset.- Specified by:
createAsset
in 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:Inventory
Creates an inventory.- Specified by:
createInventory
in 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:Inventory
Deletes an asset resource by identifier.- Specified by:
deleteAsset
in 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:Inventory
Deletes an inventory resource by identifier.- Specified by:
deleteInventory
in 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:Inventory
Gets an asset by identifier.
-
getInventory
public GetInventoryResponse getInventory(GetInventoryRequest request)
Description copied from interface:Inventory
Gets an inventory by identifier.- Specified by:
getInventory
in 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:Inventory
Import resources in inventory.- Specified by:
importInventory
in 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:Inventory
Returns a list of assets.- Specified by:
listAssets
in 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:Inventory
List asset historical metrics.- Specified by:
listHistoricalMetrics
in 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:Inventory
Returns a list of inventories.- Specified by:
listInventories
in 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:Inventory
Creates or updates all metrics related to the asset.- Specified by:
submitHistoricalMetrics
in 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:Inventory
Updates the asset.- Specified by:
updateAsset
in 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:Inventory
Updates an inventory.- Specified by:
updateInventory
in 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:Inventory
Gets the pre-configured waiters available for resources for this service.- Specified by:
getWaiters
in interfaceInventory
- Returns:
- The service waiters.
-
getPaginators
public InventoryPaginators getPaginators()
Description copied from interface:Inventory
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.- Specified by:
getPaginators
in interfaceInventory
- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
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
-
populateServiceParametersInEndpoint
public 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 userequiredParametersMap
- Map of parameter name as key and value set in request path or query parameter as value
-
updateBaseEndpoint
public 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
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-