software.amazon.awssdk.services.ivs.model.RenditionConfiguration Maven / Gradle / Ivy
Show all versions of ivs 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.ivs.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
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.Function;
import software.amazon.awssdk.annotations.Generated;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Object that describes which renditions should be recorded for a stream.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class RenditionConfiguration implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField RENDITION_SELECTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("renditionSelection").getter(getter(RenditionConfiguration::renditionSelectionAsString))
.setter(setter(Builder::renditionSelection))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("renditionSelection").build())
.build();
private static final SdkField> RENDITIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("renditions")
.getter(getter(RenditionConfiguration::renditionsAsStrings))
.setter(setter(Builder::renditionsWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("renditions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(RENDITION_SELECTION_FIELD,
RENDITIONS_FIELD));
private static final long serialVersionUID = 1L;
private final String renditionSelection;
private final List renditions;
private RenditionConfiguration(BuilderImpl builder) {
this.renditionSelection = builder.renditionSelection;
this.renditions = builder.renditions;
}
/**
*
* Indicates which set of renditions are recorded for a stream. For BASIC channels, the
* CUSTOM value has no effect. If CUSTOM is specified, a set of renditions must be
* specified in the renditions field. Default: ALL.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #renditionSelection} will return {@link RenditionConfigurationRenditionSelection#UNKNOWN_TO_SDK_VERSION}.
* The raw value returned by the service is available from {@link #renditionSelectionAsString}.
*
*
* @return Indicates which set of renditions are recorded for a stream. For BASIC channels, the
* CUSTOM value has no effect. If CUSTOM is specified, a set of renditions must be
* specified in the renditions field. Default: ALL.
* @see RenditionConfigurationRenditionSelection
*/
public final RenditionConfigurationRenditionSelection renditionSelection() {
return RenditionConfigurationRenditionSelection.fromValue(renditionSelection);
}
/**
*
* Indicates which set of renditions are recorded for a stream. For BASIC channels, the
* CUSTOM value has no effect. If CUSTOM is specified, a set of renditions must be
* specified in the renditions field. Default: ALL.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #renditionSelection} will return {@link RenditionConfigurationRenditionSelection#UNKNOWN_TO_SDK_VERSION}.
* The raw value returned by the service is available from {@link #renditionSelectionAsString}.
*
*
* @return Indicates which set of renditions are recorded for a stream. For BASIC channels, the
* CUSTOM value has no effect. If CUSTOM is specified, a set of renditions must be
* specified in the renditions field. Default: ALL.
* @see RenditionConfigurationRenditionSelection
*/
public final String renditionSelectionAsString() {
return renditionSelection;
}
/**
*
* Indicates which renditions are recorded for a stream, if renditionSelection is CUSTOM;
* otherwise, this field is irrelevant. The selected renditions are recorded if they are available during the
* stream. If a selected rendition is unavailable, the best available rendition is recorded. For details on the
* resolution dimensions of each rendition, see Auto-Record to Amazon S3.
*
*
* 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 #hasRenditions} method.
*
*
* @return Indicates which renditions are recorded for a stream, if renditionSelection is
* CUSTOM; otherwise, this field is irrelevant. The selected renditions are recorded if they
* are available during the stream. If a selected rendition is unavailable, the best available rendition is
* recorded. For details on the resolution dimensions of each rendition, see Auto-Record to Amazon S3.
*/
public final List renditions() {
return RenditionConfigurationRenditionListCopier.copyStringToEnum(renditions);
}
/**
* For responses, this returns true if the service returned a value for the Renditions 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 hasRenditions() {
return renditions != null && !(renditions instanceof SdkAutoConstructList);
}
/**
*
* Indicates which renditions are recorded for a stream, if renditionSelection is CUSTOM;
* otherwise, this field is irrelevant. The selected renditions are recorded if they are available during the
* stream. If a selected rendition is unavailable, the best available rendition is recorded. For details on the
* resolution dimensions of each rendition, see Auto-Record to Amazon S3.
*
*
* 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 #hasRenditions} method.
*
*
* @return Indicates which renditions are recorded for a stream, if renditionSelection is
* CUSTOM; otherwise, this field is irrelevant. The selected renditions are recorded if they
* are available during the stream. If a selected rendition is unavailable, the best available rendition is
* recorded. For details on the resolution dimensions of each rendition, see Auto-Record to Amazon S3.
*/
public final List renditionsAsStrings() {
return renditions;
}
@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 + Objects.hashCode(renditionSelectionAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasRenditions() ? renditionsAsStrings() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof RenditionConfiguration)) {
return false;
}
RenditionConfiguration other = (RenditionConfiguration) obj;
return Objects.equals(renditionSelectionAsString(), other.renditionSelectionAsString())
&& hasRenditions() == other.hasRenditions() && Objects.equals(renditionsAsStrings(), other.renditionsAsStrings());
}
/**
* 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("RenditionConfiguration").add("RenditionSelection", renditionSelectionAsString())
.add("Renditions", hasRenditions() ? renditionsAsStrings() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "renditionSelection":
return Optional.ofNullable(clazz.cast(renditionSelectionAsString()));
case "renditions":
return Optional.ofNullable(clazz.cast(renditionsAsStrings()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((RenditionConfiguration) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Indicates which set of renditions are recorded for a stream. For BASIC channels, the
* CUSTOM value has no effect. If CUSTOM is specified, a set of renditions must be
* specified in the renditions field. Default: ALL.
*
*
* @param renditionSelection
* Indicates which set of renditions are recorded for a stream. For BASIC channels, the
* CUSTOM value has no effect. If CUSTOM is specified, a set of renditions must
* be specified in the renditions field. Default: ALL.
* @see RenditionConfigurationRenditionSelection
* @return Returns a reference to this object so that method calls can be chained together.
* @see RenditionConfigurationRenditionSelection
*/
Builder renditionSelection(String renditionSelection);
/**
*
* Indicates which set of renditions are recorded for a stream. For BASIC channels, the
* CUSTOM value has no effect. If CUSTOM is specified, a set of renditions must be
* specified in the renditions field. Default: ALL.
*
*
* @param renditionSelection
* Indicates which set of renditions are recorded for a stream. For BASIC channels, the
* CUSTOM value has no effect. If CUSTOM is specified, a set of renditions must
* be specified in the renditions field. Default: ALL.
* @see RenditionConfigurationRenditionSelection
* @return Returns a reference to this object so that method calls can be chained together.
* @see RenditionConfigurationRenditionSelection
*/
Builder renditionSelection(RenditionConfigurationRenditionSelection renditionSelection);
/**
*
* Indicates which renditions are recorded for a stream, if renditionSelection is
* CUSTOM; otherwise, this field is irrelevant. The selected renditions are recorded if they are
* available during the stream. If a selected rendition is unavailable, the best available rendition is
* recorded. For details on the resolution dimensions of each rendition, see Auto-Record to Amazon S3.
*
*
* @param renditions
* Indicates which renditions are recorded for a stream, if renditionSelection is
* CUSTOM; otherwise, this field is irrelevant. The selected renditions are recorded if they
* are available during the stream. If a selected rendition is unavailable, the best available rendition
* is recorded. For details on the resolution dimensions of each rendition, see Auto-Record to Amazon
* S3.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder renditionsWithStrings(Collection renditions);
/**
*
* Indicates which renditions are recorded for a stream, if renditionSelection is
* CUSTOM; otherwise, this field is irrelevant. The selected renditions are recorded if they are
* available during the stream. If a selected rendition is unavailable, the best available rendition is
* recorded. For details on the resolution dimensions of each rendition, see Auto-Record to Amazon S3.
*
*
* @param renditions
* Indicates which renditions are recorded for a stream, if renditionSelection is
* CUSTOM; otherwise, this field is irrelevant. The selected renditions are recorded if they
* are available during the stream. If a selected rendition is unavailable, the best available rendition
* is recorded. For details on the resolution dimensions of each rendition, see Auto-Record to Amazon
* S3.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder renditionsWithStrings(String... renditions);
/**
*
* Indicates which renditions are recorded for a stream, if renditionSelection is
* CUSTOM; otherwise, this field is irrelevant. The selected renditions are recorded if they are
* available during the stream. If a selected rendition is unavailable, the best available rendition is
* recorded. For details on the resolution dimensions of each rendition, see Auto-Record to Amazon S3.
*
*
* @param renditions
* Indicates which renditions are recorded for a stream, if renditionSelection is
* CUSTOM; otherwise, this field is irrelevant. The selected renditions are recorded if they
* are available during the stream. If a selected rendition is unavailable, the best available rendition
* is recorded. For details on the resolution dimensions of each rendition, see Auto-Record to Amazon
* S3.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder renditions(Collection renditions);
/**
*
* Indicates which renditions are recorded for a stream, if renditionSelection is
* CUSTOM; otherwise, this field is irrelevant. The selected renditions are recorded if they are
* available during the stream. If a selected rendition is unavailable, the best available rendition is
* recorded. For details on the resolution dimensions of each rendition, see Auto-Record to Amazon S3.
*
*
* @param renditions
* Indicates which renditions are recorded for a stream, if renditionSelection is
* CUSTOM; otherwise, this field is irrelevant. The selected renditions are recorded if they
* are available during the stream. If a selected rendition is unavailable, the best available rendition
* is recorded. For details on the resolution dimensions of each rendition, see Auto-Record to Amazon
* S3.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder renditions(RenditionConfigurationRendition... renditions);
}
static final class BuilderImpl implements Builder {
private String renditionSelection;
private List renditions = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(RenditionConfiguration model) {
renditionSelection(model.renditionSelection);
renditionsWithStrings(model.renditions);
}
public final String getRenditionSelection() {
return renditionSelection;
}
public final void setRenditionSelection(String renditionSelection) {
this.renditionSelection = renditionSelection;
}
@Override
public final Builder renditionSelection(String renditionSelection) {
this.renditionSelection = renditionSelection;
return this;
}
@Override
public final Builder renditionSelection(RenditionConfigurationRenditionSelection renditionSelection) {
this.renditionSelection(renditionSelection == null ? null : renditionSelection.toString());
return this;
}
public final Collection getRenditions() {
if (renditions instanceof SdkAutoConstructList) {
return null;
}
return renditions;
}
public final void setRenditions(Collection renditions) {
this.renditions = RenditionConfigurationRenditionListCopier.copy(renditions);
}
@Override
public final Builder renditionsWithStrings(Collection renditions) {
this.renditions = RenditionConfigurationRenditionListCopier.copy(renditions);
return this;
}
@Override
@SafeVarargs
public final Builder renditionsWithStrings(String... renditions) {
renditionsWithStrings(Arrays.asList(renditions));
return this;
}
@Override
public final Builder renditions(Collection renditions) {
this.renditions = RenditionConfigurationRenditionListCopier.copyEnumToString(renditions);
return this;
}
@Override
@SafeVarargs
public final Builder renditions(RenditionConfigurationRendition... renditions) {
renditions(Arrays.asList(renditions));
return this;
}
@Override
public RenditionConfiguration build() {
return new RenditionConfiguration(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}