JournalKinesisStreamDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.qldb.model.JournalKinesisStreamDescription

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class JournalKinesisStreamDescription
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Information about an Amazon QLDB journal stream, including the Amazon Resource Name (ARN), stream name, creation time, current status, and the parameters of the original stream creation request.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

JournalKinesisStreamDescription()

Constructors
Constructor and Description
`JournalKinesisStreamDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JournalKinesisStreamDescription`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the QLDB journal stream.
`Date`	`getCreationTime()` The date and time, in epoch time format, when the QLDB journal stream was created.
`String`	`getErrorCause()` The error message that describes the reason that a stream has a status of `IMPAIRED` or `FAILED`.
`Date`	`getExclusiveEndTime()` The exclusive date and time that specifies when the stream ends.
`Date`	`getInclusiveStartTime()` The inclusive start date and time from which to start streaming journal data.
`KinesisConfiguration`	`getKinesisConfiguration()` The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.
`String`	`getLedgerName()` The name of the ledger.
`String`	`getRoleArn()` The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.
`String`	`getStatus()` The current state of the QLDB journal stream.
`String`	`getStreamId()` The UUID (represented in Base62-encoded text) of the QLDB journal stream.
`String`	`getStreamName()` The user-defined name of the QLDB journal stream.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the QLDB journal stream.
`void`	`setCreationTime(Date creationTime)` The date and time, in epoch time format, when the QLDB journal stream was created.
`void`	`setErrorCause(String errorCause)` The error message that describes the reason that a stream has a status of `IMPAIRED` or `FAILED`.
`void`	`setExclusiveEndTime(Date exclusiveEndTime)` The exclusive date and time that specifies when the stream ends.
`void`	`setInclusiveStartTime(Date inclusiveStartTime)` The inclusive start date and time from which to start streaming journal data.
`void`	`setKinesisConfiguration(KinesisConfiguration kinesisConfiguration)` The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.
`void`	`setLedgerName(String ledgerName)` The name of the ledger.
`void`	`setRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.
`void`	`setStatus(String status)` The current state of the QLDB journal stream.
`void`	`setStreamId(String streamId)` The UUID (represented in Base62-encoded text) of the QLDB journal stream.
`void`	`setStreamName(String streamName)` The user-defined name of the QLDB journal stream.
`String`	`toString()` Returns a string representation of this object.
`JournalKinesisStreamDescription`	`withArn(String arn)` The Amazon Resource Name (ARN) of the QLDB journal stream.
`JournalKinesisStreamDescription`	`withCreationTime(Date creationTime)` The date and time, in epoch time format, when the QLDB journal stream was created.
`JournalKinesisStreamDescription`	`withErrorCause(ErrorCause errorCause)` The error message that describes the reason that a stream has a status of `IMPAIRED` or `FAILED`.
`JournalKinesisStreamDescription`	`withErrorCause(String errorCause)` The error message that describes the reason that a stream has a status of `IMPAIRED` or `FAILED`.
`JournalKinesisStreamDescription`	`withExclusiveEndTime(Date exclusiveEndTime)` The exclusive date and time that specifies when the stream ends.
`JournalKinesisStreamDescription`	`withInclusiveStartTime(Date inclusiveStartTime)` The inclusive start date and time from which to start streaming journal data.
`JournalKinesisStreamDescription`	`withKinesisConfiguration(KinesisConfiguration kinesisConfiguration)` The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.
`JournalKinesisStreamDescription`	`withLedgerName(String ledgerName)` The name of the ledger.
`JournalKinesisStreamDescription`	`withRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.
`JournalKinesisStreamDescription`	`withStatus(StreamStatus status)` The current state of the QLDB journal stream.
`JournalKinesisStreamDescription`	`withStatus(String status)` The current state of the QLDB journal stream.
`JournalKinesisStreamDescription`	`withStreamId(String streamId)` The UUID (represented in Base62-encoded text) of the QLDB journal stream.
`JournalKinesisStreamDescription`	`withStreamName(String streamName)` The user-defined name of the QLDB journal stream.

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

- Constructor Detail
  - JournalKinesisStreamDescription
```
public JournalKinesisStreamDescription()
```
- Method Detail
  - setLedgerName
```
public void setLedgerName(String ledgerName)
```
    The name of the ledger.
    
    Parameters:
    
    ledgerName - The name of the ledger.
  - getLedgerName
