Class ConnectorSummary
- java.lang.Object
-
- software.amazon.awssdk.services.kafkaconnect.model.ConnectorSummary
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ConnectorSummary.Builder,ConnectorSummary>
@Generated("software.amazon.awssdk:codegen") public final class ConnectorSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ConnectorSummary.Builder,ConnectorSummary>
Summary of a connector.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceConnectorSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ConnectorSummary.Builderbuilder()CapacityDescriptioncapacity()The connector's compute capacity settings.StringconnectorArn()The Amazon Resource Name (ARN) of the connector.StringconnectorDescription()The description of the connector.StringconnectorName()The name of the connector.ConnectorStateconnectorState()The state of the connector.StringconnectorStateAsString()The state of the connector.InstantcreationTime()The time that the connector was created.StringcurrentVersion()The current version of the connector.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasPlugins()For responses, this returns true if the service returned a value for the Plugins property.KafkaClusterDescriptionkafkaCluster()The details of the Apache Kafka cluster to which the connector is connected.KafkaClusterClientAuthenticationDescriptionkafkaClusterClientAuthentication()The type of client authentication used to connect to the Apache Kafka cluster.KafkaClusterEncryptionInTransitDescriptionkafkaClusterEncryptionInTransit()Details of encryption in transit to the Apache Kafka cluster.StringkafkaConnectVersion()The version of Kafka Connect.LogDeliveryDescriptionlogDelivery()The settings for delivering connector logs to Amazon CloudWatch Logs.List<PluginDescription>plugins()Specifies which plugins were used for this connector.List<SdkField<?>>sdkFields()static Class<? extends ConnectorSummary.Builder>serializableBuilderClass()StringserviceExecutionRoleArn()The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.ConnectorSummary.BuildertoBuilder()StringtoString()Returns a string representation of this object.WorkerConfigurationDescriptionworkerConfiguration()The worker configurations that are in use with the connector.-
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 CapacityDescription capacity()
The connector's compute capacity settings.
- Returns:
- The connector's compute capacity settings.
-
connectorArn
public final String connectorArn()
The Amazon Resource Name (ARN) of the connector.
- Returns:
- The Amazon Resource Name (ARN) of the connector.
-
connectorDescription
public final String connectorDescription()
The description of the connector.
- Returns:
- The 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,
connectorStatewill returnConnectorState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromconnectorStateAsString().- Returns:
- The state of the connector.
- See Also:
ConnectorState
-
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,
connectorStatewill returnConnectorState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromconnectorStateAsString().- Returns:
- The state of the connector.
- See Also:
ConnectorState
-
creationTime
public final Instant creationTime()
The time that the connector was created.
- Returns:
- The time that 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 details of the Apache Kafka cluster to which the connector is connected.
- Returns:
- The details of the Apache Kafka cluster to which the connector is connected.
-
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()
The settings for delivering connector logs to Amazon CloudWatch Logs.
- Returns:
- The settings for delivering connector 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 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<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.
-
workerConfiguration
public final WorkerConfigurationDescription workerConfiguration()
The worker configurations that are in use with the connector.
- Returns:
- The worker configurations that are in use with the connector.
-
toBuilder
public ConnectorSummary.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ConnectorSummary.Builder,ConnectorSummary>
-
builder
public static ConnectorSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends ConnectorSummary.Builder> serializableBuilderClass()
-
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.
-
-