Interface Cloud9Client
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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 Cloud9ClientBuilder
builder()
Create a builder that can be used to configure and create aCloud9Client
.static Cloud9Client
create()
Create aCloud9Client
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default 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.default 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.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.default DeleteEnvironmentResponse
deleteEnvironment
(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest) Deletes an Cloud9 development environment.default DeleteEnvironmentResponse
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.default DescribeEnvironmentsResponse
describeEnvironments
(Consumer<DescribeEnvironmentsRequest.Builder> describeEnvironmentsRequest) Gets information about Cloud9 development environments.default DescribeEnvironmentsResponse
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.default ListEnvironmentsResponse
Gets a list of Cloud9 development environment identifiers.default ListEnvironmentsResponse
listEnvironments
(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) Gets a list of Cloud9 development environment identifiers.default ListEnvironmentsResponse
listEnvironments
(ListEnvironmentsRequest listEnvironmentsRequest) Gets a list of Cloud9 development environment identifiers.default ListEnvironmentsIterable
This is a variant oflistEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest)
operation.default ListEnvironmentsIterable
listEnvironmentsPaginator
(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) This is a variant oflistEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest)
operation.default ListEnvironmentsIterable
listEnvironmentsPaginator
(ListEnvironmentsRequest listEnvironmentsRequest) This is a variant oflistEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Gets a list of the tags associated with an Cloud9 development environment.default ListTagsForResourceResponse
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., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds tags to an Cloud9 development environment.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds tags to an Cloud9 development environment.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from an Cloud9 development environment.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes tags from an Cloud9 development environment.default UpdateEnvironmentResponse
updateEnvironment
(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest) Changes the settings of an existing Cloud9 development environment.default UpdateEnvironmentResponse
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 CreateEnvironmentEc2Response createEnvironmentEC2(CreateEnvironmentEc2Request createEnvironmentEc2Request) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception 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:
- Result of the CreateEnvironmentEC2 operation returned by the service.
- See Also:
-
createEnvironmentEC2
default CreateEnvironmentEc2Response createEnvironmentEC2(Consumer<CreateEnvironmentEc2Request.Builder> createEnvironmentEc2Request) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception 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:
- Result of the CreateEnvironmentEC2 operation returned by the service.
- See Also:
-
createEnvironmentMembership
default CreateEnvironmentMembershipResponse createEnvironmentMembership(CreateEnvironmentMembershipRequest createEnvironmentMembershipRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception Adds an environment member to an Cloud9 development environment.
- Parameters:
createEnvironmentMembershipRequest
-- Returns:
- Result of the CreateEnvironmentMembership operation returned by the service.
- See Also:
-
createEnvironmentMembership
default CreateEnvironmentMembershipResponse createEnvironmentMembership(Consumer<CreateEnvironmentMembershipRequest.Builder> createEnvironmentMembershipRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception 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:
- Result of the CreateEnvironmentMembership operation returned by the service.
- See Also:
-
deleteEnvironment
default DeleteEnvironmentResponse deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception Deletes an Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.
- Parameters:
deleteEnvironmentRequest
-- Returns:
- Result of the DeleteEnvironment operation returned by the service.
- See Also:
-
deleteEnvironment
default DeleteEnvironmentResponse deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception 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:
- Result of the DeleteEnvironment operation returned by the service.
- See Also:
-
deleteEnvironmentMembership
default DeleteEnvironmentMembershipResponse deleteEnvironmentMembership(DeleteEnvironmentMembershipRequest deleteEnvironmentMembershipRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception Deletes an environment member from a development environment.
- Parameters:
deleteEnvironmentMembershipRequest
-- Returns:
- Result of the DeleteEnvironmentMembership operation returned by the service.
- See Also:
-
deleteEnvironmentMembership
default DeleteEnvironmentMembershipResponse deleteEnvironmentMembership(Consumer<DeleteEnvironmentMembershipRequest.Builder> deleteEnvironmentMembershipRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception 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:
- Result of the DeleteEnvironmentMembership operation returned by the service.
- See Also:
-
describeEnvironmentMemberships
default DescribeEnvironmentMembershipsResponse describeEnvironmentMemberships(DescribeEnvironmentMembershipsRequest describeEnvironmentMembershipsRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception Gets information about environment members for an Cloud9 development environment.
- Parameters:
describeEnvironmentMembershipsRequest
-- Returns:
- Result of the DescribeEnvironmentMemberships operation returned by the service.
- See Also:
-
describeEnvironmentMemberships
default DescribeEnvironmentMembershipsResponse describeEnvironmentMemberships(Consumer<DescribeEnvironmentMembershipsRequest.Builder> describeEnvironmentMembershipsRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception 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:
- Result of the DescribeEnvironmentMemberships operation returned by the service.
- See Also:
-
describeEnvironmentMemberships
default DescribeEnvironmentMembershipsResponse describeEnvironmentMemberships() throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9ExceptionGets information about environment members for an Cloud9 development environment.
- Returns:
- Result of the DescribeEnvironmentMemberships operation returned by the service.
- See Also:
-
describeEnvironmentMembershipsPaginator
default DescribeEnvironmentMembershipsIterable describeEnvironmentMembershipsPaginator() throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9ExceptionThis is a variant of
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 Streamsoftware.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsIterable responses = client.describeEnvironmentMembershipsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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
describeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEnvironmentMembershipsPaginator
default DescribeEnvironmentMembershipsIterable describeEnvironmentMembershipsPaginator(DescribeEnvironmentMembershipsRequest describeEnvironmentMembershipsRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception This is a variant of
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 Streamsoftware.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsIterable responses = client.describeEnvironmentMembershipsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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
describeEnvironmentMemberships(software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest)
operation.- Parameters:
describeEnvironmentMembershipsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEnvironmentMembershipsPaginator
default DescribeEnvironmentMembershipsIterable describeEnvironmentMembershipsPaginator(Consumer<DescribeEnvironmentMembershipsRequest.Builder> describeEnvironmentMembershipsRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception This is a variant of
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 Streamsoftware.amazon.awssdk.services.cloud9.paginators.DescribeEnvironmentMembershipsIterable responses = client.describeEnvironmentMembershipsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEnvironmentStatus
default DescribeEnvironmentStatusResponse describeEnvironmentStatus(DescribeEnvironmentStatusRequest describeEnvironmentStatusRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception Gets status information for an Cloud9 development environment.
- Parameters:
describeEnvironmentStatusRequest
-- Returns:
- Result of the DescribeEnvironmentStatus operation returned by the service.
- See Also:
-
describeEnvironmentStatus
default DescribeEnvironmentStatusResponse describeEnvironmentStatus(Consumer<DescribeEnvironmentStatusRequest.Builder> describeEnvironmentStatusRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception 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:
- Result of the DescribeEnvironmentStatus operation returned by the service.
- See Also:
-
describeEnvironments
default DescribeEnvironmentsResponse describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception Gets information about Cloud9 development environments.
- Parameters:
describeEnvironmentsRequest
-- Returns:
- Result of the DescribeEnvironments operation returned by the service.
- See Also:
-
describeEnvironments
default DescribeEnvironmentsResponse describeEnvironments(Consumer<DescribeEnvironmentsRequest.Builder> describeEnvironmentsRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception 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:
- Result of the DescribeEnvironments operation returned by the service.
- See Also:
-
listEnvironments
default ListEnvironmentsResponse listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception Gets a list of Cloud9 development environment identifiers.
- Parameters:
listEnvironmentsRequest
-- Returns:
- Result of the ListEnvironments operation returned by the service.
- See Also:
-
listEnvironments
default ListEnvironmentsResponse listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception 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:
- Result of the ListEnvironments operation returned by the service.
- See Also:
-
listEnvironments
default ListEnvironmentsResponse listEnvironments() throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9ExceptionGets a list of Cloud9 development environment identifiers.
- Returns:
- Result of the ListEnvironments operation returned by the service.
- See Also:
-
listEnvironmentsPaginator
default ListEnvironmentsIterable listEnvironmentsPaginator() throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9ExceptionThis is a variant of
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 Streamsoftware.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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
listEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEnvironmentsPaginator
default ListEnvironmentsIterable listEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception This is a variant of
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 Streamsoftware.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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
listEnvironments(software.amazon.awssdk.services.cloud9.model.ListEnvironmentsRequest)
operation.- Parameters:
listEnvironmentsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEnvironmentsPaginator
default ListEnvironmentsIterable listEnvironmentsPaginator(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception This is a variant of
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 Streamsoftware.amazon.awssdk.services.cloud9.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws NotFoundException, InternalServerErrorException, BadRequestException, AwsServiceException, SdkClientException, Cloud9Exception Gets a list of the tags associated with an Cloud9 development environment.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws NotFoundException, InternalServerErrorException, BadRequestException, AwsServiceException, SdkClientException, Cloud9Exception 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:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws NotFoundException, InternalServerErrorException, BadRequestException, ConcurrentAccessException, AwsServiceException, SdkClientException, Cloud9Exception 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:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws NotFoundException, InternalServerErrorException, BadRequestException, ConcurrentAccessException, AwsServiceException, SdkClientException, Cloud9Exception 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:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws NotFoundException, InternalServerErrorException, BadRequestException, ConcurrentAccessException, AwsServiceException, SdkClientException, Cloud9Exception Removes tags from an Cloud9 development environment.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws NotFoundException, InternalServerErrorException, BadRequestException, ConcurrentAccessException, AwsServiceException, SdkClientException, Cloud9Exception 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:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateEnvironment
default UpdateEnvironmentResponse updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception Changes the settings of an existing Cloud9 development environment.
- Parameters:
updateEnvironmentRequest
-- Returns:
- Result of the UpdateEnvironment operation returned by the service.
- See Also:
-
updateEnvironment
default UpdateEnvironmentResponse updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception 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:
- Result of the UpdateEnvironment operation returned by the service.
- See Also:
-
updateEnvironmentMembership
default UpdateEnvironmentMembershipResponse updateEnvironmentMembership(UpdateEnvironmentMembershipRequest updateEnvironmentMembershipRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception Changes the settings of an existing environment member for an Cloud9 development environment.
- Parameters:
updateEnvironmentMembershipRequest
-- Returns:
- Result of the UpdateEnvironmentMembership operation returned by the service.
- See Also:
-
updateEnvironmentMembership
default UpdateEnvironmentMembershipResponse updateEnvironmentMembership(Consumer<UpdateEnvironmentMembershipRequest.Builder> updateEnvironmentMembershipRequest) throws BadRequestException, ConflictException, NotFoundException, ForbiddenException, TooManyRequestsException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, Cloud9Exception 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:
- Result of the UpdateEnvironmentMembership operation returned by the service.
- See Also:
-
create
Create aCloud9Client
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aCloud9Client
. -
serviceMetadata
-
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
-