software.amazon.awssdk.services.cloud9.Cloud9AsyncClient Maven / Gradle / Ivy
Show all versions of cloud9 Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.cloud9;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.services.cloud9.model.CreateEnvironmentEc2Request;
import software.amazon.awssdk.services.cloud9.model.CreateEnvironmentEc2Response;
import software.amazon.awssdk.services.cloud9.model.CreateEnvironmentMembershipRequest;
import software.amazon.awssdk.services.cloud9.model.CreateEnvironmentMembershipResponse;
import software.amazon.awssdk.services.cloud9.model.DeleteEnvironmentMembershipRequest;
import software.amazon.awssdk.services.cloud9.model.DeleteEnvironmentMembershipResponse;
import software.amazon.awssdk.services.cloud9.model.DeleteEnvironmentRequest;
import software.amazon.awssdk.services.cloud9.model.DeleteEnvironmentResponse;
import software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest;
import software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsResponse;
import software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentStatusRequest;
import software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentStatusResponse;
import software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentsRequest;
import software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentsResponse;
import software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest;
import software.amazon.awssdk.services.cloud9.model.ListEnvironmentsResponse;
import software.amazon.awssdk.services.cloud9.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.cloud9.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.cloud9.model.TagResourceRequest;
import software.amazon.awssdk.services.cloud9.model.TagResourceResponse;
import software.amazon.awssdk.services.cloud9.model.UntagResourceRequest;
import software.amazon.awssdk.services.cloud9.model.UntagResourceResponse;
import software.amazon.awssdk.services.cloud9.model.UpdateEnvironmentMembershipRequest;
import software.amazon.awssdk.services.cloud9.model.UpdateEnvironmentMembershipResponse;
import software.amazon.awssdk.services.cloud9.model.UpdateEnvironmentRequest;
import software.amazon.awssdk.services.cloud9.model.UpdateEnvironmentResponse;
import software.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsPublisher;
import software.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsPublisher;
/**
* Service client for accessing AWS Cloud9 asynchronously. This can be created using the static {@link #builder()}
* method.The asynchronous client performs non-blocking I/O when configured with any {@code SdkAsyncHttpClient}
* supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
* some cases such as credentials retrieval and endpoint discovery as part of the async API call.
*
* Cloud9
*
* Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and release software in the cloud.
*
*
* For more information about Cloud9, see the Cloud9 User
* Guide.
*
*
* Cloud9 supports these operations:
*
*
* -
*
* CreateEnvironmentEC2: Creates an Cloud9 development environment, launches an Amazon EC2 instance, and
* then connects from the instance to the environment.
*
*
* -
*
* CreateEnvironmentMembership: Adds an environment member to an environment.
*
*
* -
*
* DeleteEnvironment: Deletes an environment. If an Amazon EC2 instance is connected to the environment,
* also terminates the instance.
*
*
* -
*
* DeleteEnvironmentMembership: Deletes an environment member from an environment.
*
*
* -
*
* DescribeEnvironmentMemberships: Gets information about environment members for an environment.
*
*
* -
*
* DescribeEnvironments: Gets information about environments.
*
*
* -
*
* DescribeEnvironmentStatus: Gets status information for an environment.
*
*
* -
*
* ListEnvironments: Gets a list of environment identifiers.
*
*
* -
*
* ListTagsForResource: Gets the tags for an environment.
*
*
* -
*
* TagResource: Adds tags to an environment.
*
*
* -
*
* UntagResource: Removes tags from an environment.
*
*
* -
*
* UpdateEnvironment: Changes the settings of an existing environment.
*
*
* -
*
* UpdateEnvironmentMembership: Changes the settings of an existing environment member for an environment.
*
*
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface Cloud9AsyncClient extends AwsClient {
String SERVICE_NAME = "cloud9";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "cloud9";
/**
*
* Creates an Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and
* then connects from the instance to the environment.
*
*
* @param createEnvironmentEc2Request
* @return A Java Future containing the result of the CreateEnvironmentEC2 operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.CreateEnvironmentEC2
* @see AWS
* API Documentation
*/
default CompletableFuture createEnvironmentEC2(
CreateEnvironmentEc2Request createEnvironmentEc2Request) {
throw new UnsupportedOperationException();
}
/**
*
* Creates an Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and
* then connects from the instance to the environment.
*
*
*
* This is a convenience which creates an instance of the {@link CreateEnvironmentEc2Request.Builder} avoiding the
* need to create one manually via {@link CreateEnvironmentEc2Request#builder()}
*
*
* @param createEnvironmentEc2Request
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloud9.model.CreateEnvironmentEc2Request.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateEnvironmentEC2 operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.CreateEnvironmentEC2
* @see AWS
* API Documentation
*/
default CompletableFuture createEnvironmentEC2(
Consumer createEnvironmentEc2Request) {
return createEnvironmentEC2(CreateEnvironmentEc2Request.builder().applyMutation(createEnvironmentEc2Request).build());
}
/**
*
* Adds an environment member to an Cloud9 development environment.
*
*
* @param createEnvironmentMembershipRequest
* @return A Java Future containing the result of the CreateEnvironmentMembership operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.CreateEnvironmentMembership
* @see AWS API Documentation
*/
default CompletableFuture createEnvironmentMembership(
CreateEnvironmentMembershipRequest createEnvironmentMembershipRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Adds an environment member to an Cloud9 development environment.
*
*
*
* This is a convenience which creates an instance of the {@link CreateEnvironmentMembershipRequest.Builder}
* avoiding the need to create one manually via {@link CreateEnvironmentMembershipRequest#builder()}
*
*
* @param createEnvironmentMembershipRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloud9.model.CreateEnvironmentMembershipRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the CreateEnvironmentMembership operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.CreateEnvironmentMembership
* @see AWS API Documentation
*/
default CompletableFuture createEnvironmentMembership(
Consumer createEnvironmentMembershipRequest) {
return createEnvironmentMembership(CreateEnvironmentMembershipRequest.builder()
.applyMutation(createEnvironmentMembershipRequest).build());
}
/**
*
* Deletes an Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also
* terminates the instance.
*
*
* @param deleteEnvironmentRequest
* @return A Java Future containing the result of the DeleteEnvironment operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.DeleteEnvironment
* @see AWS API
* Documentation
*/
default CompletableFuture deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also
* terminates the instance.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteEnvironmentRequest.Builder} avoiding the need
* to create one manually via {@link DeleteEnvironmentRequest#builder()}
*
*
* @param deleteEnvironmentRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloud9.model.DeleteEnvironmentRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteEnvironment operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.DeleteEnvironment
* @see AWS API
* Documentation
*/
default CompletableFuture deleteEnvironment(
Consumer deleteEnvironmentRequest) {
return deleteEnvironment(DeleteEnvironmentRequest.builder().applyMutation(deleteEnvironmentRequest).build());
}
/**
*
* Deletes an environment member from a development environment.
*
*
* @param deleteEnvironmentMembershipRequest
* @return A Java Future containing the result of the DeleteEnvironmentMembership operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.DeleteEnvironmentMembership
* @see AWS API Documentation
*/
default CompletableFuture deleteEnvironmentMembership(
DeleteEnvironmentMembershipRequest deleteEnvironmentMembershipRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an environment member from a development environment.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteEnvironmentMembershipRequest.Builder}
* avoiding the need to create one manually via {@link DeleteEnvironmentMembershipRequest#builder()}
*
*
* @param deleteEnvironmentMembershipRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloud9.model.DeleteEnvironmentMembershipRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the DeleteEnvironmentMembership operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.DeleteEnvironmentMembership
* @see AWS API Documentation
*/
default CompletableFuture deleteEnvironmentMembership(
Consumer deleteEnvironmentMembershipRequest) {
return deleteEnvironmentMembership(DeleteEnvironmentMembershipRequest.builder()
.applyMutation(deleteEnvironmentMembershipRequest).build());
}
/**
*
* Gets information about environment members for an Cloud9 development environment.
*
*
* @param describeEnvironmentMembershipsRequest
* @return A Java Future containing the result of the DescribeEnvironmentMemberships operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.DescribeEnvironmentMemberships
* @see AWS API Documentation
*/
default CompletableFuture describeEnvironmentMemberships(
DescribeEnvironmentMembershipsRequest describeEnvironmentMembershipsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about environment members for an Cloud9 development environment.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeEnvironmentMembershipsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeEnvironmentMembershipsRequest#builder()}
*
*
* @param describeEnvironmentMembershipsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DescribeEnvironmentMemberships operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.DescribeEnvironmentMemberships
* @see AWS API Documentation
*/
default CompletableFuture describeEnvironmentMemberships(
Consumer describeEnvironmentMembershipsRequest) {
return describeEnvironmentMemberships(DescribeEnvironmentMembershipsRequest.builder()
.applyMutation(describeEnvironmentMembershipsRequest).build());
}
/**
*
* Gets information about environment members for an Cloud9 development environment.
*
*
* @return A Java Future containing the result of the DescribeEnvironmentMemberships operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.DescribeEnvironmentMemberships
* @see AWS API Documentation
*/
default CompletableFuture describeEnvironmentMemberships() {
return describeEnvironmentMemberships(DescribeEnvironmentMembershipsRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #describeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsPublisher publisher = client.describeEnvironmentMembershipsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsPublisher publisher = client.describeEnvironmentMembershipsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest)}
* operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.DescribeEnvironmentMemberships
* @see AWS API Documentation
*/
default DescribeEnvironmentMembershipsPublisher describeEnvironmentMembershipsPaginator() {
return describeEnvironmentMembershipsPaginator(DescribeEnvironmentMembershipsRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #describeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsPublisher publisher = client.describeEnvironmentMembershipsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsPublisher publisher = client.describeEnvironmentMembershipsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest)}
* operation.
*
*
* @param describeEnvironmentMembershipsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.DescribeEnvironmentMemberships
* @see AWS API Documentation
*/
default DescribeEnvironmentMembershipsPublisher describeEnvironmentMembershipsPaginator(
DescribeEnvironmentMembershipsRequest describeEnvironmentMembershipsRequest) {
return new DescribeEnvironmentMembershipsPublisher(this, describeEnvironmentMembershipsRequest);
}
/**
*
* This is a variant of
* {@link #describeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsPublisher publisher = client.describeEnvironmentMembershipsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsPublisher publisher = client.describeEnvironmentMembershipsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeEnvironmentMembershipsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeEnvironmentMembershipsRequest#builder()}
*
*
* @param describeEnvironmentMembershipsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest.Builder} to
* create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.DescribeEnvironmentMemberships
* @see AWS API Documentation
*/
default DescribeEnvironmentMembershipsPublisher describeEnvironmentMembershipsPaginator(
Consumer describeEnvironmentMembershipsRequest) {
return describeEnvironmentMembershipsPaginator(DescribeEnvironmentMembershipsRequest.builder()
.applyMutation(describeEnvironmentMembershipsRequest).build());
}
/**
*
* Gets status information for an Cloud9 development environment.
*
*
* @param describeEnvironmentStatusRequest
* @return A Java Future containing the result of the DescribeEnvironmentStatus operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.DescribeEnvironmentStatus
* @see AWS API Documentation
*/
default CompletableFuture describeEnvironmentStatus(
DescribeEnvironmentStatusRequest describeEnvironmentStatusRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets status information for an Cloud9 development environment.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeEnvironmentStatusRequest.Builder} avoiding
* the need to create one manually via {@link DescribeEnvironmentStatusRequest#builder()}
*
*
* @param describeEnvironmentStatusRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentStatusRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeEnvironmentStatus operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.DescribeEnvironmentStatus
* @see AWS API Documentation
*/
default CompletableFuture describeEnvironmentStatus(
Consumer describeEnvironmentStatusRequest) {
return describeEnvironmentStatus(DescribeEnvironmentStatusRequest.builder()
.applyMutation(describeEnvironmentStatusRequest).build());
}
/**
*
* Gets information about Cloud9 development environments.
*
*
* @param describeEnvironmentsRequest
* @return A Java Future containing the result of the DescribeEnvironments operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.DescribeEnvironments
* @see AWS
* API Documentation
*/
default CompletableFuture describeEnvironments(
DescribeEnvironmentsRequest describeEnvironmentsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about Cloud9 development environments.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeEnvironmentsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeEnvironmentsRequest#builder()}
*
*
* @param describeEnvironmentsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeEnvironments operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.DescribeEnvironments
* @see AWS
* API Documentation
*/
default CompletableFuture describeEnvironments(
Consumer describeEnvironmentsRequest) {
return describeEnvironments(DescribeEnvironmentsRequest.builder().applyMutation(describeEnvironmentsRequest).build());
}
/**
*
* Gets a list of Cloud9 development environment identifiers.
*
*
* @param listEnvironmentsRequest
* @return A Java Future containing the result of the ListEnvironments operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.ListEnvironments
* @see AWS API
* Documentation
*/
default CompletableFuture listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets a list of Cloud9 development environment identifiers.
*
*
*
* This is a convenience which creates an instance of the {@link ListEnvironmentsRequest.Builder} avoiding the need
* to create one manually via {@link ListEnvironmentsRequest#builder()}
*
*
* @param listEnvironmentsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListEnvironments operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.ListEnvironments
* @see AWS API
* Documentation
*/
default CompletableFuture listEnvironments(
Consumer listEnvironmentsRequest) {
return listEnvironments(ListEnvironmentsRequest.builder().applyMutation(listEnvironmentsRequest).build());
}
/**
*
* Gets a list of Cloud9 development environment identifiers.
*
*
* @return A Java Future containing the result of the ListEnvironments operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.ListEnvironments
* @see AWS API
* Documentation
*/
default CompletableFuture listEnvironments() {
return listEnvironments(ListEnvironmentsRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #listEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest)} operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.ListEnvironments
* @see AWS API
* Documentation
*/
default ListEnvironmentsPublisher listEnvironmentsPaginator() {
return listEnvironmentsPaginator(ListEnvironmentsRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #listEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest)} operation.
*
*
* @param listEnvironmentsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.ListEnvironments
* @see AWS API
* Documentation
*/
default ListEnvironmentsPublisher listEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest) {
return new ListEnvironmentsPublisher(this, listEnvironmentsRequest);
}
/**
*
* This is a variant of
* {@link #listEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListEnvironmentsRequest.Builder} avoiding the need
* to create one manually via {@link ListEnvironmentsRequest#builder()}
*
*
* @param listEnvironmentsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.ListEnvironments
* @see AWS API
* Documentation
*/
default ListEnvironmentsPublisher listEnvironmentsPaginator(Consumer listEnvironmentsRequest) {
return listEnvironmentsPaginator(ListEnvironmentsRequest.builder().applyMutation(listEnvironmentsRequest).build());
}
/**
*
* Gets a list of the tags associated with an Cloud9 development environment.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - NotFoundException The target resource cannot be found.
* - InternalServerErrorException An internal server error occurred.
* - BadRequestException The target request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.ListTagsForResource
* @see AWS
* API Documentation
*/
default CompletableFuture listTagsForResource(
ListTagsForResourceRequest listTagsForResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets a list of the tags associated with an Cloud9 development environment.
*
*
*
* This is a convenience which creates an instance of the {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloud9.model.ListTagsForResourceRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - NotFoundException The target resource cannot be found.
* - InternalServerErrorException An internal server error occurred.
* - BadRequestException The target request is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.ListTagsForResource
* @see AWS
* API Documentation
*/
default CompletableFuture listTagsForResource(
Consumer listTagsForResourceRequest) {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* Adds tags to an Cloud9 development environment.
*
*
*
* Tags that you add to an Cloud9 environment by using this method will NOT be automatically propagated to
* underlying resources.
*
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - NotFoundException The target resource cannot be found.
* - InternalServerErrorException An internal server error occurred.
* - BadRequestException The target request is invalid.
* - ConcurrentAccessException A concurrent access issue occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.TagResource
* @see AWS API
* Documentation
*/
default CompletableFuture tagResource(TagResourceRequest tagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Adds tags to an Cloud9 development environment.
*
*
*
* Tags that you add to an Cloud9 environment by using this method will NOT be automatically propagated to
* underlying resources.
*
*
*
* This is a convenience which creates an instance of the {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloud9.model.TagResourceRequest.Builder} to create a request.
* @return A Java Future containing the result of the TagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - NotFoundException The target resource cannot be found.
* - InternalServerErrorException An internal server error occurred.
* - BadRequestException The target request is invalid.
* - ConcurrentAccessException A concurrent access issue occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.TagResource
* @see AWS API
* Documentation
*/
default CompletableFuture tagResource(Consumer tagResourceRequest) {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* Removes tags from an Cloud9 development environment.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - NotFoundException The target resource cannot be found.
* - InternalServerErrorException An internal server error occurred.
* - BadRequestException The target request is invalid.
* - ConcurrentAccessException A concurrent access issue occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.UntagResource
* @see AWS API
* Documentation
*/
default CompletableFuture untagResource(UntagResourceRequest untagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Removes tags from an Cloud9 development environment.
*
*
*
* This is a convenience which creates an instance of the {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloud9.model.UntagResourceRequest.Builder} to create a request.
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - NotFoundException The target resource cannot be found.
* - InternalServerErrorException An internal server error occurred.
* - BadRequestException The target request is invalid.
* - ConcurrentAccessException A concurrent access issue occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.UntagResource
* @see AWS API
* Documentation
*/
default CompletableFuture untagResource(Consumer untagResourceRequest) {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* Changes the settings of an existing Cloud9 development environment.
*
*
* @param updateEnvironmentRequest
* @return A Java Future containing the result of the UpdateEnvironment operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.UpdateEnvironment
* @see AWS API
* Documentation
*/
default CompletableFuture updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Changes the settings of an existing Cloud9 development environment.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateEnvironmentRequest.Builder} avoiding the need
* to create one manually via {@link UpdateEnvironmentRequest#builder()}
*
*
* @param updateEnvironmentRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloud9.model.UpdateEnvironmentRequest.Builder} to create a request.
* @return A Java Future containing the result of the UpdateEnvironment operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.UpdateEnvironment
* @see AWS API
* Documentation
*/
default CompletableFuture updateEnvironment(
Consumer updateEnvironmentRequest) {
return updateEnvironment(UpdateEnvironmentRequest.builder().applyMutation(updateEnvironmentRequest).build());
}
/**
*
* Changes the settings of an existing environment member for an Cloud9 development environment.
*
*
* @param updateEnvironmentMembershipRequest
* @return A Java Future containing the result of the UpdateEnvironmentMembership operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.UpdateEnvironmentMembership
* @see AWS API Documentation
*/
default CompletableFuture updateEnvironmentMembership(
UpdateEnvironmentMembershipRequest updateEnvironmentMembershipRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Changes the settings of an existing environment member for an Cloud9 development environment.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateEnvironmentMembershipRequest.Builder}
* avoiding the need to create one manually via {@link UpdateEnvironmentMembershipRequest#builder()}
*
*
* @param updateEnvironmentMembershipRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloud9.model.UpdateEnvironmentMembershipRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the UpdateEnvironmentMembership operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - BadRequestException The target request is invalid.
* - ConflictException A conflict occurred.
* - NotFoundException The target resource cannot be found.
* - ForbiddenException An access permissions issue occurred.
* - TooManyRequestsException Too many service requests were made over the given time period.
* - LimitExceededException A service limit was exceeded.
* - InternalServerErrorException An internal server error occurred.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - Cloud9Exception Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample Cloud9AsyncClient.UpdateEnvironmentMembership
* @see AWS API Documentation
*/
default CompletableFuture updateEnvironmentMembership(
Consumer updateEnvironmentMembershipRequest) {
return updateEnvironmentMembership(UpdateEnvironmentMembershipRequest.builder()
.applyMutation(updateEnvironmentMembershipRequest).build());
}
@Override
default Cloud9ServiceClientConfiguration serviceClientConfiguration() {
throw new UnsupportedOperationException();
}
/**
* Create a {@link Cloud9AsyncClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static Cloud9AsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link Cloud9AsyncClient}.
*/
static Cloud9AsyncClientBuilder builder() {
return new DefaultCloud9AsyncClientBuilder();
}
}