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("software.amazon.awssdk:codegen") public final class CreateConnectorRequest extends KafkaConnectRequest implements ToCopyableBuilder<CreateConnectorRequest.Builder,CreateConnectorRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateConnectorRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateConnectorRequest.Builderbuilder()Capacitycapacity()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.StringconnectorDescription()A summary description of the connector.StringconnectorName()The name of the connector.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasConnectorConfiguration()For responses, this returns true if the service returned a value for the ConnectorConfiguration property.inthashCode()booleanhasPlugins()For responses, this returns true if the service returned a value for the Plugins property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.KafkaClusterkafkaCluster()Specifies which Apache Kafka cluster to connect to.KafkaClusterClientAuthenticationkafkaClusterClientAuthentication()Details of the client authentication used by the Apache Kafka cluster.KafkaClusterEncryptionInTransitkafkaClusterEncryptionInTransit()Details of encryption in transit to the Apache Kafka cluster.StringkafkaConnectVersion()The version of Kafka Connect.LogDeliverylogDelivery()Details about log delivery.List<Plugin>plugins()Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateConnectorRequest.Builder>serializableBuilderClass()StringserviceExecutionRoleArn()The Amazon Resource Name (ARN) of the IAM role used by the connector to access the Amazon Web Services resources that it needs.Map<String,String>tags()The tags you want to attach to the connector.CreateConnectorRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.WorkerConfigurationworkerConfiguration()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 theisEmpty()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 theisEmpty()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()
Amazon MSK Connect does not currently support specifying multiple plugins as a list. To use more than one plugin for your connector, you can create a single custom plugin using a ZIP file that bundles multiple plugins together.
Specifies which plugin to use for the connector. You must specify a single-element list containing one
customPluginobject.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:
Amazon MSK Connect does not currently support specifying multiple plugins as a list. To use more than one plugin for your connector, you can create a single custom plugin using a ZIP file that bundles multiple plugins together.
Specifies which plugin to use for the connector. You must specify a single-element list containing one
customPluginobject.
-
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.
-
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 theisEmpty()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()
The tags you want to attach to 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
hasTags()method.- Returns:
- The tags you want to attach to the connector.
-
toBuilder
public CreateConnectorRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateConnectorRequest.Builder,CreateConnectorRequest>- Specified by:
toBuilderin classKafkaConnectRequest
-
builder
public static CreateConnectorRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateConnectorRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-