software.amazon.awssdk.services.kafka.model.Configuration Maven / Gradle / Ivy
Show all versions of kafka Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.kafka.model;
import java.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.TimestampFormatTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
*
* Represents an MSK Configuration.
*
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Configuration implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Arn")
.getter(getter(Configuration::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("arn").build()).build();
private static final SdkField CREATION_TIME_FIELD = SdkField
. builder(MarshallingType.INSTANT)
.memberName("CreationTime")
.getter(getter(Configuration::creationTime))
.setter(setter(Builder::creationTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("creationTime").build(),
TimestampFormatTrait.create(TimestampFormatTrait.Format.ISO_8601)).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(Configuration::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("description").build()).build();
private static final SdkField> KAFKA_VERSIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("KafkaVersions")
.getter(getter(Configuration::kafkaVersions))
.setter(setter(Builder::kafkaVersions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("kafkaVersions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField LATEST_REVISION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("LatestRevision")
.getter(getter(Configuration::latestRevision)).setter(setter(Builder::latestRevision))
.constructor(ConfigurationRevision::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("latestRevision").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(Configuration::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField STATE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("State")
.getter(getter(Configuration::stateAsString)).setter(setter(Builder::state))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("state").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ARN_FIELD,
CREATION_TIME_FIELD, DESCRIPTION_FIELD, KAFKA_VERSIONS_FIELD, LATEST_REVISION_FIELD, NAME_FIELD, STATE_FIELD));
private static final long serialVersionUID = 1L;
private final String arn;
private final Instant creationTime;
private final String description;
private final List kafkaVersions;
private final ConfigurationRevision latestRevision;
private final String name;
private final String state;
private Configuration(BuilderImpl builder) {
this.arn = builder.arn;
this.creationTime = builder.creationTime;
this.description = builder.description;
this.kafkaVersions = builder.kafkaVersions;
this.latestRevision = builder.latestRevision;
this.name = builder.name;
this.state = builder.state;
}
/**
*
*
* The Amazon Resource Name (ARN) of the configuration.
*
*
* @return
* The Amazon Resource Name (ARN) of the configuration.
*
*/
public final String arn() {
return arn;
}
/**
*
*
* The time when the configuration was created.
*
*
* @return
* The time when the configuration was created.
*
*/
public final Instant creationTime() {
return creationTime;
}
/**
*
*
* The description of the configuration.
*
*
* @return
* The description of the configuration.
*
*/
public final String description() {
return description;
}
/**
* For responses, this returns true if the service returned a value for the KafkaVersions property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code 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.
*/
public final boolean hasKafkaVersions() {
return kafkaVersions != null && !(kafkaVersions instanceof SdkAutoConstructList);
}
/**
*
*
* An array of the versions of Apache Kafka with which you can use this MSK configuration. You can use this
* configuration for an MSK cluster only if the Apache Kafka version specified for the cluster appears in this
* array.
*
*
*
* 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 {@link #hasKafkaVersions} method.
*
*
* @return
* An array of the versions of Apache Kafka with which you can use this MSK configuration. You can use this
* configuration for an MSK cluster only if the Apache Kafka version specified for the cluster appears in
* this array.
*
*/
public final List kafkaVersions() {
return kafkaVersions;
}
/**
*
*
* Latest revision of the configuration.
*
*
* @return
* Latest revision of the configuration.
*
*/
public final ConfigurationRevision latestRevision() {
return latestRevision;
}
/**
*
*
* The name of the configuration.
*
*
* @return
* The name of the configuration.
*
*/
public final String name() {
return name;
}
/**
*
*
* The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link ConfigurationState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return
* The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
*
* @see ConfigurationState
*/
public final ConfigurationState state() {
return ConfigurationState.fromValue(state);
}
/**
*
*
* The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link ConfigurationState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return
* The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
*
* @see ConfigurationState
*/
public final String stateAsString() {
return state;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(arn());
hashCode = 31 * hashCode + Objects.hashCode(creationTime());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(hasKafkaVersions() ? kafkaVersions() : null);
hashCode = 31 * hashCode + Objects.hashCode(latestRevision());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(stateAsString());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof Configuration)) {
return false;
}
Configuration other = (Configuration) obj;
return Objects.equals(arn(), other.arn()) && Objects.equals(creationTime(), other.creationTime())
&& Objects.equals(description(), other.description()) && hasKafkaVersions() == other.hasKafkaVersions()
&& Objects.equals(kafkaVersions(), other.kafkaVersions())
&& Objects.equals(latestRevision(), other.latestRevision()) && Objects.equals(name(), other.name())
&& Objects.equals(stateAsString(), other.stateAsString());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("Configuration").add("Arn", arn()).add("CreationTime", creationTime())
.add("Description", description()).add("KafkaVersions", hasKafkaVersions() ? kafkaVersions() : null)
.add("LatestRevision", latestRevision()).add("Name", name()).add("State", stateAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Arn":
return Optional.ofNullable(clazz.cast(arn()));
case "CreationTime":
return Optional.ofNullable(clazz.cast(creationTime()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "KafkaVersions":
return Optional.ofNullable(clazz.cast(kafkaVersions()));
case "LatestRevision":
return Optional.ofNullable(clazz.cast(latestRevision()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "State":
return Optional.ofNullable(clazz.cast(stateAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Configuration) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
*
* The Amazon Resource Name (ARN) of the configuration.
*
*
* @param arn
*
* The Amazon Resource Name (ARN) of the configuration.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arn(String arn);
/**
*
*
* The time when the configuration was created.
*
*
* @param creationTime
*
* The time when the configuration was created.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder creationTime(Instant creationTime);
/**
*
*
* The description of the configuration.
*
*
* @param description
*
* The description of the configuration.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
*
* An array of the versions of Apache Kafka with which you can use this MSK configuration. You can use this
* configuration for an MSK cluster only if the Apache Kafka version specified for the cluster appears in this
* array.
*
*
* @param kafkaVersions
*
* An array of the versions of Apache Kafka with which you can use this MSK configuration. You can use
* this configuration for an MSK cluster only if the Apache Kafka version specified for the cluster
* appears in this array.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder kafkaVersions(Collection kafkaVersions);
/**
*
*
* An array of the versions of Apache Kafka with which you can use this MSK configuration. You can use this
* configuration for an MSK cluster only if the Apache Kafka version specified for the cluster appears in this
* array.
*
*
* @param kafkaVersions
*
* An array of the versions of Apache Kafka with which you can use this MSK configuration. You can use
* this configuration for an MSK cluster only if the Apache Kafka version specified for the cluster
* appears in this array.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder kafkaVersions(String... kafkaVersions);
/**
*
*
* Latest revision of the configuration.
*
*
* @param latestRevision
*
* Latest revision of the configuration.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder latestRevision(ConfigurationRevision latestRevision);
/**
*
*
* Latest revision of the configuration.
*
*
* This is a convenience method that creates an instance of the {@link ConfigurationRevision.Builder} avoiding
* the need to create one manually via {@link ConfigurationRevision#builder()}.
*
*
* When the {@link Consumer} completes, {@link ConfigurationRevision.Builder#build()} is called immediately and
* its result is passed to {@link #latestRevision(ConfigurationRevision)}.
*
* @param latestRevision
* a consumer that will call methods on {@link ConfigurationRevision.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #latestRevision(ConfigurationRevision)
*/
default Builder latestRevision(Consumer latestRevision) {
return latestRevision(ConfigurationRevision.builder().applyMutation(latestRevision).build());
}
/**
*
*
* The name of the configuration.
*
*
* @param name
*
* The name of the configuration.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
*
* The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
*
*
* @param state
*
* The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
*
* @see ConfigurationState
* @return Returns a reference to this object so that method calls can be chained together.
* @see ConfigurationState
*/
Builder state(String state);
/**
*
*
* The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
*
*
* @param state
*
* The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
*
* @see ConfigurationState
* @return Returns a reference to this object so that method calls can be chained together.
* @see ConfigurationState
*/
Builder state(ConfigurationState state);
}
static final class BuilderImpl implements Builder {
private String arn;
private Instant creationTime;
private String description;
private List kafkaVersions = DefaultSdkAutoConstructList.getInstance();
private ConfigurationRevision latestRevision;
private String name;
private String state;
private BuilderImpl() {
}
private BuilderImpl(Configuration model) {
arn(model.arn);
creationTime(model.creationTime);
description(model.description);
kafkaVersions(model.kafkaVersions);
latestRevision(model.latestRevision);
name(model.name);
state(model.state);
}
public final String getArn() {
return arn;
}
public final void setArn(String arn) {
this.arn = arn;
}
@Override
public final Builder arn(String arn) {
this.arn = arn;
return this;
}
public final Instant getCreationTime() {
return creationTime;
}
public final void setCreationTime(Instant creationTime) {
this.creationTime = creationTime;
}
@Override
public final Builder creationTime(Instant creationTime) {
this.creationTime = creationTime;
return this;
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final Collection getKafkaVersions() {
if (kafkaVersions instanceof SdkAutoConstructList) {
return null;
}
return kafkaVersions;
}
public final void setKafkaVersions(Collection kafkaVersions) {
this.kafkaVersions = ___listOf__stringCopier.copy(kafkaVersions);
}
@Override
public final Builder kafkaVersions(Collection kafkaVersions) {
this.kafkaVersions = ___listOf__stringCopier.copy(kafkaVersions);
return this;
}
@Override
@SafeVarargs
public final Builder kafkaVersions(String... kafkaVersions) {
kafkaVersions(Arrays.asList(kafkaVersions));
return this;
}
public final ConfigurationRevision.Builder getLatestRevision() {
return latestRevision != null ? latestRevision.toBuilder() : null;
}
public final void setLatestRevision(ConfigurationRevision.BuilderImpl latestRevision) {
this.latestRevision = latestRevision != null ? latestRevision.build() : null;
}
@Override
public final Builder latestRevision(ConfigurationRevision latestRevision) {
this.latestRevision = latestRevision;
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getState() {
return state;
}
public final void setState(String state) {
this.state = state;
}
@Override
public final Builder state(String state) {
this.state = state;
return this;
}
@Override
public final Builder state(ConfigurationState state) {
this.state(state == null ? null : state.toString());
return this;
}
@Override
public Configuration build() {
return new Configuration(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}