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 SoftwareSourceAsyncAsync 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 anInputStream, 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 Description static classSoftwareSourceAsyncClient.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 SoftwareSource.
-
Constructor Summary
Constructors Constructor Description SoftwareSourceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.SoftwareSourceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.SoftwareSourceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.SoftwareSourceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.SoftwareSourceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.SoftwareSourceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.SoftwareSourceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
-
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.osmanagementhub.SoftwareSourceAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
SoftwareSourceAsyncClient
@Deprecated public SoftwareSourceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeSoftwareSourceAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
SoftwareSourceAsyncClient
@Deprecated public SoftwareSourceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeSoftwareSourceAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
SoftwareSourceAsyncClient
@Deprecated public SoftwareSourceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeSoftwareSourceAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
SoftwareSourceAsyncClient
@Deprecated public SoftwareSourceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeSoftwareSourceAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeSoftwareSourceAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
SoftwareSourceAsyncClient
@Deprecated public SoftwareSourceAsyncClient(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 (seeSoftwareSourceAsyncClient.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)
-
SoftwareSourceAsyncClient
@Deprecated public SoftwareSourceAsyncClient(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 (seeSoftwareSourceAsyncClient.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
-
-
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:SoftwareSourceAsyncSets 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.- Specified by:
setRegionin interfaceSoftwareSourceAsync- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:SoftwareSourceAsyncSets 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.- Specified by:
setRegionin interfaceSoftwareSourceAsync- Parameters:
regionId- The public region ID.
-
addPackagesToSoftwareSource
public Future<AddPackagesToSoftwareSourceResponse> addPackagesToSoftwareSource(AddPackagesToSoftwareSourceRequest request, AsyncHandler<AddPackagesToSoftwareSourceRequest,AddPackagesToSoftwareSourceResponse> handler)
Description copied from interface:SoftwareSourceAsyncAdds 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. Packages can be of the format: * name (for example: git). If isLatestContentOnly is true, only the latest version of the package will be added, otherwise all versions of the package will be added. * name-version-release.architecture (for example: git-2.43.5-1.el8_10.x86_64) * name-epoch:version-release.architecture (for example: git-0:2.43.5-1.el8_10.x86_64)
- Specified by:
addPackagesToSoftwareSourcein interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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:SoftwareSourceAsyncUpdates the availability for a list of specified software sources.- Specified by:
changeAvailabilityOfSoftwareSourcesin interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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:SoftwareSourceAsyncMoves 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:
changeSoftwareSourceCompartmentin interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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:SoftwareSourceAsyncRegisters the necessary entitlement credentials for OS vendor software sources for a tenancy.- Specified by:
createEntitlementin interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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:SoftwareSourceAsyncCreates a new software source.- Specified by:
createSoftwareSourcein interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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:SoftwareSourceAsyncDeletes the specified software source.- Specified by:
deleteSoftwareSourcein interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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:SoftwareSourceAsyncReturns information about the specified erratum based on its advisory name.- Specified by:
getErratumin interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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:SoftwareSourceAsyncReturns information about the specified module stream in a software source.- Specified by:
getModuleStreamin interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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:SoftwareSourceAsyncReturns information about the specified module stream profile in a software source.- Specified by:
getModuleStreamProfilein interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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:SoftwareSourceAsyncReturns information about the specified package group from a software source.- Specified by:
getPackageGroupin interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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:SoftwareSourceAsyncReturns information about the specified software package.- Specified by:
getSoftwarePackagein interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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:SoftwareSourceAsyncReturns information about the specified software package based on its fully qualified name (NVRA or NEVRA).- Specified by:
getSoftwarePackageByNamein interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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:SoftwareSourceAsyncReturns information about the specified software source.- Specified by:
getSoftwareSourcein interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
getSoftwareSourceManifest
public Future<GetSoftwareSourceManifestResponse> getSoftwareSourceManifest(GetSoftwareSourceManifestRequest request, AsyncHandler<GetSoftwareSourceManifestRequest,GetSoftwareSourceManifestResponse> handler)
Description copied from interface:SoftwareSourceAsyncReturns an archive containing the list of packages in the software source.- Specified by:
getSoftwareSourceManifestin interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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:SoftwareSourceAsyncLists 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:
listAllSoftwarePackagesin interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
listAvailableSoftwarePackages
public Future<ListAvailableSoftwarePackagesResponse> listAvailableSoftwarePackages(ListAvailableSoftwarePackagesRequest request, AsyncHandler<ListAvailableSoftwarePackagesRequest,ListAvailableSoftwarePackagesResponse> handler)
Description copied from interface:SoftwareSourceAsyncLists software packages that are available to be added to a custom software source of type MANIFEST.Filter the list against a variety of criteria including but not limited to its name.
- Specified by:
listAvailableSoftwarePackagesin interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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:SoftwareSourceAsyncLists 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:
listEntitlementsin interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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:SoftwareSourceAsyncLists 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:
listErratain interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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:SoftwareSourceAsyncLists 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:
listModuleStreamProfilesin interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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:SoftwareSourceAsyncLists 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:
listModuleStreamsin interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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:SoftwareSourceAsyncLists 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:
listPackageGroupsin interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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:SoftwareSourceAsyncLists 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:
listSoftwarePackageSoftwareSourcesin interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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:SoftwareSourceAsyncLists software packages in the specified software source.Filter the list against a variety of criteria including but not limited to its name.
- Specified by:
listSoftwarePackagesin interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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:SoftwareSourceAsyncLists available software source vendors.Filter the list against a variety of criteria including but not limited to its name.
- Specified by:
listSoftwareSourceVendorsin interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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:SoftwareSourceAsyncLists 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:
listSoftwareSourcesin interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
removePackagesFromSoftwareSource
public Future<RemovePackagesFromSoftwareSourceResponse> removePackagesFromSoftwareSource(RemovePackagesFromSoftwareSourceRequest request, AsyncHandler<RemovePackagesFromSoftwareSourceRequest,RemovePackagesFromSoftwareSourceResponse> handler)
Description copied from interface:SoftwareSourceAsyncRemoves packages from a software source.This operation can only be done for custom software sources that are not created using filters. Packages can be of the format: * name (for example: git). This removes all versions of the package. * name-version-release.architecture (for example: git-2.43.5-1.el8_10.x86_64) * name-epoch:version-release.architecture (for example: git-0:2.43.5-1.el8_10.x86_64)
- Specified by:
removePackagesFromSoftwareSourcein interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
replacePackagesInSoftwareSource
public Future<ReplacePackagesInSoftwareSourceResponse> replacePackagesInSoftwareSource(ReplacePackagesInSoftwareSourceRequest request, AsyncHandler<ReplacePackagesInSoftwareSourceRequest,ReplacePackagesInSoftwareSourceResponse> handler)
Description copied from interface:SoftwareSourceAsyncReplaces packages in a software source with the provided list of packages.This operation can only be done for custom software sources that are not created using filters. Packages can be of the format: * name (for example: git). If isLatestContentOnly is true, only the latest version of the package will be added, otherwise all versions of the package will be added. * name-version-release.architecture (for example: git-2.43.5-1.el8_10.x86_64) * name-epoch:version-release.architecture (for example: git-0:2.43.5-1.el8_10.x86_64)
- Specified by:
replacePackagesInSoftwareSourcein interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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:SoftwareSourceAsyncReturns a list of module streams from the specified software sources.Filter the list against a variety of criteria including the module name.
- Specified by:
searchSoftwareSourceModuleStreamsin interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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:SoftwareSourceAsyncLists modules from a list of software sources.Filter the list against a variety of criteria including the module name.
- Specified by:
searchSoftwareSourceModulesin interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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:SoftwareSourceAsyncSearches 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:
searchSoftwareSourcePackageGroupsin interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
softwareSourceGenerateMetadata
public Future<SoftwareSourceGenerateMetadataResponse> softwareSourceGenerateMetadata(SoftwareSourceGenerateMetadataRequest request, AsyncHandler<SoftwareSourceGenerateMetadataRequest,SoftwareSourceGenerateMetadataResponse> handler)
Description copied from interface:SoftwareSourceAsyncRegenerates metadata for the specified custom software source.- Specified by:
softwareSourceGenerateMetadatain interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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:SoftwareSourceAsyncUpdates the specified software source’s details, including but not limited to name, description, and tags.- Specified by:
updateSoftwareSourcein interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
updateSoftwareSourceManifest
public Future<UpdateSoftwareSourceManifestResponse> updateSoftwareSourceManifest(UpdateSoftwareSourceManifestRequest request, AsyncHandler<UpdateSoftwareSourceManifestRequest,UpdateSoftwareSourceManifestResponse> handler)
Description copied from interface:SoftwareSourceAsyncUpdates the package list document for the software source.- Specified by:
updateSoftwareSourceManifestin interfaceSoftwareSourceAsync- Parameters:
request- The request object containing the details to sendhandler- 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()
-
enableDualStackEndpoints
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
This method should be used to enable or disable the use of dual-stack endpoints.The default value is false i.e. dual-stack endpoints are disabled by default.
- Parameters:
enableDualStackEndpoints- This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
-
getOptionsMap
public Map<String,Boolean> getOptionsMap()
Return an immutable snapshot representing the current options set for this client.- Returns:
- immutable snapshot representing the current options set for this client
-
getResolvedEndpoint
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.- Parameters:
requiredParametersMap- the map from required parameter name to their values- Returns:
- resolved endpoint, with all options and placeholders filled in
-
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
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
Get the endpoint of the client.Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a
Region.Examples of endpoints this may return:
- Unparameterized endpoints
https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with placeholders
https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with options
https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com - Parameterized endpoints with placeholders and options
https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
To get the actual endpoint for a parameterized request, you can use
BaseClient.getResolvedEndpoint(Map)orParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).- Returns:
- the endpoint being used by the client
- Unparameterized endpoints
-
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()
-
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)
-
-