Interface Cloud9AsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any 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 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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic Cloud9AsyncClientBuilder
builder()
Create a builder that can be used to configure and create aCloud9AsyncClient
.static Cloud9AsyncClient
create()
Create aCloud9AsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createEnvironmentEC2
(Consumer<CreateEnvironmentEc2Request.Builder> createEnvironmentEc2Request) Creates an Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment.createEnvironmentEC2
(CreateEnvironmentEc2Request createEnvironmentEc2Request) Creates an Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment.createEnvironmentMembership
(Consumer<CreateEnvironmentMembershipRequest.Builder> createEnvironmentMembershipRequest) Adds an environment member to an Cloud9 development environment.createEnvironmentMembership
(CreateEnvironmentMembershipRequest createEnvironmentMembershipRequest) Adds an environment member to an Cloud9 development environment.deleteEnvironment
(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest) Deletes an Cloud9 development environment.deleteEnvironment
(DeleteEnvironmentRequest deleteEnvironmentRequest) Deletes an Cloud9 development environment.deleteEnvironmentMembership
(Consumer<DeleteEnvironmentMembershipRequest.Builder> deleteEnvironmentMembershipRequest) Deletes an environment member from a development environment.deleteEnvironmentMembership
(DeleteEnvironmentMembershipRequest deleteEnvironmentMembershipRequest) Deletes an environment member from a development environment.Gets information about environment members for an Cloud9 development environment.describeEnvironmentMemberships
(Consumer<DescribeEnvironmentMembershipsRequest.Builder> describeEnvironmentMembershipsRequest) Gets information about environment members for an Cloud9 development environment.describeEnvironmentMemberships
(DescribeEnvironmentMembershipsRequest describeEnvironmentMembershipsRequest) Gets information about environment members for an Cloud9 development environment.This is a variant ofdescribeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest)
operation.describeEnvironmentMembershipsPaginator
(Consumer<DescribeEnvironmentMembershipsRequest.Builder> describeEnvironmentMembershipsRequest) This is a variant ofdescribeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest)
operation.describeEnvironmentMembershipsPaginator
(DescribeEnvironmentMembershipsRequest describeEnvironmentMembershipsRequest) This is a variant ofdescribeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest)
operation.describeEnvironments
(Consumer<DescribeEnvironmentsRequest.Builder> describeEnvironmentsRequest) Gets information about Cloud9 development environments.describeEnvironments
(DescribeEnvironmentsRequest describeEnvironmentsRequest) Gets information about Cloud9 development environments.describeEnvironmentStatus
(Consumer<DescribeEnvironmentStatusRequest.Builder> describeEnvironmentStatusRequest) Gets status information for an Cloud9 development environment.describeEnvironmentStatus
(DescribeEnvironmentStatusRequest describeEnvironmentStatusRequest) Gets status information for an Cloud9 development environment.Gets a list of Cloud9 development environment identifiers.listEnvironments
(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) Gets a list of Cloud9 development environment identifiers.listEnvironments
(ListEnvironmentsRequest listEnvironmentsRequest) Gets a list of Cloud9 development environment identifiers.default ListEnvironmentsPublisher
This is a variant oflistEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest)
operation.default ListEnvironmentsPublisher
listEnvironmentsPaginator
(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) This is a variant oflistEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest)
operation.default ListEnvironmentsPublisher
listEnvironmentsPaginator
(ListEnvironmentsRequest listEnvironmentsRequest) This is a variant oflistEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Gets a list of the tags associated with an Cloud9 development environment.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Gets a list of the tags associated with an Cloud9 development environment.default Cloud9ServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds tags to an Cloud9 development environment.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds tags to an Cloud9 development environment.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from an Cloud9 development environment.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes tags from an Cloud9 development environment.updateEnvironment
(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest) Changes the settings of an existing Cloud9 development environment.updateEnvironment
(UpdateEnvironmentRequest updateEnvironmentRequest) Changes the settings of an existing Cloud9 development environment.updateEnvironmentMembership
(Consumer<UpdateEnvironmentMembershipRequest.Builder> updateEnvironmentMembershipRequest) Changes the settings of an existing environment member for an Cloud9 development environment.updateEnvironmentMembership
(UpdateEnvironmentMembershipRequest updateEnvironmentMembershipRequest) Changes the settings of an existing environment member for an Cloud9 development environment.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createEnvironmentEC2
default CompletableFuture<CreateEnvironmentEc2Response> createEnvironmentEC2(CreateEnvironmentEc2Request createEnvironmentEc2Request) Creates an Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment.
- Parameters:
createEnvironmentEc2Request
-- Returns:
- 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 invokeThrowable.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.
- See Also:
-
createEnvironmentEC2
default CompletableFuture<CreateEnvironmentEc2Response> createEnvironmentEC2(Consumer<CreateEnvironmentEc2Request.Builder> createEnvironmentEc2Request) 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
CreateEnvironmentEc2Request.Builder
avoiding the need to create one manually viaCreateEnvironmentEc2Request.builder()
- Parameters:
createEnvironmentEc2Request
- AConsumer
that will call methods onCreateEnvironmentEc2Request.Builder
to create a request.- Returns:
- 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 invokeThrowable.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.
- See Also:
-
createEnvironmentMembership
default CompletableFuture<CreateEnvironmentMembershipResponse> createEnvironmentMembership(CreateEnvironmentMembershipRequest createEnvironmentMembershipRequest) Adds an environment member to an Cloud9 development environment.
- Parameters:
createEnvironmentMembershipRequest
-- Returns:
- 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 invokeThrowable.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.
- See Also:
-
createEnvironmentMembership
default CompletableFuture<CreateEnvironmentMembershipResponse> createEnvironmentMembership(Consumer<CreateEnvironmentMembershipRequest.Builder> createEnvironmentMembershipRequest) Adds an environment member to an Cloud9 development environment.
This is a convenience which creates an instance of the
CreateEnvironmentMembershipRequest.Builder
avoiding the need to create one manually viaCreateEnvironmentMembershipRequest.builder()
- Parameters:
createEnvironmentMembershipRequest
- AConsumer
that will call methods onCreateEnvironmentMembershipRequest.Builder
to create a request.- Returns:
- 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 invokeThrowable.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.
- See Also:
-
deleteEnvironment
default CompletableFuture<DeleteEnvironmentResponse> deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest) Deletes an Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.
- Parameters:
deleteEnvironmentRequest
-- Returns:
- 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 invokeThrowable.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.
- See Also:
-
deleteEnvironment
default CompletableFuture<DeleteEnvironmentResponse> deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest) 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
DeleteEnvironmentRequest.Builder
avoiding the need to create one manually viaDeleteEnvironmentRequest.builder()
- Parameters:
deleteEnvironmentRequest
- AConsumer
that will call methods onDeleteEnvironmentRequest.Builder
to create a request.- Returns:
- 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 invokeThrowable.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.
- See Also:
-
deleteEnvironmentMembership
default CompletableFuture<DeleteEnvironmentMembershipResponse> deleteEnvironmentMembership(DeleteEnvironmentMembershipRequest deleteEnvironmentMembershipRequest) Deletes an environment member from a development environment.
- Parameters:
deleteEnvironmentMembershipRequest
-- Returns:
- 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 invokeThrowable.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.
- See Also:
-
deleteEnvironmentMembership
default CompletableFuture<DeleteEnvironmentMembershipResponse> deleteEnvironmentMembership(Consumer<DeleteEnvironmentMembershipRequest.Builder> deleteEnvironmentMembershipRequest) Deletes an environment member from a development environment.
This is a convenience which creates an instance of the
DeleteEnvironmentMembershipRequest.Builder
avoiding the need to create one manually viaDeleteEnvironmentMembershipRequest.builder()
- Parameters:
deleteEnvironmentMembershipRequest
- AConsumer
that will call methods onDeleteEnvironmentMembershipRequest.Builder
to create a request.- Returns:
- 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 invokeThrowable.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.
- See Also:
-
describeEnvironmentMemberships
default CompletableFuture<DescribeEnvironmentMembershipsResponse> describeEnvironmentMemberships(DescribeEnvironmentMembershipsRequest describeEnvironmentMembershipsRequest) Gets information about environment members for an Cloud9 development environment.
- Parameters:
describeEnvironmentMembershipsRequest
-- Returns:
- 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 invokeThrowable.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.
- See Also:
-
describeEnvironmentMemberships
default CompletableFuture<DescribeEnvironmentMembershipsResponse> describeEnvironmentMemberships(Consumer<DescribeEnvironmentMembershipsRequest.Builder> describeEnvironmentMembershipsRequest) Gets information about environment members for an Cloud9 development environment.
This is a convenience which creates an instance of the
DescribeEnvironmentMembershipsRequest.Builder
avoiding the need to create one manually viaDescribeEnvironmentMembershipsRequest.builder()
- Parameters:
describeEnvironmentMembershipsRequest
- AConsumer
that will call methods onDescribeEnvironmentMembershipsRequest.Builder
to create a request.- Returns:
- 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 invokeThrowable.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.
- See Also:
-
describeEnvironmentMemberships
Gets information about environment members for an Cloud9 development environment.
- Returns:
- 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 invokeThrowable.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.
- See Also:
-
describeEnvironmentMembershipsPaginator
This is a variant of
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
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
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 methodsoftware.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsPublisher publisher = client.describeEnvironmentMembershipsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsPublisher publisher = client.describeEnvironmentMembershipsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsResponse response) { //... }; });
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
describeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest)
operation.- Returns:
- 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 invokeThrowable.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.
- See Also:
-
describeEnvironmentMembershipsPaginator
default DescribeEnvironmentMembershipsPublisher describeEnvironmentMembershipsPaginator(DescribeEnvironmentMembershipsRequest describeEnvironmentMembershipsRequest) This is a variant of
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
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
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 methodsoftware.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsPublisher publisher = client.describeEnvironmentMembershipsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsPublisher publisher = client.describeEnvironmentMembershipsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsResponse response) { //... }; });
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
describeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest)
operation.- Parameters:
describeEnvironmentMembershipsRequest
-- Returns:
- 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 invokeThrowable.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.
- See Also:
-
describeEnvironmentMembershipsPaginator
default DescribeEnvironmentMembershipsPublisher describeEnvironmentMembershipsPaginator(Consumer<DescribeEnvironmentMembershipsRequest.Builder> describeEnvironmentMembershipsRequest) This is a variant of
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
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
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 methodsoftware.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsPublisher publisher = client.describeEnvironmentMembershipsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsPublisher publisher = client.describeEnvironmentMembershipsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsResponse response) { //... }; });
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
describeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest)
operation.
This is a convenience which creates an instance of the
DescribeEnvironmentMembershipsRequest.Builder
avoiding the need to create one manually viaDescribeEnvironmentMembershipsRequest.builder()
- Parameters:
describeEnvironmentMembershipsRequest
- AConsumer
that will call methods onDescribeEnvironmentMembershipsRequest.Builder
to create a request.- Returns:
- 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 invokeThrowable.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.
- See Also:
-
describeEnvironmentStatus
default CompletableFuture<DescribeEnvironmentStatusResponse> describeEnvironmentStatus(DescribeEnvironmentStatusRequest describeEnvironmentStatusRequest) Gets status information for an Cloud9 development environment.
- Parameters:
describeEnvironmentStatusRequest
-- Returns:
- 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 invokeThrowable.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.
- See Also:
-
describeEnvironmentStatus
default CompletableFuture<DescribeEnvironmentStatusResponse> describeEnvironmentStatus(Consumer<DescribeEnvironmentStatusRequest.Builder> describeEnvironmentStatusRequest) Gets status information for an Cloud9 development environment.
This is a convenience which creates an instance of the
DescribeEnvironmentStatusRequest.Builder
avoiding the need to create one manually viaDescribeEnvironmentStatusRequest.builder()
- Parameters:
describeEnvironmentStatusRequest
- AConsumer
that will call methods onDescribeEnvironmentStatusRequest.Builder
to create a request.- Returns:
- 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 invokeThrowable.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.
- See Also:
-
describeEnvironments
default CompletableFuture<DescribeEnvironmentsResponse> describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest) Gets information about Cloud9 development environments.
- Parameters:
describeEnvironmentsRequest
-- Returns:
- 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 invokeThrowable.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.
- See Also:
-
describeEnvironments
default CompletableFuture<DescribeEnvironmentsResponse> describeEnvironments(Consumer<DescribeEnvironmentsRequest.Builder> describeEnvironmentsRequest) Gets information about Cloud9 development environments.
This is a convenience which creates an instance of the
DescribeEnvironmentsRequest.Builder
avoiding the need to create one manually viaDescribeEnvironmentsRequest.builder()
- Parameters:
describeEnvironmentsRequest
- AConsumer
that will call methods onDescribeEnvironmentsRequest.Builder
to create a request.- Returns:
- 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 invokeThrowable.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.
- See Also:
-
listEnvironments
default CompletableFuture<ListEnvironmentsResponse> listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest) Gets a list of Cloud9 development environment identifiers.
- Parameters:
listEnvironmentsRequest
-- Returns:
- 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 invokeThrowable.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.
- See Also:
-
listEnvironments
default CompletableFuture<ListEnvironmentsResponse> listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) Gets a list of Cloud9 development environment identifiers.
This is a convenience which creates an instance of the
ListEnvironmentsRequest.Builder
avoiding the need to create one manually viaListEnvironmentsRequest.builder()
- Parameters:
listEnvironmentsRequest
- AConsumer
that will call methods onListEnvironmentsRequest.Builder
to create a request.- Returns:
- 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 invokeThrowable.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.
- See Also:
-
listEnvironments
Gets a list of Cloud9 development environment identifiers.
- Returns:
- 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 invokeThrowable.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.
- See Also:
-
listEnvironmentsPaginator
This is a variant of
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
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
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 methodsoftware.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloud9.model.ListEnvironmentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsResponse response) { //... }; });
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
listEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest)
operation.- Returns:
- 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 invokeThrowable.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.
- See Also:
-
listEnvironmentsPaginator
default ListEnvironmentsPublisher listEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest) This is a variant of
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
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
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 methodsoftware.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloud9.model.ListEnvironmentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsResponse response) { //... }; });
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
listEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest)
operation.- Parameters:
listEnvironmentsRequest
-- Returns:
- 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 invokeThrowable.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.
- See Also:
-
listEnvironmentsPaginator
default ListEnvironmentsPublisher listEnvironmentsPaginator(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) This is a variant of
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
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
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 methodsoftware.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloud9.model.ListEnvironmentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsResponse response) { //... }; });
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
listEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest)
operation.
This is a convenience which creates an instance of the
ListEnvironmentsRequest.Builder
avoiding the need to create one manually viaListEnvironmentsRequest.builder()
- Parameters:
listEnvironmentsRequest
- AConsumer
that will call methods onListEnvironmentsRequest.Builder
to create a request.- Returns:
- 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 invokeThrowable.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.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Gets a list of the tags associated with an Cloud9 development environment.
- Parameters:
listTagsForResourceRequest
-- Returns:
- 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 invokeThrowable.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.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Gets a list of the tags associated with an Cloud9 development environment.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- 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 invokeThrowable.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.
- See Also:
-
tagResource
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.
- Parameters:
tagResourceRequest
-- Returns:
- 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 invokeThrowable.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.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) 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
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- 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 invokeThrowable.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.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes tags from an Cloud9 development environment.
- Parameters:
untagResourceRequest
-- Returns:
- 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 invokeThrowable.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.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from an Cloud9 development environment.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- 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 invokeThrowable.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.
- See Also:
-
updateEnvironment
default CompletableFuture<UpdateEnvironmentResponse> updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest) Changes the settings of an existing Cloud9 development environment.
- Parameters:
updateEnvironmentRequest
-- Returns:
- 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 invokeThrowable.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.
- See Also:
-
updateEnvironment
default CompletableFuture<UpdateEnvironmentResponse> updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest) Changes the settings of an existing Cloud9 development environment.
This is a convenience which creates an instance of the
UpdateEnvironmentRequest.Builder
avoiding the need to create one manually viaUpdateEnvironmentRequest.builder()
- Parameters:
updateEnvironmentRequest
- AConsumer
that will call methods onUpdateEnvironmentRequest.Builder
to create a request.- Returns:
- 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 invokeThrowable.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.
- See Also:
-
updateEnvironmentMembership
default CompletableFuture<UpdateEnvironmentMembershipResponse> updateEnvironmentMembership(UpdateEnvironmentMembershipRequest updateEnvironmentMembershipRequest) Changes the settings of an existing environment member for an Cloud9 development environment.
- Parameters:
updateEnvironmentMembershipRequest
-- Returns:
- 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 invokeThrowable.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.
- See Also:
-
updateEnvironmentMembership
default CompletableFuture<UpdateEnvironmentMembershipResponse> updateEnvironmentMembership(Consumer<UpdateEnvironmentMembershipRequest.Builder> updateEnvironmentMembershipRequest) Changes the settings of an existing environment member for an Cloud9 development environment.
This is a convenience which creates an instance of the
UpdateEnvironmentMembershipRequest.Builder
avoiding the need to create one manually viaUpdateEnvironmentMembershipRequest.builder()
- Parameters:
updateEnvironmentMembershipRequest
- AConsumer
that will call methods onUpdateEnvironmentMembershipRequest.Builder
to create a request.- Returns:
- 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 invokeThrowable.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.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aCloud9AsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aCloud9AsyncClient
.
-