software.amazon.awssdk.services.transcribe.model.JobExecutionSettings 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;
/**
*
* Makes it possible to control how your transcription job is processed. Currently, the only
* JobExecutionSettings modification you can choose is enabling job queueing using the
* AllowDeferredExecution sub-parameter.
*
*
* If you include JobExecutionSettings in your request, you must also include the sub-parameters:
* AllowDeferredExecution and DataAccessRoleArn.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class JobExecutionSettings implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ALLOW_DEFERRED_EXECUTION_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("AllowDeferredExecution").getter(getter(JobExecutionSettings::allowDeferredExecution))
.setter(setter(Builder::allowDeferredExecution))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AllowDeferredExecution").build())
.build();
private static final SdkField DATA_ACCESS_ROLE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DataAccessRoleArn").getter(getter(JobExecutionSettings::dataAccessRoleArn))
.setter(setter(Builder::dataAccessRoleArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DataAccessRoleArn").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
ALLOW_DEFERRED_EXECUTION_FIELD, DATA_ACCESS_ROLE_ARN_FIELD));
private static final long serialVersionUID = 1L;
private final Boolean allowDeferredExecution;
private final String dataAccessRoleArn;
private JobExecutionSettings(BuilderImpl builder) {
this.allowDeferredExecution = builder.allowDeferredExecution;
this.dataAccessRoleArn = builder.dataAccessRoleArn;
}
/**
*
* Makes it possible to enable job queuing when your concurrent request limit is exceeded. When
* AllowDeferredExecution is set to true, transcription job requests are placed in a queue
* until the number of jobs falls below the concurrent request limit. If AllowDeferredExecution is set
* to false and the number of transcription job requests exceed the concurrent request limit, you get a
* LimitExceededException error.
*
*
* If you include AllowDeferredExecution in your request, you must also include
* DataAccessRoleArn.
*
*
* @return Makes it possible to enable job queuing when your concurrent request limit is exceeded. When
* AllowDeferredExecution is set to true, transcription job requests are placed in
* a queue until the number of jobs falls below the concurrent request limit. If
* AllowDeferredExecution is set to false and the number of transcription job
* requests exceed the concurrent request limit, you get a LimitExceededException error.
*
* If you include AllowDeferredExecution in your request, you must also include
* DataAccessRoleArn.
*/
public final Boolean allowDeferredExecution() {
return allowDeferredExecution;
}
/**
*
* The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains
* your input files. If the role that you specify doesn’t have the appropriate permissions to access the specified
* Amazon S3 location, your request fails.
*
*
* IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example:
* arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs.
*
*
* Note that if you include DataAccessRoleArn in your request, you must also include
* AllowDeferredExecution.
*
*
* @return The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that
* contains your input files. If the role that you specify doesn’t have the appropriate permissions to
* access the specified Amazon S3 location, your request fails.
*
* IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For
* example: arn:aws:iam::111122223333:role/Admin. For more information, see IAM
* ARNs.
*
*
* Note that if you include DataAccessRoleArn in your request, you must also include
* AllowDeferredExecution.
*/
public final String dataAccessRoleArn() {
return dataAccessRoleArn;
}
@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(allowDeferredExecution());
hashCode = 31 * hashCode + Objects.hashCode(dataAccessRoleArn());
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 JobExecutionSettings)) {
return false;
}
JobExecutionSettings other = (JobExecutionSettings) obj;
return Objects.equals(allowDeferredExecution(), other.allowDeferredExecution())
&& Objects.equals(dataAccessRoleArn(), other.dataAccessRoleArn());
}
/**
* 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("JobExecutionSettings").add("AllowDeferredExecution", allowDeferredExecution())
.add("DataAccessRoleArn", dataAccessRoleArn()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AllowDeferredExecution":
return Optional.ofNullable(clazz.cast(allowDeferredExecution()));
case "DataAccessRoleArn":
return Optional.ofNullable(clazz.cast(dataAccessRoleArn()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((JobExecutionSettings) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Makes it possible to enable job queuing when your concurrent request limit is exceeded. When
* AllowDeferredExecution is set to true, transcription job requests are placed in a
* queue until the number of jobs falls below the concurrent request limit. If
* AllowDeferredExecution is set to false and the number of transcription job requests
* exceed the concurrent request limit, you get a LimitExceededException error.
*
*
* If you include AllowDeferredExecution in your request, you must also include
* DataAccessRoleArn.
*
*
* @param allowDeferredExecution
* Makes it possible to enable job queuing when your concurrent request limit is exceeded. When
* AllowDeferredExecution is set to true, transcription job requests are placed
* in a queue until the number of jobs falls below the concurrent request limit. If
* AllowDeferredExecution is set to false and the number of transcription job
* requests exceed the concurrent request limit, you get a LimitExceededException error.
*
* If you include AllowDeferredExecution in your request, you must also include
* DataAccessRoleArn.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder allowDeferredExecution(Boolean allowDeferredExecution);
/**
*
* The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that
* contains your input files. If the role that you specify doesn’t have the appropriate permissions to access
* the specified Amazon S3 location, your request fails.
*
*
* IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example:
* arn:aws:iam::111122223333:role/Admin. For more information, see IAM
* ARNs.
*
*
* Note that if you include DataAccessRoleArn in your request, you must also include
* AllowDeferredExecution.
*
*
* @param dataAccessRoleArn
* The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that
* contains your input files. If the role that you specify doesn’t have the appropriate permissions to
* access the specified Amazon S3 location, your request fails.
*
* IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For
* example: arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs.
*
*
* Note that if you include DataAccessRoleArn in your request, you must also include
* AllowDeferredExecution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dataAccessRoleArn(String dataAccessRoleArn);
}
static final class BuilderImpl implements Builder {
private Boolean allowDeferredExecution;
private String dataAccessRoleArn;
private BuilderImpl() {
}
private BuilderImpl(JobExecutionSettings model) {
allowDeferredExecution(model.allowDeferredExecution);
dataAccessRoleArn(model.dataAccessRoleArn);
}
public final Boolean getAllowDeferredExecution() {
return allowDeferredExecution;
}
public final void setAllowDeferredExecution(Boolean allowDeferredExecution) {
this.allowDeferredExecution = allowDeferredExecution;
}
@Override
public final Builder allowDeferredExecution(Boolean allowDeferredExecution) {
this.allowDeferredExecution = allowDeferredExecution;
return this;
}
public final String getDataAccessRoleArn() {
return dataAccessRoleArn;
}
public final void setDataAccessRoleArn(String dataAccessRoleArn) {
this.dataAccessRoleArn = dataAccessRoleArn;
}
@Override
public final Builder dataAccessRoleArn(String dataAccessRoleArn) {
this.dataAccessRoleArn = dataAccessRoleArn;
return this;
}
@Override
public JobExecutionSettings build() {
return new JobExecutionSettings(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}