software.amazon.awssdk.services.ivs.model.CreateStreamKeyRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ivs Show documentation
Show all versions of ivs Show documentation
The AWS Java SDK for Ivs module holds the client classes that are used for
communicating with Ivs.
/*
* 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.ivs.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
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.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
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 CreateStreamKeyRequest extends IvsRequest implements
ToCopyableBuilder {
private static final SdkField CHANNEL_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("channelArn").getter(getter(CreateStreamKeyRequest::channelArn)).setter(setter(Builder::channelArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("channelArn").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("tags")
.getter(getter(CreateStreamKeyRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tags").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections
.unmodifiableList(Arrays.asList(CHANNEL_ARN_FIELD, TAGS_FIELD));
private final String channelArn;
private final Map tags;
private CreateStreamKeyRequest(BuilderImpl builder) {
super(builder);
this.channelArn = builder.channelArn;
this.tags = builder.tags;
}
/**
*
* ARN of the channel for which to create the stream key.
*
*
* @return ARN of the channel for which to create the stream key.
*/
public final String channelArn() {
return channelArn;
}
/**
* For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that
* the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is useful
* because the SDK will never return a null collection or map, but you may need to differentiate between the service
* returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
* if a value for the property was specified in the request builder, and false if a value was not specified.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructMap);
}
/**
*
* Array of 1-50 maps, each of the form string:string (key:value). See Best practices and
* strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions
* that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints
* beyond what is documented there.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasTags} method.
*
*
* @return Array of 1-50 maps, each of the form string:string (key:value). See Best
* practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details,
* including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no
* service-specific constraints beyond what is documented there.
*/
public final Map tags() {
return tags;
}
@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(channelArn());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
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 CreateStreamKeyRequest)) {
return false;
}
CreateStreamKeyRequest other = (CreateStreamKeyRequest) obj;
return Objects.equals(channelArn(), other.channelArn()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags());
}
/**
* 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("CreateStreamKeyRequest").add("ChannelArn", channelArn()).add("Tags", hasTags() ? tags() : null)
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "channelArn":
return Optional.ofNullable(clazz.cast(channelArn()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateStreamKeyRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends IvsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* ARN of the channel for which to create the stream key.
*
*
* @param channelArn
* ARN of the channel for which to create the stream key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder channelArn(String channelArn);
/**
*
* Array of 1-50 maps, each of the form string:string (key:value). See Best practices
* and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including
* restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific
* constraints beyond what is documented there.
*
*
* @param tags
* Array of 1-50 maps, each of the form string:string (key:value). See Best
* practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for
* details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon
* IVS has no service-specific constraints beyond what is documented there.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends IvsRequest.BuilderImpl implements Builder {
private String channelArn;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateStreamKeyRequest model) {
super(model);
channelArn(model.channelArn);
tags(model.tags);
}
public final String getChannelArn() {
return channelArn;
}
public final void setChannelArn(String channelArn) {
this.channelArn = channelArn;
}
@Override
public final Builder channelArn(String channelArn) {
this.channelArn = channelArn;
return this;
}
public final Map getTags() {
if (tags instanceof SdkAutoConstructMap) {
return null;
}
return tags;
}
public final void setTags(Map tags) {
this.tags = TagsCopier.copy(tags);
}
@Override
public final Builder tags(Map tags) {
this.tags = TagsCopier.copy(tags);
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 CreateStreamKeyRequest build() {
return new CreateStreamKeyRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}