software.amazon.awssdk.services.medialive.model.InputPrepareScheduleActionSettings Maven / Gradle / Ivy
/*
* 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.medialive.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.Consumer;
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;
/**
* Action to prepare an input for a future immediate input switch.
*/
@Generated("software.amazon.awssdk:codegen")
public final class InputPrepareScheduleActionSettings implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField INPUT_ATTACHMENT_NAME_REFERENCE_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("InputAttachmentNameReference")
.getter(getter(InputPrepareScheduleActionSettings::inputAttachmentNameReference))
.setter(setter(Builder::inputAttachmentNameReference))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("inputAttachmentNameReference")
.build()).build();
private static final SdkField INPUT_CLIPPING_SETTINGS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("InputClippingSettings")
.getter(getter(InputPrepareScheduleActionSettings::inputClippingSettings))
.setter(setter(Builder::inputClippingSettings)).constructor(InputClippingSettings::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("inputClippingSettings").build())
.build();
private static final SdkField> URL_PATH_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("UrlPath")
.getter(getter(InputPrepareScheduleActionSettings::urlPath))
.setter(setter(Builder::urlPath))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("urlPath").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(
INPUT_ATTACHMENT_NAME_REFERENCE_FIELD, INPUT_CLIPPING_SETTINGS_FIELD, URL_PATH_FIELD));
private static final long serialVersionUID = 1L;
private final String inputAttachmentNameReference;
private final InputClippingSettings inputClippingSettings;
private final List urlPath;
private InputPrepareScheduleActionSettings(BuilderImpl builder) {
this.inputAttachmentNameReference = builder.inputAttachmentNameReference;
this.inputClippingSettings = builder.inputClippingSettings;
this.urlPath = builder.urlPath;
}
/**
* The name of the input attachment that should be prepared by this action. If no name is provided, the action will
* stop the most recent prepare (if any) when activated.
*
* @return The name of the input attachment that should be prepared by this action. If no name is provided, the
* action will stop the most recent prepare (if any) when activated.
*/
public final String inputAttachmentNameReference() {
return inputAttachmentNameReference;
}
/**
* Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of the
* file.
*
* @return Settings to let you create a clip of the file input, in order to set up the input to ingest only a
* portion of the file.
*/
public final InputClippingSettings inputClippingSettings() {
return inputClippingSettings;
}
/**
* For responses, this returns true if the service returned a value for the UrlPath 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 hasUrlPath() {
return urlPath != null && !(urlPath instanceof SdkAutoConstructList);
}
/**
* The value for the variable portion of the URL for the dynamic input, for this instance of the input. Each time
* you use the same dynamic input in an input switch action, you can provide a different value, in order to connect
* the input to a different content source.
*
* 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 #hasUrlPath} method.
*
*
* @return The value for the variable portion of the URL for the dynamic input, for this instance of the input. Each
* time you use the same dynamic input in an input switch action, you can provide a different value, in
* order to connect the input to a different content source.
*/
public final List urlPath() {
return urlPath;
}
@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(inputAttachmentNameReference());
hashCode = 31 * hashCode + Objects.hashCode(inputClippingSettings());
hashCode = 31 * hashCode + Objects.hashCode(hasUrlPath() ? urlPath() : 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 InputPrepareScheduleActionSettings)) {
return false;
}
InputPrepareScheduleActionSettings other = (InputPrepareScheduleActionSettings) obj;
return Objects.equals(inputAttachmentNameReference(), other.inputAttachmentNameReference())
&& Objects.equals(inputClippingSettings(), other.inputClippingSettings()) && hasUrlPath() == other.hasUrlPath()
&& Objects.equals(urlPath(), other.urlPath());
}
/**
* 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("InputPrepareScheduleActionSettings")
.add("InputAttachmentNameReference", inputAttachmentNameReference())
.add("InputClippingSettings", inputClippingSettings()).add("UrlPath", hasUrlPath() ? urlPath() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "InputAttachmentNameReference":
return Optional.ofNullable(clazz.cast(inputAttachmentNameReference()));
case "InputClippingSettings":
return Optional.ofNullable(clazz.cast(inputClippingSettings()));
case "UrlPath":
return Optional.ofNullable(clazz.cast(urlPath()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((InputPrepareScheduleActionSettings) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
* The name of the input attachment that should be prepared by this action. If no name is provided, the action
* will stop the most recent prepare (if any) when activated.
*
* @param inputAttachmentNameReference
* The name of the input attachment that should be prepared by this action. If no name is provided, the
* action will stop the most recent prepare (if any) when activated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder inputAttachmentNameReference(String inputAttachmentNameReference);
/**
* Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of
* the file.
*
* @param inputClippingSettings
* Settings to let you create a clip of the file input, in order to set up the input to ingest only a
* portion of the file.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder inputClippingSettings(InputClippingSettings inputClippingSettings);
/**
* Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of
* the file. This is a convenience method that creates an instance of the {@link InputClippingSettings.Builder}
* avoiding the need to create one manually via {@link InputClippingSettings#builder()}.
*
*
* When the {@link Consumer} completes, {@link InputClippingSettings.Builder#build()} is called immediately and
* its result is passed to {@link #inputClippingSettings(InputClippingSettings)}.
*
* @param inputClippingSettings
* a consumer that will call methods on {@link InputClippingSettings.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #inputClippingSettings(InputClippingSettings)
*/
default Builder inputClippingSettings(Consumer inputClippingSettings) {
return inputClippingSettings(InputClippingSettings.builder().applyMutation(inputClippingSettings).build());
}
/**
* The value for the variable portion of the URL for the dynamic input, for this instance of the input. Each
* time you use the same dynamic input in an input switch action, you can provide a different value, in order to
* connect the input to a different content source.
*
* @param urlPath
* The value for the variable portion of the URL for the dynamic input, for this instance of the input.
* Each time you use the same dynamic input in an input switch action, you can provide a different value,
* in order to connect the input to a different content source.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder urlPath(Collection urlPath);
/**
* The value for the variable portion of the URL for the dynamic input, for this instance of the input. Each
* time you use the same dynamic input in an input switch action, you can provide a different value, in order to
* connect the input to a different content source.
*
* @param urlPath
* The value for the variable portion of the URL for the dynamic input, for this instance of the input.
* Each time you use the same dynamic input in an input switch action, you can provide a different value,
* in order to connect the input to a different content source.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder urlPath(String... urlPath);
}
static final class BuilderImpl implements Builder {
private String inputAttachmentNameReference;
private InputClippingSettings inputClippingSettings;
private List urlPath = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(InputPrepareScheduleActionSettings model) {
inputAttachmentNameReference(model.inputAttachmentNameReference);
inputClippingSettings(model.inputClippingSettings);
urlPath(model.urlPath);
}
public final String getInputAttachmentNameReference() {
return inputAttachmentNameReference;
}
public final void setInputAttachmentNameReference(String inputAttachmentNameReference) {
this.inputAttachmentNameReference = inputAttachmentNameReference;
}
@Override
public final Builder inputAttachmentNameReference(String inputAttachmentNameReference) {
this.inputAttachmentNameReference = inputAttachmentNameReference;
return this;
}
public final InputClippingSettings.Builder getInputClippingSettings() {
return inputClippingSettings != null ? inputClippingSettings.toBuilder() : null;
}
public final void setInputClippingSettings(InputClippingSettings.BuilderImpl inputClippingSettings) {
this.inputClippingSettings = inputClippingSettings != null ? inputClippingSettings.build() : null;
}
@Override
public final Builder inputClippingSettings(InputClippingSettings inputClippingSettings) {
this.inputClippingSettings = inputClippingSettings;
return this;
}
public final Collection getUrlPath() {
if (urlPath instanceof SdkAutoConstructList) {
return null;
}
return urlPath;
}
public final void setUrlPath(Collection urlPath) {
this.urlPath = ___listOf__stringCopier.copy(urlPath);
}
@Override
public final Builder urlPath(Collection urlPath) {
this.urlPath = ___listOf__stringCopier.copy(urlPath);
return this;
}
@Override
@SafeVarargs
public final Builder urlPath(String... urlPath) {
urlPath(Arrays.asList(urlPath));
return this;
}
@Override
public InputPrepareScheduleActionSettings build() {
return new InputPrepareScheduleActionSettings(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}