software.amazon.awssdk.services.kafkaconnect.model

Class CreateConnectorRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kafkaconnect.model.KafkaConnectRequest

software.amazon.awssdk.services.kafkaconnect.model.CreateConnectorRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateConnectorRequest.Builder,CreateConnectorRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateConnectorRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateConnectorRequest.Builder	builder()
Capacity	capacity() Information about the capacity allocated to the connector.
Map<String,String>	connectorConfiguration() A map of keys to values that represent the configuration for the connector.
String	connectorDescription() A summary description of the connector.
String	connectorName() The name of the connector.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasConnectorConfiguration() For responses, this returns true if the service returned a value for the ConnectorConfiguration property.
int	hashCode()
boolean	hasPlugins() For responses, this returns true if the service returned a value for the Plugins property.
KafkaCluster	kafkaCluster() Specifies which Apache Kafka cluster to connect to.
KafkaClusterClientAuthentication	kafkaClusterClientAuthentication() Details of the client authentication used by the Apache Kafka cluster.
KafkaClusterEncryptionInTransit	kafkaClusterEncryptionInTransit() Details of encryption in transit to the Apache Kafka cluster.
String	kafkaConnectVersion() The version of Kafka Connect.
LogDelivery	logDelivery() Details about log delivery.
List<Plugin>	plugins() Specifies which plugins to use for the connector.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateConnectorRequest.Builder>	serializableBuilderClass()
String	serviceExecutionRoleArn() The Amazon Resource Name (ARN) of the IAM role used by the connector to access the Amazon Web Services resources that it needs.
CreateConnectorRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
WorkerConfiguration	workerConfiguration() Specifies which worker configuration to use with the connector.

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

capacity

public final Capacity capacity()

Information about the capacity allocated to the connector. Exactly one of the two properties must be specified.

Returns:

Information about the capacity allocated to the connector. Exactly one of the two properties must be specified.

hasConnectorConfiguration

public final boolean hasConnectorConfiguration()

For responses, this returns true if the service returned a value for the ConnectorConfiguration 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.

connectorConfiguration

public final Map<String,String> connectorConfiguration()

A map of keys to values that represent the configuration for the connector.

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 hasConnectorConfiguration() method.

Returns:

A map of keys to values that represent the configuration for the connector.

connectorDescription

public final String connectorDescription()

A summary description of the connector.

Returns:

A summary description of the connector.

connectorName

public final String connectorName()

The name of the connector.

Returns:

The name of the connector.

kafkaCluster

public final KafkaCluster kafkaCluster()

Specifies which Apache Kafka cluster to connect to.

Returns:

Specifies which Apache Kafka cluster to connect to.

kafkaClusterClientAuthentication

public final KafkaClusterClientAuthentication kafkaClusterClientAuthentication()

Details of the client authentication used by the Apache Kafka cluster.

Returns:

Details of the client authentication used by the Apache Kafka cluster.

kafkaClusterEncryptionInTransit

public final KafkaClusterEncryptionInTransit kafkaClusterEncryptionInTransit()

Details of encryption in transit to the Apache Kafka cluster.

Returns:

Details of encryption in transit to the Apache Kafka cluster.

kafkaConnectVersion

public final String kafkaConnectVersion()

The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.

Returns:

The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.

logDelivery

public final LogDelivery logDelivery()

Details about log delivery.

Returns:

Details about log delivery.

hasPlugins

public final boolean hasPlugins()

For responses, this returns true if the service returned a value for the Plugins 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.

plugins

public final List<Plugin> plugins()

Specifies which plugins to use for the connector.

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 hasPlugins() method.

Returns:

Specifies which plugins to use for the connector.

serviceExecutionRoleArn

public final String serviceExecutionRoleArn()

The Amazon Resource Name (ARN) of the IAM role used by the connector to access the Amazon Web Services resources that it needs. The types of resources depends on the logic of the connector. For example, a connector that has Amazon S3 as a destination must have permissions that allow it to write to the S3 destination bucket.

Returns:

The Amazon Resource Name (ARN) of the IAM role used by the connector to access the Amazon Web Services resources that it needs. The types of resources depends on the logic of the connector. For example, a connector that has Amazon S3 as a destination must have permissions that allow it to write to the S3 destination bucket.

workerConfiguration

public final WorkerConfiguration workerConfiguration()

Specifies which worker configuration to use with the connector.

Returns:

Specifies which worker configuration to use with the connector.

toBuilder

public CreateConnectorRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateConnectorRequest.Builder,CreateConnectorRequest>

Specified by:

toBuilder in class KafkaConnectRequest

builder

public static CreateConnectorRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateConnectorRequest.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