Class DiscoveryClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.cloudbridge.DiscoveryClient
-
- All Implemented Interfaces:
Discovery,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20220509") public class DiscoveryClient extends BaseSyncClient implements Discovery
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDiscoveryClient.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 Discovery.
-
Constructor Summary
Constructors Constructor Description DiscoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.DiscoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.DiscoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.DiscoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.DiscoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.DiscoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.DiscoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.DiscoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DiscoveryClient.Builderbuilder()Create a builder for this client.ChangeAssetSourceCompartmentResponsechangeAssetSourceCompartment(ChangeAssetSourceCompartmentRequest request)Moves a resource into a different compartment.ChangeDiscoveryScheduleCompartmentResponsechangeDiscoveryScheduleCompartment(ChangeDiscoveryScheduleCompartmentRequest request)Moves the specified discovery schedule into a different compartment.voidclose()CreateAssetSourceResponsecreateAssetSource(CreateAssetSourceRequest request)Creates an asset source.CreateDiscoveryScheduleResponsecreateDiscoverySchedule(CreateDiscoveryScheduleRequest request)Creates the discovery schedule.DeleteAssetSourceResponsedeleteAssetSource(DeleteAssetSourceRequest request)Deletes the asset source by ID.DeleteDiscoveryScheduleResponsedeleteDiscoverySchedule(DeleteDiscoveryScheduleRequest request)Deletes the specified discovery schedule.GetAssetSourceResponsegetAssetSource(GetAssetSourceRequest request)Gets the asset source by ID.StringgetClientCommonLibraryVersion()protected ClientConfiguratorgetDefaultConfigurator()GetDiscoveryScheduleResponsegetDiscoverySchedule(GetDiscoveryScheduleRequest request)Reads information about the specified discovery schedule.StringgetEndpoint()Optional<String>getMinimumClientCommonLibraryVersionFromClient()DiscoveryPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.DiscoveryWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.ListAssetSourceConnectionsResponselistAssetSourceConnections(ListAssetSourceConnectionsRequest request)Gets known connections to the asset source by the asset source ID.ListAssetSourcesResponselistAssetSources(ListAssetSourcesRequest request)Returns a list of asset sources.ListDiscoverySchedulesResponselistDiscoverySchedules(ListDiscoverySchedulesRequest request)Lists discovery schedules.ListSupportedCloudRegionsResponselistSupportedCloudRegions(ListSupportedCloudRegionsRequest request)Returns a list of supported cloud regions related to AssetSourceTypeParam.voidpopulateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)Populate the parameters in the endpoint with its corresponding value and update the base endpoint.RefreshAssetSourceResponserefreshAssetSource(RefreshAssetSourceRequest request)Initiates the process of asset metadata synchronization with the related asset source.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’).UpdateAssetSourceResponseupdateAssetSource(UpdateAssetSourceRequest request)Updates the asset source.voidupdateBaseEndpoint(String endpoint)This method should be used for parameterized endpoint templates only.UpdateDiscoveryScheduleResponseupdateDiscoverySchedule(UpdateDiscoveryScheduleRequest request)Updates the specified discovery schedule.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.Discovery
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
DiscoveryClient
@Deprecated public DiscoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDiscoveryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
DiscoveryClient
@Deprecated public DiscoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDiscoveryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
DiscoveryClient
@Deprecated public DiscoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDiscoveryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
DiscoveryClient
@Deprecated public DiscoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDiscoveryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
DiscoveryClient
@Deprecated public DiscoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDiscoveryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
DiscoveryClient
@Deprecated public DiscoveryClient(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 (seeDiscoveryClient.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)
-
DiscoveryClient
@Deprecated public DiscoveryClient(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 (seeDiscoveryClient.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
-
DiscoveryClient
@Deprecated public DiscoveryClient(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 (seeDiscoveryClient.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-DiscoveryClient.Builder.executorService
-
-
Method Detail
-
builder
public static DiscoveryClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:DiscoverySets 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:DiscoverySets 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.
-
changeAssetSourceCompartment
public ChangeAssetSourceCompartmentResponse changeAssetSourceCompartment(ChangeAssetSourceCompartmentRequest request)
Description copied from interface:DiscoveryMoves a resource into a different compartment.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
changeAssetSourceCompartmentin interfaceDiscovery- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeDiscoveryScheduleCompartment
public ChangeDiscoveryScheduleCompartmentResponse changeDiscoveryScheduleCompartment(ChangeDiscoveryScheduleCompartmentRequest request)
Description copied from interface:DiscoveryMoves the specified discovery schedule into a different compartment.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
changeDiscoveryScheduleCompartmentin interfaceDiscovery- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createAssetSource
public CreateAssetSourceResponse createAssetSource(CreateAssetSourceRequest request)
Description copied from interface:DiscoveryCreates an asset source.- Specified by:
createAssetSourcein interfaceDiscovery- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDiscoverySchedule
public CreateDiscoveryScheduleResponse createDiscoverySchedule(CreateDiscoveryScheduleRequest request)
Description copied from interface:DiscoveryCreates the discovery schedule.- Specified by:
createDiscoverySchedulein interfaceDiscovery- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteAssetSource
public DeleteAssetSourceResponse deleteAssetSource(DeleteAssetSourceRequest request)
Description copied from interface:DiscoveryDeletes the asset source by ID.- Specified by:
deleteAssetSourcein interfaceDiscovery- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDiscoverySchedule
public DeleteDiscoveryScheduleResponse deleteDiscoverySchedule(DeleteDiscoveryScheduleRequest request)
Description copied from interface:DiscoveryDeletes the specified discovery schedule.- Specified by:
deleteDiscoverySchedulein interfaceDiscovery- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAssetSource
public GetAssetSourceResponse getAssetSource(GetAssetSourceRequest request)
Description copied from interface:DiscoveryGets the asset source by ID.- Specified by:
getAssetSourcein interfaceDiscovery- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDiscoverySchedule
public GetDiscoveryScheduleResponse getDiscoverySchedule(GetDiscoveryScheduleRequest request)
Description copied from interface:DiscoveryReads information about the specified discovery schedule.- Specified by:
getDiscoverySchedulein interfaceDiscovery- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAssetSourceConnections
public ListAssetSourceConnectionsResponse listAssetSourceConnections(ListAssetSourceConnectionsRequest request)
Description copied from interface:DiscoveryGets known connections to the asset source by the asset source ID.- Specified by:
listAssetSourceConnectionsin interfaceDiscovery- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAssetSources
public ListAssetSourcesResponse listAssetSources(ListAssetSourcesRequest request)
Description copied from interface:DiscoveryReturns a list of asset sources.- Specified by:
listAssetSourcesin interfaceDiscovery- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDiscoverySchedules
public ListDiscoverySchedulesResponse listDiscoverySchedules(ListDiscoverySchedulesRequest request)
Description copied from interface:DiscoveryLists discovery schedules.- Specified by:
listDiscoverySchedulesin interfaceDiscovery- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSupportedCloudRegions
public ListSupportedCloudRegionsResponse listSupportedCloudRegions(ListSupportedCloudRegionsRequest request)
Description copied from interface:DiscoveryReturns a list of supported cloud regions related to AssetSourceTypeParam.- Specified by:
listSupportedCloudRegionsin interfaceDiscovery- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
refreshAssetSource
public RefreshAssetSourceResponse refreshAssetSource(RefreshAssetSourceRequest request)
Description copied from interface:DiscoveryInitiates the process of asset metadata synchronization with the related asset source.- Specified by:
refreshAssetSourcein interfaceDiscovery- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateAssetSource
public UpdateAssetSourceResponse updateAssetSource(UpdateAssetSourceRequest request)
Description copied from interface:DiscoveryUpdates the asset source.- Specified by:
updateAssetSourcein interfaceDiscovery- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDiscoverySchedule
public UpdateDiscoveryScheduleResponse updateDiscoverySchedule(UpdateDiscoveryScheduleRequest request)
Description copied from interface:DiscoveryUpdates the specified discovery schedule.- Specified by:
updateDiscoverySchedulein interfaceDiscovery- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public DiscoveryWaiters getWaiters()
Description copied from interface:DiscoveryGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceDiscovery- Returns:
- The service waiters.
-
getPaginators
public DiscoveryPaginators getPaginators()
Description copied from interface:DiscoveryGets 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 interfaceDiscovery- 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
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()
-
-