software.amazon.awssdk.services.kinesis.model.ListShardsResponse Maven / Gradle / Ivy
/*
* Copyright 2013-2018 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.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.Consumer;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class ListShardsResponse extends KinesisResponse implements
ToCopyableBuilder {
private final List shards;
private final String nextToken;
private ListShardsResponse(BuilderImpl builder) {
super(builder);
this.shards = builder.shards;
this.nextToken = builder.nextToken;
}
/**
*
* An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's
* parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending
* hash keys and the starting and ending sequence numbers for the shard.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the
* shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the
* starting and ending hash keys and the starting and ending sequence numbers for the shard.
*/
public List shards() {
return shards;
}
/**
*
* When the number of shards in the data stream is greater than the default value for the MaxResults
* parameter, or if you explicitly specify a value for MaxResults that is less than the number of
* shards in the data stream, the response includes a pagination token named NextToken. You can specify
* this NextToken value in a subsequent call to ListShards to list the next set of shards.
* For more information about the use of this pagination token when calling the ListShards operation,
* see ListShardsInput$NextToken.
*
*
*
* Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to
* ListShards, you have 300 seconds to use that value. If you specify an expired token in a call to
* ListShards, you get ExpiredNextTokenException.
*
*
*
* @return When the number of shards in the data stream is greater than the default value for the
* MaxResults parameter, or if you explicitly specify a value for MaxResults that
* is less than the number of shards in the data stream, the response includes a pagination token named
* NextToken. You can specify this NextToken value in a subsequent call to
* ListShards to list the next set of shards. For more information about the use of this
* pagination token when calling the ListShards operation, see
* ListShardsInput$NextToken.
*
* Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a
* call to ListShards, you have 300 seconds to use that value. If you specify an expired token
* in a call to ListShards, you get ExpiredNextTokenException.
*
*/
public String nextToken() {
return nextToken;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(shards());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ListShardsResponse)) {
return false;
}
ListShardsResponse other = (ListShardsResponse) obj;
return Objects.equals(shards(), other.shards()) && Objects.equals(nextToken(), other.nextToken());
}
@Override
public String toString() {
return ToString.builder("ListShardsResponse").add("Shards", shards()).add("NextToken", nextToken()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Shards":
return Optional.ofNullable(clazz.cast(shards()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
default:
return Optional.empty();
}
}
public interface Builder extends KinesisResponse.Builder, CopyableBuilder {
/**
*
* An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's
* parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and
* ending hash keys and the starting and ending sequence numbers for the shard.
*
*
* @param shards
* An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the
* shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the
* starting and ending hash keys and the starting and ending sequence numbers for the shard.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder shards(Collection shards);
/**
*
* An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's
* parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and
* ending hash keys and the starting and ending sequence numbers for the shard.
*
*
* @param shards
* An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the
* shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the
* starting and ending hash keys and the starting and ending sequence numbers for the shard.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder shards(Shard... shards);
/**
*
* An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's
* parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and
* ending hash keys and the starting and ending sequence numbers for the shard.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create
* one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result
* is passed to {@link #shards(List)}.
*
* @param shards
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #shards(List)
*/
Builder shards(Consumer... shards);
/**
*
* When the number of shards in the data stream is greater than the default value for the
* MaxResults parameter, or if you explicitly specify a value for MaxResults that is
* less than the number of shards in the data stream, the response includes a pagination token named
* NextToken. You can specify this NextToken value in a subsequent call to
* ListShards to list the next set of shards. For more information about the use of this pagination
* token when calling the ListShards operation, see ListShardsInput$NextToken.
*
*
*
* Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call
* to ListShards, you have 300 seconds to use that value. If you specify an expired token in a call
* to ListShards, you get ExpiredNextTokenException.
*
*
*
* @param nextToken
* When the number of shards in the data stream is greater than the default value for the
* MaxResults parameter, or if you explicitly specify a value for MaxResults
* that is less than the number of shards in the data stream, the response includes a pagination token
* named NextToken. You can specify this NextToken value in a subsequent call
* to ListShards to list the next set of shards. For more information about the use of this
* pagination token when calling the ListShards operation, see
* ListShardsInput$NextToken.
*
* Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to
* a call to ListShards, you have 300 seconds to use that value. If you specify an expired
* token in a call to ListShards, you get ExpiredNextTokenException.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
}
static final class BuilderImpl extends KinesisResponse.BuilderImpl implements Builder {
private List shards = DefaultSdkAutoConstructList.getInstance();
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(ListShardsResponse model) {
super(model);
shards(model.shards);
nextToken(model.nextToken);
}
public final Collection getShards() {
return shards != null ? shards.stream().map(Shard::toBuilder).collect(Collectors.toList()) : null;
}
@Override
public final Builder shards(Collection shards) {
this.shards = ShardListCopier.copy(shards);
return this;
}
@Override
@SafeVarargs
public final Builder shards(Shard... shards) {
shards(Arrays.asList(shards));
return this;
}
@Override
@SafeVarargs
public final Builder shards(Consumer... shards) {
shards(Stream.of(shards).map(c -> Shard.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final void setShards(Collection shards) {
this.shards = ShardListCopier.copyFromBuilder(shards);
}
public final String getNextToken() {
return nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public ListShardsResponse build() {
return new ListShardsResponse(this);
}
}
}