Class MSKSourceDescription
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<MSKSourceDescription.Builder,
MSKSourceDescription>
Details about the Amazon MSK cluster used as the source for a Firehose stream.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionThe authentication configuration of the Amazon MSK cluster.static MSKSourceDescription.Builder
builder()
final Instant
Firehose starts retrieving records from the topic within the Amazon MSK cluster starting with this timestamp.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
The ARN of the Amazon MSK cluster.final Instant
The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read.static Class
<? extends MSKSourceDescription.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
The topic name within the Amazon MSK cluster.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
mskClusterARN
The ARN of the Amazon MSK cluster.
- Returns:
- The ARN of the Amazon MSK cluster.
-
topicName
The topic name within the Amazon MSK cluster.
- Returns:
- The topic name within the Amazon MSK cluster.
-
authenticationConfiguration
The authentication configuration of the Amazon MSK cluster.
- Returns:
- The authentication configuration of the Amazon MSK cluster.
-
deliveryStartTimestamp
Firehose starts retrieving records from the topic within the Amazon MSK cluster starting with this timestamp.
- Returns:
- Firehose starts retrieving records from the topic within the Amazon MSK cluster starting with this timestamp.
-
readFromTimestamp
The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.
If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the
ReadFromTimestampUTC
parameter to Epoch (1970-01-01T00:00:00Z).- Returns:
- The start date and time in UTC for the offset position within your MSK topic from where Firehose begins
to read. By default, this is set to timestamp when Firehose becomes Active.
If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the
ReadFromTimestampUTC
parameter to Epoch (1970-01-01T00:00:00Z).
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<MSKSourceDescription.Builder,
MSKSourceDescription> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-