```
public String getLedgerName()
```
    The name of the ledger.
    
    Returns:
    
    The name of the ledger.
  - withLedgerName
```
public JournalKinesisStreamDescription withLedgerName(String ledgerName)
```
    The name of the ledger.
    
    Parameters:
    
    ledgerName - The name of the ledger.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The date and time, in epoch time format, when the QLDB journal stream was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
    
    Parameters:
    
    creationTime - The date and time, in epoch time format, when the QLDB journal stream was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
  - getCreationTime
```
public Date getCreationTime()
```
    The date and time, in epoch time format, when the QLDB journal stream was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
    
    Returns:
    
    The date and time, in epoch time format, when the QLDB journal stream was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
  - withCreationTime
```
public JournalKinesisStreamDescription withCreationTime(Date creationTime)
```
    The date and time, in epoch time format, when the QLDB journal stream was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
    
    Parameters:
    
    creationTime - The date and time, in epoch time format, when the QLDB journal stream was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInclusiveStartTime
```
public void setInclusiveStartTime(Date inclusiveStartTime)
```
    The inclusive start date and time from which to start streaming journal data.
    
    Parameters:
    
    inclusiveStartTime - The inclusive start date and time from which to start streaming journal data.
  - getInclusiveStartTime
```
public Date getInclusiveStartTime()
```
    The inclusive start date and time from which to start streaming journal data.
    
    Returns:
    
    The inclusive start date and time from which to start streaming journal data.
  - withInclusiveStartTime
```
public JournalKinesisStreamDescription withInclusiveStartTime(Date inclusiveStartTime)
```
    The inclusive start date and time from which to start streaming journal data.
    
    Parameters:
    
    inclusiveStartTime - The inclusive start date and time from which to start streaming journal data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExclusiveEndTime
```
public void setExclusiveEndTime(Date exclusiveEndTime)
```
    The exclusive date and time that specifies when the stream ends. If this parameter is undefined, the stream runs indefinitely until you cancel it.
    
    Parameters:
    
    exclusiveEndTime - The exclusive date and time that specifies when the stream ends. If this parameter is undefined, the stream runs indefinitely until you cancel it.
  - getExclusiveEndTime
```
public Date getExclusiveEndTime()
```
    The exclusive date and time that specifies when the stream ends. If this parameter is undefined, the stream runs indefinitely until you cancel it.
    
    Returns:
    
    The exclusive date and time that specifies when the stream ends. If this parameter is undefined, the stream runs indefinitely until you cancel it.
  - withExclusiveEndTime
```
public JournalKinesisStreamDescription withExclusiveEndTime(Date exclusiveEndTime)
```
    The exclusive date and time that specifies when the stream ends. If this parameter is undefined, the stream runs indefinitely until you cancel it.
    
    Parameters:
    
    exclusiveEndTime - The exclusive date and time that specifies when the stream ends. If this parameter is undefined, the stream runs indefinitely until you cancel it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.
  - getRoleArn
```
public String getRoleArn()
```
    The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.
  - withRoleArn
