software.amazon.awssdk.services.iotanalytics.IoTAnalyticsAsyncClient Maven / Gradle / Ivy
/*
* 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.iotanalytics;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.services.iotanalytics.model.BatchPutMessageRequest;
import software.amazon.awssdk.services.iotanalytics.model.BatchPutMessageResponse;
import software.amazon.awssdk.services.iotanalytics.model.CancelPipelineReprocessingRequest;
import software.amazon.awssdk.services.iotanalytics.model.CancelPipelineReprocessingResponse;
import software.amazon.awssdk.services.iotanalytics.model.CreateChannelRequest;
import software.amazon.awssdk.services.iotanalytics.model.CreateChannelResponse;
import software.amazon.awssdk.services.iotanalytics.model.CreateDatasetContentRequest;
import software.amazon.awssdk.services.iotanalytics.model.CreateDatasetContentResponse;
import software.amazon.awssdk.services.iotanalytics.model.CreateDatasetRequest;
import software.amazon.awssdk.services.iotanalytics.model.CreateDatasetResponse;
import software.amazon.awssdk.services.iotanalytics.model.CreateDatastoreRequest;
import software.amazon.awssdk.services.iotanalytics.model.CreateDatastoreResponse;
import software.amazon.awssdk.services.iotanalytics.model.CreatePipelineRequest;
import software.amazon.awssdk.services.iotanalytics.model.CreatePipelineResponse;
import software.amazon.awssdk.services.iotanalytics.model.DeleteChannelRequest;
import software.amazon.awssdk.services.iotanalytics.model.DeleteChannelResponse;
import software.amazon.awssdk.services.iotanalytics.model.DeleteDatasetContentRequest;
import software.amazon.awssdk.services.iotanalytics.model.DeleteDatasetContentResponse;
import software.amazon.awssdk.services.iotanalytics.model.DeleteDatasetRequest;
import software.amazon.awssdk.services.iotanalytics.model.DeleteDatasetResponse;
import software.amazon.awssdk.services.iotanalytics.model.DeleteDatastoreRequest;
import software.amazon.awssdk.services.iotanalytics.model.DeleteDatastoreResponse;
import software.amazon.awssdk.services.iotanalytics.model.DeletePipelineRequest;
import software.amazon.awssdk.services.iotanalytics.model.DeletePipelineResponse;
import software.amazon.awssdk.services.iotanalytics.model.DescribeChannelRequest;
import software.amazon.awssdk.services.iotanalytics.model.DescribeChannelResponse;
import software.amazon.awssdk.services.iotanalytics.model.DescribeDatasetRequest;
import software.amazon.awssdk.services.iotanalytics.model.DescribeDatasetResponse;
import software.amazon.awssdk.services.iotanalytics.model.DescribeDatastoreRequest;
import software.amazon.awssdk.services.iotanalytics.model.DescribeDatastoreResponse;
import software.amazon.awssdk.services.iotanalytics.model.DescribeLoggingOptionsRequest;
import software.amazon.awssdk.services.iotanalytics.model.DescribeLoggingOptionsResponse;
import software.amazon.awssdk.services.iotanalytics.model.DescribePipelineRequest;
import software.amazon.awssdk.services.iotanalytics.model.DescribePipelineResponse;
import software.amazon.awssdk.services.iotanalytics.model.GetDatasetContentRequest;
import software.amazon.awssdk.services.iotanalytics.model.GetDatasetContentResponse;
import software.amazon.awssdk.services.iotanalytics.model.ListChannelsRequest;
import software.amazon.awssdk.services.iotanalytics.model.ListChannelsResponse;
import software.amazon.awssdk.services.iotanalytics.model.ListDatasetContentsRequest;
import software.amazon.awssdk.services.iotanalytics.model.ListDatasetContentsResponse;
import software.amazon.awssdk.services.iotanalytics.model.ListDatasetsRequest;
import software.amazon.awssdk.services.iotanalytics.model.ListDatasetsResponse;
import software.amazon.awssdk.services.iotanalytics.model.ListDatastoresRequest;
import software.amazon.awssdk.services.iotanalytics.model.ListDatastoresResponse;
import software.amazon.awssdk.services.iotanalytics.model.ListPipelinesRequest;
import software.amazon.awssdk.services.iotanalytics.model.ListPipelinesResponse;
import software.amazon.awssdk.services.iotanalytics.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.iotanalytics.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.iotanalytics.model.PutLoggingOptionsRequest;
import software.amazon.awssdk.services.iotanalytics.model.PutLoggingOptionsResponse;
import software.amazon.awssdk.services.iotanalytics.model.RunPipelineActivityRequest;
import software.amazon.awssdk.services.iotanalytics.model.RunPipelineActivityResponse;
import software.amazon.awssdk.services.iotanalytics.model.SampleChannelDataRequest;
import software.amazon.awssdk.services.iotanalytics.model.SampleChannelDataResponse;
import software.amazon.awssdk.services.iotanalytics.model.StartPipelineReprocessingRequest;
import software.amazon.awssdk.services.iotanalytics.model.StartPipelineReprocessingResponse;
import software.amazon.awssdk.services.iotanalytics.model.TagResourceRequest;
import software.amazon.awssdk.services.iotanalytics.model.TagResourceResponse;
import software.amazon.awssdk.services.iotanalytics.model.UntagResourceRequest;
import software.amazon.awssdk.services.iotanalytics.model.UntagResourceResponse;
import software.amazon.awssdk.services.iotanalytics.model.UpdateChannelRequest;
import software.amazon.awssdk.services.iotanalytics.model.UpdateChannelResponse;
import software.amazon.awssdk.services.iotanalytics.model.UpdateDatasetRequest;
import software.amazon.awssdk.services.iotanalytics.model.UpdateDatasetResponse;
import software.amazon.awssdk.services.iotanalytics.model.UpdateDatastoreRequest;
import software.amazon.awssdk.services.iotanalytics.model.UpdateDatastoreResponse;
import software.amazon.awssdk.services.iotanalytics.model.UpdatePipelineRequest;
import software.amazon.awssdk.services.iotanalytics.model.UpdatePipelineResponse;
import software.amazon.awssdk.services.iotanalytics.paginators.ListChannelsPublisher;
import software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetContentsPublisher;
import software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetsPublisher;
import software.amazon.awssdk.services.iotanalytics.paginators.ListDatastoresPublisher;
import software.amazon.awssdk.services.iotanalytics.paginators.ListPipelinesPublisher;
/**
* Service client for accessing AWS IoT Analytics asynchronously. This can be created using the static
* {@link #builder()} method.
*
*
* AWS IoT Analytics allows you to collect large amounts of device data, process messages, and store them. You can then
* query the data and run sophisticated analytics on it. AWS IoT Analytics enables advanced data exploration through
* integration with Jupyter Notebooks and data visualization through integration with Amazon QuickSight.
*
*
* Traditional analytics and business intelligence tools are designed to process structured data. IoT data often comes
* from devices that record noisy processes (such as temperature, motion, or sound). As a result the data from these
* devices can have significant gaps, corrupted messages, and false readings that must be cleaned up before analysis can
* occur. Also, IoT data is often only meaningful in the context of other data from external sources.
*
*
* AWS IoT Analytics automates the steps required to analyze data from IoT devices. AWS IoT Analytics filters,
* transforms, and enriches IoT data before storing it in a time-series data store for analysis. You can set up the
* service to collect only the data you need from your devices, apply mathematical transforms to process the data, and
* enrich the data with device-specific metadata such as device type and location before storing it. Then, you can
* analyze your data by running queries using the built-in SQL query engine, or perform more complex analytics and
* machine learning inference. AWS IoT Analytics includes pre-built models for common IoT use cases so you can answer
* questions like which devices are about to fail or which customers are at risk of abandoning their wearable devices.
*
*/
@Generated("software.amazon.awssdk:codegen")
public interface IoTAnalyticsAsyncClient extends SdkClient {
String SERVICE_NAME = "iotanalytics";
/**
* Create a {@link IoTAnalyticsAsyncClient} 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 IoTAnalyticsAsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link IoTAnalyticsAsyncClient}.
*/
static IoTAnalyticsAsyncClientBuilder builder() {
return new DefaultIoTAnalyticsAsyncClientBuilder();
}
/**
*
* Sends messages to a channel.
*
*
* @param batchPutMessageRequest
* @return A Java Future containing the result of the BatchPutMessage operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.BatchPutMessage
* @see AWS
* API Documentation
*/
default CompletableFuture batchPutMessage(BatchPutMessageRequest batchPutMessageRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Sends messages to a channel.
*
*
*
* This is a convenience which creates an instance of the {@link BatchPutMessageRequest.Builder} avoiding the need
* to create one manually via {@link BatchPutMessageRequest#builder()}
*
*
* @param batchPutMessageRequest
* A {@link Consumer} that will call methods on {@link BatchPutMessageRequest.Builder} to create a request.
* @return A Java Future containing the result of the BatchPutMessage operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.BatchPutMessage
* @see AWS
* API Documentation
*/
default CompletableFuture batchPutMessage(
Consumer batchPutMessageRequest) {
return batchPutMessage(BatchPutMessageRequest.builder().applyMutation(batchPutMessageRequest).build());
}
/**
*
* Cancels the reprocessing of data through the pipeline.
*
*
* @param cancelPipelineReprocessingRequest
* @return A Java Future containing the result of the CancelPipelineReprocessing operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.CancelPipelineReprocessing
* @see AWS API Documentation
*/
default CompletableFuture cancelPipelineReprocessing(
CancelPipelineReprocessingRequest cancelPipelineReprocessingRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Cancels the reprocessing of data through the pipeline.
*
*
*
* This is a convenience which creates an instance of the {@link CancelPipelineReprocessingRequest.Builder} avoiding
* the need to create one manually via {@link CancelPipelineReprocessingRequest#builder()}
*
*
* @param cancelPipelineReprocessingRequest
* A {@link Consumer} that will call methods on {@link CancelPipelineReprocessingRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CancelPipelineReprocessing operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.CancelPipelineReprocessing
* @see AWS API Documentation
*/
default CompletableFuture cancelPipelineReprocessing(
Consumer cancelPipelineReprocessingRequest) {
return cancelPipelineReprocessing(CancelPipelineReprocessingRequest.builder()
.applyMutation(cancelPipelineReprocessingRequest).build());
}
/**
*
* Creates a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before
* publishing the data to a pipeline.
*
*
* @param createChannelRequest
* @return A Java Future containing the result of the CreateChannel operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceAlreadyExistsException A resource with the same name already exists.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - LimitExceededException The command caused an internal limit to be 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.CreateChannel
* @see AWS API
* Documentation
*/
default CompletableFuture createChannel(CreateChannelRequest createChannelRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before
* publishing the data to a pipeline.
*
*
*
* This is a convenience which creates an instance of the {@link CreateChannelRequest.Builder} avoiding the need to
* create one manually via {@link CreateChannelRequest#builder()}
*
*
* @param createChannelRequest
* A {@link Consumer} that will call methods on {@link CreateChannelRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateChannel operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceAlreadyExistsException A resource with the same name already exists.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - LimitExceededException The command caused an internal limit to be 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.CreateChannel
* @see AWS API
* Documentation
*/
default CompletableFuture createChannel(Consumer createChannelRequest) {
return createChannel(CreateChannelRequest.builder().applyMutation(createChannelRequest).build());
}
/**
*
* Creates a data set. A data set stores data retrieved from a data store by applying a "queryAction" (a SQL query)
* or a "containerAction" (executing a containerized application). This operation creates the skeleton of a data
* set. The data set can be populated manually by calling "CreateDatasetContent" or automatically according to a
* "trigger" you specify.
*
*
* @param createDatasetRequest
* @return A Java Future containing the result of the CreateDataset operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceAlreadyExistsException A resource with the same name already exists.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - LimitExceededException The command caused an internal limit to be 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.CreateDataset
* @see AWS API
* Documentation
*/
default CompletableFuture createDataset(CreateDatasetRequest createDatasetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a data set. A data set stores data retrieved from a data store by applying a "queryAction" (a SQL query)
* or a "containerAction" (executing a containerized application). This operation creates the skeleton of a data
* set. The data set can be populated manually by calling "CreateDatasetContent" or automatically according to a
* "trigger" you specify.
*
*
*
* This is a convenience which creates an instance of the {@link CreateDatasetRequest.Builder} avoiding the need to
* create one manually via {@link CreateDatasetRequest#builder()}
*
*
* @param createDatasetRequest
* A {@link Consumer} that will call methods on {@link CreateDatasetRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateDataset operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceAlreadyExistsException A resource with the same name already exists.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - LimitExceededException The command caused an internal limit to be 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.CreateDataset
* @see AWS API
* Documentation
*/
default CompletableFuture createDataset(Consumer createDatasetRequest) {
return createDataset(CreateDatasetRequest.builder().applyMutation(createDatasetRequest).build());
}
/**
*
* Creates the content of a data set by applying a "queryAction" (a SQL query) or a "containerAction" (executing a
* containerized application).
*
*
* @param createDatasetContentRequest
* @return A Java Future containing the result of the CreateDatasetContent operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.CreateDatasetContent
* @see AWS API Documentation
*/
default CompletableFuture createDatasetContent(
CreateDatasetContentRequest createDatasetContentRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates the content of a data set by applying a "queryAction" (a SQL query) or a "containerAction" (executing a
* containerized application).
*
*
*
* This is a convenience which creates an instance of the {@link CreateDatasetContentRequest.Builder} avoiding the
* need to create one manually via {@link CreateDatasetContentRequest#builder()}
*
*
* @param createDatasetContentRequest
* A {@link Consumer} that will call methods on {@link CreateDatasetContentRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateDatasetContent operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.CreateDatasetContent
* @see AWS API Documentation
*/
default CompletableFuture createDatasetContent(
Consumer createDatasetContentRequest) {
return createDatasetContent(CreateDatasetContentRequest.builder().applyMutation(createDatasetContentRequest).build());
}
/**
*
* Creates a data store, which is a repository for messages.
*
*
* @param createDatastoreRequest
* @return A Java Future containing the result of the CreateDatastore operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceAlreadyExistsException A resource with the same name already exists.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - LimitExceededException The command caused an internal limit to be 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.CreateDatastore
* @see AWS
* API Documentation
*/
default CompletableFuture createDatastore(CreateDatastoreRequest createDatastoreRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a data store, which is a repository for messages.
*
*
*
* This is a convenience which creates an instance of the {@link CreateDatastoreRequest.Builder} avoiding the need
* to create one manually via {@link CreateDatastoreRequest#builder()}
*
*
* @param createDatastoreRequest
* A {@link Consumer} that will call methods on {@link CreateDatastoreRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateDatastore operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceAlreadyExistsException A resource with the same name already exists.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - LimitExceededException The command caused an internal limit to be 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.CreateDatastore
* @see AWS
* API Documentation
*/
default CompletableFuture createDatastore(
Consumer createDatastoreRequest) {
return createDatastore(CreateDatastoreRequest.builder().applyMutation(createDatastoreRequest).build());
}
/**
*
* Creates a pipeline. A pipeline consumes messages from a channel and allows you to process the messages before
* storing them in a data store. You must specify both a channel and a datastore activity
* and, optionally, as many as 23 additional activities in the pipelineActivities array.
*
*
* @param createPipelineRequest
* @return A Java Future containing the result of the CreatePipeline operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceAlreadyExistsException A resource with the same name already exists.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - LimitExceededException The command caused an internal limit to be 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.CreatePipeline
* @see AWS
* API Documentation
*/
default CompletableFuture createPipeline(CreatePipelineRequest createPipelineRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a pipeline. A pipeline consumes messages from a channel and allows you to process the messages before
* storing them in a data store. You must specify both a channel and a datastore activity
* and, optionally, as many as 23 additional activities in the pipelineActivities array.
*
*
*
* This is a convenience which creates an instance of the {@link CreatePipelineRequest.Builder} avoiding the need to
* create one manually via {@link CreatePipelineRequest#builder()}
*
*
* @param createPipelineRequest
* A {@link Consumer} that will call methods on {@link CreatePipelineRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreatePipeline operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceAlreadyExistsException A resource with the same name already exists.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - LimitExceededException The command caused an internal limit to be 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.CreatePipeline
* @see AWS
* API Documentation
*/
default CompletableFuture createPipeline(Consumer createPipelineRequest) {
return createPipeline(CreatePipelineRequest.builder().applyMutation(createPipelineRequest).build());
}
/**
*
* Deletes the specified channel.
*
*
* @param deleteChannelRequest
* @return A Java Future containing the result of the DeleteChannel operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.DeleteChannel
* @see AWS API
* Documentation
*/
default CompletableFuture deleteChannel(DeleteChannelRequest deleteChannelRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified channel.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteChannelRequest.Builder} avoiding the need to
* create one manually via {@link DeleteChannelRequest#builder()}
*
*
* @param deleteChannelRequest
* A {@link Consumer} that will call methods on {@link DeleteChannelRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteChannel operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.DeleteChannel
* @see AWS API
* Documentation
*/
default CompletableFuture deleteChannel(Consumer deleteChannelRequest) {
return deleteChannel(DeleteChannelRequest.builder().applyMutation(deleteChannelRequest).build());
}
/**
*
* Deletes the specified data set.
*
*
* You do not have to delete the content of the data set before you perform this operation.
*
*
* @param deleteDatasetRequest
* @return A Java Future containing the result of the DeleteDataset operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.DeleteDataset
* @see AWS API
* Documentation
*/
default CompletableFuture deleteDataset(DeleteDatasetRequest deleteDatasetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified data set.
*
*
* You do not have to delete the content of the data set before you perform this operation.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteDatasetRequest.Builder} avoiding the need to
* create one manually via {@link DeleteDatasetRequest#builder()}
*
*
* @param deleteDatasetRequest
* A {@link Consumer} that will call methods on {@link DeleteDatasetRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteDataset operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.DeleteDataset
* @see AWS API
* Documentation
*/
default CompletableFuture deleteDataset(Consumer deleteDatasetRequest) {
return deleteDataset(DeleteDatasetRequest.builder().applyMutation(deleteDatasetRequest).build());
}
/**
*
* Deletes the content of the specified data set.
*
*
* @param deleteDatasetContentRequest
* @return A Java Future containing the result of the DeleteDatasetContent operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.DeleteDatasetContent
* @see AWS API Documentation
*/
default CompletableFuture deleteDatasetContent(
DeleteDatasetContentRequest deleteDatasetContentRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the content of the specified data set.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteDatasetContentRequest.Builder} avoiding the
* need to create one manually via {@link DeleteDatasetContentRequest#builder()}
*
*
* @param deleteDatasetContentRequest
* A {@link Consumer} that will call methods on {@link DeleteDatasetContentRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteDatasetContent operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.DeleteDatasetContent
* @see AWS API Documentation
*/
default CompletableFuture deleteDatasetContent(
Consumer deleteDatasetContentRequest) {
return deleteDatasetContent(DeleteDatasetContentRequest.builder().applyMutation(deleteDatasetContentRequest).build());
}
/**
*
* Deletes the specified data store.
*
*
* @param deleteDatastoreRequest
* @return A Java Future containing the result of the DeleteDatastore operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.DeleteDatastore
* @see AWS
* API Documentation
*/
default CompletableFuture deleteDatastore(DeleteDatastoreRequest deleteDatastoreRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified data store.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteDatastoreRequest.Builder} avoiding the need
* to create one manually via {@link DeleteDatastoreRequest#builder()}
*
*
* @param deleteDatastoreRequest
* A {@link Consumer} that will call methods on {@link DeleteDatastoreRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteDatastore operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.DeleteDatastore
* @see AWS
* API Documentation
*/
default CompletableFuture deleteDatastore(
Consumer deleteDatastoreRequest) {
return deleteDatastore(DeleteDatastoreRequest.builder().applyMutation(deleteDatastoreRequest).build());
}
/**
*
* Deletes the specified pipeline.
*
*
* @param deletePipelineRequest
* @return A Java Future containing the result of the DeletePipeline operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.DeletePipeline
* @see AWS
* API Documentation
*/
default CompletableFuture deletePipeline(DeletePipelineRequest deletePipelineRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified pipeline.
*
*
*
* This is a convenience which creates an instance of the {@link DeletePipelineRequest.Builder} avoiding the need to
* create one manually via {@link DeletePipelineRequest#builder()}
*
*
* @param deletePipelineRequest
* A {@link Consumer} that will call methods on {@link DeletePipelineRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeletePipeline operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.DeletePipeline
* @see AWS
* API Documentation
*/
default CompletableFuture deletePipeline(Consumer deletePipelineRequest) {
return deletePipeline(DeletePipelineRequest.builder().applyMutation(deletePipelineRequest).build());
}
/**
*
* Retrieves information about a channel.
*
*
* @param describeChannelRequest
* @return A Java Future containing the result of the DescribeChannel operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.DescribeChannel
* @see AWS
* API Documentation
*/
default CompletableFuture describeChannel(DescribeChannelRequest describeChannelRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves information about a channel.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeChannelRequest.Builder} avoiding the need
* to create one manually via {@link DescribeChannelRequest#builder()}
*
*
* @param describeChannelRequest
* A {@link Consumer} that will call methods on {@link DescribeChannelRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribeChannel operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.DescribeChannel
* @see AWS
* API Documentation
*/
default CompletableFuture describeChannel(
Consumer describeChannelRequest) {
return describeChannel(DescribeChannelRequest.builder().applyMutation(describeChannelRequest).build());
}
/**
*
* Retrieves information about a data set.
*
*
* @param describeDatasetRequest
* @return A Java Future containing the result of the DescribeDataset operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.DescribeDataset
* @see AWS
* API Documentation
*/
default CompletableFuture describeDataset(DescribeDatasetRequest describeDatasetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves information about a data set.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeDatasetRequest.Builder} avoiding the need
* to create one manually via {@link DescribeDatasetRequest#builder()}
*
*
* @param describeDatasetRequest
* A {@link Consumer} that will call methods on {@link DescribeDatasetRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribeDataset operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.DescribeDataset
* @see AWS
* API Documentation
*/
default CompletableFuture describeDataset(
Consumer describeDatasetRequest) {
return describeDataset(DescribeDatasetRequest.builder().applyMutation(describeDatasetRequest).build());
}
/**
*
* Retrieves information about a data store.
*
*
* @param describeDatastoreRequest
* @return A Java Future containing the result of the DescribeDatastore operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.DescribeDatastore
* @see AWS
* API Documentation
*/
default CompletableFuture describeDatastore(DescribeDatastoreRequest describeDatastoreRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves information about a data store.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeDatastoreRequest.Builder} avoiding the need
* to create one manually via {@link DescribeDatastoreRequest#builder()}
*
*
* @param describeDatastoreRequest
* A {@link Consumer} that will call methods on {@link DescribeDatastoreRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribeDatastore operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.DescribeDatastore
* @see AWS
* API Documentation
*/
default CompletableFuture describeDatastore(
Consumer describeDatastoreRequest) {
return describeDatastore(DescribeDatastoreRequest.builder().applyMutation(describeDatastoreRequest).build());
}
/**
*
* Retrieves the current settings of the AWS IoT Analytics logging options.
*
*
* @param describeLoggingOptionsRequest
* @return A Java Future containing the result of the DescribeLoggingOptions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.DescribeLoggingOptions
* @see AWS API Documentation
*/
default CompletableFuture describeLoggingOptions(
DescribeLoggingOptionsRequest describeLoggingOptionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves the current settings of the AWS IoT Analytics logging options.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeLoggingOptionsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeLoggingOptionsRequest#builder()}
*
*
* @param describeLoggingOptionsRequest
* A {@link Consumer} that will call methods on {@link DescribeLoggingOptionsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeLoggingOptions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.DescribeLoggingOptions
* @see AWS API Documentation
*/
default CompletableFuture describeLoggingOptions(
Consumer describeLoggingOptionsRequest) {
return describeLoggingOptions(DescribeLoggingOptionsRequest.builder().applyMutation(describeLoggingOptionsRequest)
.build());
}
/**
*
* Retrieves information about a pipeline.
*
*
* @param describePipelineRequest
* @return A Java Future containing the result of the DescribePipeline operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.DescribePipeline
* @see AWS
* API Documentation
*/
default CompletableFuture describePipeline(DescribePipelineRequest describePipelineRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves information about a pipeline.
*
*
*
* This is a convenience which creates an instance of the {@link DescribePipelineRequest.Builder} avoiding the need
* to create one manually via {@link DescribePipelineRequest#builder()}
*
*
* @param describePipelineRequest
* A {@link Consumer} that will call methods on {@link DescribePipelineRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribePipeline operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.DescribePipeline
* @see AWS
* API Documentation
*/
default CompletableFuture describePipeline(
Consumer describePipelineRequest) {
return describePipeline(DescribePipelineRequest.builder().applyMutation(describePipelineRequest).build());
}
/**
*
* Retrieves the contents of a data set as pre-signed URIs.
*
*
* @param getDatasetContentRequest
* @return A Java Future containing the result of the GetDatasetContent operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.GetDatasetContent
* @see AWS
* API Documentation
*/
default CompletableFuture getDatasetContent(GetDatasetContentRequest getDatasetContentRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves the contents of a data set as pre-signed URIs.
*
*
*
* This is a convenience which creates an instance of the {@link GetDatasetContentRequest.Builder} avoiding the need
* to create one manually via {@link GetDatasetContentRequest#builder()}
*
*
* @param getDatasetContentRequest
* A {@link Consumer} that will call methods on {@link GetDatasetContentRequest.Builder} to create a request.
* @return A Java Future containing the result of the GetDatasetContent operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.GetDatasetContent
* @see AWS
* API Documentation
*/
default CompletableFuture getDatasetContent(
Consumer getDatasetContentRequest) {
return getDatasetContent(GetDatasetContentRequest.builder().applyMutation(getDatasetContentRequest).build());
}
/**
*
* Retrieves a list of channels.
*
*
* @param listChannelsRequest
* @return A Java Future containing the result of the ListChannels operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListChannels
* @see AWS API
* Documentation
*/
default CompletableFuture listChannels(ListChannelsRequest listChannelsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a list of channels.
*
*
*
* This is a convenience which creates an instance of the {@link ListChannelsRequest.Builder} avoiding the need to
* create one manually via {@link ListChannelsRequest#builder()}
*
*
* @param listChannelsRequest
* A {@link Consumer} that will call methods on {@link ListChannelsRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListChannels operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListChannels
* @see AWS API
* Documentation
*/
default CompletableFuture listChannels(Consumer listChannelsRequest) {
return listChannels(ListChannelsRequest.builder().applyMutation(listChannelsRequest).build());
}
/**
*
* Retrieves a list of channels.
*
*
* @return A Java Future containing the result of the ListChannels operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListChannels
* @see AWS API
* Documentation
*/
default CompletableFuture listChannels() {
return listChannels(ListChannelsRequest.builder().build());
}
/**
*
* Retrieves a list of channels.
*
*
*
* This is a variant of
* {@link #listChannels(software.amazon.awssdk.services.iotanalytics.model.ListChannelsRequest)} 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.iotanalytics.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.iotanalytics.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListChannelsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listChannels(software.amazon.awssdk.services.iotanalytics.model.ListChannelsRequest)} operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListChannels
* @see AWS API
* Documentation
*/
default ListChannelsPublisher listChannelsPaginator() {
return listChannelsPaginator(ListChannelsRequest.builder().build());
}
/**
*
* Retrieves a list of channels.
*
*
*
* This is a variant of
* {@link #listChannels(software.amazon.awssdk.services.iotanalytics.model.ListChannelsRequest)} 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.iotanalytics.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.iotanalytics.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListChannelsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listChannels(software.amazon.awssdk.services.iotanalytics.model.ListChannelsRequest)} operation.
*
*
* @param listChannelsRequest
* @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 was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListChannels
* @see AWS API
* Documentation
*/
default ListChannelsPublisher listChannelsPaginator(ListChannelsRequest listChannelsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a list of channels.
*
*
*
* This is a variant of
* {@link #listChannels(software.amazon.awssdk.services.iotanalytics.model.ListChannelsRequest)} 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.iotanalytics.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.iotanalytics.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListChannelsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listChannels(software.amazon.awssdk.services.iotanalytics.model.ListChannelsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListChannelsRequest.Builder} avoiding the need to
* create one manually via {@link ListChannelsRequest#builder()}
*
*
* @param listChannelsRequest
* A {@link Consumer} that will call methods on {@link ListChannelsRequest.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 was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListChannels
* @see AWS API
* Documentation
*/
default ListChannelsPublisher listChannelsPaginator(Consumer listChannelsRequest) {
return listChannelsPaginator(ListChannelsRequest.builder().applyMutation(listChannelsRequest).build());
}
/**
*
* Lists information about data set contents that have been created.
*
*
* @param listDatasetContentsRequest
* @return A Java Future containing the result of the ListDatasetContents operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListDatasetContents
* @see AWS API Documentation
*/
default CompletableFuture listDatasetContents(
ListDatasetContentsRequest listDatasetContentsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists information about data set contents that have been created.
*
*
*
* This is a convenience which creates an instance of the {@link ListDatasetContentsRequest.Builder} avoiding the
* need to create one manually via {@link ListDatasetContentsRequest#builder()}
*
*
* @param listDatasetContentsRequest
* A {@link Consumer} that will call methods on {@link ListDatasetContentsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListDatasetContents operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListDatasetContents
* @see AWS API Documentation
*/
default CompletableFuture listDatasetContents(
Consumer listDatasetContentsRequest) {
return listDatasetContents(ListDatasetContentsRequest.builder().applyMutation(listDatasetContentsRequest).build());
}
/**
*
* Lists information about data set contents that have been created.
*
*
*
* This is a variant of
* {@link #listDatasetContents(software.amazon.awssdk.services.iotanalytics.model.ListDatasetContentsRequest)}
* 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.iotanalytics.paginators.ListDatasetContentsPublisher publisher = client.listDatasetContentsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetContentsPublisher publisher = client.listDatasetContentsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListDatasetContentsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listDatasetContents(software.amazon.awssdk.services.iotanalytics.model.ListDatasetContentsRequest)}
* operation.
*
*
* @param listDatasetContentsRequest
* @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 was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListDatasetContents
* @see AWS API Documentation
*/
default ListDatasetContentsPublisher listDatasetContentsPaginator(ListDatasetContentsRequest listDatasetContentsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists information about data set contents that have been created.
*
*
*
* This is a variant of
* {@link #listDatasetContents(software.amazon.awssdk.services.iotanalytics.model.ListDatasetContentsRequest)}
* 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.iotanalytics.paginators.ListDatasetContentsPublisher publisher = client.listDatasetContentsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetContentsPublisher publisher = client.listDatasetContentsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListDatasetContentsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listDatasetContents(software.amazon.awssdk.services.iotanalytics.model.ListDatasetContentsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListDatasetContentsRequest.Builder} avoiding the
* need to create one manually via {@link ListDatasetContentsRequest#builder()}
*
*
* @param listDatasetContentsRequest
* A {@link Consumer} that will call methods on {@link ListDatasetContentsRequest.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 was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListDatasetContents
* @see AWS API Documentation
*/
default ListDatasetContentsPublisher listDatasetContentsPaginator(
Consumer listDatasetContentsRequest) {
return listDatasetContentsPaginator(ListDatasetContentsRequest.builder().applyMutation(listDatasetContentsRequest)
.build());
}
/**
*
* Retrieves information about data sets.
*
*
* @param listDatasetsRequest
* @return A Java Future containing the result of the ListDatasets operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListDatasets
* @see AWS API
* Documentation
*/
default CompletableFuture listDatasets(ListDatasetsRequest listDatasetsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves information about data sets.
*
*
*
* This is a convenience which creates an instance of the {@link ListDatasetsRequest.Builder} avoiding the need to
* create one manually via {@link ListDatasetsRequest#builder()}
*
*
* @param listDatasetsRequest
* A {@link Consumer} that will call methods on {@link ListDatasetsRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListDatasets operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListDatasets
* @see AWS API
* Documentation
*/
default CompletableFuture listDatasets(Consumer listDatasetsRequest) {
return listDatasets(ListDatasetsRequest.builder().applyMutation(listDatasetsRequest).build());
}
/**
*
* Retrieves information about data sets.
*
*
* @return A Java Future containing the result of the ListDatasets operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListDatasets
* @see AWS API
* Documentation
*/
default CompletableFuture listDatasets() {
return listDatasets(ListDatasetsRequest.builder().build());
}
/**
*
* Retrieves information about data sets.
*
*
*
* This is a variant of
* {@link #listDatasets(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsRequest)} 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.iotanalytics.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listDatasets(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsRequest)} operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListDatasets
* @see AWS API
* Documentation
*/
default ListDatasetsPublisher listDatasetsPaginator() {
return listDatasetsPaginator(ListDatasetsRequest.builder().build());
}
/**
*
* Retrieves information about data sets.
*
*
*
* This is a variant of
* {@link #listDatasets(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsRequest)} 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.iotanalytics.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listDatasets(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsRequest)} operation.
*
*
* @param listDatasetsRequest
* @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 was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListDatasets
* @see AWS API
* Documentation
*/
default ListDatasetsPublisher listDatasetsPaginator(ListDatasetsRequest listDatasetsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves information about data sets.
*
*
*
* This is a variant of
* {@link #listDatasets(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsRequest)} 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.iotanalytics.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.iotanalytics.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listDatasets(software.amazon.awssdk.services.iotanalytics.model.ListDatasetsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListDatasetsRequest.Builder} avoiding the need to
* create one manually via {@link ListDatasetsRequest#builder()}
*
*
* @param listDatasetsRequest
* A {@link Consumer} that will call methods on {@link ListDatasetsRequest.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 was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListDatasets
* @see AWS API
* Documentation
*/
default ListDatasetsPublisher listDatasetsPaginator(Consumer listDatasetsRequest) {
return listDatasetsPaginator(ListDatasetsRequest.builder().applyMutation(listDatasetsRequest).build());
}
/**
*
* Retrieves a list of data stores.
*
*
* @param listDatastoresRequest
* @return A Java Future containing the result of the ListDatastores operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListDatastores
* @see AWS
* API Documentation
*/
default CompletableFuture listDatastores(ListDatastoresRequest listDatastoresRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a list of data stores.
*
*
*
* This is a convenience which creates an instance of the {@link ListDatastoresRequest.Builder} avoiding the need to
* create one manually via {@link ListDatastoresRequest#builder()}
*
*
* @param listDatastoresRequest
* A {@link Consumer} that will call methods on {@link ListDatastoresRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListDatastores operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListDatastores
* @see AWS
* API Documentation
*/
default CompletableFuture listDatastores(Consumer listDatastoresRequest) {
return listDatastores(ListDatastoresRequest.builder().applyMutation(listDatastoresRequest).build());
}
/**
*
* Retrieves a list of data stores.
*
*
* @return A Java Future containing the result of the ListDatastores operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListDatastores
* @see AWS
* API Documentation
*/
default CompletableFuture listDatastores() {
return listDatastores(ListDatastoresRequest.builder().build());
}
/**
*
* Retrieves a list of data stores.
*
*
*
* This is a variant of
* {@link #listDatastores(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresRequest)} 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.iotanalytics.paginators.ListDatastoresPublisher publisher = client.listDatastoresPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.iotanalytics.paginators.ListDatastoresPublisher publisher = client.listDatastoresPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listDatastores(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresRequest)} operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListDatastores
* @see AWS
* API Documentation
*/
default ListDatastoresPublisher listDatastoresPaginator() {
return listDatastoresPaginator(ListDatastoresRequest.builder().build());
}
/**
*
* Retrieves a list of data stores.
*
*
*
* This is a variant of
* {@link #listDatastores(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresRequest)} 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.iotanalytics.paginators.ListDatastoresPublisher publisher = client.listDatastoresPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.iotanalytics.paginators.ListDatastoresPublisher publisher = client.listDatastoresPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listDatastores(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresRequest)} operation.
*
*
* @param listDatastoresRequest
* @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 was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListDatastores
* @see AWS
* API Documentation
*/
default ListDatastoresPublisher listDatastoresPaginator(ListDatastoresRequest listDatastoresRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a list of data stores.
*
*
*
* This is a variant of
* {@link #listDatastores(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresRequest)} 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.iotanalytics.paginators.ListDatastoresPublisher publisher = client.listDatastoresPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.iotanalytics.paginators.ListDatastoresPublisher publisher = client.listDatastoresPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listDatastores(software.amazon.awssdk.services.iotanalytics.model.ListDatastoresRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListDatastoresRequest.Builder} avoiding the need to
* create one manually via {@link ListDatastoresRequest#builder()}
*
*
* @param listDatastoresRequest
* A {@link Consumer} that will call methods on {@link ListDatastoresRequest.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 was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListDatastores
* @see AWS
* API Documentation
*/
default ListDatastoresPublisher listDatastoresPaginator(Consumer listDatastoresRequest) {
return listDatastoresPaginator(ListDatastoresRequest.builder().applyMutation(listDatastoresRequest).build());
}
/**
*
* Retrieves a list of pipelines.
*
*
* @param listPipelinesRequest
* @return A Java Future containing the result of the ListPipelines operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListPipelines
* @see AWS API
* Documentation
*/
default CompletableFuture listPipelines(ListPipelinesRequest listPipelinesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a list of pipelines.
*
*
*
* This is a convenience which creates an instance of the {@link ListPipelinesRequest.Builder} avoiding the need to
* create one manually via {@link ListPipelinesRequest#builder()}
*
*
* @param listPipelinesRequest
* A {@link Consumer} that will call methods on {@link ListPipelinesRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListPipelines operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListPipelines
* @see AWS API
* Documentation
*/
default CompletableFuture listPipelines(Consumer listPipelinesRequest) {
return listPipelines(ListPipelinesRequest.builder().applyMutation(listPipelinesRequest).build());
}
/**
*
* Retrieves a list of pipelines.
*
*
* @return A Java Future containing the result of the ListPipelines operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListPipelines
* @see AWS API
* Documentation
*/
default CompletableFuture listPipelines() {
return listPipelines(ListPipelinesRequest.builder().build());
}
/**
*
* Retrieves a list of pipelines.
*
*
*
* This is a variant of
* {@link #listPipelines(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesRequest)} 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.iotanalytics.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.iotanalytics.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listPipelines(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesRequest)} operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListPipelines
* @see AWS API
* Documentation
*/
default ListPipelinesPublisher listPipelinesPaginator() {
return listPipelinesPaginator(ListPipelinesRequest.builder().build());
}
/**
*
* Retrieves a list of pipelines.
*
*
*
* This is a variant of
* {@link #listPipelines(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesRequest)} 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.iotanalytics.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.iotanalytics.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listPipelines(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesRequest)} operation.
*
*
* @param listPipelinesRequest
* @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 was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListPipelines
* @see AWS API
* Documentation
*/
default ListPipelinesPublisher listPipelinesPaginator(ListPipelinesRequest listPipelinesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a list of pipelines.
*
*
*
* This is a variant of
* {@link #listPipelines(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesRequest)} 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.iotanalytics.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.iotanalytics.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listPipelines(software.amazon.awssdk.services.iotanalytics.model.ListPipelinesRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListPipelinesRequest.Builder} avoiding the need to
* create one manually via {@link ListPipelinesRequest#builder()}
*
*
* @param listPipelinesRequest
* A {@link Consumer} that will call methods on {@link ListPipelinesRequest.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 was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListPipelines
* @see AWS API
* Documentation
*/
default ListPipelinesPublisher listPipelinesPaginator(Consumer listPipelinesRequest) {
return listPipelinesPaginator(ListPipelinesRequest.builder().applyMutation(listPipelinesRequest).build());
}
/**
*
* Lists the tags (metadata) which you have assigned to the resource.
*
*
* @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.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - LimitExceededException The command caused an internal limit to be exceeded.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListTagsForResource
* @see AWS API Documentation
*/
default CompletableFuture listTagsForResource(
ListTagsForResourceRequest listTagsForResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the tags (metadata) which you have assigned to the resource.
*
*
*
* 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.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - LimitExceededException The command caused an internal limit to be exceeded.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.ListTagsForResource
* @see AWS API Documentation
*/
default CompletableFuture listTagsForResource(
Consumer listTagsForResourceRequest) {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* Sets or updates the AWS IoT Analytics logging options.
*
*
* Note that if you update the value of any loggingOptions field, it takes up to one minute for the
* change to take effect. Also, if you change the policy attached to the role you specified in the roleArn field
* (for example, to correct an invalid policy) it takes up to 5 minutes for that change to take effect.
*
*
* @param putLoggingOptionsRequest
* @return A Java Future containing the result of the PutLoggingOptions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.PutLoggingOptions
* @see AWS
* API Documentation
*/
default CompletableFuture putLoggingOptions(PutLoggingOptionsRequest putLoggingOptionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Sets or updates the AWS IoT Analytics logging options.
*
*
* Note that if you update the value of any loggingOptions field, it takes up to one minute for the
* change to take effect. Also, if you change the policy attached to the role you specified in the roleArn field
* (for example, to correct an invalid policy) it takes up to 5 minutes for that change to take effect.
*
*
*
* This is a convenience which creates an instance of the {@link PutLoggingOptionsRequest.Builder} avoiding the need
* to create one manually via {@link PutLoggingOptionsRequest#builder()}
*
*
* @param putLoggingOptionsRequest
* A {@link Consumer} that will call methods on {@link PutLoggingOptionsRequest.Builder} to create a request.
* @return A Java Future containing the result of the PutLoggingOptions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.PutLoggingOptions
* @see AWS
* API Documentation
*/
default CompletableFuture putLoggingOptions(
Consumer putLoggingOptionsRequest) {
return putLoggingOptions(PutLoggingOptionsRequest.builder().applyMutation(putLoggingOptionsRequest).build());
}
/**
*
* Simulates the results of running a pipeline activity on a message payload.
*
*
* @param runPipelineActivityRequest
* @return A Java Future containing the result of the RunPipelineActivity operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.RunPipelineActivity
* @see AWS API Documentation
*/
default CompletableFuture runPipelineActivity(
RunPipelineActivityRequest runPipelineActivityRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Simulates the results of running a pipeline activity on a message payload.
*
*
*
* This is a convenience which creates an instance of the {@link RunPipelineActivityRequest.Builder} avoiding the
* need to create one manually via {@link RunPipelineActivityRequest#builder()}
*
*
* @param runPipelineActivityRequest
* A {@link Consumer} that will call methods on {@link RunPipelineActivityRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the RunPipelineActivity operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.RunPipelineActivity
* @see AWS API Documentation
*/
default CompletableFuture runPipelineActivity(
Consumer runPipelineActivityRequest) {
return runPipelineActivity(RunPipelineActivityRequest.builder().applyMutation(runPipelineActivityRequest).build());
}
/**
*
* Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10
* messages can be retrieved.
*
*
* @param sampleChannelDataRequest
* @return A Java Future containing the result of the SampleChannelData operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.SampleChannelData
* @see AWS
* API Documentation
*/
default CompletableFuture sampleChannelData(SampleChannelDataRequest sampleChannelDataRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10
* messages can be retrieved.
*
*
*
* This is a convenience which creates an instance of the {@link SampleChannelDataRequest.Builder} avoiding the need
* to create one manually via {@link SampleChannelDataRequest#builder()}
*
*
* @param sampleChannelDataRequest
* A {@link Consumer} that will call methods on {@link SampleChannelDataRequest.Builder} to create a request.
* @return A Java Future containing the result of the SampleChannelData operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.SampleChannelData
* @see AWS
* API Documentation
*/
default CompletableFuture sampleChannelData(
Consumer sampleChannelDataRequest) {
return sampleChannelData(SampleChannelDataRequest.builder().applyMutation(sampleChannelDataRequest).build());
}
/**
*
* Starts the reprocessing of raw message data through the pipeline.
*
*
* @param startPipelineReprocessingRequest
* @return A Java Future containing the result of the StartPipelineReprocessing operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException A resource with the specified name could not be found.
* - ResourceAlreadyExistsException A resource with the same name already exists.
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.StartPipelineReprocessing
* @see AWS API Documentation
*/
default CompletableFuture startPipelineReprocessing(
StartPipelineReprocessingRequest startPipelineReprocessingRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Starts the reprocessing of raw message data through the pipeline.
*
*
*
* This is a convenience which creates an instance of the {@link StartPipelineReprocessingRequest.Builder} avoiding
* the need to create one manually via {@link StartPipelineReprocessingRequest#builder()}
*
*
* @param startPipelineReprocessingRequest
* A {@link Consumer} that will call methods on {@link StartPipelineReprocessingRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the StartPipelineReprocessing operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException A resource with the specified name could not be found.
* - ResourceAlreadyExistsException A resource with the same name already exists.
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.StartPipelineReprocessing
* @see AWS API Documentation
*/
default CompletableFuture startPipelineReprocessing(
Consumer startPipelineReprocessingRequest) {
return startPipelineReprocessing(StartPipelineReprocessingRequest.builder()
.applyMutation(startPipelineReprocessingRequest).build());
}
/**
*
* Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
*
*
* @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.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - LimitExceededException The command caused an internal limit to be exceeded.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.TagResource
* @see AWS API
* Documentation
*/
default CompletableFuture tagResource(TagResourceRequest tagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
*
*
*
* 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.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - LimitExceededException The command caused an internal limit to be exceeded.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.TagResource
* @see AWS API
* Documentation
*/
default CompletableFuture tagResource(Consumer tagResourceRequest) {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* Removes the given tags (metadata) from the resource.
*
*
* @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.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - LimitExceededException The command caused an internal limit to be exceeded.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.UntagResource
* @see AWS API
* Documentation
*/
default CompletableFuture untagResource(UntagResourceRequest untagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Removes the given tags (metadata) from the resource.
*
*
*
* 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.
*
* - InvalidRequestException The request was not valid.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - LimitExceededException The command caused an internal limit to be exceeded.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.UntagResource
* @see AWS API
* Documentation
*/
default CompletableFuture untagResource(Consumer untagResourceRequest) {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* Updates the settings of a channel.
*
*
* @param updateChannelRequest
* @return A Java Future containing the result of the UpdateChannel operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.UpdateChannel
* @see AWS API
* Documentation
*/
default CompletableFuture updateChannel(UpdateChannelRequest updateChannelRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates the settings of a channel.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateChannelRequest.Builder} avoiding the need to
* create one manually via {@link UpdateChannelRequest#builder()}
*
*
* @param updateChannelRequest
* A {@link Consumer} that will call methods on {@link UpdateChannelRequest.Builder} to create a request.
* @return A Java Future containing the result of the UpdateChannel operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.UpdateChannel
* @see AWS API
* Documentation
*/
default CompletableFuture updateChannel(Consumer updateChannelRequest) {
return updateChannel(UpdateChannelRequest.builder().applyMutation(updateChannelRequest).build());
}
/**
*
* Updates the settings of a data set.
*
*
* @param updateDatasetRequest
* @return A Java Future containing the result of the UpdateDataset operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.UpdateDataset
* @see AWS API
* Documentation
*/
default CompletableFuture updateDataset(UpdateDatasetRequest updateDatasetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates the settings of a data set.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateDatasetRequest.Builder} avoiding the need to
* create one manually via {@link UpdateDatasetRequest#builder()}
*
*
* @param updateDatasetRequest
* A {@link Consumer} that will call methods on {@link UpdateDatasetRequest.Builder} to create a request.
* @return A Java Future containing the result of the UpdateDataset operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.UpdateDataset
* @see AWS API
* Documentation
*/
default CompletableFuture updateDataset(Consumer updateDatasetRequest) {
return updateDataset(UpdateDatasetRequest.builder().applyMutation(updateDatasetRequest).build());
}
/**
*
* Updates the settings of a data store.
*
*
* @param updateDatastoreRequest
* @return A Java Future containing the result of the UpdateDatastore operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.UpdateDatastore
* @see AWS
* API Documentation
*/
default CompletableFuture updateDatastore(UpdateDatastoreRequest updateDatastoreRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates the settings of a data store.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateDatastoreRequest.Builder} avoiding the need
* to create one manually via {@link UpdateDatastoreRequest#builder()}
*
*
* @param updateDatastoreRequest
* A {@link Consumer} that will call methods on {@link UpdateDatastoreRequest.Builder} to create a request.
* @return A Java Future containing the result of the UpdateDatastore operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.UpdateDatastore
* @see AWS
* API Documentation
*/
default CompletableFuture updateDatastore(
Consumer updateDatastoreRequest) {
return updateDatastore(UpdateDatastoreRequest.builder().applyMutation(updateDatastoreRequest).build());
}
/**
*
* Updates the settings of a pipeline. You must specify both a channel and a datastore
* activity and, optionally, as many as 23 additional activities in the pipelineActivities array.
*
*
* @param updatePipelineRequest
* @return A Java Future containing the result of the UpdatePipeline operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - LimitExceededException The command caused an internal limit to be 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.UpdatePipeline
* @see AWS
* API Documentation
*/
default CompletableFuture updatePipeline(UpdatePipelineRequest updatePipelineRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates the settings of a pipeline. You must specify both a channel and a datastore
* activity and, optionally, as many as 23 additional activities in the pipelineActivities array.
*
*
*
* This is a convenience which creates an instance of the {@link UpdatePipelineRequest.Builder} avoiding the need to
* create one manually via {@link UpdatePipelineRequest#builder()}
*
*
* @param updatePipelineRequest
* A {@link Consumer} that will call methods on {@link UpdatePipelineRequest.Builder} to create a request.
* @return A Java Future containing the result of the UpdatePipeline operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidRequestException The request was not valid.
* - ResourceNotFoundException A resource with the specified name could not be found.
* - InternalFailureException There was an internal failure.
* - ServiceUnavailableException The service is temporarily unavailable.
* - ThrottlingException The request was denied due to request throttling.
* - LimitExceededException The command caused an internal limit to be 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.
* - IoTAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample IoTAnalyticsAsyncClient.UpdatePipeline
* @see AWS
* API Documentation
*/
default CompletableFuture updatePipeline(Consumer updatePipelineRequest) {
return updatePipeline(UpdatePipelineRequest.builder().applyMutation(updatePipelineRequest).build());
}
}