All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.oracle.bmc.apigateway.WorkRequestsAsyncClient Maven / Gradle / Ivy

There is a newer version: 3.55.1
Show newest version
/**
 * Copyright (c) 2016, 2024, Oracle and/or its affiliates.  All rights reserved.
 * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
 */
package com.oracle.bmc.apigateway;

import com.oracle.bmc.util.internal.Validate;
import com.oracle.bmc.apigateway.requests.*;
import com.oracle.bmc.apigateway.responses.*;

import java.util.Objects;

/**
 * Async client implementation for WorkRequests service. 
* There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response * to the call is an {@link java.io.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 */ @jakarta.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20190501") public class WorkRequestsAsyncClient extends com.oracle.bmc.http.internal.BaseAsyncClient implements WorkRequestsAsync { /** Service instance for WorkRequests. */ public static final com.oracle.bmc.Service SERVICE = com.oracle.bmc.Services.serviceBuilder() .serviceName("WORKREQUESTS") .serviceEndpointPrefix("") .serviceEndpointTemplate("https://apigateway.{region}.oci.{secondLevelDomain}") .build(); private static final org.slf4j.Logger LOG = org.slf4j.LoggerFactory.getLogger(WorkRequestsAsyncClient.class); WorkRequestsAsyncClient( com.oracle.bmc.common.ClientBuilderBase builder, com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider) { super(builder, authenticationDetailsProvider); } /** * Create a builder for this client. * * @return builder */ public static Builder builder() { return new Builder(SERVICE); } /** * Builder class for this client. The "authenticationDetailsProvider" is required and must be * passed to the {@link #build(AbstractAuthenticationDetailsProvider)} method. */ public static class Builder extends com.oracle.bmc.common.RegionalClientBuilder { private Builder(com.oracle.bmc.Service service) { super(service); final String packageName = "apigateway"; com.oracle.bmc.internal.Alloy.throwDisabledServiceExceptionIfAppropriate(packageName); requestSignerFactory = new com.oracle.bmc.http.signing.internal.DefaultRequestSignerFactory( com.oracle.bmc.http.signing.SigningStrategy.STANDARD); } /** * Build the client. * * @param authenticationDetailsProvider authentication details provider * @return the client */ public WorkRequestsAsyncClient build( @jakarta.annotation.Nonnull com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider) { return new WorkRequestsAsyncClient(this, authenticationDetailsProvider); } } @Override public void setRegion(com.oracle.bmc.Region region) { super.setRegion(region); } @Override public void setRegion(String regionId) { super.setRegion(regionId); } @Override public java.util.concurrent.Future cancelWorkRequest( CancelWorkRequestRequest request, final com.oracle.bmc.responses.AsyncHandler< CancelWorkRequestRequest, CancelWorkRequestResponse> handler) { Validate.notBlank(request.getWorkRequestId(), "workRequestId must not be blank"); return clientCall(request, CancelWorkRequestResponse::builder) .logger(LOG, "cancelWorkRequest") .serviceDetails( "WorkRequests", "CancelWorkRequest", "https://docs.oracle.com/iaas/api/#/en/api-gateway/20190501/WorkRequest/CancelWorkRequest") .method(com.oracle.bmc.http.client.Method.DELETE) .requestBuilder(CancelWorkRequestRequest::builder) .basePath("/20190501") .appendPathParam("workRequests") .appendPathParam(request.getWorkRequestId()) .accept("application/json") .appendHeader("opc-retry-token", request.getOpcRetryToken()) .appendHeader("if-match", request.getIfMatch()) .appendHeader("opc-request-id", request.getOpcRequestId()) .handleResponseHeaderString( "opc-request-id", CancelWorkRequestResponse.Builder::opcRequestId) .callAsync(handler); } @Override public java.util.concurrent.Future getWorkRequest( GetWorkRequestRequest request, final com.oracle.bmc.responses.AsyncHandler< GetWorkRequestRequest, GetWorkRequestResponse> handler) { Validate.notBlank(request.getWorkRequestId(), "workRequestId must not be blank"); return clientCall(request, GetWorkRequestResponse::builder) .logger(LOG, "getWorkRequest") .serviceDetails( "WorkRequests", "GetWorkRequest", "https://docs.oracle.com/iaas/api/#/en/api-gateway/20190501/WorkRequest/GetWorkRequest") .method(com.oracle.bmc.http.client.Method.GET) .requestBuilder(GetWorkRequestRequest::builder) .basePath("/20190501") .appendPathParam("workRequests") .appendPathParam(request.getWorkRequestId()) .accept("application/json") .appendHeader("opc-request-id", request.getOpcRequestId()) .handleBody( com.oracle.bmc.apigateway.model.WorkRequest.class, GetWorkRequestResponse.Builder::workRequest) .handleResponseHeaderString("etag", GetWorkRequestResponse.Builder::etag) .handleResponseHeaderString( "opc-request-id", GetWorkRequestResponse.Builder::opcRequestId) .handleResponseHeaderBigDecimal( "retry-after", GetWorkRequestResponse.Builder::retryAfter) .callAsync(handler); } @Override public java.util.concurrent.Future listWorkRequestErrors( ListWorkRequestErrorsRequest request, final com.oracle.bmc.responses.AsyncHandler< ListWorkRequestErrorsRequest, ListWorkRequestErrorsResponse> handler) { Validate.notBlank(request.getWorkRequestId(), "workRequestId must not be blank"); return clientCall(request, ListWorkRequestErrorsResponse::builder) .logger(LOG, "listWorkRequestErrors") .serviceDetails( "WorkRequests", "ListWorkRequestErrors", "https://docs.oracle.com/iaas/api/#/en/api-gateway/20190501/WorkRequestError/ListWorkRequestErrors") .method(com.oracle.bmc.http.client.Method.GET) .requestBuilder(ListWorkRequestErrorsRequest::builder) .basePath("/20190501") .appendPathParam("workRequests") .appendPathParam(request.getWorkRequestId()) .appendPathParam("errors") .appendQueryParam("page", request.getPage()) .appendQueryParam("limit", request.getLimit()) .appendEnumQueryParam("sortOrder", request.getSortOrder()) .appendEnumQueryParam("sortBy", request.getSortBy()) .accept("application/json") .appendHeader("opc-request-id", request.getOpcRequestId()) .handleBody( com.oracle.bmc.apigateway.model.WorkRequestErrorCollection.class, ListWorkRequestErrorsResponse.Builder::workRequestErrorCollection) .handleResponseHeaderString( "opc-next-page", ListWorkRequestErrorsResponse.Builder::opcNextPage) .handleResponseHeaderString( "opc-prev-page", ListWorkRequestErrorsResponse.Builder::opcPrevPage) .handleResponseHeaderString( "opc-request-id", ListWorkRequestErrorsResponse.Builder::opcRequestId) .callAsync(handler); } @Override public java.util.concurrent.Future listWorkRequestLogs( ListWorkRequestLogsRequest request, final com.oracle.bmc.responses.AsyncHandler< ListWorkRequestLogsRequest, ListWorkRequestLogsResponse> handler) { Validate.notBlank(request.getWorkRequestId(), "workRequestId must not be blank"); return clientCall(request, ListWorkRequestLogsResponse::builder) .logger(LOG, "listWorkRequestLogs") .serviceDetails( "WorkRequests", "ListWorkRequestLogs", "https://docs.oracle.com/iaas/api/#/en/api-gateway/20190501/WorkRequestLog/ListWorkRequestLogs") .method(com.oracle.bmc.http.client.Method.GET) .requestBuilder(ListWorkRequestLogsRequest::builder) .basePath("/20190501") .appendPathParam("workRequests") .appendPathParam(request.getWorkRequestId()) .appendPathParam("logs") .appendQueryParam("page", request.getPage()) .appendQueryParam("limit", request.getLimit()) .appendEnumQueryParam("sortOrder", request.getSortOrder()) .appendEnumQueryParam("sortBy", request.getSortBy()) .accept("application/json") .appendHeader("opc-request-id", request.getOpcRequestId()) .handleBody( com.oracle.bmc.apigateway.model.WorkRequestLogCollection.class, ListWorkRequestLogsResponse.Builder::workRequestLogCollection) .handleResponseHeaderString( "opc-next-page", ListWorkRequestLogsResponse.Builder::opcNextPage) .handleResponseHeaderString( "opc-prev-page", ListWorkRequestLogsResponse.Builder::opcPrevPage) .handleResponseHeaderString( "opc-request-id", ListWorkRequestLogsResponse.Builder::opcRequestId) .callAsync(handler); } @Override public java.util.concurrent.Future listWorkRequests( ListWorkRequestsRequest request, final com.oracle.bmc.responses.AsyncHandler< ListWorkRequestsRequest, ListWorkRequestsResponse> handler) { Objects.requireNonNull(request.getCompartmentId(), "compartmentId is required"); return clientCall(request, ListWorkRequestsResponse::builder) .logger(LOG, "listWorkRequests") .serviceDetails( "WorkRequests", "ListWorkRequests", "https://docs.oracle.com/iaas/api/#/en/api-gateway/20190501/WorkRequestSummary/ListWorkRequests") .method(com.oracle.bmc.http.client.Method.GET) .requestBuilder(ListWorkRequestsRequest::builder) .basePath("/20190501") .appendPathParam("workRequests") .appendQueryParam("compartmentId", request.getCompartmentId()) .appendQueryParam("resourceId", request.getResourceId()) .appendQueryParam("page", request.getPage()) .appendQueryParam("limit", request.getLimit()) .appendEnumQueryParam("sortOrder", request.getSortOrder()) .appendEnumQueryParam("sortBy", request.getSortBy()) .accept("application/json") .appendHeader("opc-request-id", request.getOpcRequestId()) .handleBody( com.oracle.bmc.apigateway.model.WorkRequestCollection.class, ListWorkRequestsResponse.Builder::workRequestCollection) .handleResponseHeaderString( "opc-request-id", ListWorkRequestsResponse.Builder::opcRequestId) .handleResponseHeaderString( "opc-next-page", ListWorkRequestsResponse.Builder::opcNextPage) .handleResponseHeaderString( "opc-prev-page", ListWorkRequestsResponse.Builder::opcPrevPage) .callAsync(handler); } /** * Create a new client instance. * * @param authenticationDetailsProvider The authentication details (see {@link Builder#build}) * @deprecated Use the {@link #builder() builder} instead. */ @Deprecated public WorkRequestsAsyncClient( com.oracle.bmc.auth.BasicAuthenticationDetailsProvider authenticationDetailsProvider) { this(builder(), authenticationDetailsProvider); } /** * Create a new client instance. * * @param authenticationDetailsProvider The authentication details (see {@link Builder#build}) * @param configuration {@link Builder#configuration} * @deprecated Use the {@link #builder() builder} instead. */ @Deprecated public WorkRequestsAsyncClient( com.oracle.bmc.auth.BasicAuthenticationDetailsProvider authenticationDetailsProvider, com.oracle.bmc.ClientConfiguration configuration) { this(builder().configuration(configuration), authenticationDetailsProvider); } /** * Create a new client instance. * * @param authenticationDetailsProvider The authentication details (see {@link Builder#build}) * @param configuration {@link Builder#configuration} * @param clientConfigurator {@link Builder#clientConfigurator} * @deprecated Use the {@link #builder() builder} instead. */ @Deprecated public WorkRequestsAsyncClient( com.oracle.bmc.auth.BasicAuthenticationDetailsProvider authenticationDetailsProvider, com.oracle.bmc.ClientConfiguration configuration, com.oracle.bmc.http.ClientConfigurator clientConfigurator) { this( builder().configuration(configuration).clientConfigurator(clientConfigurator), authenticationDetailsProvider); } /** * Create a new client instance. * * @param authenticationDetailsProvider The authentication details (see {@link Builder#build}) * @param configuration {@link Builder#configuration} * @param clientConfigurator {@link Builder#clientConfigurator} * @param defaultRequestSignerFactory {@link Builder#requestSignerFactory} * @deprecated Use the {@link #builder() builder} instead. */ @Deprecated public WorkRequestsAsyncClient( com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider, com.oracle.bmc.ClientConfiguration configuration, com.oracle.bmc.http.ClientConfigurator clientConfigurator, com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory) { this( builder() .configuration(configuration) .clientConfigurator(clientConfigurator) .requestSignerFactory(defaultRequestSignerFactory), authenticationDetailsProvider); } /** * Create a new client instance. * * @param authenticationDetailsProvider The authentication details (see {@link Builder#build}) * @param configuration {@link Builder#configuration} * @param clientConfigurator {@link Builder#clientConfigurator} * @param defaultRequestSignerFactory {@link Builder#requestSignerFactory} * @param additionalClientConfigurators {@link Builder#additionalClientConfigurators} * @deprecated Use the {@link #builder() builder} instead. */ @Deprecated public WorkRequestsAsyncClient( com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider, com.oracle.bmc.ClientConfiguration configuration, com.oracle.bmc.http.ClientConfigurator clientConfigurator, com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory, java.util.List additionalClientConfigurators) { this( builder() .configuration(configuration) .clientConfigurator(clientConfigurator) .requestSignerFactory(defaultRequestSignerFactory) .additionalClientConfigurators(additionalClientConfigurators), authenticationDetailsProvider); } /** * Create a new client instance. * * @param authenticationDetailsProvider The authentication details (see {@link Builder#build}) * @param configuration {@link Builder#configuration} * @param clientConfigurator {@link Builder#clientConfigurator} * @param defaultRequestSignerFactory {@link Builder#requestSignerFactory} * @param additionalClientConfigurators {@link Builder#additionalClientConfigurators} * @param endpoint {@link Builder#endpoint} * @deprecated Use the {@link #builder() builder} instead. */ @Deprecated public WorkRequestsAsyncClient( com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider, com.oracle.bmc.ClientConfiguration configuration, com.oracle.bmc.http.ClientConfigurator clientConfigurator, com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory, java.util.List additionalClientConfigurators, String endpoint) { this( builder() .configuration(configuration) .clientConfigurator(clientConfigurator) .requestSignerFactory(defaultRequestSignerFactory) .additionalClientConfigurators(additionalClientConfigurators) .endpoint(endpoint), authenticationDetailsProvider); } /** * Create a new client instance. * * @param authenticationDetailsProvider The authentication details (see {@link Builder#build}) * @param configuration {@link Builder#configuration} * @param clientConfigurator {@link Builder#clientConfigurator} * @param defaultRequestSignerFactory {@link Builder#requestSignerFactory} * @param additionalClientConfigurators {@link Builder#additionalClientConfigurators} * @param endpoint {@link Builder#endpoint} * @param signingStrategyRequestSignerFactories {@link * Builder#signingStrategyRequestSignerFactories} * @deprecated Use the {@link #builder() builder} instead. */ @Deprecated public WorkRequestsAsyncClient( com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider, com.oracle.bmc.ClientConfiguration configuration, com.oracle.bmc.http.ClientConfigurator clientConfigurator, com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory, java.util.Map< com.oracle.bmc.http.signing.SigningStrategy, com.oracle.bmc.http.signing.RequestSignerFactory> signingStrategyRequestSignerFactories, java.util.List additionalClientConfigurators, String endpoint) { this( builder() .configuration(configuration) .clientConfigurator(clientConfigurator) .requestSignerFactory(defaultRequestSignerFactory) .additionalClientConfigurators(additionalClientConfigurators) .endpoint(endpoint) .signingStrategyRequestSignerFactories( signingStrategyRequestSignerFactories), authenticationDetailsProvider); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy