com.oracle.bmc.osmanagementhub

Class SoftwareSourceAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.osmanagementhub.SoftwareSourceAsyncClient

All Implemented Interfaces:

SoftwareSourceAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220901")
public class SoftwareSourceAsyncClient
extends BaseAsyncClient
implements SoftwareSourceAsync

Async client implementation for SoftwareSource service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoftwareSourceAsyncClient.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 SoftwareSource.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Future<AddPackagesToSoftwareSourceResponse>	addPackagesToSoftwareSource(AddPackagesToSoftwareSourceRequest request, AsyncHandler<AddPackagesToSoftwareSourceRequest,AddPackagesToSoftwareSourceResponse> handler) Adds packages to a software source.
static SoftwareSourceAsyncClient.Builder	builder() Create a builder for this client.
Future<ChangeAvailabilityOfSoftwareSourcesResponse>	changeAvailabilityOfSoftwareSources(ChangeAvailabilityOfSoftwareSourcesRequest request, AsyncHandler<ChangeAvailabilityOfSoftwareSourcesRequest,ChangeAvailabilityOfSoftwareSourcesResponse> handler) Updates the availability for a list of specified software sources.
Future<ChangeSoftwareSourceCompartmentResponse>	changeSoftwareSourceCompartment(ChangeSoftwareSourceCompartmentRequest request, AsyncHandler<ChangeSoftwareSourceCompartmentRequest,ChangeSoftwareSourceCompartmentResponse> handler) Moves the specified software sources to a different compartment within the same tenancy.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
Future<CreateEntitlementResponse>	createEntitlement(CreateEntitlementRequest request, AsyncHandler<CreateEntitlementRequest,CreateEntitlementResponse> handler) Registers the necessary entitlement credentials for OS vendor software sources for a tenancy.
Future<CreateSoftwareSourceResponse>	createSoftwareSource(CreateSoftwareSourceRequest request, AsyncHandler<CreateSoftwareSourceRequest,CreateSoftwareSourceResponse> handler) Creates a new versioned or custom software source.
Future<DeleteSoftwareSourceResponse>	deleteSoftwareSource(DeleteSoftwareSourceRequest request, AsyncHandler<DeleteSoftwareSourceRequest,DeleteSoftwareSourceResponse> handler) Deletes the specified software source.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Future<GetErratumResponse>	getErratum(GetErratumRequest request, AsyncHandler<GetErratumRequest,GetErratumResponse> handler) Returns information about the specified erratum based on its advisory name.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetModuleStreamResponse>	getModuleStream(GetModuleStreamRequest request, AsyncHandler<GetModuleStreamRequest,GetModuleStreamResponse> handler) Returns information about the specified module stream in a software source.
Future<GetModuleStreamProfileResponse>	getModuleStreamProfile(GetModuleStreamProfileRequest request, AsyncHandler<GetModuleStreamProfileRequest,GetModuleStreamProfileResponse> handler) Returns information about the specified module stream profile in a software source.
Future<GetPackageGroupResponse>	getPackageGroup(GetPackageGroupRequest request, AsyncHandler<GetPackageGroupRequest,GetPackageGroupResponse> handler) Returns information about the specified package group from a software source.
Future<GetSoftwarePackageResponse>	getSoftwarePackage(GetSoftwarePackageRequest request, AsyncHandler<GetSoftwarePackageRequest,GetSoftwarePackageResponse> handler) Returns information about the specified software package.
Future<GetSoftwarePackageByNameResponse>	getSoftwarePackageByName(GetSoftwarePackageByNameRequest request, AsyncHandler<GetSoftwarePackageByNameRequest,GetSoftwarePackageByNameResponse> handler) Returns information about the specified software package based on its fully qualified name.
Future<GetSoftwareSourceResponse>	getSoftwareSource(GetSoftwareSourceRequest request, AsyncHandler<GetSoftwareSourceRequest,GetSoftwareSourceResponse> handler) Returns information about the specified software source.
Future<ListAllSoftwarePackagesResponse>	listAllSoftwarePackages(ListAllSoftwarePackagesRequest request, AsyncHandler<ListAllSoftwarePackagesRequest,ListAllSoftwarePackagesResponse> handler) Lists software packages available through the OS Management Hub service.
Future<ListEntitlementsResponse>	listEntitlements(ListEntitlementsRequest request, AsyncHandler<ListEntitlementsRequest,ListEntitlementsResponse> handler) Lists entitlements in the specified tenancy OCID.
Future<ListErrataResponse>	listErrata(ListErrataRequest request, AsyncHandler<ListErrataRequest,ListErrataResponse> handler) Lists all of the currently available errata.
Future<ListModuleStreamProfilesResponse>	listModuleStreamProfiles(ListModuleStreamProfilesRequest request, AsyncHandler<ListModuleStreamProfilesRequest,ListModuleStreamProfilesResponse> handler) Lists module stream profiles from the specified software source OCID.
Future<ListModuleStreamsResponse>	listModuleStreams(ListModuleStreamsRequest request, AsyncHandler<ListModuleStreamsRequest,ListModuleStreamsResponse> handler) Lists module streams from the specified software source OCID.
Future<ListPackageGroupsResponse>	listPackageGroups(ListPackageGroupsRequest request, AsyncHandler<ListPackageGroupsRequest,ListPackageGroupsResponse> handler) Lists package groups that are associated with the specified software source OCID.
Future<ListSoftwarePackagesResponse>	listSoftwarePackages(ListSoftwarePackagesRequest request, AsyncHandler<ListSoftwarePackagesRequest,ListSoftwarePackagesResponse> handler) Lists software packages in the specified software source.
Future<ListSoftwarePackageSoftwareSourcesResponse>	listSoftwarePackageSoftwareSources(ListSoftwarePackageSoftwareSourcesRequest request, AsyncHandler<ListSoftwarePackageSoftwareSourcesRequest,ListSoftwarePackageSoftwareSourcesResponse> handler) Lists the software sources in the tenancy that contain the software package.
Future<ListSoftwareSourcesResponse>	listSoftwareSources(ListSoftwareSourcesRequest request, AsyncHandler<ListSoftwareSourcesRequest,ListSoftwareSourcesResponse> handler) Lists software sources that match the specified tenancy or software source OCID.
Future<ListSoftwareSourceVendorsResponse>	listSoftwareSourceVendors(ListSoftwareSourceVendorsRequest request, AsyncHandler<ListSoftwareSourceVendorsRequest,ListSoftwareSourceVendorsResponse> handler) Lists available software source vendors.
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.
Future<SearchSoftwareSourceModulesResponse>	searchSoftwareSourceModules(SearchSoftwareSourceModulesRequest request, AsyncHandler<SearchSoftwareSourceModulesRequest,SearchSoftwareSourceModulesResponse> handler) Lists modules from a list of software sources.
Future<SearchSoftwareSourceModuleStreamsResponse>	searchSoftwareSourceModuleStreams(SearchSoftwareSourceModuleStreamsRequest request, AsyncHandler<SearchSoftwareSourceModuleStreamsRequest,SearchSoftwareSourceModuleStreamsResponse> handler) Returns a list of module streams from the specified software sources.
Future<SearchSoftwareSourcePackageGroupsResponse>	searchSoftwareSourcePackageGroups(SearchSoftwareSourcePackageGroupsRequest request, AsyncHandler<SearchSoftwareSourcePackageGroupsRequest,SearchSoftwareSourcePackageGroupsResponse> handler) Searches the package groups from the specified list of software sources.
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’).
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
Future<UpdateSoftwareSourceResponse>	updateSoftwareSource(UpdateSoftwareSourceRequest request, AsyncHandler<UpdateSoftwareSourceRequest,UpdateSoftwareSourceResponse> handler) Updates the specified software source’s details, including but not limited to name, description, and tags.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

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.osmanagementhub.SoftwareSourceAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for SoftwareSource.

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

