software.amazon.awssdk.services.cloud9.Cloud9Client 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.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.exception.AwsServiceException;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.regions.ServiceMetadata;
import software.amazon.awssdk.services.cloud9.model.BadRequestException;
import software.amazon.awssdk.services.cloud9.model.Cloud9Exception;
import software.amazon.awssdk.services.cloud9.model.ConcurrentAccessException;
import software.amazon.awssdk.services.cloud9.model.ConflictException;
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.ForbiddenException;
import software.amazon.awssdk.services.cloud9.model.InternalServerErrorException;
import software.amazon.awssdk.services.cloud9.model.LimitExceededException;
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.NotFoundException;
import software.amazon.awssdk.services.cloud9.model.TagResourceRequest;
import software.amazon.awssdk.services.cloud9.model.TagResourceResponse;
import software.amazon.awssdk.services.cloud9.model.TooManyRequestsException;
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.DescribeEnvironmentMembershipsIterable;
import software.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsIterable;
/**
* Service client for accessing AWS Cloud9. This can be created using the static {@link #builder()} method.
*
* 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 Cloud9Client extends SdkClient {
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";
/**
* Create a {@link Cloud9Client} 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 Cloud9Client create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link Cloud9Client}.
*/
static Cloud9ClientBuilder builder() {
return new DefaultCloud9ClientBuilder();
}
/**
*
* 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 Result of the CreateEnvironmentEC2 operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.CreateEnvironmentEC2
* @see AWS
* API Documentation
*/
default CreateEnvironmentEc2Response createEnvironmentEC2(CreateEnvironmentEc2Request createEnvironmentEc2Request)
throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException,
LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
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 CreateEnvironmentEC2Request.Builder} to create a
* request.
* @return Result of the CreateEnvironmentEC2 operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.CreateEnvironmentEC2
* @see AWS
* API Documentation
*/
default CreateEnvironmentEc2Response createEnvironmentEC2(
Consumer createEnvironmentEc2Request) throws BadRequestException,
ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException,
InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
return createEnvironmentEC2(CreateEnvironmentEc2Request.builder().applyMutation(createEnvironmentEc2Request).build());
}
/**
*
* Adds an environment member to an Cloud9 development environment.
*
*
* @param createEnvironmentMembershipRequest
* @return Result of the CreateEnvironmentMembership operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.CreateEnvironmentMembership
* @see AWS API Documentation
*/
default CreateEnvironmentMembershipResponse createEnvironmentMembership(
CreateEnvironmentMembershipRequest createEnvironmentMembershipRequest) throws BadRequestException, ConflictException,
NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException,
InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
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 CreateEnvironmentMembershipRequest.Builder} to create
* a request.
* @return Result of the CreateEnvironmentMembership operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.CreateEnvironmentMembership
* @see AWS API Documentation
*/
default CreateEnvironmentMembershipResponse createEnvironmentMembership(
Consumer createEnvironmentMembershipRequest) throws BadRequestException,
ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException,
InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
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 Result of the DeleteEnvironment operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.DeleteEnvironment
* @see AWS API
* Documentation
*/
default DeleteEnvironmentResponse deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)
throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException,
LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
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 DeleteEnvironmentRequest.Builder} to create a request.
* @return Result of the DeleteEnvironment operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.DeleteEnvironment
* @see AWS API
* Documentation
*/
default DeleteEnvironmentResponse deleteEnvironment(Consumer deleteEnvironmentRequest)
throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException,
LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
return deleteEnvironment(DeleteEnvironmentRequest.builder().applyMutation(deleteEnvironmentRequest).build());
}
/**
*
* Deletes an environment member from an Cloud9 development environment.
*
*
* @param deleteEnvironmentMembershipRequest
* @return Result of the DeleteEnvironmentMembership operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.DeleteEnvironmentMembership
* @see AWS API Documentation
*/
default DeleteEnvironmentMembershipResponse deleteEnvironmentMembership(
DeleteEnvironmentMembershipRequest deleteEnvironmentMembershipRequest) throws BadRequestException, ConflictException,
NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException,
InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an environment member from an Cloud9 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 DeleteEnvironmentMembershipRequest.Builder} to create
* a request.
* @return Result of the DeleteEnvironmentMembership operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.DeleteEnvironmentMembership
* @see AWS API Documentation
*/
default DeleteEnvironmentMembershipResponse deleteEnvironmentMembership(
Consumer deleteEnvironmentMembershipRequest) throws BadRequestException,
ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException,
InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
return deleteEnvironmentMembership(DeleteEnvironmentMembershipRequest.builder()
.applyMutation(deleteEnvironmentMembershipRequest).build());
}
/**
*
* Gets information about environment members for an Cloud9 development environment.
*
*
* @return Result of the DescribeEnvironmentMemberships operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.DescribeEnvironmentMemberships
* @see #describeEnvironmentMemberships(DescribeEnvironmentMembershipsRequest)
* @see AWS API Documentation
*/
default DescribeEnvironmentMembershipsResponse describeEnvironmentMemberships() throws BadRequestException,
ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException,
InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
return describeEnvironmentMemberships(DescribeEnvironmentMembershipsRequest.builder().build());
}
/**
*
* Gets information about environment members for an Cloud9 development environment.
*
*
* @param describeEnvironmentMembershipsRequest
* @return Result of the DescribeEnvironmentMemberships operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.DescribeEnvironmentMemberships
* @see AWS API Documentation
*/
default DescribeEnvironmentMembershipsResponse describeEnvironmentMemberships(
DescribeEnvironmentMembershipsRequest describeEnvironmentMembershipsRequest) throws BadRequestException,
ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException,
InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
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 DescribeEnvironmentMembershipsRequest.Builder} to
* create a request.
* @return Result of the DescribeEnvironmentMemberships operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.DescribeEnvironmentMemberships
* @see AWS API Documentation
*/
default DescribeEnvironmentMembershipsResponse describeEnvironmentMemberships(
Consumer describeEnvironmentMembershipsRequest)
throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException,
LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
return describeEnvironmentMemberships(DescribeEnvironmentMembershipsRequest.builder()
.applyMutation(describeEnvironmentMembershipsRequest).build());
}
/**
*
* Gets information about environment members for an Cloud9 development environment.
*
*
*
* This is a variant of
* {@link #describeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsIterable responses = client.describeEnvironmentMembershipsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsIterable responses = client
* .describeEnvironmentMembershipsPaginator(request);
* for (software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsIterable responses = client.describeEnvironmentMembershipsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.DescribeEnvironmentMemberships
* @see #describeEnvironmentMembershipsPaginator(DescribeEnvironmentMembershipsRequest)
* @see AWS API Documentation
*/
default DescribeEnvironmentMembershipsIterable describeEnvironmentMembershipsPaginator() throws BadRequestException,
ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException,
InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
return describeEnvironmentMembershipsPaginator(DescribeEnvironmentMembershipsRequest.builder().build());
}
/**
*
* Gets information about environment members for an Cloud9 development environment.
*
*
*
* This is a variant of
* {@link #describeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsIterable responses = client.describeEnvironmentMembershipsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsIterable responses = client
* .describeEnvironmentMembershipsPaginator(request);
* for (software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsIterable responses = client.describeEnvironmentMembershipsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.DescribeEnvironmentMemberships
* @see AWS API Documentation
*/
default DescribeEnvironmentMembershipsIterable describeEnvironmentMembershipsPaginator(
DescribeEnvironmentMembershipsRequest describeEnvironmentMembershipsRequest) throws BadRequestException,
ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException,
InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about environment members for an Cloud9 development environment.
*
*
*
* This is a variant of
* {@link #describeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsIterable responses = client.describeEnvironmentMembershipsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsIterable responses = client
* .describeEnvironmentMembershipsPaginator(request);
* for (software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsIterable responses = client.describeEnvironmentMembershipsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 DescribeEnvironmentMembershipsRequest.Builder} to
* create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.DescribeEnvironmentMemberships
* @see AWS API Documentation
*/
default DescribeEnvironmentMembershipsIterable describeEnvironmentMembershipsPaginator(
Consumer describeEnvironmentMembershipsRequest)
throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException,
LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
return describeEnvironmentMembershipsPaginator(DescribeEnvironmentMembershipsRequest.builder()
.applyMutation(describeEnvironmentMembershipsRequest).build());
}
/**
*
* Gets status information for an Cloud9 development environment.
*
*
* @param describeEnvironmentStatusRequest
* @return Result of the DescribeEnvironmentStatus operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.DescribeEnvironmentStatus
* @see AWS API Documentation
*/
default DescribeEnvironmentStatusResponse describeEnvironmentStatus(
DescribeEnvironmentStatusRequest describeEnvironmentStatusRequest) throws BadRequestException, ConflictException,
NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException,
InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
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 DescribeEnvironmentStatusRequest.Builder} to create a
* request.
* @return Result of the DescribeEnvironmentStatus operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.DescribeEnvironmentStatus
* @see AWS API Documentation
*/
default DescribeEnvironmentStatusResponse describeEnvironmentStatus(
Consumer describeEnvironmentStatusRequest) throws BadRequestException,
ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException,
InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
return describeEnvironmentStatus(DescribeEnvironmentStatusRequest.builder()
.applyMutation(describeEnvironmentStatusRequest).build());
}
/**
*
* Gets information about Cloud9 development environments.
*
*
* @param describeEnvironmentsRequest
* @return Result of the DescribeEnvironments operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.DescribeEnvironments
* @see AWS
* API Documentation
*/
default DescribeEnvironmentsResponse describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest)
throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException,
LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
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 DescribeEnvironmentsRequest.Builder} to create a
* request.
* @return Result of the DescribeEnvironments operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.DescribeEnvironments
* @see AWS
* API Documentation
*/
default DescribeEnvironmentsResponse describeEnvironments(
Consumer describeEnvironmentsRequest) throws BadRequestException,
ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException,
InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
return describeEnvironments(DescribeEnvironmentsRequest.builder().applyMutation(describeEnvironmentsRequest).build());
}
/**
*
* Gets a list of Cloud9 development environment identifiers.
*
*
* @return Result of the ListEnvironments operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.ListEnvironments
* @see #listEnvironments(ListEnvironmentsRequest)
* @see AWS API
* Documentation
*/
default ListEnvironmentsResponse listEnvironments() throws BadRequestException, ConflictException, NotFoundException,
ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException,
AwsServiceException, SdkClientException, Cloud9Exception {
return listEnvironments(ListEnvironmentsRequest.builder().build());
}
/**
*
* Gets a list of Cloud9 development environment identifiers.
*
*
* @param listEnvironmentsRequest
* @return Result of the ListEnvironments operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.ListEnvironments
* @see AWS API
* Documentation
*/
default ListEnvironmentsResponse listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)
throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException,
LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
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 ListEnvironmentsRequest.Builder} to create a request.
* @return Result of the ListEnvironments operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.ListEnvironments
* @see AWS API
* Documentation
*/
default ListEnvironmentsResponse listEnvironments(Consumer listEnvironmentsRequest)
throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException,
LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
return listEnvironments(ListEnvironmentsRequest.builder().applyMutation(listEnvironmentsRequest).build());
}
/**
*
* Gets a list of Cloud9 development environment identifiers.
*
*
*
* This is a variant of
* {@link #listEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest)} operation. The
* return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
* making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsIterable responses = client
* .listEnvironmentsPaginator(request);
* for (software.amazon.awssdk.services.cloud9.model.ListEnvironmentsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.ListEnvironments
* @see #listEnvironmentsPaginator(ListEnvironmentsRequest)
* @see AWS API
* Documentation
*/
default ListEnvironmentsIterable listEnvironmentsPaginator() throws BadRequestException, ConflictException,
NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException,
InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
return listEnvironmentsPaginator(ListEnvironmentsRequest.builder().build());
}
/**
*
* Gets a list of Cloud9 development environment identifiers.
*
*
*
* This is a variant of
* {@link #listEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest)} operation. The
* return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
* making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsIterable responses = client
* .listEnvironmentsPaginator(request);
* for (software.amazon.awssdk.services.cloud9.model.ListEnvironmentsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.ListEnvironments
* @see AWS API
* Documentation
*/
default ListEnvironmentsIterable listEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest)
throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException,
LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
throw new UnsupportedOperationException();
}
/**
*
* Gets a list of Cloud9 development environment identifiers.
*
*
*
* This is a variant of
* {@link #listEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest)} operation. The
* return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
* making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsIterable responses = client
* .listEnvironmentsPaginator(request);
* for (software.amazon.awssdk.services.cloud9.model.ListEnvironmentsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* 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 ListEnvironmentsRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.ListEnvironments
* @see AWS API
* Documentation
*/
default ListEnvironmentsIterable listEnvironmentsPaginator(Consumer listEnvironmentsRequest)
throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException,
LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
return listEnvironmentsPaginator(ListEnvironmentsRequest.builder().applyMutation(listEnvironmentsRequest).build());
}
/**
*
* Gets a list of the tags associated with an Cloud9 development environment.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws NotFoundException
* The target resource cannot be found.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws BadRequestException
* The target request is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.ListTagsForResource
* @see AWS
* API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
throws NotFoundException, InternalServerErrorException, BadRequestException, AwsServiceException, SdkClientException,
Cloud9Exception {
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 ListTagsForResourceRequest.Builder} to create a
* request.
* @return Result of the ListTagsForResource operation returned by the service.
* @throws NotFoundException
* The target resource cannot be found.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws BadRequestException
* The target request is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.ListTagsForResource
* @see AWS
* API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(
Consumer listTagsForResourceRequest) throws NotFoundException,
InternalServerErrorException, BadRequestException, AwsServiceException, SdkClientException, Cloud9Exception {
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 Result of the TagResource operation returned by the service.
* @throws NotFoundException
* The target resource cannot be found.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws BadRequestException
* The target request is invalid.
* @throws ConcurrentAccessException
* A concurrent access issue occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.TagResource
* @see AWS API
* Documentation
*/
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws NotFoundException,
InternalServerErrorException, BadRequestException, ConcurrentAccessException, AwsServiceException,
SdkClientException, Cloud9Exception {
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 TagResourceRequest.Builder} to create a request.
* @return Result of the TagResource operation returned by the service.
* @throws NotFoundException
* The target resource cannot be found.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws BadRequestException
* The target request is invalid.
* @throws ConcurrentAccessException
* A concurrent access issue occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.TagResource
* @see AWS API
* Documentation
*/
default TagResourceResponse tagResource(Consumer tagResourceRequest) throws NotFoundException,
InternalServerErrorException, BadRequestException, ConcurrentAccessException, AwsServiceException,
SdkClientException, Cloud9Exception {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* Removes tags from an Cloud9 development environment.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws NotFoundException
* The target resource cannot be found.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws BadRequestException
* The target request is invalid.
* @throws ConcurrentAccessException
* A concurrent access issue occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.UntagResource
* @see AWS API
* Documentation
*/
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws NotFoundException,
InternalServerErrorException, BadRequestException, ConcurrentAccessException, AwsServiceException,
SdkClientException, Cloud9Exception {
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 UntagResourceRequest.Builder} to create a request.
* @return Result of the UntagResource operation returned by the service.
* @throws NotFoundException
* The target resource cannot be found.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws BadRequestException
* The target request is invalid.
* @throws ConcurrentAccessException
* A concurrent access issue occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.UntagResource
* @see AWS API
* Documentation
*/
default UntagResourceResponse untagResource(Consumer untagResourceRequest)
throws NotFoundException, InternalServerErrorException, BadRequestException, ConcurrentAccessException,
AwsServiceException, SdkClientException, Cloud9Exception {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* Changes the settings of an existing Cloud9 development environment.
*
*
* @param updateEnvironmentRequest
* @return Result of the UpdateEnvironment operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.UpdateEnvironment
* @see AWS API
* Documentation
*/
default UpdateEnvironmentResponse updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)
throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException,
LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
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 UpdateEnvironmentRequest.Builder} to create a request.
* @return Result of the UpdateEnvironment operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.UpdateEnvironment
* @see AWS API
* Documentation
*/
default UpdateEnvironmentResponse updateEnvironment(Consumer updateEnvironmentRequest)
throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException,
LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
return updateEnvironment(UpdateEnvironmentRequest.builder().applyMutation(updateEnvironmentRequest).build());
}
/**
*
* Changes the settings of an existing environment member for an Cloud9 development environment.
*
*
* @param updateEnvironmentMembershipRequest
* @return Result of the UpdateEnvironmentMembership operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.UpdateEnvironmentMembership
* @see AWS API Documentation
*/
default UpdateEnvironmentMembershipResponse updateEnvironmentMembership(
UpdateEnvironmentMembershipRequest updateEnvironmentMembershipRequest) throws BadRequestException, ConflictException,
NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException,
InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
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 UpdateEnvironmentMembershipRequest.Builder} to create
* a request.
* @return Result of the UpdateEnvironmentMembership operation returned by the service.
* @throws BadRequestException
* The target request is invalid.
* @throws ConflictException
* A conflict occurred.
* @throws NotFoundException
* The target resource cannot be found.
* @throws ForbiddenException
* An access permissions issue occurred.
* @throws TooManyRequestsException
* Too many service requests were made over the given time period.
* @throws LimitExceededException
* A service limit was exceeded.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws Cloud9Exception
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample Cloud9Client.UpdateEnvironmentMembership
* @see AWS API Documentation
*/
default UpdateEnvironmentMembershipResponse updateEnvironmentMembership(
Consumer updateEnvironmentMembershipRequest) throws BadRequestException,
ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException,
InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception {
return updateEnvironmentMembership(UpdateEnvironmentMembershipRequest.builder()
.applyMutation(updateEnvironmentMembershipRequest).build());
}
static ServiceMetadata serviceMetadata() {
return ServiceMetadata.of(SERVICE_METADATA_ID);
}
}