software.amazon.awssdk.services.kafka.model

Class CreateReplicatorRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kafka.model.KafkaRequest

software.amazon.awssdk.services.kafka.model.CreateReplicatorRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateReplicatorRequest.Builder,CreateReplicatorRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateReplicatorRequest
extends KafkaRequest
implements ToCopyableBuilder<CreateReplicatorRequest.Builder,CreateReplicatorRequest>

Creates a replicator using the specified configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateReplicatorRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateReplicatorRequest.Builder	builder()
String	description() A summary description of the replicator.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasKafkaClusters() For responses, this returns true if the service returned a value for the KafkaClusters property.
boolean	hasReplicationInfoList() For responses, this returns true if the service returned a value for the ReplicationInfoList property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
List<KafkaCluster>	kafkaClusters() Kafka Clusters to use in setting up sources / targets for replication.
List<ReplicationInfo>	replicationInfoList() A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
String	replicatorName() The name of the replicator.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateReplicatorRequest.Builder>	serializableBuilderClass()
String	serviceExecutionRoleArn() The ARN of the IAM role used by the replicator to access resources in the customer's account (e.g source and target clusters)
Map<String,String>	tags() List of tags to attach to created Replicator.
CreateReplicatorRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

description

public final String description()

A summary description of the replicator.

Returns:

A summary description of the replicator.

hasKafkaClusters

public final boolean hasKafkaClusters()

For responses, this returns true if the service returned a value for the KafkaClusters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

kafkaClusters

public final List<KafkaCluster> kafkaClusters()

Kafka Clusters to use in setting up sources / targets for replication.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasKafkaClusters() method.

Returns:

Kafka Clusters to use in setting up sources / targets for replication.

hasReplicationInfoList

public final boolean hasReplicationInfoList()

For responses, this returns true if the service returned a value for the ReplicationInfoList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

replicationInfoList

public final List<ReplicationInfo> replicationInfoList()

A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasReplicationInfoList() method.

Returns:

A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.

replicatorName

public final String replicatorName()

The name of the replicator. Alpha-numeric characters with '-' are allowed.

Returns:

The name of the replicator. Alpha-numeric characters with '-' are allowed.

serviceExecutionRoleArn

public final String serviceExecutionRoleArn()

The ARN of the IAM role used by the replicator to access resources in the customer's account (e.g source and target clusters)

Returns:

The ARN of the IAM role used by the replicator to access resources in the customer's account (e.g source and target clusters)

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final Map<String,String> tags()

List of tags to attach to created Replicator.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

List of tags to attach to created Replicator.

toBuilder

public CreateReplicatorRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateReplicatorRequest.Builder,CreateReplicatorRequest>

Specified by:

toBuilder in class KafkaRequest

builder

public static CreateReplicatorRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateReplicatorRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo