@Generated(value="OracleSDKGenerator", comments="API Version: 20220509") public class InventoryClient extends BaseSyncClient implements Inventory
Modifier and Type | Class and Description |
---|---|
static class |
InventoryClient.Builder
Builder class for this client.
|
Modifier and Type | Field and 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 and Description |
---|
InventoryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Deprecated.
Use the
builder instead. |
InventoryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Deprecated.
Use the
builder instead. |
InventoryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
InventoryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
InventoryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Deprecated.
Use the
builder instead. |
InventoryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.
Use the
builder instead. |
InventoryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Deprecated.
Use the
builder instead. |
InventoryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Deprecated.
Use the
builder instead. |
Modifier and Type | Method and 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 backing
HttpClient . |
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.
|
clientCall
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
close
public static final Service SERVICE
Service instance for Inventory.
public final String clientCommonLibraryVersion
@Deprecated public InventoryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see InventoryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public InventoryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see InventoryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public InventoryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see InventoryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public InventoryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
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
@Deprecated public InventoryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
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
@Deprecated public InventoryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
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)
@Deprecated public InventoryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
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
@Deprecated public InventoryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
builder
instead.Create a new client instance.
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
public static InventoryClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
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.
public void setRegion(String regionId)
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 call setEndpoint
.
public AnalyzeAssetsResponse analyzeAssets(AnalyzeAssetsRequest request)
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.
analyzeAssets
in interface Inventory
request
- The request object containing the details to sendpublic ChangeAssetCompartmentResponse changeAssetCompartment(ChangeAssetCompartmentRequest request)
Inventory
Moves an asset resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.
changeAssetCompartment
in interface Inventory
request
- The request object containing the details to sendpublic ChangeAssetTagsResponse changeAssetTags(ChangeAssetTagsRequest request)
Inventory
Change an asset’s tag.
changeAssetTags
in interface Inventory
request
- The request object containing the details to sendpublic CreateAssetResponse createAsset(CreateAssetRequest request)
Inventory
Creates an asset.
createAsset
in interface Inventory
request
- The request object containing the details to sendpublic CreateInventoryResponse createInventory(CreateInventoryRequest request)
Inventory
Creates an inventory.
createInventory
in interface Inventory
request
- The request object containing the details to sendpublic DeleteAssetResponse deleteAsset(DeleteAssetRequest request)
Inventory
Deletes an asset resource by identifier.
deleteAsset
in interface Inventory
request
- The request object containing the details to sendpublic DeleteInventoryResponse deleteInventory(DeleteInventoryRequest request)
Inventory
Deletes an inventory resource by identifier.
deleteInventory
in interface Inventory
request
- The request object containing the details to sendpublic GetAssetResponse getAsset(GetAssetRequest request)
Inventory
Gets an asset by identifier.
public GetInventoryResponse getInventory(GetInventoryRequest request)
Inventory
Gets an inventory by identifier.
getInventory
in interface Inventory
request
- The request object containing the details to sendpublic ImportInventoryResponse importInventory(ImportInventoryRequest request)
Inventory
Import resources in inventory.
importInventory
in interface Inventory
request
- The request object containing the details to sendpublic ListAssetsResponse listAssets(ListAssetsRequest request)
Inventory
Returns a list of assets.
listAssets
in interface Inventory
request
- The request object containing the details to sendpublic ListHistoricalMetricsResponse listHistoricalMetrics(ListHistoricalMetricsRequest request)
Inventory
List asset historical metrics.
listHistoricalMetrics
in interface Inventory
request
- The request object containing the details to sendpublic ListInventoriesResponse listInventories(ListInventoriesRequest request)
Inventory
Returns a list of inventories.
listInventories
in interface Inventory
request
- The request object containing the details to sendpublic SubmitHistoricalMetricsResponse submitHistoricalMetrics(SubmitHistoricalMetricsRequest request)
Inventory
Creates or updates all metrics related to the asset.
submitHistoricalMetrics
in interface Inventory
request
- The request object containing the details to sendpublic UpdateAssetResponse updateAsset(UpdateAssetRequest request)
Inventory
Updates the asset.
updateAsset
in interface Inventory
request
- The request object containing the details to sendpublic UpdateInventoryResponse updateInventory(UpdateInventoryRequest request)
Inventory
Updates an inventory.
updateInventory
in interface Inventory
request
- The request object containing the details to sendpublic InventoryWaiters getWaiters()
Inventory
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface Inventory
public InventoryPaginators getPaginators()
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.
getPaginators
in interface Inventory
protected ClientConfigurator getDefaultConfigurator()
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to
enable or disable the use of realm-specific endpoint template respectivelypublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or
query parameter as valuepublic final void updateBaseEndpoint(String endpoint)
endpoint
- The updated endpoint to usepublic final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient
. This will call ClientConfigurator
s again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close
in interface AutoCloseable
public String getClientCommonLibraryVersion()
Copyright © 2016–2024. All rights reserved.