software.amazon.awssdk.services.kinesis.model.ListStreamConsumersResponse 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.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 ListStreamConsumersResponse extends KinesisResponse implements
ToCopyableBuilder {
private final List consumers;
private final String nextToken;
private ListStreamConsumersResponse(BuilderImpl builder) {
super(builder);
this.consumers = builder.consumers;
this.nextToken = builder.nextToken;
}
/**
*
* An array of JSON objects. Each object represents one registered consumer.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return An array of JSON objects. Each object represents one registered consumer.
*/
public List consumers() {
return consumers;
}
/**
*
* When the number of consumers that are registered with 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 registered consumers, the response includes a pagination token named NextToken.
* You can specify this NextToken value in a subsequent call to ListStreamConsumers to
* list the next set of registered consumers. For more information about the use of this pagination token when
* calling the ListStreamConsumers operation, see ListStreamConsumersInput$NextToken.
*
*
*
* Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to
* ListStreamConsumers, you have 300 seconds to use that value. If you specify an expired token in a
* call to ListStreamConsumers, you get ExpiredNextTokenException.
*
*
*
* @return When the number of consumers that are registered with 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 registered consumers, the response includes a
* pagination token named NextToken. You can specify this NextToken value in a
* subsequent call to ListStreamConsumers to list the next set of registered consumers. For
* more information about the use of this pagination token when calling the ListStreamConsumers
* operation, see ListStreamConsumersInput$NextToken.
*
* Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a
* call to ListStreamConsumers, you have 300 seconds to use that value. If you specify an
* expired token in a call to ListStreamConsumers, 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(consumers());
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 ListStreamConsumersResponse)) {
return false;
}
ListStreamConsumersResponse other = (ListStreamConsumersResponse) obj;
return Objects.equals(consumers(), other.consumers()) && Objects.equals(nextToken(), other.nextToken());
}
@Override
public String toString() {
return ToString.builder("ListStreamConsumersResponse").add("Consumers", consumers()).add("NextToken", nextToken())
.build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Consumers":
return Optional.ofNullable(clazz.cast(consumers()));
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 registered consumer.
*
*
* @param consumers
* An array of JSON objects. Each object represents one registered consumer.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder consumers(Collection consumers);
/**
*
* An array of JSON objects. Each object represents one registered consumer.
*
*
* @param consumers
* An array of JSON objects. Each object represents one registered consumer.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder consumers(Consumer... consumers);
/**
*
* An array of JSON objects. Each object represents one registered consumer.
*
* 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 #consumers(List)}.
*
* @param consumers
* 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 #consumers(List)
*/
Builder consumers(java.util.function.Consumer... consumers);
/**
*
* When the number of consumers that are registered with 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 registered consumers, the response includes a pagination token named
* NextToken. You can specify this NextToken value in a subsequent call to
* ListStreamConsumers to list the next set of registered consumers. For more information about the
* use of this pagination token when calling the ListStreamConsumers operation, see
* ListStreamConsumersInput$NextToken.
*
*
*
* Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call
* to ListStreamConsumers, you have 300 seconds to use that value. If you specify an expired token
* in a call to ListStreamConsumers, you get ExpiredNextTokenException.
*
*
*
* @param nextToken
* When the number of consumers that are registered with 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 registered consumers, the response includes a
* pagination token named NextToken. You can specify this NextToken value in a
* subsequent call to ListStreamConsumers to list the next set of registered consumers. For
* more information about the use of this pagination token when calling the
* ListStreamConsumers operation, see ListStreamConsumersInput$NextToken.
*
*
* Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to
* a call to ListStreamConsumers, you have 300 seconds to use that value. If you specify an
* expired token in a call to ListStreamConsumers, 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 consumers = DefaultSdkAutoConstructList.getInstance();
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(ListStreamConsumersResponse model) {
super(model);
consumers(model.consumers);
nextToken(model.nextToken);
}
public final Collection getConsumers() {
return consumers != null ? consumers.stream().map(Consumer::toBuilder).collect(Collectors.toList()) : null;
}
@Override
public final Builder consumers(Collection consumers) {
this.consumers = ConsumerListCopier.copy(consumers);
return this;
}
@Override
@SafeVarargs
public final Builder consumers(Consumer... consumers) {
consumers(Arrays.asList(consumers));
return this;
}
@Override
@SafeVarargs
public final Builder consumers(java.util.function.Consumer... consumers) {
consumers(Stream.of(consumers).map(c -> Consumer.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final void setConsumers(Collection consumers) {
this.consumers = ConsumerListCopier.copyFromBuilder(consumers);
}
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 ListStreamConsumersResponse build() {
return new ListStreamConsumersResponse(this);
}
}
}