ConnectorSummary (AWS Java SDK :: Services :: Kafka Connect 2.20.149 API)

java.lang.Object
- software.amazon.awssdk.services.kafkaconnect.model.ConnectorSummary

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ConnectorSummary.Builder,ConnectorSummary>

@Generated(value="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 and Description

static interface ConnectorSummary.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ConnectorSummary.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ConnectorSummary.Builder`	`builder()`
`CapacityDescription`	`capacity()` The connector's compute capacity settings.
`String`	`connectorArn()` The Amazon Resource Name (ARN) of the connector.
`String`	`connectorDescription()` The description of the connector.
`String`	`connectorName()` The name of the connector.
`ConnectorState`	`connectorState()` The state of the connector.
`String`	`connectorStateAsString()` The state of the connector.
`Instant`	`creationTime()` The time that the connector was created.
`String`	`currentVersion()` The current version of the connector.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasPlugins()` For responses, this returns true if the service returned a value for the Plugins property.
`KafkaClusterDescription`	`kafkaCluster()` The details of the Apache Kafka cluster to which the connector is connected.
`KafkaClusterClientAuthenticationDescription`	`kafkaClusterClientAuthentication()` The type of client authentication used to connect to the Apache Kafka cluster.
`KafkaClusterEncryptionInTransitDescription`	`kafkaClusterEncryptionInTransit()` Details of encryption in transit to the Apache Kafka cluster.
`String`	`kafkaConnectVersion()` The version of Kafka Connect.
`LogDeliveryDescription`	`logDelivery()` 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()`
`String`	`serviceExecutionRoleArn()` The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.
`ConnectorSummary.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`WorkerConfigurationDescription`	`workerConfiguration()` 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, 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:
    
    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, 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:
    
    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 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.
  - 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:
    
    toBuilder in interface ToCopyableBuilder<ConnectorSummary.Builder,ConnectorSummary>
  - builder
```
public static ConnectorSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ConnectorSummary.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ConnectorSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

capacity

connectorArn

connectorDescription

connectorName

connectorState

connectorStateAsString

creationTime

currentVersion

kafkaCluster

kafkaClusterClientAuthentication

kafkaClusterEncryptionInTransit

kafkaConnectVersion

logDelivery

hasPlugins

plugins

serviceExecutionRoleArn

workerConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields