OutputDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kinesisanalyticsv2.model.OutputDescription

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class OutputDescription
extends Object
implements Serializable, Cloneable, StructuredPojo
```
For an SQL-based Amazon Kinesis Data Analytics application, describes the application output configuration, which includes the in-application stream name and the destination where the stream data is written. The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

OutputDescription()

Constructors
Constructor and Description
`OutputDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OutputDescription`	`clone()`
`boolean`	`equals(Object obj)`
`DestinationSchema`	`getDestinationSchema()` The data format used for writing data to the destination.
`KinesisFirehoseOutputDescription`	`getKinesisFirehoseOutputDescription()` Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.
`KinesisStreamsOutputDescription`	`getKinesisStreamsOutputDescription()` Describes the Kinesis data stream that is configured as the destination where output is written.
`LambdaOutputDescription`	`getLambdaOutputDescription()` Describes the Lambda function that is configured as the destination where output is written.
`String`	`getName()` The name of the in-application stream that is configured as output.
`String`	`getOutputId()` A unique identifier for the output configuration.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDestinationSchema(DestinationSchema destinationSchema)` The data format used for writing data to the destination.
`void`	`setKinesisFirehoseOutputDescription(KinesisFirehoseOutputDescription kinesisFirehoseOutputDescription)` Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.
`void`	`setKinesisStreamsOutputDescription(KinesisStreamsOutputDescription kinesisStreamsOutputDescription)` Describes the Kinesis data stream that is configured as the destination where output is written.
`void`	`setLambdaOutputDescription(LambdaOutputDescription lambdaOutputDescription)` Describes the Lambda function that is configured as the destination where output is written.
`void`	`setName(String name)` The name of the in-application stream that is configured as output.
`void`	`setOutputId(String outputId)` A unique identifier for the output configuration.
`String`	`toString()` Returns a string representation of this object.
`OutputDescription`	`withDestinationSchema(DestinationSchema destinationSchema)` The data format used for writing data to the destination.
`OutputDescription`	`withKinesisFirehoseOutputDescription(KinesisFirehoseOutputDescription kinesisFirehoseOutputDescription)` Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.
`OutputDescription`	`withKinesisStreamsOutputDescription(KinesisStreamsOutputDescription kinesisStreamsOutputDescription)` Describes the Kinesis data stream that is configured as the destination where output is written.
`OutputDescription`	`withLambdaOutputDescription(LambdaOutputDescription lambdaOutputDescription)` Describes the Lambda function that is configured as the destination where output is written.
`OutputDescription`	`withName(String name)` The name of the in-application stream that is configured as output.
`OutputDescription`	`withOutputId(String outputId)` A unique identifier for the output configuration.

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

- Constructor Detail
  - OutputDescription
```
public OutputDescription()
```
- Method Detail
  - setOutputId
```
public void setOutputId(String outputId)
```
    A unique identifier for the output configuration.
    
    Parameters:
    
    outputId - A unique identifier for the output configuration.
  - getOutputId
```
public String getOutputId()
```
    A unique identifier for the output configuration.
    
    Returns:
    
    A unique identifier for the output configuration.
  - withOutputId
```
public OutputDescription withOutputId(String outputId)
```
    A unique identifier for the output configuration.
    
    Parameters:
    
    outputId - A unique identifier for the output configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the in-application stream that is configured as output.
    
    Parameters:
    
    name - The name of the in-application stream that is configured as output.
  - getName
```
public String getName()
```
    The name of the in-application stream that is configured as output.
    
    Returns:
    
    The name of the in-application stream that is configured as output.
  - withName
```
public OutputDescription withName(String name)
```
    The name of the in-application stream that is configured as output.
    
    Parameters:
    
    name - The name of the in-application stream that is configured as output.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKinesisStreamsOutputDescription
```
public void setKinesisStreamsOutputDescription(KinesisStreamsOutputDescription kinesisStreamsOutputDescription)
```
    Describes the Kinesis data stream that is configured as the destination where output is written.
    
    Parameters:
    
    kinesisStreamsOutputDescription - Describes the Kinesis data stream that is configured as the destination where output is written.
  - getKinesisStreamsOutputDescription
```
public KinesisStreamsOutputDescription getKinesisStreamsOutputDescription()
```
    Describes the Kinesis data stream that is configured as the destination where output is written.
    
    Returns:
    
    Describes the Kinesis data stream that is configured as the destination where output is written.
  - withKinesisStreamsOutputDescription
```
public OutputDescription withKinesisStreamsOutputDescription(KinesisStreamsOutputDescription kinesisStreamsOutputDescription)
```
    Describes the Kinesis data stream that is configured as the destination where output is written.
    
    Parameters:
    
    kinesisStreamsOutputDescription - Describes the Kinesis data stream that is configured as the destination where output is written.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKinesisFirehoseOutputDescription
```
public void setKinesisFirehoseOutputDescription(KinesisFirehoseOutputDescription kinesisFirehoseOutputDescription)
```
    Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.
    
    Parameters:
    
    kinesisFirehoseOutputDescription - Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.
  - getKinesisFirehoseOutputDescription
```
public KinesisFirehoseOutputDescription getKinesisFirehoseOutputDescription()
```
    Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.
    
    Returns:
    
    Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.
  - withKinesisFirehoseOutputDescription
```
public OutputDescription withKinesisFirehoseOutputDescription(KinesisFirehoseOutputDescription kinesisFirehoseOutputDescription)
```
    Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.
    
    Parameters:
    
    kinesisFirehoseOutputDescription - Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLambdaOutputDescription
```
public void setLambdaOutputDescription(LambdaOutputDescription lambdaOutputDescription)
```
    Describes the Lambda function that is configured as the destination where output is written.
    
    Parameters:
    
    lambdaOutputDescription - Describes the Lambda function that is configured as the destination where output is written.
  - getLambdaOutputDescription
```
public LambdaOutputDescription getLambdaOutputDescription()
```
    Describes the Lambda function that is configured as the destination where output is written.
    
    Returns:
    
    Describes the Lambda function that is configured as the destination where output is written.
  - withLambdaOutputDescription
```
public OutputDescription withLambdaOutputDescription(LambdaOutputDescription lambdaOutputDescription)
```
    Describes the Lambda function that is configured as the destination where output is written.
    
    Parameters:
    
    lambdaOutputDescription - Describes the Lambda function that is configured as the destination where output is written.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDestinationSchema
```
public void setDestinationSchema(DestinationSchema destinationSchema)
```
    The data format used for writing data to the destination.
    
    Parameters:
    
    destinationSchema - The data format used for writing data to the destination.
  - getDestinationSchema
```
public DestinationSchema getDestinationSchema()
```
    The data format used for writing data to the destination.
    
    Returns:
    
    The data format used for writing data to the destination.
  - withDestinationSchema
```
public OutputDescription withDestinationSchema(DestinationSchema destinationSchema)
```
    The data format used for writing data to the destination.
    
    Parameters:
    
    destinationSchema - The data format used for writing data to the destination.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public OutputDescription clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class OutputDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OutputDescription

Method Detail

setOutputId

getOutputId

withOutputId

setName

getName

withName

setKinesisStreamsOutputDescription

getKinesisStreamsOutputDescription

withKinesisStreamsOutputDescription

setKinesisFirehoseOutputDescription

getKinesisFirehoseOutputDescription

withKinesisFirehoseOutputDescription

setLambdaOutputDescription

getLambdaOutputDescription

withLambdaOutputDescription

setDestinationSchema

getDestinationSchema

withDestinationSchema

toString

equals

hashCode

clone

marshall