Class CreateClusterRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.kafka.model.KafkaRequest
software.amazon.awssdk.services.kafka.model.CreateClusterRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateClusterRequest extends KafkaRequest implements ToCopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>

  • Method Details

    • brokerNodeGroupInfo

      public final BrokerNodeGroupInfo brokerNodeGroupInfo()

      Information about the broker nodes in the cluster.

      Returns:

      Information about the broker nodes in the cluster.

    • clientAuthentication

      public final ClientAuthentication clientAuthentication()

      Includes all client authentication related information.

      Returns:

      Includes all client authentication related information.

    • clusterName

      public final String clusterName()

      The name of the cluster.

      Returns:

      The name of the cluster.

    • configurationInfo

      public final ConfigurationInfo configurationInfo()

      Represents the configuration that you want MSK to use for the brokers in a cluster.

      Returns:

      Represents the configuration that you want MSK to use for the brokers in a cluster.

    • encryptionInfo

      public final EncryptionInfo encryptionInfo()

      Includes all encryption-related information.

      Returns:

      Includes all encryption-related information.

    • enhancedMonitoring

      public final EnhancedMonitoring enhancedMonitoring()

      Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.

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

      Returns:

      Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.

      See Also:

    • enhancedMonitoringAsString

      public final String enhancedMonitoringAsString()

      Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.

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

      Returns:

      Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.

      See Also:

    • openMonitoring

      public final OpenMonitoringInfo openMonitoring()

      The settings for open monitoring.

      Returns:

      The settings for open monitoring.

    • kafkaVersion

      public final String kafkaVersion()

      The version of Apache Kafka.

      Returns:

      The version of Apache Kafka.

    • loggingInfo

      public final LoggingInfo loggingInfo()
      Returns the value of the LoggingInfo property for this object.
      Returns:
      The value of the LoggingInfo property for this object.

    • numberOfBrokerNodes

      public final Integer numberOfBrokerNodes()

      The number of broker nodes in the cluster.

      Returns:

      The number of broker nodes in the cluster.

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

      Create tags when creating the cluster.

      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:

      Create tags when creating the cluster.

    • storageMode

      public final StorageMode storageMode()

      This controls storage mode for supported storage tiers.

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

      Returns:

      This controls storage mode for supported storage tiers.

      See Also:

    • storageModeAsString

      public final String storageModeAsString()

      This controls storage mode for supported storage tiers.

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

      Returns:

      This controls storage mode for supported storage tiers.

      See Also:

    • toBuilder

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

    • builder

      public static CreateClusterRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateClusterRequest.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.