```
public JournalKinesisStreamDescription withRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStreamId
```
public void setStreamId(String streamId)
```
    The UUID (represented in Base62-encoded text) of the QLDB journal stream.
    
    Parameters:
    
    streamId - The UUID (represented in Base62-encoded text) of the QLDB journal stream.
  - getStreamId
```
public String getStreamId()
```
    The UUID (represented in Base62-encoded text) of the QLDB journal stream.
    
    Returns:
    
    The UUID (represented in Base62-encoded text) of the QLDB journal stream.
  - withStreamId
```
public JournalKinesisStreamDescription withStreamId(String streamId)
```
    The UUID (represented in Base62-encoded text) of the QLDB journal stream.
    
    Parameters:
    
    streamId - The UUID (represented in Base62-encoded text) of the QLDB journal stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the QLDB journal stream.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the QLDB journal stream.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the QLDB journal stream.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the QLDB journal stream.
  - withArn
```
public JournalKinesisStreamDescription withArn(String arn)
```
    The Amazon Resource Name (ARN) of the QLDB journal stream.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the QLDB journal stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The current state of the QLDB journal stream.
    
    Parameters:
    
    status - The current state of the QLDB journal stream.
    
    See Also:
    
    StreamStatus
  - getStatus
```
public String getStatus()
```
    The current state of the QLDB journal stream.
    
    Returns:
    
    The current state of the QLDB journal stream.
    
    See Also:
    
    StreamStatus
  - withStatus
```
public JournalKinesisStreamDescription withStatus(String status)
```
    The current state of the QLDB journal stream.
    
    Parameters:
    
    status - The current state of the QLDB journal stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StreamStatus
  - withStatus
```
public JournalKinesisStreamDescription withStatus(StreamStatus status)
```
    The current state of the QLDB journal stream.
    
    Parameters:
    
    status - The current state of the QLDB journal stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StreamStatus
  - setKinesisConfiguration
```
public void setKinesisConfiguration(KinesisConfiguration kinesisConfiguration)
```
    The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.
    
    Parameters:
    
    kinesisConfiguration - The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.
  - getKinesisConfiguration
```
public KinesisConfiguration getKinesisConfiguration()
```
    The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.
    
    Returns:
    
    The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.
  - withKinesisConfiguration
```
public JournalKinesisStreamDescription withKinesisConfiguration(KinesisConfiguration kinesisConfiguration)
```
    The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.
    
    Parameters:
    
    kinesisConfiguration - The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setErrorCause
```
public void setErrorCause(String errorCause)
```
    The error message that describes the reason that a stream has a status of IMPAIRED or FAILED. This is not applicable to streams that have other status values.
    
    Parameters:
    
    errorCause - The error message that describes the reason that a stream has a status of IMPAIRED or FAILED. This is not applicable to streams that have other status values.
    
    See Also:
    
    ErrorCause
  - getErrorCause
```
public String getErrorCause()
```
    The error message that describes the reason that a stream has a status of IMPAIRED or FAILED. This is not applicable to streams that have other status values.
    
    Returns:
    
    The error message that describes the reason that a stream has a status of IMPAIRED or FAILED. This is not applicable to streams that have other status values.
    
    See Also:
    
    ErrorCause
  - withErrorCause
```
public JournalKinesisStreamDescription withErrorCause(String errorCause)
```
    The error message that describes the reason that a stream has a status of IMPAIRED or FAILED. This is not applicable to streams that have other status values.
    
    Parameters:
    
    errorCause - The error message that describes the reason that a stream has a status of IMPAIRED or FAILED. This is not applicable to streams that have other status values.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ErrorCause
  - withErrorCause
```
public JournalKinesisStreamDescription withErrorCause(ErrorCause errorCause)
```
    The error message that describes the reason that a stream has a status of IMPAIRED or FAILED. This is not applicable to streams that have other status values.
    
    Parameters:
    
    errorCause - The error message that describes the reason that a stream has a status of IMPAIRED or FAILED. This is not applicable to streams that have other status values.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ErrorCause
  - setStreamName
```
public void setStreamName(String streamName)
```
    The user-defined name of the QLDB journal stream.
    
    Parameters:
    
    streamName - The user-defined name of the QLDB journal stream.
  - getStreamName
```
public String getStreamName()
```
    The user-defined name of the QLDB journal stream.
    
    Returns:
    
    The user-defined name of the QLDB journal stream.
  - withStreamName
```
public JournalKinesisStreamDescription withStreamName(String streamName)
```
    The user-defined name of the QLDB journal stream.
    
    Parameters:
    
    streamName - The user-defined name of the QLDB journal stream.
    
    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 JournalKinesisStreamDescription 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.

AWS SDK for Java 1.x API Reference - 1.12.778

Class JournalKinesisStreamDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JournalKinesisStreamDescription

Method Detail

setLedgerName

getLedgerName

withLedgerName

setCreationTime

getCreationTime

withCreationTime

setInclusiveStartTime

getInclusiveStartTime

withInclusiveStartTime

setExclusiveEndTime

getExclusiveEndTime

withExclusiveEndTime

setRoleArn

getRoleArn

withRoleArn

setStreamId

getStreamId

withStreamId

setArn

getArn

withArn

setStatus

getStatus

withStatus

withStatus

setKinesisConfiguration

getKinesisConfiguration

withKinesisConfiguration

setErrorCause

getErrorCause

withErrorCause

withErrorCause

setStreamName

getStreamName

withStreamName

toString

equals

hashCode

clone

marshall