software.amazon.awssdk.services.kinesis.model.ChildShard Maven / Gradle / Ivy
Show all versions of kinesis 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.kinesis.model;
import java.io.Serializable;
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.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;
/**
*
* Output parameter of the GetRecords API. The existing child shard of the current shard.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ChildShard implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField SHARD_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ShardId").getter(getter(ChildShard::shardId)).setter(setter(Builder::shardId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ShardId").build()).build();
private static final SdkField> PARENT_SHARDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ParentShards")
.getter(getter(ChildShard::parentShards))
.setter(setter(Builder::parentShards))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ParentShards").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 HASH_KEY_RANGE_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("HashKeyRange").getter(getter(ChildShard::hashKeyRange)).setter(setter(Builder::hashKeyRange))
.constructor(HashKeyRange::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("HashKeyRange").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SHARD_ID_FIELD,
PARENT_SHARDS_FIELD, HASH_KEY_RANGE_FIELD));
private static final long serialVersionUID = 1L;
private final String shardId;
private final List parentShards;
private final HashKeyRange hashKeyRange;
private ChildShard(BuilderImpl builder) {
this.shardId = builder.shardId;
this.parentShards = builder.parentShards;
this.hashKeyRange = builder.hashKeyRange;
}
/**
*
* The shard ID of the existing child shard of the current shard.
*
*
* @return The shard ID of the existing child shard of the current shard.
*/
public final String shardId() {
return shardId;
}
/**
* For responses, this returns true if the service returned a value for the ParentShards 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 hasParentShards() {
return parentShards != null && !(parentShards instanceof SdkAutoConstructList);
}
/**
*
* The current shard that is the parent of the existing child shard.
*
*
* 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 #hasParentShards} method.
*
*
* @return The current shard that is the parent of the existing child shard.
*/
public final List parentShards() {
return parentShards;
}
/**
* Returns the value of the HashKeyRange property for this object.
*
* @return The value of the HashKeyRange property for this object.
*/
public final HashKeyRange hashKeyRange() {
return hashKeyRange;
}
@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(shardId());
hashCode = 31 * hashCode + Objects.hashCode(hasParentShards() ? parentShards() : null);
hashCode = 31 * hashCode + Objects.hashCode(hashKeyRange());
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 ChildShard)) {
return false;
}
ChildShard other = (ChildShard) obj;
return Objects.equals(shardId(), other.shardId()) && hasParentShards() == other.hasParentShards()
&& Objects.equals(parentShards(), other.parentShards()) && Objects.equals(hashKeyRange(), other.hashKeyRange());
}
/**
* 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("ChildShard").add("ShardId", shardId())
.add("ParentShards", hasParentShards() ? parentShards() : null).add("HashKeyRange", hashKeyRange()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ShardId":
return Optional.ofNullable(clazz.cast(shardId()));
case "ParentShards":
return Optional.ofNullable(clazz.cast(parentShards()));
case "HashKeyRange":
return Optional.ofNullable(clazz.cast(hashKeyRange()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ChildShard) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The shard ID of the existing child shard of the current shard.
*
*
* @param shardId
* The shard ID of the existing child shard of the current shard.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder shardId(String shardId);
/**
*
* The current shard that is the parent of the existing child shard.
*
*
* @param parentShards
* The current shard that is the parent of the existing child shard.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder parentShards(Collection parentShards);
/**
*
* The current shard that is the parent of the existing child shard.
*
*
* @param parentShards
* The current shard that is the parent of the existing child shard.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder parentShards(String... parentShards);
/**
* Sets the value of the HashKeyRange property for this object.
*
* @param hashKeyRange
* The new value for the HashKeyRange property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder hashKeyRange(HashKeyRange hashKeyRange);
/**
* Sets the value of the HashKeyRange property for this object.
*
* This is a convenience method that creates an instance of the {@link HashKeyRange.Builder} avoiding the need
* to create one manually via {@link HashKeyRange#builder()}.
*
*
* When the {@link Consumer} completes, {@link HashKeyRange.Builder#build()} is called immediately and its
* result is passed to {@link #hashKeyRange(HashKeyRange)}.
*
* @param hashKeyRange
* a consumer that will call methods on {@link HashKeyRange.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #hashKeyRange(HashKeyRange)
*/
default Builder hashKeyRange(Consumer hashKeyRange) {
return hashKeyRange(HashKeyRange.builder().applyMutation(hashKeyRange).build());
}
}
static final class BuilderImpl implements Builder {
private String shardId;
private List parentShards = DefaultSdkAutoConstructList.getInstance();
private HashKeyRange hashKeyRange;
private BuilderImpl() {
}
private BuilderImpl(ChildShard model) {
shardId(model.shardId);
parentShards(model.parentShards);
hashKeyRange(model.hashKeyRange);
}
public final String getShardId() {
return shardId;
}
public final void setShardId(String shardId) {
this.shardId = shardId;
}
@Override
public final Builder shardId(String shardId) {
this.shardId = shardId;
return this;
}
public final Collection getParentShards() {
if (parentShards instanceof SdkAutoConstructList) {
return null;
}
return parentShards;
}
public final void setParentShards(Collection parentShards) {
this.parentShards = ShardIdListCopier.copy(parentShards);
}
@Override
public final Builder parentShards(Collection parentShards) {
this.parentShards = ShardIdListCopier.copy(parentShards);
return this;
}
@Override
@SafeVarargs
public final Builder parentShards(String... parentShards) {
parentShards(Arrays.asList(parentShards));
return this;
}
public final HashKeyRange.Builder getHashKeyRange() {
return hashKeyRange != null ? hashKeyRange.toBuilder() : null;
}
public final void setHashKeyRange(HashKeyRange.BuilderImpl hashKeyRange) {
this.hashKeyRange = hashKeyRange != null ? hashKeyRange.build() : null;
}
@Override
public final Builder hashKeyRange(HashKeyRange hashKeyRange) {
this.hashKeyRange = hashKeyRange;
return this;
}
@Override
public ChildShard build() {
return new ChildShard(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}