com.amazonaws.services.qldb.model

Class StreamJournalToKinesisRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.qldb.model.StreamJournalToKinesisRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StreamJournalToKinesisRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StreamJournalToKinesisRequest()

Method Summary

Modifier and Type	Method and Description
StreamJournalToKinesisRequest	addTagsEntry(String key, String value) Add a single Tags entry
StreamJournalToKinesisRequest	clearTagsEntries() Removes all the entries added into Tags.
StreamJournalToKinesisRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
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 Kinesis Data Streams destination for your stream request.
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	getStreamName() The name that you want to assign to the QLDB journal stream.
Map<String,String>	getTags() The key-value pairs to add as tags to the stream that you want to create.
int	hashCode()
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 Kinesis Data Streams destination for your stream request.
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	setStreamName(String streamName) The name that you want to assign to the QLDB journal stream.
void	setTags(Map<String,String> tags) The key-value pairs to add as tags to the stream that you want to create.
String	toString() Returns a string representation of this object.
StreamJournalToKinesisRequest	withExclusiveEndTime(Date exclusiveEndTime) The exclusive date and time that specifies when the stream ends.
StreamJournalToKinesisRequest	withInclusiveStartTime(Date inclusiveStartTime) The inclusive start date and time from which to start streaming journal data.
StreamJournalToKinesisRequest	withKinesisConfiguration(KinesisConfiguration kinesisConfiguration) The configuration settings of the Kinesis Data Streams destination for your stream request.
StreamJournalToKinesisRequest	withLedgerName(String ledgerName) The name of the ledger.
StreamJournalToKinesisRequest	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.
StreamJournalToKinesisRequest	withStreamName(String streamName) The name that you want to assign to the QLDB journal stream.
StreamJournalToKinesisRequest	withTags(Map<String,String> tags) The key-value pairs to add as tags to the stream that you want to create.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StreamJournalToKinesisRequest

public StreamJournalToKinesisRequest()

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 StreamJournalToKinesisRequest 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.

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.

To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the iam:PassRole action on the IAM role resource. This is required for all journal stream requests.

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.

To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the iam:PassRole action on the IAM role resource. This is required for all journal stream requests.

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.

To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the iam:PassRole action on the IAM role resource. This is required for all journal stream requests.

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.

To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the iam:PassRole action on the IAM role resource. This is required for all journal stream requests.

withRoleArn

public StreamJournalToKinesisRequest 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.

To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the iam:PassRole action on the IAM role resource. This is required for all journal stream requests.

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.

To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the iam:PassRole action on the IAM role resource. This is required for all journal stream requests.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public Map<String,String> getTags()

The key-value pairs to add as tags to the stream that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

Returns:

The key-value pairs to add as tags to the stream that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

setTags

public void setTags(Map<String,String> tags)

The key-value pairs to add as tags to the stream that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

Parameters:

tags - The key-value pairs to add as tags to the stream that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

withTags

public StreamJournalToKinesisRequest withTags(Map<String,String> tags)

The key-value pairs to add as tags to the stream that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

Parameters:

tags - The key-value pairs to add as tags to the stream that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

Returns:

Returns a reference to this object so that method calls can be chained together.

addTagsEntry

public StreamJournalToKinesisRequest addTagsEntry(String key,
                                                  String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public StreamJournalToKinesisRequest clearTagsEntries()

Removes all the entries added into Tags.

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. This parameter must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

The InclusiveStartTime cannot be in the future and must be before ExclusiveEndTime.

If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, QLDB effectively defaults it to the ledger's CreationDateTime.

Parameters:

inclusiveStartTime - The inclusive start date and time from which to start streaming journal data. This parameter must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

The InclusiveStartTime cannot be in the future and must be before ExclusiveEndTime.

If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, QLDB effectively defaults it to the ledger's CreationDateTime.

getInclusiveStartTime

public Date getInclusiveStartTime()

The inclusive start date and time from which to start streaming journal data. This parameter must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

The InclusiveStartTime cannot be in the future and must be before ExclusiveEndTime.

If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, QLDB effectively defaults it to the ledger's CreationDateTime.

Returns:

The inclusive start date and time from which to start streaming journal data. This parameter must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

The InclusiveStartTime cannot be in the future and must be before ExclusiveEndTime.

If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, QLDB effectively defaults it to the ledger's CreationDateTime.

withInclusiveStartTime

public StreamJournalToKinesisRequest withInclusiveStartTime(Date inclusiveStartTime)

The inclusive start date and time from which to start streaming journal data. This parameter must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

The InclusiveStartTime cannot be in the future and must be before ExclusiveEndTime.

If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, QLDB effectively defaults it to the ledger's CreationDateTime.

Parameters:

inclusiveStartTime - The inclusive start date and time from which to start streaming journal data. This parameter must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

The InclusiveStartTime cannot be in the future and must be before ExclusiveEndTime.

If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, QLDB effectively defaults it to the ledger's CreationDateTime.

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 you don't define this parameter, the stream runs indefinitely until you cancel it.

The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

Parameters:

exclusiveEndTime - The exclusive date and time that specifies when the stream ends. If you don't define this parameter, the stream runs indefinitely until you cancel it.

The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

getExclusiveEndTime

public Date getExclusiveEndTime()

The exclusive date and time that specifies when the stream ends. If you don't define this parameter, the stream runs indefinitely until you cancel it.

The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

Returns:

The exclusive date and time that specifies when the stream ends. If you don't define this parameter, the stream runs indefinitely until you cancel it.

The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

withExclusiveEndTime

public StreamJournalToKinesisRequest withExclusiveEndTime(Date exclusiveEndTime)

The exclusive date and time that specifies when the stream ends. If you don't define this parameter, the stream runs indefinitely until you cancel it.

The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

Parameters:

exclusiveEndTime - The exclusive date and time that specifies when the stream ends. If you don't define this parameter, the stream runs indefinitely until you cancel it.

The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

Returns:

Returns a reference to this object so that method calls can be chained together.

setKinesisConfiguration

public void setKinesisConfiguration(KinesisConfiguration kinesisConfiguration)

The configuration settings of the Kinesis Data Streams destination for your stream request.

Parameters:

kinesisConfiguration - The configuration settings of the Kinesis Data Streams destination for your stream request.

getKinesisConfiguration

public KinesisConfiguration getKinesisConfiguration()

The configuration settings of the Kinesis Data Streams destination for your stream request.

Returns:

The configuration settings of the Kinesis Data Streams destination for your stream request.

withKinesisConfiguration

public StreamJournalToKinesisRequest withKinesisConfiguration(KinesisConfiguration kinesisConfiguration)

The configuration settings of the Kinesis Data Streams destination for your stream request.

Parameters:

kinesisConfiguration - The configuration settings of the Kinesis Data Streams destination for your stream request.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStreamName

public void setStreamName(String streamName)

The name that you want to assign to the QLDB journal stream. User-defined names can help identify and indicate the purpose of a stream.

Your stream name must be unique among other active streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.

Parameters:

streamName - The name that you want to assign to the QLDB journal stream. User-defined names can help identify and indicate the purpose of a stream.

Your stream name must be unique among other active streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.

getStreamName

public String getStreamName()

The name that you want to assign to the QLDB journal stream. User-defined names can help identify and indicate the purpose of a stream.

Your stream name must be unique among other active streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.

Returns:

The name that you want to assign to the QLDB journal stream. User-defined names can help identify and indicate the purpose of a stream.

Your stream name must be unique among other active streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.

withStreamName

public StreamJournalToKinesisRequest withStreamName(String streamName)

The name that you want to assign to the QLDB journal stream. User-defined names can help identify and indicate the purpose of a stream.

Your stream name must be unique among other active streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.

Parameters:

streamName - The name that you want to assign to the QLDB journal stream. User-defined names can help identify and indicate the purpose of a stream.

Your stream name must be unique among other active streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.

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 StreamJournalToKinesisRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()