Package software.amazon.awssdk.services.kafka.model

Interface ClusterInfo.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ClusterInfo.Builder,ClusterInfo>, SdkBuilder<ClusterInfo.Builder,ClusterInfo>, SdkPojo
Enclosing class:
ClusterInfo
public static interface ClusterInfo.Builder extends SdkPojo, CopyableBuilder<ClusterInfo.Builder,ClusterInfo>

  • Method Details

    • activeOperationArn

      ClusterInfo.Builder activeOperationArn(String activeOperationArn)

      Arn of active cluster operation.

      Parameters:
      activeOperationArn -

      Arn of active cluster operation.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • brokerNodeGroupInfo

      ClusterInfo.Builder brokerNodeGroupInfo(BrokerNodeGroupInfo brokerNodeGroupInfo)

      Information about the broker nodes.

      Parameters:
      brokerNodeGroupInfo -

      Information about the broker nodes.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • brokerNodeGroupInfo

      default ClusterInfo.Builder brokerNodeGroupInfo(Consumer<BrokerNodeGroupInfo.Builder> brokerNodeGroupInfo)

      Information about the broker nodes.

      This is a convenience method that creates an instance of the BrokerNodeGroupInfo.Builder avoiding the need to create one manually via BrokerNodeGroupInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to brokerNodeGroupInfo(BrokerNodeGroupInfo).

      Parameters:
      brokerNodeGroupInfo - a consumer that will call methods on BrokerNodeGroupInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientAuthentication

      ClusterInfo.Builder clientAuthentication(ClientAuthentication clientAuthentication)

      Includes all client authentication information.

      Parameters:
      clientAuthentication -

      Includes all client authentication information.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientAuthentication

      default ClusterInfo.Builder clientAuthentication(Consumer<ClientAuthentication.Builder> clientAuthentication)

      Includes all client authentication information.

      This is a convenience method that creates an instance of the ClientAuthentication.Builder avoiding the need to create one manually via ClientAuthentication.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to clientAuthentication(ClientAuthentication).

      Parameters:
      clientAuthentication - a consumer that will call methods on ClientAuthentication.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clusterArn

      ClusterInfo.Builder clusterArn(String clusterArn)

      The Amazon Resource Name (ARN) that uniquely identifies the cluster.

      Parameters:
      clusterArn -

      The Amazon Resource Name (ARN) that uniquely identifies the cluster.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterName

      ClusterInfo.Builder clusterName(String clusterName)

      The name of the cluster.

      Parameters:
      clusterName -

      The name of the cluster.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationTime

      ClusterInfo.Builder creationTime(Instant creationTime)

      The time when the cluster was created.

      Parameters:
      creationTime -

      The time when the cluster was created.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • currentBrokerSoftwareInfo

      ClusterInfo.Builder currentBrokerSoftwareInfo(BrokerSoftwareInfo currentBrokerSoftwareInfo)

      Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.

      Parameters:
      currentBrokerSoftwareInfo -

      Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • currentBrokerSoftwareInfo

      default ClusterInfo.Builder currentBrokerSoftwareInfo(Consumer<BrokerSoftwareInfo.Builder> currentBrokerSoftwareInfo)

      Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.

      This is a convenience method that creates an instance of the BrokerSoftwareInfo.Builder avoiding the need to create one manually via BrokerSoftwareInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to currentBrokerSoftwareInfo(BrokerSoftwareInfo).

      Parameters:
      currentBrokerSoftwareInfo - a consumer that will call methods on BrokerSoftwareInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • currentVersion

      ClusterInfo.Builder currentVersion(String currentVersion)

      The current version of the MSK cluster.

      Parameters:
      currentVersion -

      The current version of the MSK cluster.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionInfo

      ClusterInfo.Builder encryptionInfo(EncryptionInfo encryptionInfo)

      Includes all encryption-related information.

      Parameters:
      encryptionInfo -

      Includes all encryption-related information.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionInfo

      default ClusterInfo.Builder encryptionInfo(Consumer<EncryptionInfo.Builder> encryptionInfo)

      Includes all encryption-related information.

      This is a convenience method that creates an instance of the EncryptionInfo.Builder avoiding the need to create one manually via EncryptionInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryptionInfo(EncryptionInfo).

      Parameters:
      encryptionInfo - a consumer that will call methods on EncryptionInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • enhancedMonitoring

      ClusterInfo.Builder enhancedMonitoring(String enhancedMonitoring)

      Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.

      Parameters:
      enhancedMonitoring -

      Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • enhancedMonitoring

      ClusterInfo.Builder enhancedMonitoring(EnhancedMonitoring enhancedMonitoring)

      Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.

      Parameters:
      enhancedMonitoring -

      Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • openMonitoring

      ClusterInfo.Builder openMonitoring(OpenMonitoring openMonitoring)

      Settings for open monitoring using Prometheus.

      Parameters:
      openMonitoring -

      Settings for open monitoring using Prometheus.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • openMonitoring

      default ClusterInfo.Builder openMonitoring(Consumer<OpenMonitoring.Builder> openMonitoring)

      Settings for open monitoring using Prometheus.

      This is a convenience method that creates an instance of the OpenMonitoring.Builder avoiding the need to create one manually via OpenMonitoring.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to openMonitoring(OpenMonitoring).

      Parameters:
      openMonitoring - a consumer that will call methods on OpenMonitoring.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • loggingInfo

      ClusterInfo.Builder loggingInfo(LoggingInfo loggingInfo)
      Sets the value of the LoggingInfo property for this object.
      Parameters:
      loggingInfo - The new value for the LoggingInfo property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • loggingInfo

      default ClusterInfo.Builder loggingInfo(Consumer<LoggingInfo.Builder> loggingInfo)
      Sets the value of the LoggingInfo property for this object. This is a convenience method that creates an instance of the LoggingInfo.Builder avoiding the need to create one manually via LoggingInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to loggingInfo(LoggingInfo).

      Parameters:
      loggingInfo - a consumer that will call methods on LoggingInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • numberOfBrokerNodes

      ClusterInfo.Builder numberOfBrokerNodes(Integer numberOfBrokerNodes)

      The number of broker nodes in the cluster.

      Parameters:
      numberOfBrokerNodes -

      The number of broker nodes in the cluster.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      ClusterInfo.Builder state(String state)

      The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

      Parameters:
      state -

      The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      ClusterInfo.Builder state(ClusterState state)

      The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

      Parameters:
      state -

      The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • stateInfo

      ClusterInfo.Builder stateInfo(StateInfo stateInfo)
      Sets the value of the StateInfo property for this object.
      Parameters:
      stateInfo - The new value for the StateInfo property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stateInfo

      default ClusterInfo.Builder stateInfo(Consumer<StateInfo.Builder> stateInfo)
      Sets the value of the StateInfo property for this object. This is a convenience method that creates an instance of the StateInfo.Builder avoiding the need to create one manually via StateInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to stateInfo(StateInfo).

      Parameters:
      stateInfo - a consumer that will call methods on StateInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      ClusterInfo.Builder tags(Map<String,String> tags)

      Tags attached to the cluster.

      Parameters:
      tags -

      Tags attached to the cluster.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • zookeeperConnectString

      ClusterInfo.Builder zookeeperConnectString(String zookeeperConnectString)

      The connection string to use to connect to the Apache ZooKeeper cluster.

      Parameters:
      zookeeperConnectString -

      The connection string to use to connect to the Apache ZooKeeper cluster.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • zookeeperConnectStringTls

      ClusterInfo.Builder zookeeperConnectStringTls(String zookeeperConnectStringTls)

      The connection string to use to connect to zookeeper cluster on Tls port.

      Parameters:
      zookeeperConnectStringTls -

      The connection string to use to connect to zookeeper cluster on Tls port.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storageMode

      ClusterInfo.Builder storageMode(String storageMode)

      This controls storage mode for supported storage tiers.

      Parameters:
      storageMode -

      This controls storage mode for supported storage tiers.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageMode

      ClusterInfo.Builder storageMode(StorageMode storageMode)

      This controls storage mode for supported storage tiers.

      Parameters:
      storageMode -

      This controls storage mode for supported storage tiers.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • customerActionStatus

      ClusterInfo.Builder customerActionStatus(String customerActionStatus)

      Determines if there is an action required from the customer.

      Parameters:
      customerActionStatus -

      Determines if there is an action required from the customer.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • customerActionStatus

      ClusterInfo.Builder customerActionStatus(CustomerActionStatus customerActionStatus)

      Determines if there is an action required from the customer.

      Parameters:
      customerActionStatus -

      Determines if there is an action required from the customer.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: