com.oracle.bmc.cloudbridge

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 and Description
static class	DiscoveryClient.Builder Builder class for this client.

Field Summary

Fields

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 Discovery.

Constructor Summary

Constructors

Constructor and Description
DiscoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
DiscoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
DiscoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
DiscoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
DiscoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated. Use the builder instead.
DiscoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
DiscoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
DiscoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static DiscoveryClient.Builder	builder() Create a builder for this client.
ChangeAssetSourceCompartmentResponse	changeAssetSourceCompartment(ChangeAssetSourceCompartmentRequest request) Moves a resource into a different compartment.
ChangeDiscoveryScheduleCompartmentResponse	changeDiscoveryScheduleCompartment(ChangeDiscoveryScheduleCompartmentRequest request) Moves the specified discovery schedule into a different compartment.
void	close()
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.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
GetDiscoveryScheduleResponse	getDiscoverySchedule(GetDiscoveryScheduleRequest request) Reads information about the specified discovery schedule.
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
RefreshAssetSourceResponse	refreshAssetSource(RefreshAssetSourceRequest request) Initiates the process of asset metadata synchronization with the related asset source.
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’).
UpdateAssetSourceResponse	updateAssetSource(UpdateAssetSourceRequest request) Updates the asset source.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
UpdateDiscoveryScheduleResponse	updateDiscoverySchedule(UpdateDiscoveryScheduleRequest request) Updates the specified discovery schedule.
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 com.oracle.bmc.cloudbridge.Discovery

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Discovery.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

DiscoveryClient

@Deprecated
public DiscoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DiscoveryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

DiscoveryClient

@Deprecated
public DiscoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                   ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DiscoveryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

DiscoveryClient

@Deprecated
public DiscoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                   ClientConfiguration configuration,
                                   ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DiscoveryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

DiscoveryClient

@Deprecated
public DiscoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                   ClientConfiguration configuration,
                                   ClientConfigurator clientConfigurator,
                                   RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DiscoveryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - 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 the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DiscoveryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

DiscoveryClient

@Deprecated
public DiscoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                   ClientConfiguration configuration,
                                   ClientConfigurator clientConfigurator,
                                   RequestSignerFactory defaultRequestSignerFactory,
                                   List<ClientConfigurator> additionalClientConfigurators,
                                   String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DiscoveryClient.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)

DiscoveryClient

@Deprecated
public DiscoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                   ClientConfiguration configuration,
                                   ClientConfigurator clientConfigurator,
                                   RequestSignerFactory defaultRequestSignerFactory,
                                   Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                   List<ClientConfigurator> additionalClientConfigurators,
                                   String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DiscoveryClient.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

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 the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DiscoveryClient.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 - 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: Discovery

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.

Specified by:

setRegion in interface Discovery

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Discovery

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.

Specified by:

setRegion in interface Discovery

Parameters:

regionId - The public region ID.

changeAssetSourceCompartment

public ChangeAssetSourceCompartmentResponse changeAssetSourceCompartment(ChangeAssetSourceCompartmentRequest request)

Description copied from interface: Discovery

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeAssetSourceCompartment in interface Discovery

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: Discovery

Moves the specified discovery schedule into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeDiscoveryScheduleCompartment in interface Discovery

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: Discovery

Creates an asset source.

Specified by:

createAssetSource in interface Discovery

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: Discovery

Creates the discovery schedule.

Specified by:

createDiscoverySchedule in interface Discovery

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: Discovery

Deletes the asset source by ID.

Specified by:

deleteAssetSource in interface Discovery

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: Discovery

Deletes the specified discovery schedule.

Specified by:

deleteDiscoverySchedule in interface Discovery

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: Discovery

Gets the asset source by ID.

Specified by:

getAssetSource in interface Discovery

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: Discovery

Reads information about the specified discovery schedule.

Specified by:

getDiscoverySchedule in interface Discovery

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: Discovery

Gets known connections to the asset source by the asset source ID.

Specified by:

listAssetSourceConnections in interface Discovery

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: Discovery

Returns a list of asset sources.

Specified by:

listAssetSources in interface Discovery

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: Discovery

Lists discovery schedules.

Specified by:

listDiscoverySchedules in interface Discovery

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: Discovery

Returns a list of supported cloud regions related to AssetSourceTypeParam.

Specified by:

listSupportedCloudRegions in interface Discovery

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: Discovery

Initiates the process of asset metadata synchronization with the related asset source.

Specified by:

refreshAssetSource in interface Discovery

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: Discovery

Updates the asset source.

Specified by:

updateAssetSource in interface Discovery

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: Discovery

Updates the specified discovery schedule.

Specified by:

updateDiscoverySchedule in interface Discovery

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: Discovery

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface Discovery

Returns:

The service waiters.

getPaginators

public DiscoveryPaginators getPaginators()

Description copied from interface: Discovery

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 interface Discovery

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 use

requiredParametersMap - 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 backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()