Interface Discovery
-
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
DiscoveryClient
@Generated(value="OracleSDKGenerator", comments="API Version: 20220509") public interface Discovery 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 Description ChangeAssetSourceCompartmentResponse
changeAssetSourceCompartment(ChangeAssetSourceCompartmentRequest request)
Moves a resource into a different compartment.ChangeDiscoveryScheduleCompartmentResponse
changeDiscoveryScheduleCompartment(ChangeDiscoveryScheduleCompartmentRequest request)
Moves the specified discovery schedule into a different compartment.CreateAssetSourceResponse
createAssetSource(CreateAssetSourceRequest request)
Creates an asset source.CreateDiscoveryScheduleResponse
createDiscoverySchedule(CreateDiscoveryScheduleRequest request)
Creates the discovery schedule.DeleteAssetSourceResponse
deleteAssetSource(DeleteAssetSourceRequest request)
Deletes the asset source by ID.DeleteDiscoveryScheduleResponse
deleteDiscoverySchedule(DeleteDiscoveryScheduleRequest request)
Deletes the specified discovery schedule.GetAssetSourceResponse
getAssetSource(GetAssetSourceRequest request)
Gets the asset source by ID.GetDiscoveryScheduleResponse
getDiscoverySchedule(GetDiscoveryScheduleRequest request)
Reads information about the specified discovery schedule.String
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)DiscoveryPaginators
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.DiscoveryWaiters
getWaiters()
Gets the pre-configured waiters available for resources for this service.ListAssetSourceConnectionsResponse
listAssetSourceConnections(ListAssetSourceConnectionsRequest request)
Gets known connections to the asset source by the asset source ID.ListAssetSourcesResponse
listAssetSources(ListAssetSourcesRequest request)
Returns a list of asset sources.ListDiscoverySchedulesResponse
listDiscoverySchedules(ListDiscoverySchedulesRequest request)
Lists discovery schedules.ListSupportedCloudRegionsResponse
listSupportedCloudRegions(ListSupportedCloudRegionsRequest request)
Returns a list of supported cloud regions related to AssetSourceTypeParam.RefreshAssetSourceResponse
refreshAssetSource(RefreshAssetSourceRequest request)
Initiates the process of asset metadata synchronization with the related asset source.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’).UpdateAssetSourceResponse
updateAssetSource(UpdateAssetSourceRequest request)
Updates the asset source.UpdateDiscoveryScheduleResponse
updateDiscoverySchedule(UpdateDiscoveryScheduleRequest request)
Updates the specified discovery schedule.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 callsetEndpoint
.- 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
-
changeAssetSourceCompartment
ChangeAssetSourceCompartmentResponse changeAssetSourceCompartment(ChangeAssetSourceCompartmentRequest request)
Moves a resource into a different compartment.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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/cloudbridge/ChangeAssetSourceCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeAssetSourceCompartment API.
-
changeDiscoveryScheduleCompartment
ChangeDiscoveryScheduleCompartmentResponse changeDiscoveryScheduleCompartment(ChangeDiscoveryScheduleCompartmentRequest request)
Moves the specified discovery schedule into a different compartment.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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/cloudbridge/ChangeDiscoveryScheduleCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeDiscoveryScheduleCompartment API.
-
createAssetSource
CreateAssetSourceResponse createAssetSource(CreateAssetSourceRequest request)
Creates an asset source.- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/cloudbridge/CreateAssetSourceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateAssetSource API.
-
createDiscoverySchedule
CreateDiscoveryScheduleResponse createDiscoverySchedule(CreateDiscoveryScheduleRequest request)
Creates the discovery schedule.- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/cloudbridge/CreateDiscoveryScheduleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDiscoverySchedule API.
-
deleteAssetSource
DeleteAssetSourceResponse deleteAssetSource(DeleteAssetSourceRequest request)
Deletes the asset source by ID.- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/cloudbridge/DeleteAssetSourceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteAssetSource API.
-
deleteDiscoverySchedule
DeleteDiscoveryScheduleResponse deleteDiscoverySchedule(DeleteDiscoveryScheduleRequest request)
Deletes the specified discovery schedule.- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/cloudbridge/DeleteDiscoveryScheduleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDiscoverySchedule API.
-
getAssetSource
GetAssetSourceResponse getAssetSource(GetAssetSourceRequest request)
Gets the asset source by ID.- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/cloudbridge/GetAssetSourceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetAssetSource API.
-
getDiscoverySchedule
GetDiscoveryScheduleResponse getDiscoverySchedule(GetDiscoveryScheduleRequest request)
Reads information about the specified discovery schedule.- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/cloudbridge/GetDiscoveryScheduleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDiscoverySchedule API.
-
listAssetSourceConnections
ListAssetSourceConnectionsResponse listAssetSourceConnections(ListAssetSourceConnectionsRequest request)
Gets known connections to the asset source by the asset source ID.- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/cloudbridge/ListAssetSourceConnectionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAssetSourceConnections API.
-
listAssetSources
ListAssetSourcesResponse listAssetSources(ListAssetSourcesRequest request)
Returns a list of asset sources.- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/cloudbridge/ListAssetSourcesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAssetSources API.
-
listDiscoverySchedules
ListDiscoverySchedulesResponse listDiscoverySchedules(ListDiscoverySchedulesRequest request)
Lists discovery schedules.- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/cloudbridge/ListDiscoverySchedulesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDiscoverySchedules API.
-
listSupportedCloudRegions
ListSupportedCloudRegionsResponse listSupportedCloudRegions(ListSupportedCloudRegionsRequest request)
Returns a list of supported cloud regions related to AssetSourceTypeParam.- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/cloudbridge/ListSupportedCloudRegionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSupportedCloudRegions API.
-
refreshAssetSource
RefreshAssetSourceResponse refreshAssetSource(RefreshAssetSourceRequest request)
Initiates the process of asset metadata synchronization with the related asset source.- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/cloudbridge/RefreshAssetSourceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RefreshAssetSource API.
-
updateAssetSource
UpdateAssetSourceResponse updateAssetSource(UpdateAssetSourceRequest request)
Updates the asset source.- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/cloudbridge/UpdateAssetSourceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateAssetSource API.
-
updateDiscoverySchedule
UpdateDiscoveryScheduleResponse updateDiscoverySchedule(UpdateDiscoveryScheduleRequest request)
Updates the specified discovery schedule.- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/cloudbridge/UpdateDiscoveryScheduleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDiscoverySchedule API.
-
getWaiters
DiscoveryWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.- Returns:
- The service waiters.
-
getPaginators
DiscoveryPaginators 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.
-
-