BrokerNodeGroupInfo (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.kafka.model.BrokerNodeGroupInfo

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

@Generated(value="software.amazon.awssdk:codegen")
public final class BrokerNodeGroupInfo
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BrokerNodeGroupInfo.Builder,BrokerNodeGroupInfo>

Describes the setup to be used for Kafka broker nodes in the cluster.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface BrokerNodeGroupInfo.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BrokerAZDistribution`	`brokerAZDistribution()` The distribution of broker nodes across Availability Zones.
`String`	`brokerAZDistributionAsString()` The distribution of broker nodes across Availability Zones.
`static BrokerNodeGroupInfo.Builder`	`builder()`
`List<String>`	`clientSubnets()` The list of subnets to connect to in the client virtual private cloud (VPC).
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasClientSubnets()` For responses, this returns true if the service returned a value for the ClientSubnets property.
`int`	`hashCode()`
`boolean`	`hasSecurityGroups()` For responses, this returns true if the service returned a value for the SecurityGroups property.
`String`	`instanceType()` The type of Amazon EC2 instances to use for Kafka brokers.
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityGroups()` The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster.
`static Class<? extends BrokerNodeGroupInfo.Builder>`	`serializableBuilderClass()`
`StorageInfo`	`storageInfo()` Contains information about storage volumes attached to MSK broker nodes.
`BrokerNodeGroupInfo.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - brokerAZDistribution
```
public final BrokerAZDistribution brokerAZDistribution()
```
    The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.
    
    Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.
    
    If the service returns an enum value that is not available in the current SDK version, brokerAZDistribution will return BrokerAZDistribution.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from brokerAZDistributionAsString().
    
    Returns:
    
    The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.
    
    Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.
    
    See Also:
    
    BrokerAZDistribution
  - brokerAZDistributionAsString
```
public final String brokerAZDistributionAsString()
```
    The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.
    
    Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.
    
    If the service returns an enum value that is not available in the current SDK version, brokerAZDistribution will return BrokerAZDistribution.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from brokerAZDistributionAsString().
    
    Returns:
    
    The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.
    
    Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.
    
    See Also:
    
    BrokerAZDistribution
  - hasClientSubnets
```
public final boolean hasClientSubnets()
```
    For responses, this returns true if the service returned a value for the ClientSubnets 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.
  - clientSubnets
```
public final List<String> clientSubnets()
```
    The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't be in Availability Zone us-east-1e.
    
    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 hasClientSubnets() method.
    
    Returns:
    
    The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't be in Availability Zone us-east-1e.
  - instanceType
```
public final String instanceType()
```
    The type of Amazon EC2 instances to use for Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.
    
    Returns:
    
    The type of Amazon EC2 instances to use for Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.
  - hasSecurityGroups
```
public final boolean hasSecurityGroups()
```
    For responses, this returns true if the service returned a value for the SecurityGroups 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.
  - securityGroups
```
public final List<String> securityGroups()
```
    The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.
    
    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 hasSecurityGroups() method.
    
    Returns:
    
    The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.
  - storageInfo
```
public final StorageInfo storageInfo()
```
    Contains information about storage volumes attached to MSK broker nodes.
    
    Returns:
    
    Contains information about storage volumes attached to MSK broker nodes.
  - toBuilder
```
public BrokerNodeGroupInfo.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<BrokerNodeGroupInfo.Builder,BrokerNodeGroupInfo>
    
    Returns:
    
    a builder for type T
  - builder
```
public static BrokerNodeGroupInfo.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends BrokerNodeGroupInfo.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)
```
    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)
```
  - 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.

AWS SDK for Java API Reference - 2.17.68

Class BrokerNodeGroupInfo

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

brokerAZDistribution

brokerAZDistributionAsString

hasClientSubnets

clientSubnets

instanceType

hasSecurityGroups

securityGroups

storageInfo

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields