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>

  • Method Details

    • 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()

      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 customPlugin object.

      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 customPlugin object.

    • 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 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()

      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()
      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 interface ToCopyableBuilder<CreateConnectorRequest.Builder,CreateConnectorRequest>
      Specified by:
      toBuilder in class KafkaConnectRequest
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.