com.amazonaws.services.kinesis.model.ListStreamConsumersRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kinesis Show documentation
/*
* 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.kinesis.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ListStreamConsumersRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The ARN of the Kinesis data stream for which you want to list the registered consumers. For more information, see
*
* Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
*
*/
private String streamARN;
/**
*
* 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 consumers that are registered with the data stream, 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.
*
*
* Don't specify StreamName or StreamCreationTimestamp if you specify
* NextToken because the latter unambiguously identifies the stream.
*
*
* You can optionally specify a value for the MaxResults parameter when you specify
* NextToken. If you specify a MaxResults value that is less than the number of consumers
* that the operation returns if you don't specify MaxResults, the response will contain a new
* NextToken value. You can use the new NextToken value in a subsequent call to the
* ListStreamConsumers operation to list the next set of consumers.
*
*
*
* 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.
*
*
*/
private String nextToken;
/**
*
* The maximum number of consumers that you want a single call of ListStreamConsumers to return. The
* default value is 100. If you specify a value greater than 100, at most 100 results are returned.
*
*/
private Integer maxResults;
/**
*
* Specify this input parameter to distinguish data streams that have the same name. For example, if you create a
* data stream and then delete it, and you later create another data stream with the same name, you can use this
* input parameter to specify which of the two streams you want to list the consumers for.
*
*
* You can't specify this parameter if you specify the NextToken parameter.
*
*/
private java.util.Date streamCreationTimestamp;
/**
*
* The ARN of the Kinesis data stream for which you want to list the registered consumers. For more information, see
*
* Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
*
*
* @param streamARN
* The ARN of the Kinesis data stream for which you want to list the registered consumers. For more
* information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
*/
public void setStreamARN(String streamARN) {
this.streamARN = streamARN;
}
/**
*
* The ARN of the Kinesis data stream for which you want to list the registered consumers. For more information, see
*
* Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
*
*
* @return The ARN of the Kinesis data stream for which you want to list the registered consumers. For more
* information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
*/
public String getStreamARN() {
return this.streamARN;
}
/**
*
* The ARN of the Kinesis data stream for which you want to list the registered consumers. For more information, see
*
* Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
*
*
* @param streamARN
* The ARN of the Kinesis data stream for which you want to list the registered consumers. For more
* information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListStreamConsumersRequest withStreamARN(String streamARN) {
setStreamARN(streamARN);
return this;
}
/**
*
* 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 consumers that are registered with the data stream, 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.
*
*
* Don't specify StreamName or StreamCreationTimestamp if you specify
* NextToken because the latter unambiguously identifies the stream.
*
*
* You can optionally specify a value for the MaxResults parameter when you specify
* NextToken. If you specify a MaxResults value that is less than the number of consumers
* that the operation returns if you don't specify MaxResults, the response will contain a new
* NextToken value. You can use the new NextToken value in a subsequent call to the
* ListStreamConsumers operation to list the next set of consumers.
*
*
*
* 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 consumers that are registered with the data
* stream, 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.
*
* Don't specify StreamName or StreamCreationTimestamp if you specify
* NextToken because the latter unambiguously identifies the stream.
*
*
* You can optionally specify a value for the MaxResults parameter when you specify
* NextToken. If you specify a MaxResults value that is less than the number of
* consumers that the operation returns if you don't specify MaxResults, the response will
* contain a new NextToken value. You can use the new NextToken value in a
* subsequent call to the ListStreamConsumers operation to list the next set of consumers.
*
*
*
* 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 void setNextToken(String nextToken) {
this.nextToken = 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 consumers that are registered with the data stream, 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.
*
*
* Don't specify StreamName or StreamCreationTimestamp if you specify
* NextToken because the latter unambiguously identifies the stream.
*
*
* You can optionally specify a value for the MaxResults parameter when you specify
* NextToken. If you specify a MaxResults value that is less than the number of consumers
* that the operation returns if you don't specify MaxResults, the response will contain a new
* NextToken value. You can use the new NextToken value in a subsequent call to the
* ListStreamConsumers operation to list the next set of consumers.
*
*
*
* 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 consumers that are registered with the data
* stream, 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.
*
* Don't specify StreamName or StreamCreationTimestamp if you specify
* NextToken because the latter unambiguously identifies the stream.
*
*
* You can optionally specify a value for the MaxResults parameter when you specify
* NextToken. If you specify a MaxResults value that is less than the number of
* consumers that the operation returns if you don't specify MaxResults, the response will
* contain a new NextToken value. You can use the new NextToken value in a
* subsequent call to the ListStreamConsumers operation to list the next set of consumers.
*
*
*
* 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 getNextToken() {
return this.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 consumers that are registered with the data stream, 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.
*
*
* Don't specify StreamName or StreamCreationTimestamp if you specify
* NextToken because the latter unambiguously identifies the stream.
*
*
* You can optionally specify a value for the MaxResults parameter when you specify
* NextToken. If you specify a MaxResults value that is less than the number of consumers
* that the operation returns if you don't specify MaxResults, the response will contain a new
* NextToken value. You can use the new NextToken value in a subsequent call to the
* ListStreamConsumers operation to list the next set of consumers.
*
*
*
* 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 consumers that are registered with the data
* stream, 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.
*
* Don't specify StreamName or StreamCreationTimestamp if you specify
* NextToken because the latter unambiguously identifies the stream.
*
*
* You can optionally specify a value for the MaxResults parameter when you specify
* NextToken. If you specify a MaxResults value that is less than the number of
* consumers that the operation returns if you don't specify MaxResults, the response will
* contain a new NextToken value. You can use the new NextToken value in a
* subsequent call to the ListStreamConsumers operation to list the next set of consumers.
*
*
*
* 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.
*/
public ListStreamConsumersRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of consumers that you want a single call of ListStreamConsumers to return. The
* default value is 100. If you specify a value greater than 100, at most 100 results are returned.
*
*
* @param maxResults
* The maximum number of consumers that you want a single call of ListStreamConsumers to return.
* The default value is 100. If you specify a value greater than 100, at most 100 results are returned.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of consumers that you want a single call of ListStreamConsumers to return. The
* default value is 100. If you specify a value greater than 100, at most 100 results are returned.
*
*
* @return The maximum number of consumers that you want a single call of ListStreamConsumers to
* return. The default value is 100. If you specify a value greater than 100, at most 100 results are
* returned.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of consumers that you want a single call of ListStreamConsumers to return. The
* default value is 100. If you specify a value greater than 100, at most 100 results are returned.
*
*
* @param maxResults
* The maximum number of consumers that you want a single call of ListStreamConsumers to return.
* The default value is 100. If you specify a value greater than 100, at most 100 results are returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListStreamConsumersRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* Specify this input parameter to distinguish data streams that have the same name. For example, if you create a
* data stream and then delete it, and you later create another data stream with the same name, you can use this
* input parameter to specify which of the two streams you want to list the consumers for.
*
*
* You can't specify this parameter if you specify the NextToken parameter.
*
*
* @param streamCreationTimestamp
* Specify this input parameter to distinguish data streams that have the same name. For example, if you
* create a data stream and then delete it, and you later create another data stream with the same name, you
* can use this input parameter to specify which of the two streams you want to list the consumers for.
*
* You can't specify this parameter if you specify the NextToken parameter.
*/
public void setStreamCreationTimestamp(java.util.Date streamCreationTimestamp) {
this.streamCreationTimestamp = streamCreationTimestamp;
}
/**
*
* Specify this input parameter to distinguish data streams that have the same name. For example, if you create a
* data stream and then delete it, and you later create another data stream with the same name, you can use this
* input parameter to specify which of the two streams you want to list the consumers for.
*
*
* You can't specify this parameter if you specify the NextToken parameter.
*
*
* @return Specify this input parameter to distinguish data streams that have the same name. For example, if you
* create a data stream and then delete it, and you later create another data stream with the same name, you
* can use this input parameter to specify which of the two streams you want to list the consumers for.
*
* You can't specify this parameter if you specify the NextToken parameter.
*/
public java.util.Date getStreamCreationTimestamp() {
return this.streamCreationTimestamp;
}
/**
*
* Specify this input parameter to distinguish data streams that have the same name. For example, if you create a
* data stream and then delete it, and you later create another data stream with the same name, you can use this
* input parameter to specify which of the two streams you want to list the consumers for.
*
*
* You can't specify this parameter if you specify the NextToken parameter.
*
*
* @param streamCreationTimestamp
* Specify this input parameter to distinguish data streams that have the same name. For example, if you
* create a data stream and then delete it, and you later create another data stream with the same name, you
* can use this input parameter to specify which of the two streams you want to list the consumers for.
*
* You can't specify this parameter if you specify the NextToken parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListStreamConsumersRequest withStreamCreationTimestamp(java.util.Date streamCreationTimestamp) {
setStreamCreationTimestamp(streamCreationTimestamp);
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 (getStreamARN() != null)
sb.append("StreamARN: ").append(getStreamARN()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getStreamCreationTimestamp() != null)
sb.append("StreamCreationTimestamp: ").append(getStreamCreationTimestamp());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListStreamConsumersRequest == false)
return false;
ListStreamConsumersRequest other = (ListStreamConsumersRequest) obj;
if (other.getStreamARN() == null ^ this.getStreamARN() == null)
return false;
if (other.getStreamARN() != null && other.getStreamARN().equals(this.getStreamARN()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getStreamCreationTimestamp() == null ^ this.getStreamCreationTimestamp() == null)
return false;
if (other.getStreamCreationTimestamp() != null && other.getStreamCreationTimestamp().equals(this.getStreamCreationTimestamp()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getStreamARN() == null) ? 0 : getStreamARN().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getStreamCreationTimestamp() == null) ? 0 : getStreamCreationTimestamp().hashCode());
return hashCode;
}
@Override
public ListStreamConsumersRequest clone() {
return (ListStreamConsumersRequest) super.clone();
}
}