OutputDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kinesisanalytics.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
```
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 an Amazon Kinesis stream or an Amazon Kinesis 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()` Data format used for writing data to the destination.
`KinesisFirehoseOutputDescription`	`getKinesisFirehoseOutputDescription()` Describes the Amazon Kinesis Firehose delivery stream configured as the destination where output is written.
`KinesisStreamsOutputDescription`	`getKinesisStreamsOutputDescription()` Describes Amazon Kinesis stream configured as the destination where output is written.
`String`	`getName()` Name of the in-application stream 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)` Data format used for writing data to the destination.
`void`	`setKinesisFirehoseOutputDescription(KinesisFirehoseOutputDescription kinesisFirehoseOutputDescription)` Describes the Amazon Kinesis Firehose delivery stream configured as the destination where output is written.
`void`	`setKinesisStreamsOutputDescription(KinesisStreamsOutputDescription kinesisStreamsOutputDescription)` Describes Amazon Kinesis stream configured as the destination where output is written.
`void`	`setName(String name)` Name of the in-application stream configured as output.
`void`	`setOutputId(String outputId)` A unique identifier for the output configuration.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`OutputDescription`	`withDestinationSchema(DestinationSchema destinationSchema)` Data format used for writing data to the destination.
`OutputDescription`	`withKinesisFirehoseOutputDescription(KinesisFirehoseOutputDescription kinesisFirehoseOutputDescription)` Describes the Amazon Kinesis Firehose delivery stream configured as the destination where output is written.
`OutputDescription`	`withKinesisStreamsOutputDescription(KinesisStreamsOutputDescription kinesisStreamsOutputDescription)` Describes Amazon Kinesis stream configured as the destination where output is written.
`OutputDescription`	`withName(String name)` Name of the in-application stream 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)
```
    Name of the in-application stream configured as output.
    
    Parameters:
    
    name - Name of the in-application stream configured as output.
  - getName
```
public String getName()
```
    Name of the in-application stream configured as output.
    
    Returns:
    
    Name of the in-application stream configured as output.
  - withName
```
public OutputDescription withName(String name)
```
    Name of the in-application stream configured as output.
    
    Parameters:
    
    name - Name of the in-application stream 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 Amazon Kinesis stream configured as the destination where output is written.
    
    Parameters:
    
    kinesisStreamsOutputDescription - Describes Amazon Kinesis stream configured as the destination where output is written.
  - getKinesisStreamsOutputDescription
```
public KinesisStreamsOutputDescription getKinesisStreamsOutputDescription()
```
    Describes Amazon Kinesis stream configured as the destination where output is written.
    
    Returns:
    
    Describes Amazon Kinesis stream configured as the destination where output is written.
  - withKinesisStreamsOutputDescription
```
public OutputDescription withKinesisStreamsOutputDescription(KinesisStreamsOutputDescription kinesisStreamsOutputDescription)
```
    Describes Amazon Kinesis stream configured as the destination where output is written.
    
    Parameters:
    
    kinesisStreamsOutputDescription - Describes Amazon Kinesis stream 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 Amazon Kinesis Firehose delivery stream configured as the destination where output is written.
    
    Parameters:
    
    kinesisFirehoseOutputDescription - Describes the Amazon Kinesis Firehose delivery stream configured as the destination where output is written.
  - getKinesisFirehoseOutputDescription
```
public KinesisFirehoseOutputDescription getKinesisFirehoseOutputDescription()
```
    Describes the Amazon Kinesis Firehose delivery stream configured as the destination where output is written.
    
    Returns:
    
    Describes the Amazon Kinesis Firehose delivery stream configured as the destination where output is written.
  - withKinesisFirehoseOutputDescription
```
public OutputDescription withKinesisFirehoseOutputDescription(KinesisFirehoseOutputDescription kinesisFirehoseOutputDescription)
```
    Describes the Amazon Kinesis Firehose delivery stream configured as the destination where output is written.
    
    Parameters:
    
    kinesisFirehoseOutputDescription - Describes the Amazon Kinesis Firehose delivery stream 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)
```
    Data format used for writing data to the destination.
    
    Parameters:
    
    destinationSchema - Data format used for writing data to the destination.
  - getDestinationSchema
```
public DestinationSchema getDestinationSchema()
```
    Data format used for writing data to the destination.
    
    Returns:
    
    Data format used for writing data to the destination.
  - withDestinationSchema
```
public OutputDescription withDestinationSchema(DestinationSchema destinationSchema)
```
    Data format used for writing data to the destination.
    
    Parameters:
    
    destinationSchema - 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; useful for testing and debugging.
    
    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

setDestinationSchema

getDestinationSchema

withDestinationSchema

toString

equals

hashCode

clone

marshall