Class JavaDownloadAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.jmsjavadownloads.JavaDownloadAsyncClient
-
- All Implemented Interfaces:
JavaDownloadAsync
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20230601") public class JavaDownloadAsyncClient extends BaseAsyncClient implements JavaDownloadAsync
Async client implementation for JavaDownload 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 class
JavaDownloadAsyncClient.Builder
Builder class for this client.
-
Field Summary
Fields Modifier and Type Field 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 JavaDownload.
-
Constructor Summary
Constructors Constructor Description JavaDownloadAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.JavaDownloadAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.JavaDownloadAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.JavaDownloadAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.JavaDownloadAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.JavaDownloadAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.JavaDownloadAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
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.jmsjavadownloads.JavaDownloadAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
JavaDownloadAsyncClient
@Deprecated public JavaDownloadAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeJavaDownloadAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
JavaDownloadAsyncClient
@Deprecated public JavaDownloadAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeJavaDownloadAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
JavaDownloadAsyncClient
@Deprecated public JavaDownloadAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeJavaDownloadAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
JavaDownloadAsyncClient
@Deprecated public JavaDownloadAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeJavaDownloadAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
JavaDownloadAsyncClient
@Deprecated public JavaDownloadAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeJavaDownloadAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
JavaDownloadAsyncClient
@Deprecated public JavaDownloadAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeJavaDownloadAsyncClient.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)
-
JavaDownloadAsyncClient
@Deprecated public JavaDownloadAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeJavaDownloadAsyncClient.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 JavaDownloadAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:JavaDownloadAsync
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 interfaceJavaDownloadAsync
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:JavaDownloadAsync
Sets the region to call (ex, ‘us-phoenix-1’).Note, this will first try to map the region ID to a known Region and call
setRegion
.If no known Region could be determined, it will create an endpoint based on the default endpoint format (
Region.formatDefaultRegionEndpoint(Service, String)
and then callsetEndpoint
.- Specified by:
setRegion
in interfaceJavaDownloadAsync
- Parameters:
regionId
- The public region ID.
-
cancelWorkRequest
public Future<CancelWorkRequestResponse> cancelWorkRequest(CancelWorkRequestRequest request, AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler)
Description copied from interface:JavaDownloadAsync
Cancels the work request with the given ID.- Specified by:
cancelWorkRequest
in interfaceJavaDownloadAsync
- 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.
-
createJavaDownloadReport
public Future<CreateJavaDownloadReportResponse> createJavaDownloadReport(CreateJavaDownloadReportRequest request, AsyncHandler<CreateJavaDownloadReportRequest,CreateJavaDownloadReportResponse> handler)
Description copied from interface:JavaDownloadAsync
Create a new report in the specified format containing the download details for the tenancy.- Specified by:
createJavaDownloadReport
in interfaceJavaDownloadAsync
- 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.
-
createJavaDownloadToken
public Future<CreateJavaDownloadTokenResponse> createJavaDownloadToken(CreateJavaDownloadTokenRequest request, AsyncHandler<CreateJavaDownloadTokenRequest,CreateJavaDownloadTokenResponse> handler)
Description copied from interface:JavaDownloadAsync
Creates a new JavaDownloadToken in the tenancy with specified attributes.Ensure that you review the license terms before token generation. Visit the <a href="https://www.oracle.com/java/technologies/downloads"/>Oracle Java Downloads page to understand the license terms of the Java version for which you are generating a token. By generating a token, you agree to the associated license terms. See <a href="https://www.oracle.com/cis/java/technologies/javase/jdk-faqs.html">Oracle JDK Licensing - FAQs for detailed information.
- Specified by:
createJavaDownloadToken
in interfaceJavaDownloadAsync
- 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.
-
createJavaLicenseAcceptanceRecord
public Future<CreateJavaLicenseAcceptanceRecordResponse> createJavaLicenseAcceptanceRecord(CreateJavaLicenseAcceptanceRecordRequest request, AsyncHandler<CreateJavaLicenseAcceptanceRecordRequest,CreateJavaLicenseAcceptanceRecordResponse> handler)
Description copied from interface:JavaDownloadAsync
Creates a Java license acceptance record for the specified license type in a tenancy.- Specified by:
createJavaLicenseAcceptanceRecord
in interfaceJavaDownloadAsync
- 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.
-
deleteJavaDownloadReport
public Future<DeleteJavaDownloadReportResponse> deleteJavaDownloadReport(DeleteJavaDownloadReportRequest request, AsyncHandler<DeleteJavaDownloadReportRequest,DeleteJavaDownloadReportResponse> handler)
Description copied from interface:JavaDownloadAsync
Deletes a JavaDownloadReport resource by identifier.- Specified by:
deleteJavaDownloadReport
in interfaceJavaDownloadAsync
- 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.
-
deleteJavaDownloadToken
public Future<DeleteJavaDownloadTokenResponse> deleteJavaDownloadToken(DeleteJavaDownloadTokenRequest request, AsyncHandler<DeleteJavaDownloadTokenRequest,DeleteJavaDownloadTokenResponse> handler)
Description copied from interface:JavaDownloadAsync
Deletes a JavaDownloadToken resource by identifier.- Specified by:
deleteJavaDownloadToken
in interfaceJavaDownloadAsync
- 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.
-
deleteJavaLicenseAcceptanceRecord
public Future<DeleteJavaLicenseAcceptanceRecordResponse> deleteJavaLicenseAcceptanceRecord(DeleteJavaLicenseAcceptanceRecordRequest request, AsyncHandler<DeleteJavaLicenseAcceptanceRecordRequest,DeleteJavaLicenseAcceptanceRecordResponse> handler)
Description copied from interface:JavaDownloadAsync
Deletes a Java license acceptance record with the specified identifier.- Specified by:
deleteJavaLicenseAcceptanceRecord
in interfaceJavaDownloadAsync
- 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.
-
generateArtifactDownloadUrl
public Future<GenerateArtifactDownloadUrlResponse> generateArtifactDownloadUrl(GenerateArtifactDownloadUrlRequest request, AsyncHandler<GenerateArtifactDownloadUrlRequest,GenerateArtifactDownloadUrlResponse> handler)
Description copied from interface:JavaDownloadAsync
Generates a download URL and returns it in the response payload.The URL in the response can then be used for downloading the specific Java runtime artifact.
Use the
getJavaRelease
API to get information about available artifacts for a specific release. Each artifact is uniquely identified by an `artifactId`. ReferjavaArtifact
for more details.- Specified by:
generateArtifactDownloadUrl
in interfaceJavaDownloadAsync
- 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.
-
getJavaDownloadReport
public Future<GetJavaDownloadReportResponse> getJavaDownloadReport(GetJavaDownloadReportRequest request, AsyncHandler<GetJavaDownloadReportRequest,GetJavaDownloadReportResponse> handler)
Description copied from interface:JavaDownloadAsync
Gets a JavaDownloadReport by the specified identifier.- Specified by:
getJavaDownloadReport
in interfaceJavaDownloadAsync
- 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.
-
getJavaDownloadReportContent
public Future<GetJavaDownloadReportContentResponse> getJavaDownloadReportContent(GetJavaDownloadReportContentRequest request, AsyncHandler<GetJavaDownloadReportContentRequest,GetJavaDownloadReportContentResponse> handler)
Description copied from interface:JavaDownloadAsync
Retrieve a Java download report with the specified identifier.- Specified by:
getJavaDownloadReportContent
in interfaceJavaDownloadAsync
- 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.
-
getJavaDownloadToken
public Future<GetJavaDownloadTokenResponse> getJavaDownloadToken(GetJavaDownloadTokenRequest request, AsyncHandler<GetJavaDownloadTokenRequest,GetJavaDownloadTokenResponse> handler)
Description copied from interface:JavaDownloadAsync
Gets a JavaDownloadToken by identifier- Specified by:
getJavaDownloadToken
in interfaceJavaDownloadAsync
- 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.
-
getJavaLicense
public Future<GetJavaLicenseResponse> getJavaLicense(GetJavaLicenseRequest request, AsyncHandler<GetJavaLicenseRequest,GetJavaLicenseResponse> handler)
Description copied from interface:JavaDownloadAsync
Return details of the specified Java license type.- Specified by:
getJavaLicense
in interfaceJavaDownloadAsync
- 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.
-
getJavaLicenseAcceptanceRecord
public Future<GetJavaLicenseAcceptanceRecordResponse> getJavaLicenseAcceptanceRecord(GetJavaLicenseAcceptanceRecordRequest request, AsyncHandler<GetJavaLicenseAcceptanceRecordRequest,GetJavaLicenseAcceptanceRecordResponse> handler)
Description copied from interface:JavaDownloadAsync
Returns a specific Java license acceptance record in a tenancy.- Specified by:
getJavaLicenseAcceptanceRecord
in interfaceJavaDownloadAsync
- 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.
-
getWorkRequest
public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
Description copied from interface:JavaDownloadAsync
Gets details of the work request with the given ID.- Specified by:
getWorkRequest
in interfaceJavaDownloadAsync
- 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.
-
listJavaDownloadRecords
public Future<ListJavaDownloadRecordsResponse> listJavaDownloadRecords(ListJavaDownloadRecordsRequest request, AsyncHandler<ListJavaDownloadRecordsRequest,ListJavaDownloadRecordsResponse> handler)
Description copied from interface:JavaDownloadAsync
Returns a list of Java download records in a tenancy based on specified parameters.See
listJavaReleases
for possible values ofjavaFamilyVersion
andjavaReleaseVersion
parameters.- Specified by:
listJavaDownloadRecords
in interfaceJavaDownloadAsync
- 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.
-
listJavaDownloadReports
public Future<ListJavaDownloadReportsResponse> listJavaDownloadReports(ListJavaDownloadReportsRequest request, AsyncHandler<ListJavaDownloadReportsRequest,ListJavaDownloadReportsResponse> handler)
Description copied from interface:JavaDownloadAsync
Returns a list of JavaDownloadReports.- Specified by:
listJavaDownloadReports
in interfaceJavaDownloadAsync
- 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.
-
listJavaDownloadTokens
public Future<ListJavaDownloadTokensResponse> listJavaDownloadTokens(ListJavaDownloadTokensRequest request, AsyncHandler<ListJavaDownloadTokensRequest,ListJavaDownloadTokensResponse> handler)
Description copied from interface:JavaDownloadAsync
Returns a list of JavaDownloadTokens.- Specified by:
listJavaDownloadTokens
in interfaceJavaDownloadAsync
- 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.
-
listJavaLicenseAcceptanceRecords
public Future<ListJavaLicenseAcceptanceRecordsResponse> listJavaLicenseAcceptanceRecords(ListJavaLicenseAcceptanceRecordsRequest request, AsyncHandler<ListJavaLicenseAcceptanceRecordsRequest,ListJavaLicenseAcceptanceRecordsResponse> handler)
Description copied from interface:JavaDownloadAsync
Returns a list of all the Java license acceptance records in a tenancy.- Specified by:
listJavaLicenseAcceptanceRecords
in interfaceJavaDownloadAsync
- 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.
-
listJavaLicenses
public Future<ListJavaLicensesResponse> listJavaLicenses(ListJavaLicensesRequest request, AsyncHandler<ListJavaLicensesRequest,ListJavaLicensesResponse> handler)
Description copied from interface:JavaDownloadAsync
Return a list with details of all Java licenses.- Specified by:
listJavaLicenses
in interfaceJavaDownloadAsync
- 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.
-
listWorkRequestErrors
public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
Description copied from interface:JavaDownloadAsync
Returns a (paginated) list of errors for the work request with the given ID.- Specified by:
listWorkRequestErrors
in interfaceJavaDownloadAsync
- 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.
-
listWorkRequestLogs
public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
Description copied from interface:JavaDownloadAsync
Returns a (paginated) list of logs for the work request with the given ID.- Specified by:
listWorkRequestLogs
in interfaceJavaDownloadAsync
- 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.
-
listWorkRequests
public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
Description copied from interface:JavaDownloadAsync
Lists the work requests in a tenancy.- Specified by:
listWorkRequests
in interfaceJavaDownloadAsync
- 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.
-
requestSummarizedJavaDownloadCounts
public Future<RequestSummarizedJavaDownloadCountsResponse> requestSummarizedJavaDownloadCounts(RequestSummarizedJavaDownloadCountsRequest request, AsyncHandler<RequestSummarizedJavaDownloadCountsRequest,RequestSummarizedJavaDownloadCountsResponse> handler)
Description copied from interface:JavaDownloadAsync
Returns list of download counts grouped by the specified property.- Specified by:
requestSummarizedJavaDownloadCounts
in interfaceJavaDownloadAsync
- 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.
-
updateJavaDownloadToken
public Future<UpdateJavaDownloadTokenResponse> updateJavaDownloadToken(UpdateJavaDownloadTokenRequest request, AsyncHandler<UpdateJavaDownloadTokenRequest,UpdateJavaDownloadTokenResponse> handler)
Description copied from interface:JavaDownloadAsync
Updates the JavaDownloadToken specified by the identifier.- Specified by:
updateJavaDownloadToken
in interfaceJavaDownloadAsync
- 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.
-
updateJavaLicenseAcceptanceRecord
public Future<UpdateJavaLicenseAcceptanceRecordResponse> updateJavaLicenseAcceptanceRecord(UpdateJavaLicenseAcceptanceRecordRequest request, AsyncHandler<UpdateJavaLicenseAcceptanceRecordRequest,UpdateJavaLicenseAcceptanceRecordResponse> handler)
Description copied from interface:JavaDownloadAsync
Updates a specific Java license acceptance record in a tenancy.- Specified by:
updateJavaLicenseAcceptanceRecord
in interfaceJavaDownloadAsync
- 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()
-
useRealmSpecificEndpointTemplate
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
- Parameters:
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
-
populateServiceParametersInEndpoint
public final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
- Parameters:
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or query parameter as value
-
updateBaseEndpoint
public final void updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.This does not include {region} and {secondLevelDomain} parameters.
- Parameters:
endpoint
- The updated endpoint to use
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in 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)
-
-