AbstractAmazonKinesisAnalytics (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kinesisanalytics.AbstractAmazonKinesisAnalytics

All Implemented Interfaces:

AmazonKinesisAnalytics

Direct Known Subclasses:

AbstractAmazonKinesisAnalyticsAsync
```
public class AbstractAmazonKinesisAnalytics
extends Object
implements AmazonKinesisAnalytics
```
Abstract implementation of AmazonKinesisAnalytics. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.kinesisanalytics.AmazonKinesisAnalytics
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddApplicationInputResult`	`addApplicationInput(AddApplicationInputRequest request)` Adds a streaming source to your Amazon Kinesis application.
`AddApplicationOutputResult`	`addApplicationOutput(AddApplicationOutputRequest request)` Adds an external destination to your Amazon Kinesis Analytics application.
`AddApplicationReferenceDataSourceResult`	`addApplicationReferenceDataSource(AddApplicationReferenceDataSourceRequest request)` Adds a reference data source to an existing application.
`CreateApplicationResult`	`createApplication(CreateApplicationRequest request)` Creates an Amazon Kinesis Analytics application.
`DeleteApplicationResult`	`deleteApplication(DeleteApplicationRequest request)` Deletes the specified application.
`DeleteApplicationOutputResult`	`deleteApplicationOutput(DeleteApplicationOutputRequest request)` Deletes output destination configuration from your application configuration.
`DeleteApplicationReferenceDataSourceResult`	`deleteApplicationReferenceDataSource(DeleteApplicationReferenceDataSourceRequest request)` Deletes a reference data source configuration from the specified application configuration.
`DescribeApplicationResult`	`describeApplication(DescribeApplicationRequest request)` Returns information about a specific Amazon Kinesis Analytics application.
`DiscoverInputSchemaResult`	`discoverInputSchema(DiscoverInputSchemaRequest request)` Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream).
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`ListApplicationsResult`	`listApplications(ListApplicationsRequest request)` Returns a list of Amazon Kinesis Analytics applications in your account.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("https://kinesisanalytics.us-east-1.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `AmazonKinesisAnalytics.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartApplicationResult`	`startApplication(StartApplicationRequest request)` Starts the specified Amazon Kinesis Analytics application.
`StopApplicationResult`	`stopApplication(StopApplicationRequest request)` Stops the application from processing input data.
`UpdateApplicationResult`	`updateApplication(UpdateApplicationRequest request)` Updates an existing Kinesis Analytics application.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AmazonKinesisAnalytics
    
    Overrides the default endpoint for this client ("https://kinesisanalytics.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "kinesisanalytics.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://kinesisanalytics.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setEndpoint in interface AmazonKinesisAnalytics
    
    Parameters:
    
    endpoint - The endpoint (ex: "kinesisanalytics.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://kinesisanalytics.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AmazonKinesisAnalytics
    
    An alternative to AmazonKinesisAnalytics.setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setRegion in interface AmazonKinesisAnalytics
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - addApplicationInput
```
public AddApplicationInputResult addApplicationInput(AddApplicationInputRequest request)
```
    Description copied from interface: AmazonKinesisAnalytics
    
    Adds a streaming source to your Amazon Kinesis application. For conceptual information, see Configuring Application Input.
    
    You can add a streaming source either when you create an application or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication.
    
    Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.
    
    This operation requires permissions to perform the kinesisanalytics:AddApplicationInput action.
    
    Specified by:
    
    addApplicationInput in interface AmazonKinesisAnalytics
    
    Returns:
    
    Result of the AddApplicationInput operation returned by the service.
  - addApplicationOutput
```
public AddApplicationOutputResult addApplicationOutput(AddApplicationOutputRequest request)
```
    Description copied from interface: AmazonKinesisAnalytics
    
    Adds an external destination to your Amazon Kinesis Analytics application.
    
    If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream or a Firehose delivery stream), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination.
    
    You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. For conceptual information, see Understanding Application Output (Destination).
    
    Note that any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.
    
    For the limits on the number of application inputs and outputs you can configure, see Limits.
    
    This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.
    
    Specified by:
    
    addApplicationOutput in interface AmazonKinesisAnalytics
    
    Returns:
    
    Result of the AddApplicationOutput operation returned by the service.
  - addApplicationReferenceDataSource
```
public AddApplicationReferenceDataSourceResult addApplicationReferenceDataSource(AddApplicationReferenceDataSourceRequest request)
```
    Description copied from interface: AmazonKinesisAnalytics
    
    Adds a reference data source to an existing application.
    
    Amazon Kinesis Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in Amazon S3 object maps to columns in the resulting in-application table.
    
    For conceptual information, see Configuring Application Input. For the limits on data sources you can add to your application, see Limits.
    
    This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.
    
    Specified by:
    
    addApplicationReferenceDataSource in interface AmazonKinesisAnalytics
    
    Returns:
    
    Result of the AddApplicationReferenceDataSource operation returned by the service.
  - createApplication
```
public CreateApplicationResult createApplication(CreateApplicationRequest request)
```
    Description copied from interface: AmazonKinesisAnalytics
    
    Creates an Amazon Kinesis Analytics application. You can configure each application with one streaming source as input, application code to process the input, and up to five streaming destinations where you want Amazon Kinesis Analytics to write the output data from your application. For an overview, see How it Works.
    
    In the input configuration, you map the streaming source to an in-application stream, which you can think of as a constantly updating table. In the mapping, you must provide a schema for the in-application stream and map each data column in the in-application stream to a data element in the streaming source, with the option of renaming, casting and dropping columns as desired.
    
    Your application code is one or more SQL statements that read input data, transform it, and generate output. Your application code can create one or more SQL artifacts like SQL streams or pumps.
    
    In the output configuration, you can configure the application to write data from in-application streams created in your applications to up to five streaming destinations.
    
    To read data from your source stream or write data to destination streams, Amazon Kinesis Analytics needs your permissions. You grant these permissions by creating IAM roles. This operation requires permissions to perform the kinesisanalytics:CreateApplication action.
    
    For introductory exercises to create an Amazon Kinesis Analytics application, see Getting Started.
    
    Specified by:
    
    createApplication in interface AmazonKinesisAnalytics
    
    Parameters:
    
    request - TBD
    
    Returns:
    
    Result of the CreateApplication operation returned by the service.
  - deleteApplication
```
public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)
```
    Description copied from interface: AmazonKinesisAnalytics
    
    Deletes the specified application. Amazon Kinesis Analytics halts application execution and deletes the application, including any application artifacts (such as in-application streams, reference table, and application code).
    
    This operation requires permissions to perform the kinesisanalytics:DeleteApplication action.
    
    Specified by:
    
    deleteApplication in interface AmazonKinesisAnalytics
    
    Returns:
    
    Result of the DeleteApplication operation returned by the service.
  - deleteApplicationOutput
```
public DeleteApplicationOutputResult deleteApplicationOutput(DeleteApplicationOutputRequest request)
```
    Description copied from interface: AmazonKinesisAnalytics
    
    Deletes output destination configuration from your application configuration. Amazon Kinesis Analytics will no longer write data from the corresponding in-application stream to the external output destination.
    
    This operation requires permissions to perform the kinesisanalytics:DeleteApplicationOutput action.
    
    Specified by:
    
    deleteApplicationOutput in interface AmazonKinesisAnalytics
    
    Returns:
    
    Result of the DeleteApplicationOutput operation returned by the service.
  - deleteApplicationReferenceDataSource
```
public DeleteApplicationReferenceDataSourceResult deleteApplicationReferenceDataSource(DeleteApplicationReferenceDataSourceRequest request)
```
    Description copied from interface: AmazonKinesisAnalytics
    
    Deletes a reference data source configuration from the specified application configuration.
    
    If the application is running, Amazon Kinesis Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation.
    
    This operation requires permissions to perform the kinesisanalytics.DeleteApplicationReferenceDataSource action.
    
    Specified by:
    
    deleteApplicationReferenceDataSource in interface AmazonKinesisAnalytics
    
    Returns:
    
    Result of the DeleteApplicationReferenceDataSource operation returned by the service.
  - describeApplication
```
public DescribeApplicationResult describeApplication(DescribeApplicationRequest request)
```
    Description copied from interface: AmazonKinesisAnalytics
    
    Returns information about a specific Amazon Kinesis Analytics application.
    
    If you want to retrieve a list of all applications in your account, use the ListApplications operation.
    
    This operation requires permissions to perform the kinesisanalytics:DescribeApplication action. You can use DescribeApplication to get the current application versionId, which you need to call other operations such as Update.
    
    Specified by:
    
    describeApplication in interface AmazonKinesisAnalytics
    
    Returns:
    
    Result of the DescribeApplication operation returned by the service.
  - discoverInputSchema
```
public DiscoverInputSchemaResult discoverInputSchema(DiscoverInputSchemaRequest request)
```
    Description copied from interface: AmazonKinesisAnalytics
    
    Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream). In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema.
    
    You can use the inferred schema when configuring a streaming source for your application. For conceptual information, see Configuring Application Input. Note that when you create an application using the Amazon Kinesis Analytics console, the console uses this operation to infer a schema and show it in the console user interface.
    
    This operation requires permissions to perform the kinesisanalytics:DiscoverInputSchema action.
    
    Specified by:
    
    discoverInputSchema in interface AmazonKinesisAnalytics
    
    Returns:
    
    Result of the DiscoverInputSchema operation returned by the service.
  - listApplications
```
public ListApplicationsResult listApplications(ListApplicationsRequest request)
```
    Description copied from interface: AmazonKinesisAnalytics
    
    Returns a list of Amazon Kinesis Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If the response returns the HasMoreApplications value as true, you can send another request by adding the ExclusiveStartApplicationName in the request body, and set the value of this to the last application name from the previous response.
    
    If you want detailed information about a specific application, use DescribeApplication.
    
    This operation requires permissions to perform the kinesisanalytics:ListApplications action.
    
    Specified by:
    
    listApplications in interface AmazonKinesisAnalytics
    
    Returns:
    
    Result of the ListApplications operation returned by the service.
  - startApplication
```
public StartApplicationResult startApplication(StartApplicationRequest request)
```
    Description copied from interface: AmazonKinesisAnalytics
    
    Starts the specified Amazon Kinesis Analytics application. After creating an application, you must exclusively call this operation to start your application.
    
    After the application starts, it begins consuming the input data, processes it, and writes the output to the configured destination.
    
    The application status must be READY for you to start an application. You can get the application status in the console or using the DescribeApplication operation.
    
    After you start the application, you can stop the application from processing the input by calling the StopApplication operation.
    
    This operation requires permissions to perform the kinesisanalytics:StartApplication action.
    
    Specified by:
    
    startApplication in interface AmazonKinesisAnalytics
    
    Returns:
    
    Result of the StartApplication operation returned by the service.
  - stopApplication
```
public StopApplicationResult stopApplication(StopApplicationRequest request)
```
    Description copied from interface: AmazonKinesisAnalytics
    
    Stops the application from processing input data. You can stop an application only if it is in the running state. You can use the DescribeApplication operation to find the application state. After the application is stopped, Amazon Kinesis Analytics stops reading data from the input, the application stops processing data, and there is no output written to the destination.
    
    This operation requires permissions to perform the kinesisanalytics:StopApplication action.
    
    Specified by:
    
    stopApplication in interface AmazonKinesisAnalytics
    
    Returns:
    
    Result of the StopApplication operation returned by the service.
  - updateApplication
```
public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)
```
    Description copied from interface: AmazonKinesisAnalytics
    
    Updates an existing Kinesis Analytics application. Using this API, you can update application code, input configuration, and output configuration.
    
    Note that Kinesis Analytics updates the CurrentApplicationVersionId each time you update your application.
    
    This opeation requires permission for the kinesisanalytics:UpdateApplication action.
    
    Specified by:
    
    updateApplication in interface AmazonKinesisAnalytics
    
    Returns:
    
    Result of the UpdateApplication operation returned by the service.
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonKinesisAnalytics
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonKinesisAnalytics
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonKinesisAnalytics
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonKinesisAnalytics
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAmazonKinesisAnalytics

Field Summary

Fields inherited from interface com.amazonaws.services.kinesisanalytics.AmazonKinesisAnalytics

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

addApplicationInput

addApplicationOutput

addApplicationReferenceDataSource

createApplication

deleteApplication

deleteApplicationOutput

deleteApplicationReferenceDataSource

describeApplication

discoverInputSchema

listApplications

startApplication

stopApplication

updateApplication

shutdown

getCachedResponseMetadata