software.amazon.awssdk.services.kinesis.model.SubscribeToShardRequest 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.util.Arrays;
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.awscore.AwsRequestOverrideConfiguration;
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.LocationTrait;
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 SubscribeToShardRequest extends KinesisRequest implements
ToCopyableBuilder {
private static final SdkField CONSUMER_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ConsumerARN").getter(getter(SubscribeToShardRequest::consumerARN)).setter(setter(Builder::consumerARN))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ConsumerARN").build()).build();
private static final SdkField SHARD_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ShardId").getter(getter(SubscribeToShardRequest::shardId)).setter(setter(Builder::shardId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ShardId").build()).build();
private static final SdkField STARTING_POSITION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("StartingPosition")
.getter(getter(SubscribeToShardRequest::startingPosition)).setter(setter(Builder::startingPosition))
.constructor(StartingPosition::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StartingPosition").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CONSUMER_ARN_FIELD,
SHARD_ID_FIELD, STARTING_POSITION_FIELD));
private final String consumerARN;
private final String shardId;
private final StartingPosition startingPosition;
private SubscribeToShardRequest(BuilderImpl builder) {
super(builder);
this.consumerARN = builder.consumerARN;
this.shardId = builder.shardId;
this.startingPosition = builder.startingPosition;
}
/**
*
* For this parameter, use the value you obtained when you called RegisterStreamConsumer.
*
*
* @return For this parameter, use the value you obtained when you called RegisterStreamConsumer.
*/
public final String consumerARN() {
return consumerARN;
}
/**
*
* The ID of the shard you want to subscribe to. To see a list of all the shards for a given stream, use
* ListShards.
*
*
* @return The ID of the shard you want to subscribe to. To see a list of all the shards for a given stream, use
* ListShards.
*/
public final String shardId() {
return shardId;
}
/**
*
* The starting position in the data stream from which to start streaming.
*
*
* @return The starting position in the data stream from which to start streaming.
*/
public final StartingPosition startingPosition() {
return startingPosition;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(consumerARN());
hashCode = 31 * hashCode + Objects.hashCode(shardId());
hashCode = 31 * hashCode + Objects.hashCode(startingPosition());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof SubscribeToShardRequest)) {
return false;
}
SubscribeToShardRequest other = (SubscribeToShardRequest) obj;
return Objects.equals(consumerARN(), other.consumerARN()) && Objects.equals(shardId(), other.shardId())
&& Objects.equals(startingPosition(), other.startingPosition());
}
/**
* 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("SubscribeToShardRequest").add("ConsumerARN", consumerARN()).add("ShardId", shardId())
.add("StartingPosition", startingPosition()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ConsumerARN":
return Optional.ofNullable(clazz.cast(consumerARN()));
case "ShardId":
return Optional.ofNullable(clazz.cast(shardId()));
case "StartingPosition":
return Optional.ofNullable(clazz.cast(startingPosition()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SubscribeToShardRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends KinesisRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* For this parameter, use the value you obtained when you called RegisterStreamConsumer.
*
*
* @param consumerARN
* For this parameter, use the value you obtained when you called RegisterStreamConsumer.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder consumerARN(String consumerARN);
/**
*
* The ID of the shard you want to subscribe to. To see a list of all the shards for a given stream, use
* ListShards.
*
*
* @param shardId
* The ID of the shard you want to subscribe to. To see a list of all the shards for a given stream, use
* ListShards.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder shardId(String shardId);
/**
*
* The starting position in the data stream from which to start streaming.
*
*
* @param startingPosition
* The starting position in the data stream from which to start streaming.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder startingPosition(StartingPosition startingPosition);
/**
*
* The starting position in the data stream from which to start streaming.
*
* This is a convenience method that creates an instance of the {@link StartingPosition.Builder} avoiding the
* need to create one manually via {@link StartingPosition#builder()}.
*
*
* When the {@link Consumer} completes, {@link StartingPosition.Builder#build()} is called immediately and its
* result is passed to {@link #startingPosition(StartingPosition)}.
*
* @param startingPosition
* a consumer that will call methods on {@link StartingPosition.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #startingPosition(StartingPosition)
*/
default Builder startingPosition(Consumer startingPosition) {
return startingPosition(StartingPosition.builder().applyMutation(startingPosition).build());
}
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends KinesisRequest.BuilderImpl implements Builder {
private String consumerARN;
private String shardId;
private StartingPosition startingPosition;
private BuilderImpl() {
}
private BuilderImpl(SubscribeToShardRequest model) {
super(model);
consumerARN(model.consumerARN);
shardId(model.shardId);
startingPosition(model.startingPosition);
}
public final String getConsumerARN() {
return consumerARN;
}
public final void setConsumerARN(String consumerARN) {
this.consumerARN = consumerARN;
}
@Override
public final Builder consumerARN(String consumerARN) {
this.consumerARN = consumerARN;
return this;
}
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 StartingPosition.Builder getStartingPosition() {
return startingPosition != null ? startingPosition.toBuilder() : null;
}
public final void setStartingPosition(StartingPosition.BuilderImpl startingPosition) {
this.startingPosition = startingPosition != null ? startingPosition.build() : null;
}
@Override
public final Builder startingPosition(StartingPosition startingPosition) {
this.startingPosition = startingPosition;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public SubscribeToShardRequest build() {
return new SubscribeToShardRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}