software.amazon.awssdk.services.transcribe.model.RelativeTimeRange Maven / Gradle / Ivy
Show all versions of transcribe 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.transcribe.model;
import java.io.Serializable;
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.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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* A time range, in percentage, between two points in your media file.
*
*
* You can use StartPercentage and EndPercentage to search a custom segment. For example,
* setting StartPercentage to 10 and EndPercentage to 50 only searches for your specified
* criteria in the audio contained between the 10 percent mark and the 50 percent mark of your media file.
*
*
* You can use also First to search from the start of the media file until the time that you specify. Or
* use Last to search from the time that you specify until the end of the media file. For example, setting
* First to 10 only searches for your specified criteria in the audio contained in the first 10 percent of
* the media file.
*
*
* If you prefer to use milliseconds instead of percentage, see .
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class RelativeTimeRange implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField START_PERCENTAGE_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("StartPercentage").getter(getter(RelativeTimeRange::startPercentage))
.setter(setter(Builder::startPercentage))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StartPercentage").build()).build();
private static final SdkField END_PERCENTAGE_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("EndPercentage").getter(getter(RelativeTimeRange::endPercentage)).setter(setter(Builder::endPercentage))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EndPercentage").build()).build();
private static final SdkField FIRST_FIELD = SdkField. builder(MarshallingType.INTEGER).memberName("First")
.getter(getter(RelativeTimeRange::first)).setter(setter(Builder::first))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("First").build()).build();
private static final SdkField LAST_FIELD = SdkField. builder(MarshallingType.INTEGER).memberName("Last")
.getter(getter(RelativeTimeRange::last)).setter(setter(Builder::last))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Last").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(START_PERCENTAGE_FIELD,
END_PERCENTAGE_FIELD, FIRST_FIELD, LAST_FIELD));
private static final long serialVersionUID = 1L;
private final Integer startPercentage;
private final Integer endPercentage;
private final Integer first;
private final Integer last;
private RelativeTimeRange(BuilderImpl builder) {
this.startPercentage = builder.startPercentage;
this.endPercentage = builder.endPercentage;
this.first = builder.first;
this.last = builder.last;
}
/**
*
* The time, in percentage, when Amazon Transcribe starts searching for the specified criteria in your media file.
* If you include StartPercentage in your request, you must also include EndPercentage.
*
*
* @return The time, in percentage, when Amazon Transcribe starts searching for the specified criteria in your media
* file. If you include StartPercentage in your request, you must also include
* EndPercentage.
*/
public final Integer startPercentage() {
return startPercentage;
}
/**
*
* The time, in percentage, when Amazon Transcribe stops searching for the specified criteria in your media file. If
* you include EndPercentage in your request, you must also include StartPercentage.
*
*
* @return The time, in percentage, when Amazon Transcribe stops searching for the specified criteria in your media
* file. If you include EndPercentage in your request, you must also include
* StartPercentage.
*/
public final Integer endPercentage() {
return endPercentage;
}
/**
*
* The time, in percentage, from the start of your media file until the specified value. Amazon Transcribe searches
* for your specified criteria in this time segment.
*
*
* @return The time, in percentage, from the start of your media file until the specified value. Amazon Transcribe
* searches for your specified criteria in this time segment.
*/
public final Integer first() {
return first;
}
/**
*
* The time, in percentage, from the specified value until the end of your media file. Amazon Transcribe searches
* for your specified criteria in this time segment.
*
*
* @return The time, in percentage, from the specified value until the end of your media file. Amazon Transcribe
* searches for your specified criteria in this time segment.
*/
public final Integer last() {
return last;
}
@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(startPercentage());
hashCode = 31 * hashCode + Objects.hashCode(endPercentage());
hashCode = 31 * hashCode + Objects.hashCode(first());
hashCode = 31 * hashCode + Objects.hashCode(last());
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 RelativeTimeRange)) {
return false;
}
RelativeTimeRange other = (RelativeTimeRange) obj;
return Objects.equals(startPercentage(), other.startPercentage())
&& Objects.equals(endPercentage(), other.endPercentage()) && Objects.equals(first(), other.first())
&& Objects.equals(last(), other.last());
}
/**
* 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("RelativeTimeRange").add("StartPercentage", startPercentage())
.add("EndPercentage", endPercentage()).add("First", first()).add("Last", last()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "StartPercentage":
return Optional.ofNullable(clazz.cast(startPercentage()));
case "EndPercentage":
return Optional.ofNullable(clazz.cast(endPercentage()));
case "First":
return Optional.ofNullable(clazz.cast(first()));
case "Last":
return Optional.ofNullable(clazz.cast(last()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((RelativeTimeRange) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The time, in percentage, when Amazon Transcribe starts searching for the specified criteria in your media
* file. If you include StartPercentage in your request, you must also include
* EndPercentage.
*
*
* @param startPercentage
* The time, in percentage, when Amazon Transcribe starts searching for the specified criteria in your
* media file. If you include StartPercentage in your request, you must also include
* EndPercentage.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder startPercentage(Integer startPercentage);
/**
*
* The time, in percentage, when Amazon Transcribe stops searching for the specified criteria in your media
* file. If you include EndPercentage in your request, you must also include
* StartPercentage.
*
*
* @param endPercentage
* The time, in percentage, when Amazon Transcribe stops searching for the specified criteria in your
* media file. If you include EndPercentage in your request, you must also include
* StartPercentage.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder endPercentage(Integer endPercentage);
/**
*
* The time, in percentage, from the start of your media file until the specified value. Amazon Transcribe
* searches for your specified criteria in this time segment.
*
*
* @param first
* The time, in percentage, from the start of your media file until the specified value. Amazon
* Transcribe searches for your specified criteria in this time segment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder first(Integer first);
/**
*
* The time, in percentage, from the specified value until the end of your media file. Amazon Transcribe
* searches for your specified criteria in this time segment.
*
*
* @param last
* The time, in percentage, from the specified value until the end of your media file. Amazon Transcribe
* searches for your specified criteria in this time segment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder last(Integer last);
}
static final class BuilderImpl implements Builder {
private Integer startPercentage;
private Integer endPercentage;
private Integer first;
private Integer last;
private BuilderImpl() {
}
private BuilderImpl(RelativeTimeRange model) {
startPercentage(model.startPercentage);
endPercentage(model.endPercentage);
first(model.first);
last(model.last);
}
public final Integer getStartPercentage() {
return startPercentage;
}
public final void setStartPercentage(Integer startPercentage) {
this.startPercentage = startPercentage;
}
@Override
public final Builder startPercentage(Integer startPercentage) {
this.startPercentage = startPercentage;
return this;
}
public final Integer getEndPercentage() {
return endPercentage;
}
public final void setEndPercentage(Integer endPercentage) {
this.endPercentage = endPercentage;
}
@Override
public final Builder endPercentage(Integer endPercentage) {
this.endPercentage = endPercentage;
return this;
}
public final Integer getFirst() {
return first;
}
public final void setFirst(Integer first) {
this.first = first;
}
@Override
public final Builder first(Integer first) {
this.first = first;
return this;
}
public final Integer getLast() {
return last;
}
public final void setLast(Integer last) {
this.last = last;
}
@Override
public final Builder last(Integer last) {
this.last = last;
return this;
}
@Override
public RelativeTimeRange build() {
return new RelativeTimeRange(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}