com.amazonaws.services.kafka.model.BrokerNodeGroupInfo Maven / Gradle / Ivy
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.kafka.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Describes the setup to be used for Apache Kafka broker nodes in the cluster.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class BrokerNodeGroupInfo implements Serializable, Cloneable, StructuredPojo {
/**
*
* 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.
*
*/
private String brokerAZDistribution;
/**
*
* 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 occupy the Availability Zone with ID use use1-az3.
*
*/
private java.util.List clientSubnets;
/**
*
* The type of Amazon EC2 instances to use for Apache 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.
*
*/
private String instanceType;
/**
*
* 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.
*
*/
private java.util.List securityGroups;
/**
*
* Contains information about storage volumes attached to MSK broker nodes.
*
*/
private StorageInfo storageInfo;
/**
*
* Information about the broker access configuration.
*
*/
private ConnectivityInfo connectivityInfo;
/**
*
* The list of zoneIds for the cluster in the virtual private cloud (VPC).
*
*/
private java.util.List zoneIds;
/**
*
* 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.
*
*
* @param 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.
*
* @see BrokerAZDistribution
*/
public void setBrokerAZDistribution(String brokerAZDistribution) {
this.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.
*
*
* @return
* 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 BrokerAZDistribution
*/
public String getBrokerAZDistribution() {
return this.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.
*
*
* @param 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see BrokerAZDistribution
*/
public BrokerNodeGroupInfo withBrokerAZDistribution(String brokerAZDistribution) {
setBrokerAZDistribution(brokerAZDistribution);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see BrokerAZDistribution
*/
public BrokerNodeGroupInfo withBrokerAZDistribution(BrokerAZDistribution brokerAZDistribution) {
this.brokerAZDistribution = brokerAZDistribution.toString();
return this;
}
/**
*
* 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 occupy the Availability Zone with ID use use1-az3.
*
*
* @return
* 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 occupy the Availability Zone with ID use use1-az3.
*
*/
public java.util.List getClientSubnets() {
return 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 occupy the Availability Zone with ID use use1-az3.
*
*
* @param 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 occupy the Availability Zone with ID use use1-az3.
*
*/
public void setClientSubnets(java.util.Collection clientSubnets) {
if (clientSubnets == null) {
this.clientSubnets = null;
return;
}
this.clientSubnets = new java.util.ArrayList(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 occupy the Availability Zone with ID use use1-az3.
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setClientSubnets(java.util.Collection)} or {@link #withClientSubnets(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param 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 occupy the Availability Zone with ID use use1-az3.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BrokerNodeGroupInfo withClientSubnets(String... clientSubnets) {
if (this.clientSubnets == null) {
setClientSubnets(new java.util.ArrayList(clientSubnets.length));
}
for (String ele : clientSubnets) {
this.clientSubnets.add(ele);
}
return this;
}
/**
*
* 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 occupy the Availability Zone with ID use use1-az3.
*
*
* @param 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 occupy the Availability Zone with ID use use1-az3.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BrokerNodeGroupInfo withClientSubnets(java.util.Collection clientSubnets) {
setClientSubnets(clientSubnets);
return this;
}
/**
*
* The type of Amazon EC2 instances to use for Apache 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.
*
*
* @param instanceType
*
* The type of Amazon EC2 instances to use for Apache 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.
*
*/
public void setInstanceType(String instanceType) {
this.instanceType = instanceType;
}
/**
*
* The type of Amazon EC2 instances to use for Apache 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.
*
*
* @return
* The type of Amazon EC2 instances to use for Apache 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.
*
*/
public String getInstanceType() {
return this.instanceType;
}
/**
*
* The type of Amazon EC2 instances to use for Apache 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.
*
*
* @param instanceType
*
* The type of Amazon EC2 instances to use for Apache 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BrokerNodeGroupInfo withInstanceType(String instanceType) {
setInstanceType(instanceType);
return this;
}
/**
*
* 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.
*
*
* @return
* 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.
*
*/
public java.util.List getSecurityGroups() {
return 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.
*
*
* @param 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.
*
*/
public void setSecurityGroups(java.util.Collection securityGroups) {
if (securityGroups == null) {
this.securityGroups = null;
return;
}
this.securityGroups = new java.util.ArrayList(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.
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSecurityGroups(java.util.Collection)} or {@link #withSecurityGroups(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BrokerNodeGroupInfo withSecurityGroups(String... securityGroups) {
if (this.securityGroups == null) {
setSecurityGroups(new java.util.ArrayList(securityGroups.length));
}
for (String ele : securityGroups) {
this.securityGroups.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BrokerNodeGroupInfo withSecurityGroups(java.util.Collection securityGroups) {
setSecurityGroups(securityGroups);
return this;
}
/**
*
* Contains information about storage volumes attached to MSK broker nodes.
*
*
* @param storageInfo
*
* Contains information about storage volumes attached to MSK broker nodes.
*
*/
public void setStorageInfo(StorageInfo storageInfo) {
this.storageInfo = storageInfo;
}
/**
*
* Contains information about storage volumes attached to MSK broker nodes.
*
*
* @return
* Contains information about storage volumes attached to MSK broker nodes.
*
*/
public StorageInfo getStorageInfo() {
return this.storageInfo;
}
/**
*
* Contains information about storage volumes attached to MSK broker nodes.
*
*
* @param storageInfo
*
* Contains information about storage volumes attached to MSK broker nodes.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BrokerNodeGroupInfo withStorageInfo(StorageInfo storageInfo) {
setStorageInfo(storageInfo);
return this;
}
/**
*
* Information about the broker access configuration.
*
*
* @param connectivityInfo
*
* Information about the broker access configuration.
*
*/
public void setConnectivityInfo(ConnectivityInfo connectivityInfo) {
this.connectivityInfo = connectivityInfo;
}
/**
*
* Information about the broker access configuration.
*
*
* @return
* Information about the broker access configuration.
*
*/
public ConnectivityInfo getConnectivityInfo() {
return this.connectivityInfo;
}
/**
*
* Information about the broker access configuration.
*
*
* @param connectivityInfo
*
* Information about the broker access configuration.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BrokerNodeGroupInfo withConnectivityInfo(ConnectivityInfo connectivityInfo) {
setConnectivityInfo(connectivityInfo);
return this;
}
/**
*
* The list of zoneIds for the cluster in the virtual private cloud (VPC).
*
*
* @return
* The list of zoneIds for the cluster in the virtual private cloud (VPC).
*
*/
public java.util.List getZoneIds() {
return zoneIds;
}
/**
*
* The list of zoneIds for the cluster in the virtual private cloud (VPC).
*
*
* @param zoneIds
*
* The list of zoneIds for the cluster in the virtual private cloud (VPC).
*
*/
public void setZoneIds(java.util.Collection zoneIds) {
if (zoneIds == null) {
this.zoneIds = null;
return;
}
this.zoneIds = new java.util.ArrayList(zoneIds);
}
/**
*
* The list of zoneIds for the cluster in the virtual private cloud (VPC).
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setZoneIds(java.util.Collection)} or {@link #withZoneIds(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param zoneIds
*
* The list of zoneIds for the cluster in the virtual private cloud (VPC).
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BrokerNodeGroupInfo withZoneIds(String... zoneIds) {
if (this.zoneIds == null) {
setZoneIds(new java.util.ArrayList(zoneIds.length));
}
for (String ele : zoneIds) {
this.zoneIds.add(ele);
}
return this;
}
/**
*
* The list of zoneIds for the cluster in the virtual private cloud (VPC).
*
*
* @param zoneIds
*
* The list of zoneIds for the cluster in the virtual private cloud (VPC).
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BrokerNodeGroupInfo withZoneIds(java.util.Collection zoneIds) {
setZoneIds(zoneIds);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getBrokerAZDistribution() != null)
sb.append("BrokerAZDistribution: ").append(getBrokerAZDistribution()).append(",");
if (getClientSubnets() != null)
sb.append("ClientSubnets: ").append(getClientSubnets()).append(",");
if (getInstanceType() != null)
sb.append("InstanceType: ").append(getInstanceType()).append(",");
if (getSecurityGroups() != null)
sb.append("SecurityGroups: ").append(getSecurityGroups()).append(",");
if (getStorageInfo() != null)
sb.append("StorageInfo: ").append(getStorageInfo()).append(",");
if (getConnectivityInfo() != null)
sb.append("ConnectivityInfo: ").append(getConnectivityInfo()).append(",");
if (getZoneIds() != null)
sb.append("ZoneIds: ").append(getZoneIds());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof BrokerNodeGroupInfo == false)
return false;
BrokerNodeGroupInfo other = (BrokerNodeGroupInfo) obj;
if (other.getBrokerAZDistribution() == null ^ this.getBrokerAZDistribution() == null)
return false;
if (other.getBrokerAZDistribution() != null && other.getBrokerAZDistribution().equals(this.getBrokerAZDistribution()) == false)
return false;
if (other.getClientSubnets() == null ^ this.getClientSubnets() == null)
return false;
if (other.getClientSubnets() != null && other.getClientSubnets().equals(this.getClientSubnets()) == false)
return false;
if (other.getInstanceType() == null ^ this.getInstanceType() == null)
return false;
if (other.getInstanceType() != null && other.getInstanceType().equals(this.getInstanceType()) == false)
return false;
if (other.getSecurityGroups() == null ^ this.getSecurityGroups() == null)
return false;
if (other.getSecurityGroups() != null && other.getSecurityGroups().equals(this.getSecurityGroups()) == false)
return false;
if (other.getStorageInfo() == null ^ this.getStorageInfo() == null)
return false;
if (other.getStorageInfo() != null && other.getStorageInfo().equals(this.getStorageInfo()) == false)
return false;
if (other.getConnectivityInfo() == null ^ this.getConnectivityInfo() == null)
return false;
if (other.getConnectivityInfo() != null && other.getConnectivityInfo().equals(this.getConnectivityInfo()) == false)
return false;
if (other.getZoneIds() == null ^ this.getZoneIds() == null)
return false;
if (other.getZoneIds() != null && other.getZoneIds().equals(this.getZoneIds()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getBrokerAZDistribution() == null) ? 0 : getBrokerAZDistribution().hashCode());
hashCode = prime * hashCode + ((getClientSubnets() == null) ? 0 : getClientSubnets().hashCode());
hashCode = prime * hashCode + ((getInstanceType() == null) ? 0 : getInstanceType().hashCode());
hashCode = prime * hashCode + ((getSecurityGroups() == null) ? 0 : getSecurityGroups().hashCode());
hashCode = prime * hashCode + ((getStorageInfo() == null) ? 0 : getStorageInfo().hashCode());
hashCode = prime * hashCode + ((getConnectivityInfo() == null) ? 0 : getConnectivityInfo().hashCode());
hashCode = prime * hashCode + ((getZoneIds() == null) ? 0 : getZoneIds().hashCode());
return hashCode;
}
@Override
public BrokerNodeGroupInfo clone() {
try {
return (BrokerNodeGroupInfo) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.kafka.model.transform.BrokerNodeGroupInfoMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}