com.amazonaws.services.kinesis.model.DeregisterStreamConsumerRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kinesis Show documentation
/*
* Copyright 2014-2019 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 DeregisterStreamConsumerRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
*
*/
private String streamARN;
/**
*
* The name that you gave to the consumer.
*
*/
private String consumerName;
/**
*
* The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the
* consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the
* descriptions of all the consumers that are currently registered with a given data stream. The description of a
* consumer contains its ARN.
*
*/
private String consumerARN;
/**
*
* The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
*
*
* @param streamARN
* The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
*/
public void setStreamARN(String streamARN) {
this.streamARN = streamARN;
}
/**
*
* The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
*
*
* @return The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
*/
public String getStreamARN() {
return this.streamARN;
}
/**
*
* The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
*
*
* @param streamARN
* The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeregisterStreamConsumerRequest withStreamARN(String streamARN) {
setStreamARN(streamARN);
return this;
}
/**
*
* The name that you gave to the consumer.
*
*
* @param consumerName
* The name that you gave to the consumer.
*/
public void setConsumerName(String consumerName) {
this.consumerName = consumerName;
}
/**
*
* The name that you gave to the consumer.
*
*
* @return The name that you gave to the consumer.
*/
public String getConsumerName() {
return this.consumerName;
}
/**
*
* The name that you gave to the consumer.
*
*
* @param consumerName
* The name that you gave to the consumer.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeregisterStreamConsumerRequest withConsumerName(String consumerName) {
setConsumerName(consumerName);
return this;
}
/**
*
* The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the
* consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the
* descriptions of all the consumers that are currently registered with a given data stream. The description of a
* consumer contains its ARN.
*
*
* @param consumerARN
* The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of
* the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of
* the descriptions of all the consumers that are currently registered with a given data stream. The
* description of a consumer contains its ARN.
*/
public void setConsumerARN(String consumerARN) {
this.consumerARN = consumerARN;
}
/**
*
* The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the
* consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the
* descriptions of all the consumers that are currently registered with a given data stream. The description of a
* consumer contains its ARN.
*
*
* @return The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of
* the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of
* the descriptions of all the consumers that are currently registered with a given data stream. The
* description of a consumer contains its ARN.
*/
public String getConsumerARN() {
return this.consumerARN;
}
/**
*
* The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the
* consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the
* descriptions of all the consumers that are currently registered with a given data stream. The description of a
* consumer contains its ARN.
*
*
* @param consumerARN
* The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of
* the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of
* the descriptions of all the consumers that are currently registered with a given data stream. The
* description of a consumer contains its ARN.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeregisterStreamConsumerRequest withConsumerARN(String consumerARN) {
setConsumerARN(consumerARN);
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 (getConsumerName() != null)
sb.append("ConsumerName: ").append(getConsumerName()).append(",");
if (getConsumerARN() != null)
sb.append("ConsumerARN: ").append(getConsumerARN());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DeregisterStreamConsumerRequest == false)
return false;
DeregisterStreamConsumerRequest other = (DeregisterStreamConsumerRequest) obj;
if (other.getStreamARN() == null ^ this.getStreamARN() == null)
return false;
if (other.getStreamARN() != null && other.getStreamARN().equals(this.getStreamARN()) == false)
return false;
if (other.getConsumerName() == null ^ this.getConsumerName() == null)
return false;
if (other.getConsumerName() != null && other.getConsumerName().equals(this.getConsumerName()) == false)
return false;
if (other.getConsumerARN() == null ^ this.getConsumerARN() == null)
return false;
if (other.getConsumerARN() != null && other.getConsumerARN().equals(this.getConsumerARN()) == 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 + ((getConsumerName() == null) ? 0 : getConsumerName().hashCode());
hashCode = prime * hashCode + ((getConsumerARN() == null) ? 0 : getConsumerARN().hashCode());
return hashCode;
}
@Override
public DeregisterStreamConsumerRequest clone() {
return (DeregisterStreamConsumerRequest) super.clone();
}
}