Package software.amazon.awssdk.services.kafkaconnect.model

Class DescribeConnectorResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.kafkaconnect.model.KafkaConnectResponse
software.amazon.awssdk.services.kafkaconnect.model.DescribeConnectorResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeConnectorResponse.Builder,DescribeConnectorResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeConnectorResponse extends KafkaConnectResponse implements ToCopyableBuilder<DescribeConnectorResponse.Builder,DescribeConnectorResponse>

  • Method Details

    • capacity

      public final CapacityDescription capacity()

      Information about the capacity of the connector, whether it is auto scaled or provisioned.

      Returns:
      Information about the capacity of the connector, whether it is auto scaled or provisioned.

    • connectorArn

      public final String connectorArn()

      The Amazon Resource Name (ARN) of the connector.

      Returns:
      The Amazon Resource Name (ARN) of the connector.

    • 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.

    • connectorState

      public final ConnectorState connectorState()

      The state of the connector.

      If the service returns an enum value that is not available in the current SDK version, connectorState will return ConnectorState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectorStateAsString().

      Returns:
      The state of the connector.
      See Also:

    • connectorStateAsString

      public final String connectorStateAsString()

      The state of the connector.

      If the service returns an enum value that is not available in the current SDK version, connectorState will return ConnectorState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectorStateAsString().

      Returns:
      The state of the connector.
      See Also:

    • creationTime

      public final Instant creationTime()

      The time the connector was created.

      Returns:
      The time the connector was created.

    • currentVersion

      public final String currentVersion()

      The current version of the connector.

      Returns:
      The current version of the connector.

    • kafkaCluster

      public final KafkaClusterDescription kafkaCluster()

      The Apache Kafka cluster that the connector is connected to.

      Returns:
      The Apache Kafka cluster that the connector is connected to.

    • kafkaClusterClientAuthentication

      public final KafkaClusterClientAuthenticationDescription kafkaClusterClientAuthentication()

      The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.

      Returns:
      The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.

    • kafkaClusterEncryptionInTransit

      public final KafkaClusterEncryptionInTransitDescription 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 LogDeliveryDescription logDelivery()

      Details about delivering logs to Amazon CloudWatch Logs.

      Returns:
      Details about delivering logs to Amazon CloudWatch Logs.

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

      Specifies which plugins were used for this 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 were used for this connector.

    • serviceExecutionRoleArn

      public final String serviceExecutionRoleArn()

      The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.

    • stateDescription

      public final StateDescription stateDescription()

      Details about the state of a connector.

      Returns:
      Details about the state of a connector.

    • workerConfiguration

      public final WorkerConfigurationDescription workerConfiguration()

      Specifies which worker configuration was used for the connector.

      Returns:
      Specifies which worker configuration was used for the connector.

    • toBuilder

      public DescribeConnectorResponse.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<DescribeConnectorResponse.Builder,DescribeConnectorResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeConnectorResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.