software.amazon.awssdk.services.iotfleethub.IoTFleetHubAsyncClient Maven / Gradle / Ivy
Show all versions of iotfleethub 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.iotfleethub;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.services.iotfleethub.model.CreateApplicationRequest;
import software.amazon.awssdk.services.iotfleethub.model.CreateApplicationResponse;
import software.amazon.awssdk.services.iotfleethub.model.DeleteApplicationRequest;
import software.amazon.awssdk.services.iotfleethub.model.DeleteApplicationResponse;
import software.amazon.awssdk.services.iotfleethub.model.DescribeApplicationRequest;
import software.amazon.awssdk.services.iotfleethub.model.DescribeApplicationResponse;
import software.amazon.awssdk.services.iotfleethub.model.ListApplicationsRequest;
import software.amazon.awssdk.services.iotfleethub.model.ListApplicationsResponse;
import software.amazon.awssdk.services.iotfleethub.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.iotfleethub.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.iotfleethub.model.TagResourceRequest;
import software.amazon.awssdk.services.iotfleethub.model.TagResourceResponse;
import software.amazon.awssdk.services.iotfleethub.model.UntagResourceRequest;
import software.amazon.awssdk.services.iotfleethub.model.UntagResourceResponse;
import software.amazon.awssdk.services.iotfleethub.model.UpdateApplicationRequest;
import software.amazon.awssdk.services.iotfleethub.model.UpdateApplicationResponse;
import software.amazon.awssdk.services.iotfleethub.paginators.ListApplicationsPublisher;
/**
* Service client for accessing AWS IoT Fleet Hub asynchronously. This can be created using the static
* {@link #builder()} method.
*
*
* With Fleet Hub for AWS IoT Device Management you can build stand-alone web applications for monitoring the health of
* your device fleets.
*
*
*
* Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
*
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface IoTFleetHubAsyncClient extends SdkClient {
String SERVICE_NAME = "iotfleethub";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "api.fleethub.iot";
/**
* Create a {@link IoTFleetHubAsyncClient} 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 IoTFleetHubAsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link IoTFleetHubAsyncClient}.
*/
static IoTFleetHubAsyncClientBuilder builder() {
return new DefaultIoTFleetHubAsyncClientBuilder();
}
/**
*
* Creates a Fleet Hub for AWS IoT Device Management web application.
*
*
*
* Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
*
*
*
* @param createApplicationRequest
* @return A Java Future containing the result of the CreateApplication operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request is not valid.
* - InternalFailureException An unexpected error has occurred.
* - ThrottlingException The rate exceeds the limit.
* - LimitExceededException A limit has been exceeded.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTFleetHubAsyncClient.CreateApplication
* @see AWS
* API Documentation
*/
default CompletableFuture createApplication(CreateApplicationRequest createApplicationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a Fleet Hub for AWS IoT Device Management web application.
*
*
*
* Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
*
*
*
* This is a convenience which creates an instance of the {@link CreateApplicationRequest.Builder} avoiding the need
* to create one manually via {@link CreateApplicationRequest#builder()}
*
*
* @param createApplicationRequest
* A {@link Consumer} that will call methods on {@link CreateApplicationRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateApplication operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request is not valid.
* - InternalFailureException An unexpected error has occurred.
* - ThrottlingException The rate exceeds the limit.
* - LimitExceededException A limit has been exceeded.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTFleetHubAsyncClient.CreateApplication
* @see AWS
* API Documentation
*/
default CompletableFuture createApplication(
Consumer createApplicationRequest) {
return createApplication(CreateApplicationRequest.builder().applyMutation(createApplicationRequest).build());
}
/**
*
* Deletes a Fleet Hub for AWS IoT Device Management web application.
*
*
*
* Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
*
*
*
* @param deleteApplicationRequest
* @return A Java Future containing the result of the DeleteApplication operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request is not valid.
* - ResourceNotFoundException The specified resource does not exist.
* - InternalFailureException An unexpected error has occurred.
* - ThrottlingException The rate exceeds the limit.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTFleetHubAsyncClient.DeleteApplication
* @see AWS
* API Documentation
*/
default CompletableFuture deleteApplication(DeleteApplicationRequest deleteApplicationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a Fleet Hub for AWS IoT Device Management web application.
*
*
*
* Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteApplicationRequest.Builder} avoiding the need
* to create one manually via {@link DeleteApplicationRequest#builder()}
*
*
* @param deleteApplicationRequest
* A {@link Consumer} that will call methods on {@link DeleteApplicationRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteApplication operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request is not valid.
* - ResourceNotFoundException The specified resource does not exist.
* - InternalFailureException An unexpected error has occurred.
* - ThrottlingException The rate exceeds the limit.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTFleetHubAsyncClient.DeleteApplication
* @see AWS
* API Documentation
*/
default CompletableFuture deleteApplication(
Consumer deleteApplicationRequest) {
return deleteApplication(DeleteApplicationRequest.builder().applyMutation(deleteApplicationRequest).build());
}
/**
*
* Gets information about a Fleet Hub for AWS IoT Device Management web application.
*
*
*
* Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
*
*
*
* @param describeApplicationRequest
* @return A Java Future containing the result of the DescribeApplication operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request is not valid.
* - ResourceNotFoundException The specified resource does not exist.
* - InternalFailureException An unexpected error has occurred.
* - ThrottlingException The rate exceeds the limit.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTFleetHubAsyncClient.DescribeApplication
* @see AWS API Documentation
*/
default CompletableFuture describeApplication(
DescribeApplicationRequest describeApplicationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about a Fleet Hub for AWS IoT Device Management web application.
*
*
*
* Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeApplicationRequest.Builder} avoiding the
* need to create one manually via {@link DescribeApplicationRequest#builder()}
*
*
* @param describeApplicationRequest
* A {@link Consumer} that will call methods on {@link DescribeApplicationRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeApplication operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request is not valid.
* - ResourceNotFoundException The specified resource does not exist.
* - InternalFailureException An unexpected error has occurred.
* - ThrottlingException The rate exceeds the limit.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTFleetHubAsyncClient.DescribeApplication
* @see AWS API Documentation
*/
default CompletableFuture describeApplication(
Consumer describeApplicationRequest) {
return describeApplication(DescribeApplicationRequest.builder().applyMutation(describeApplicationRequest).build());
}
/**
*
* Gets a list of Fleet Hub for AWS IoT Device Management web applications for the current account.
*
*
*
* Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
*
*
*
* @param listApplicationsRequest
* @return A Java Future containing the result of the ListApplications operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request is not valid.
* - InternalFailureException An unexpected error has occurred.
* - ThrottlingException The rate exceeds the limit.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTFleetHubAsyncClient.ListApplications
* @see AWS
* API Documentation
*/
default CompletableFuture listApplications(ListApplicationsRequest listApplicationsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets a list of Fleet Hub for AWS IoT Device Management web applications for the current account.
*
*
*
* Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
*
*
*
* This is a convenience which creates an instance of the {@link ListApplicationsRequest.Builder} avoiding the need
* to create one manually via {@link ListApplicationsRequest#builder()}
*
*
* @param listApplicationsRequest
* A {@link Consumer} that will call methods on {@link ListApplicationsRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListApplications operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request is not valid.
* - InternalFailureException An unexpected error has occurred.
* - ThrottlingException The rate exceeds the limit.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTFleetHubAsyncClient.ListApplications
* @see AWS
* API Documentation
*/
default CompletableFuture listApplications(
Consumer listApplicationsRequest) {
return listApplications(ListApplicationsRequest.builder().applyMutation(listApplicationsRequest).build());
}
/**
*
* Gets a list of Fleet Hub for AWS IoT Device Management web applications for the current account.
*
*
*
* Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
*
*
*
* This is a variant of
* {@link #listApplications(software.amazon.awssdk.services.iotfleethub.model.ListApplicationsRequest)} operation.
* The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.iotfleethub.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.iotfleethub.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.iotfleethub.model.ListApplicationsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of null 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 #listApplications(software.amazon.awssdk.services.iotfleethub.model.ListApplicationsRequest)}
* operation.
*
*
* @param listApplicationsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request is not valid.
* - InternalFailureException An unexpected error has occurred.
* - ThrottlingException The rate exceeds the limit.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTFleetHubAsyncClient.ListApplications
* @see AWS
* API Documentation
*/
default ListApplicationsPublisher listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets a list of Fleet Hub for AWS IoT Device Management web applications for the current account.
*
*
*
* Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
*
*
*
* This is a variant of
* {@link #listApplications(software.amazon.awssdk.services.iotfleethub.model.ListApplicationsRequest)} operation.
* The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.iotfleethub.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.iotfleethub.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.iotfleethub.model.ListApplicationsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of null 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 #listApplications(software.amazon.awssdk.services.iotfleethub.model.ListApplicationsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListApplicationsRequest.Builder} avoiding the need
* to create one manually via {@link ListApplicationsRequest#builder()}
*
*
* @param listApplicationsRequest
* A {@link Consumer} that will call methods on {@link ListApplicationsRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request is not valid.
* - InternalFailureException An unexpected error has occurred.
* - ThrottlingException The rate exceeds the limit.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTFleetHubAsyncClient.ListApplications
* @see AWS
* API Documentation
*/
default ListApplicationsPublisher listApplicationsPaginator(Consumer listApplicationsRequest) {
return listApplicationsPaginator(ListApplicationsRequest.builder().applyMutation(listApplicationsRequest).build());
}
/**
*
* Lists the tags for the specified resource.
*
*
*
* Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
*
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InternalFailureException An unexpected error has occurred.
* - InvalidRequestException The request is not valid.
* - ResourceNotFoundException The specified resource does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTFleetHubAsyncClient.ListTagsForResource
* @see AWS API Documentation
*/
default CompletableFuture listTagsForResource(
ListTagsForResourceRequest listTagsForResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the tags for the specified resource.
*
*
*
* Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
*
*
*
* 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 A Java Future containing the result of the ListTagsForResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InternalFailureException An unexpected error has occurred.
* - InvalidRequestException The request is not valid.
* - ResourceNotFoundException The specified resource does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTFleetHubAsyncClient.ListTagsForResource
* @see AWS API Documentation
*/
default CompletableFuture listTagsForResource(
Consumer listTagsForResourceRequest) {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource.
*
*
*
* Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
*
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InternalFailureException An unexpected error has occurred.
* - InvalidRequestException The request is not valid.
* - ResourceNotFoundException The specified resource does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTFleetHubAsyncClient.TagResource
* @see AWS API
* Documentation
*/
default CompletableFuture tagResource(TagResourceRequest tagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource.
*
*
*
* Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
*
*
*
* 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 A Java Future containing the result of the TagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InternalFailureException An unexpected error has occurred.
* - InvalidRequestException The request is not valid.
* - ResourceNotFoundException The specified resource does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTFleetHubAsyncClient.TagResource
* @see AWS API
* Documentation
*/
default CompletableFuture tagResource(Consumer tagResourceRequest) {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* Removes the specified tags (metadata) from the resource.
*
*
*
* Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
*
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InternalFailureException An unexpected error has occurred.
* - InvalidRequestException The request is not valid.
* - ResourceNotFoundException The specified resource does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTFleetHubAsyncClient.UntagResource
* @see AWS API
* Documentation
*/
default CompletableFuture untagResource(UntagResourceRequest untagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Removes the specified tags (metadata) from the resource.
*
*
*
* Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
*
*
*
* 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 A Java Future containing the result of the UntagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InternalFailureException An unexpected error has occurred.
* - InvalidRequestException The request is not valid.
* - ResourceNotFoundException The specified resource does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTFleetHubAsyncClient.UntagResource
* @see AWS API
* Documentation
*/
default CompletableFuture untagResource(Consumer untagResourceRequest) {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* Updates information about a Fleet Hub for a AWS IoT Device Management web application.
*
*
*
* Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
*
*
*
* @param updateApplicationRequest
* @return A Java Future containing the result of the UpdateApplication operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request is not valid.
* - ResourceNotFoundException The specified resource does not exist.
* - InternalFailureException An unexpected error has occurred.
* - ConflictException The request conflicts with the current state of the resource.
* - ThrottlingException The rate exceeds the limit.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTFleetHubAsyncClient.UpdateApplication
* @see AWS
* API Documentation
*/
default CompletableFuture updateApplication(UpdateApplicationRequest updateApplicationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates information about a Fleet Hub for a AWS IoT Device Management web application.
*
*
*
* Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateApplicationRequest.Builder} avoiding the need
* to create one manually via {@link UpdateApplicationRequest#builder()}
*
*
* @param updateApplicationRequest
* A {@link Consumer} that will call methods on {@link UpdateApplicationRequest.Builder} to create a request.
* @return A Java Future containing the result of the UpdateApplication operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request is not valid.
* - ResourceNotFoundException The specified resource does not exist.
* - InternalFailureException An unexpected error has occurred.
* - ConflictException The request conflicts with the current state of the resource.
* - ThrottlingException The rate exceeds the limit.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTFleetHubAsyncClient.UpdateApplication
* @see AWS
* API Documentation
*/
default CompletableFuture updateApplication(
Consumer updateApplicationRequest) {
return updateApplication(UpdateApplicationRequest.builder().applyMutation(updateApplicationRequest).build());
}
}