software.amazon.awssdk.services.nimble.model.StopStreamingSessionRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of nimble Show documentation
Show all versions of nimble Show documentation
The AWS Java SDK for Nimble module holds the client classes that are used for
communicating with Nimble.
/*
* 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.nimble.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.DefaultValueTrait;
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 StopStreamingSessionRequest extends NimbleRequest implements
ToCopyableBuilder {
private static final SdkField CLIENT_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("clientToken")
.getter(getter(StopStreamingSessionRequest::clientToken))
.setter(setter(Builder::clientToken))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("X-Amz-Client-Token").build(),
DefaultValueTrait.idempotencyToken()).build();
private static final SdkField SESSION_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("sessionId").getter(getter(StopStreamingSessionRequest::sessionId)).setter(setter(Builder::sessionId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("sessionId").build()).build();
private static final SdkField STUDIO_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("studioId").getter(getter(StopStreamingSessionRequest::studioId)).setter(setter(Builder::studioId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("studioId").build()).build();
private static final SdkField VOLUME_RETENTION_MODE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("volumeRetentionMode").getter(getter(StopStreamingSessionRequest::volumeRetentionModeAsString))
.setter(setter(Builder::volumeRetentionMode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("volumeRetentionMode").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CLIENT_TOKEN_FIELD,
SESSION_ID_FIELD, STUDIO_ID_FIELD, VOLUME_RETENTION_MODE_FIELD));
private final String clientToken;
private final String sessionId;
private final String studioId;
private final String volumeRetentionMode;
private StopStreamingSessionRequest(BuilderImpl builder) {
super(builder);
this.clientToken = builder.clientToken;
this.sessionId = builder.sessionId;
this.studioId = builder.studioId;
this.volumeRetentionMode = builder.volumeRetentionMode;
}
/**
*
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify
* a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to
* ensure idempotency.
*
*
* @return Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t
* specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it
* for the request to ensure idempotency.
*/
public final String clientToken() {
return clientToken;
}
/**
*
* The streaming session ID for the StopStreamingSessionRequest.
*
*
* @return The streaming session ID for the StopStreamingSessionRequest.
*/
public final String sessionId() {
return sessionId;
}
/**
*
* The studioId for the StopStreamingSessionRequest.
*
*
* @return The studioId for the StopStreamingSessionRequest.
*/
public final String studioId() {
return studioId;
}
/**
*
* Adds additional instructions to a streaming session stop action to either retain the EBS volumes or delete the
* EBS volumes.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #volumeRetentionMode} will return {@link VolumeRetentionMode#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #volumeRetentionModeAsString}.
*
*
* @return Adds additional instructions to a streaming session stop action to either retain the EBS volumes or
* delete the EBS volumes.
* @see VolumeRetentionMode
*/
public final VolumeRetentionMode volumeRetentionMode() {
return VolumeRetentionMode.fromValue(volumeRetentionMode);
}
/**
*
* Adds additional instructions to a streaming session stop action to either retain the EBS volumes or delete the
* EBS volumes.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #volumeRetentionMode} will return {@link VolumeRetentionMode#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #volumeRetentionModeAsString}.
*
*
* @return Adds additional instructions to a streaming session stop action to either retain the EBS volumes or
* delete the EBS volumes.
* @see VolumeRetentionMode
*/
public final String volumeRetentionModeAsString() {
return volumeRetentionMode;
}
@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(clientToken());
hashCode = 31 * hashCode + Objects.hashCode(sessionId());
hashCode = 31 * hashCode + Objects.hashCode(studioId());
hashCode = 31 * hashCode + Objects.hashCode(volumeRetentionModeAsString());
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 StopStreamingSessionRequest)) {
return false;
}
StopStreamingSessionRequest other = (StopStreamingSessionRequest) obj;
return Objects.equals(clientToken(), other.clientToken()) && Objects.equals(sessionId(), other.sessionId())
&& Objects.equals(studioId(), other.studioId())
&& Objects.equals(volumeRetentionModeAsString(), other.volumeRetentionModeAsString());
}
/**
* 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("StopStreamingSessionRequest").add("ClientToken", clientToken()).add("SessionId", sessionId())
.add("StudioId", studioId()).add("VolumeRetentionMode", volumeRetentionModeAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "clientToken":
return Optional.ofNullable(clazz.cast(clientToken()));
case "sessionId":
return Optional.ofNullable(clazz.cast(sessionId()));
case "studioId":
return Optional.ofNullable(clazz.cast(studioId()));
case "volumeRetentionMode":
return Optional.ofNullable(clazz.cast(volumeRetentionModeAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((StopStreamingSessionRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends NimbleRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t
* specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for
* the request to ensure idempotency.
*
*
* @param clientToken
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you
* don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and
* uses it for the request to ensure idempotency.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clientToken(String clientToken);
/**
*
* The streaming session ID for the StopStreamingSessionRequest.
*
*
* @param sessionId
* The streaming session ID for the StopStreamingSessionRequest.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sessionId(String sessionId);
/**
*
* The studioId for the StopStreamingSessionRequest.
*
*
* @param studioId
* The studioId for the StopStreamingSessionRequest.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder studioId(String studioId);
/**
*
* Adds additional instructions to a streaming session stop action to either retain the EBS volumes or delete
* the EBS volumes.
*
*
* @param volumeRetentionMode
* Adds additional instructions to a streaming session stop action to either retain the EBS volumes or
* delete the EBS volumes.
* @see VolumeRetentionMode
* @return Returns a reference to this object so that method calls can be chained together.
* @see VolumeRetentionMode
*/
Builder volumeRetentionMode(String volumeRetentionMode);
/**
*
* Adds additional instructions to a streaming session stop action to either retain the EBS volumes or delete
* the EBS volumes.
*
*
* @param volumeRetentionMode
* Adds additional instructions to a streaming session stop action to either retain the EBS volumes or
* delete the EBS volumes.
* @see VolumeRetentionMode
* @return Returns a reference to this object so that method calls can be chained together.
* @see VolumeRetentionMode
*/
Builder volumeRetentionMode(VolumeRetentionMode volumeRetentionMode);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends NimbleRequest.BuilderImpl implements Builder {
private String clientToken;
private String sessionId;
private String studioId;
private String volumeRetentionMode;
private BuilderImpl() {
}
private BuilderImpl(StopStreamingSessionRequest model) {
super(model);
clientToken(model.clientToken);
sessionId(model.sessionId);
studioId(model.studioId);
volumeRetentionMode(model.volumeRetentionMode);
}
public final String getClientToken() {
return clientToken;
}
public final void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
@Override
public final Builder clientToken(String clientToken) {
this.clientToken = clientToken;
return this;
}
public final String getSessionId() {
return sessionId;
}
public final void setSessionId(String sessionId) {
this.sessionId = sessionId;
}
@Override
public final Builder sessionId(String sessionId) {
this.sessionId = sessionId;
return this;
}
public final String getStudioId() {
return studioId;
}
public final void setStudioId(String studioId) {
this.studioId = studioId;
}
@Override
public final Builder studioId(String studioId) {
this.studioId = studioId;
return this;
}
public final String getVolumeRetentionMode() {
return volumeRetentionMode;
}
public final void setVolumeRetentionMode(String volumeRetentionMode) {
this.volumeRetentionMode = volumeRetentionMode;
}
@Override
public final Builder volumeRetentionMode(String volumeRetentionMode) {
this.volumeRetentionMode = volumeRetentionMode;
return this;
}
@Override
public final Builder volumeRetentionMode(VolumeRetentionMode volumeRetentionMode) {
this.volumeRetentionMode(volumeRetentionMode == null ? null : volumeRetentionMode.toString());
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 StopStreamingSessionRequest build() {
return new StopStreamingSessionRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}