SoftwareSourceAsyncClient

@Deprecated
public SoftwareSourceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

SoftwareSourceAsyncClient

@Deprecated
public SoftwareSourceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                             ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

SoftwareSourceAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

SoftwareSourceAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

SoftwareSourceAsyncClient

@Deprecated
public SoftwareSourceAsyncClient(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 SoftwareSourceAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

SoftwareSourceAsyncClient

@Deprecated
public SoftwareSourceAsyncClient(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 SoftwareSourceAsyncClient.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)

SoftwareSourceAsyncClient

@Deprecated
public SoftwareSourceAsyncClient(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 SoftwareSourceAsyncClient.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

Method Detail

builder

public static SoftwareSourceAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: SoftwareSourceAsync

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 SoftwareSourceAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: SoftwareSourceAsync

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 SoftwareSourceAsync

Parameters:

regionId - The public region ID.

addPackagesToSoftwareSource

public Future<AddPackagesToSoftwareSourceResponse> addPackagesToSoftwareSource(AddPackagesToSoftwareSourceRequest request,
                                                                               AsyncHandler<AddPackagesToSoftwareSourceRequest,AddPackagesToSoftwareSourceResponse> handler)

Description copied from interface: SoftwareSourceAsync

Adds packages to a software source. This operation can only be done for custom and versioned custom software sources that are not created using filters. For a versioned custom software source, you can only add packages when the source is created. Once content is added to a versioned custom software source, it is immutable.

Specified by:

addPackagesToSoftwareSource in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

changeAvailabilityOfSoftwareSources

public Future<ChangeAvailabilityOfSoftwareSourcesResponse> changeAvailabilityOfSoftwareSources(ChangeAvailabilityOfSoftwareSourcesRequest request,
                                                                                               AsyncHandler<ChangeAvailabilityOfSoftwareSourcesRequest,ChangeAvailabilityOfSoftwareSourcesResponse> handler)

Description copied from interface: SoftwareSourceAsync

Updates the availability for a list of specified software sources.

Specified by:

changeAvailabilityOfSoftwareSources in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

changeSoftwareSourceCompartment

public Future<ChangeSoftwareSourceCompartmentResponse> changeSoftwareSourceCompartment(ChangeSoftwareSourceCompartmentRequest request,
                                                                                       AsyncHandler<ChangeSoftwareSourceCompartmentRequest,ChangeSoftwareSourceCompartmentResponse> handler)

Description copied from interface: SoftwareSourceAsync

Moves the specified software sources to a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Specified by:

changeSoftwareSourceCompartment in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createEntitlement

public Future<CreateEntitlementResponse> createEntitlement(CreateEntitlementRequest request,
                                                           AsyncHandler<CreateEntitlementRequest,CreateEntitlementResponse> handler)

Description copied from interface: SoftwareSourceAsync

Registers the necessary entitlement credentials for OS vendor software sources for a tenancy.

Specified by:

createEntitlement in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createSoftwareSource

public Future<CreateSoftwareSourceResponse> createSoftwareSource(CreateSoftwareSourceRequest request,
                                                                 AsyncHandler<CreateSoftwareSourceRequest,CreateSoftwareSourceResponse> handler)

Description copied from interface: SoftwareSourceAsync

Creates a new versioned or custom software source.

Specified by:

createSoftwareSource in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteSoftwareSource

public Future<DeleteSoftwareSourceResponse> deleteSoftwareSource(DeleteSoftwareSourceRequest request,
                                                                 AsyncHandler<DeleteSoftwareSourceRequest,DeleteSoftwareSourceResponse> handler)

Description copied from interface: SoftwareSourceAsync

Deletes the specified software source.

Specified by:

deleteSoftwareSource in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getErratum

public Future<GetErratumResponse> getErratum(GetErratumRequest request,
                                             AsyncHandler<GetErratumRequest,GetErratumResponse> handler)

Description copied from interface: SoftwareSourceAsync

Returns information about the specified erratum based on its advisory name.

Specified by:

getErratum in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getModuleStream

public Future<GetModuleStreamResponse> getModuleStream(GetModuleStreamRequest request,
                                                       AsyncHandler<GetModuleStreamRequest,GetModuleStreamResponse> handler)

Description copied from interface: SoftwareSourceAsync

Returns information about the specified module stream in a software source.

Specified by:

getModuleStream in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getModuleStreamProfile

public Future<GetModuleStreamProfileResponse> getModuleStreamProfile(GetModuleStreamProfileRequest request,
                                                                     AsyncHandler<GetModuleStreamProfileRequest,GetModuleStreamProfileResponse> handler)

Description copied from interface: SoftwareSourceAsync

Returns information about the specified module stream profile in a software source.

Specified by:

getModuleStreamProfile in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getPackageGroup

public Future<GetPackageGroupResponse> getPackageGroup(GetPackageGroupRequest request,
                                                       AsyncHandler<GetPackageGroupRequest,GetPackageGroupResponse> handler)

Description copied from interface: SoftwareSourceAsync

Returns information about the specified package group from a software source.

Specified by:

getPackageGroup in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getSoftwarePackage

public Future<GetSoftwarePackageResponse> getSoftwarePackage(GetSoftwarePackageRequest request,
                                                             AsyncHandler<GetSoftwarePackageRequest,GetSoftwarePackageResponse> handler)

Description copied from interface: SoftwareSourceAsync

Returns information about the specified software package.

Specified by:

getSoftwarePackage in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getSoftwarePackageByName

public Future<GetSoftwarePackageByNameResponse> getSoftwarePackageByName(GetSoftwarePackageByNameRequest request,
                                                                         AsyncHandler<GetSoftwarePackageByNameRequest,GetSoftwarePackageByNameResponse> handler)

Description copied from interface: SoftwareSourceAsync

Returns information about the specified software package based on its fully qualified name.

Specified by:

getSoftwarePackageByName in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getSoftwareSource

public Future<GetSoftwareSourceResponse> getSoftwareSource(GetSoftwareSourceRequest request,
                                                           AsyncHandler<GetSoftwareSourceRequest,GetSoftwareSourceResponse> handler)

Description copied from interface: SoftwareSourceAsync

Returns information about the specified software source.

Specified by:

getSoftwareSource in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listAllSoftwarePackages

public Future<ListAllSoftwarePackagesResponse> listAllSoftwarePackages(ListAllSoftwarePackagesRequest request,
                                                                       AsyncHandler<ListAllSoftwarePackagesRequest,ListAllSoftwarePackagesResponse> handler)

Description copied from interface: SoftwareSourceAsync

Lists software packages available through the OS Management Hub service. Filter the list against a variety of criteria including but not limited to its name.

Specified by:

listAllSoftwarePackages in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listEntitlements

public Future<ListEntitlementsResponse> listEntitlements(ListEntitlementsRequest request,
                                                         AsyncHandler<ListEntitlementsRequest,ListEntitlementsResponse> handler)

Description copied from interface: SoftwareSourceAsync

Lists entitlements in the specified tenancy OCID. Filter the list against a variety of criteria including but not limited to its Customer Support Identifier (CSI), and vendor name.

Specified by:

listEntitlements in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listErrata

public Future<ListErrataResponse> listErrata(ListErrataRequest request,
                                             AsyncHandler<ListErrataRequest,ListErrataResponse> handler)

Description copied from interface: SoftwareSourceAsync

Lists all of the currently available errata. Filter the list against a variety of criteria including but not limited to its name, classification type, advisory severity, and OS family.

Specified by:

listErrata in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listModuleStreamProfiles

public Future<ListModuleStreamProfilesResponse> listModuleStreamProfiles(ListModuleStreamProfilesRequest request,
                                                                         AsyncHandler<ListModuleStreamProfilesRequest,ListModuleStreamProfilesResponse> handler)

Description copied from interface: SoftwareSourceAsync

Lists module stream profiles from the specified software source OCID. Filter the list against a variety of criteria including but not limited to its module name, stream name, and profile name.

Specified by:

listModuleStreamProfiles in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listModuleStreams

public Future<ListModuleStreamsResponse> listModuleStreams(ListModuleStreamsRequest request,
                                                           AsyncHandler<ListModuleStreamsRequest,ListModuleStreamsResponse> handler)

Description copied from interface: SoftwareSourceAsync

Lists module streams from the specified software source OCID. Filter the list against a variety of criteria including but not limited to its module name and (stream) name.

Specified by:

listModuleStreams in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listPackageGroups

public Future<ListPackageGroupsResponse> listPackageGroups(ListPackageGroupsRequest request,
                                                           AsyncHandler<ListPackageGroupsRequest,ListPackageGroupsResponse> handler)

Description copied from interface: SoftwareSourceAsync

Lists package groups that are associated with the specified software source OCID. Filter the list against a variety of criteria including but not limited to its name, and package group type.

Specified by:

listPackageGroups in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listSoftwarePackageSoftwareSources

public Future<ListSoftwarePackageSoftwareSourcesResponse> listSoftwarePackageSoftwareSources(ListSoftwarePackageSoftwareSourcesRequest request,
                                                                                             AsyncHandler<ListSoftwarePackageSoftwareSourcesRequest,ListSoftwarePackageSoftwareSourcesResponse> handler)

Description copied from interface: SoftwareSourceAsync

Lists the software sources in the tenancy that contain the software package. Filter the list against a variety of criteria including but not limited to its name, type, architecture, and OS family.

Specified by:

listSoftwarePackageSoftwareSources in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listSoftwarePackages

public Future<ListSoftwarePackagesResponse> listSoftwarePackages(ListSoftwarePackagesRequest request,
                                                                 AsyncHandler<ListSoftwarePackagesRequest,ListSoftwarePackagesResponse> handler)

Description copied from interface: SoftwareSourceAsync

Lists software packages in the specified software source. Filter the list against a variety of criteria including but not limited to its name.

Specified by:

listSoftwarePackages in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listSoftwareSourceVendors

public Future<ListSoftwareSourceVendorsResponse> listSoftwareSourceVendors(ListSoftwareSourceVendorsRequest request,
                                                                           AsyncHandler<ListSoftwareSourceVendorsRequest,ListSoftwareSourceVendorsResponse> handler)

Description copied from interface: SoftwareSourceAsync

Lists available software source vendors. Filter the list against a variety of criteria including but not limited to its name.

Specified by:

listSoftwareSourceVendors in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listSoftwareSources

public Future<ListSoftwareSourcesResponse> listSoftwareSources(ListSoftwareSourcesRequest request,
                                                               AsyncHandler<ListSoftwareSourcesRequest,ListSoftwareSourcesResponse> handler)

Description copied from interface: SoftwareSourceAsync

Lists software sources that match the specified tenancy or software source OCID. Filter the list against a variety of criteria including but not limited to its name, status, architecture, and OS family.

Specified by:

listSoftwareSources in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

searchSoftwareSourceModuleStreams

public Future<SearchSoftwareSourceModuleStreamsResponse> searchSoftwareSourceModuleStreams(SearchSoftwareSourceModuleStreamsRequest request,
                                                                                           AsyncHandler<SearchSoftwareSourceModuleStreamsRequest,SearchSoftwareSourceModuleStreamsResponse> handler)

Description copied from interface: SoftwareSourceAsync

Returns a list of module streams from the specified software sources. Filter the list against a variety of criteria including the module name.

Specified by:

searchSoftwareSourceModuleStreams in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

searchSoftwareSourceModules

public Future<SearchSoftwareSourceModulesResponse> searchSoftwareSourceModules(SearchSoftwareSourceModulesRequest request,
                                                                               AsyncHandler<SearchSoftwareSourceModulesRequest,SearchSoftwareSourceModulesResponse> handler)

Description copied from interface: SoftwareSourceAsync

Lists modules from a list of software sources. Filter the list against a variety of criteria including the module name.

Specified by:

searchSoftwareSourceModules in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

searchSoftwareSourcePackageGroups

public Future<SearchSoftwareSourcePackageGroupsResponse> searchSoftwareSourcePackageGroups(SearchSoftwareSourcePackageGroupsRequest request,
                                                                                           AsyncHandler<SearchSoftwareSourcePackageGroupsRequest,SearchSoftwareSourcePackageGroupsResponse> handler)

Description copied from interface: SoftwareSourceAsync

Searches the package groups from the specified list of software sources. Filter the list against a variety of criteria including but not limited to its name, and group type.

Specified by:

searchSoftwareSourcePackageGroups in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateSoftwareSource

public Future<UpdateSoftwareSourceResponse> updateSoftwareSource(UpdateSoftwareSourceRequest request,
                                                                 AsyncHandler<UpdateSoftwareSourceRequest,UpdateSoftwareSourceResponse> handler)

Description copied from interface: SoftwareSourceAsync

Updates the specified software source’s details, including but not limited to name, description, and tags.

Specified by:

updateSoftwareSource in interface SoftwareSourceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

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()

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                           Supplier<RESP_BUILDER> responseBuilder)