com.amazonaws.services.transcribe.model.InputDataConfig Maven / Gradle / Ivy
Show all versions of aws-java-sdk-transcribe Show documentation
/*
* Copyright 2019-2024 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 com.amazonaws.services.transcribe.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Contains the Amazon S3 location of the training data you want to use to create a new custom language model, and
* permissions to access this location.
*
*
* When using InputDataConfig, you must include these sub-parameters: S3Uri and
* DataAccessRoleArn. You can optionally include TuningDataS3Uri.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class InputDataConfig implements Serializable, Cloneable, StructuredPojo {
/**
*
* The Amazon S3 location (URI) of the text files you want to use to train your custom language model.
*
*
* Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-training-data/
*
*/
private String s3Uri;
/**
*
* The Amazon S3 location (URI) of the text files you want to use to tune your custom language model.
*
*
* Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/
*
*/
private String tuningDataS3Uri;
/**
*
* 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.
*
*/
private String dataAccessRoleArn;
/**
*
* The Amazon S3 location (URI) of the text files you want to use to train your custom language model.
*
*
* Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-training-data/
*
*
* @param s3Uri
* The Amazon S3 location (URI) of the text files you want to use to train your custom language model.
*
* Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-training-data/
*/
public void setS3Uri(String s3Uri) {
this.s3Uri = s3Uri;
}
/**
*
* The Amazon S3 location (URI) of the text files you want to use to train your custom language model.
*
*
* Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-training-data/
*
*
* @return The Amazon S3 location (URI) of the text files you want to use to train your custom language model.
*
* Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-training-data/
*/
public String getS3Uri() {
return this.s3Uri;
}
/**
*
* The Amazon S3 location (URI) of the text files you want to use to train your custom language model.
*
*
* Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-training-data/
*
*
* @param s3Uri
* The Amazon S3 location (URI) of the text files you want to use to train your custom language model.
*
* Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-training-data/
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InputDataConfig withS3Uri(String s3Uri) {
setS3Uri(s3Uri);
return this;
}
/**
*
* The Amazon S3 location (URI) of the text files you want to use to tune your custom language model.
*
*
* Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/
*
*
* @param tuningDataS3Uri
* The Amazon S3 location (URI) of the text files you want to use to tune your custom language model.
*
* Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/
*/
public void setTuningDataS3Uri(String tuningDataS3Uri) {
this.tuningDataS3Uri = tuningDataS3Uri;
}
/**
*
* The Amazon S3 location (URI) of the text files you want to use to tune your custom language model.
*
*
* Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/
*
*
* @return The Amazon S3 location (URI) of the text files you want to use to tune your custom language model.
*
* Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/
*/
public String getTuningDataS3Uri() {
return this.tuningDataS3Uri;
}
/**
*
* The Amazon S3 location (URI) of the text files you want to use to tune your custom language model.
*
*
* Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/
*
*
* @param tuningDataS3Uri
* The Amazon S3 location (URI) of the text files you want to use to tune your custom language model.
*
* Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InputDataConfig withTuningDataS3Uri(String tuningDataS3Uri) {
setTuningDataS3Uri(tuningDataS3Uri);
return this;
}
/**
*
* 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.
*
*
* @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.
*/
public void setDataAccessRoleArn(String dataAccessRoleArn) {
this.dataAccessRoleArn = 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.
*
*
* @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.
*/
public String getDataAccessRoleArn() {
return this.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.
*
*
* @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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InputDataConfig withDataAccessRoleArn(String dataAccessRoleArn) {
setDataAccessRoleArn(dataAccessRoleArn);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getS3Uri() != null)
sb.append("S3Uri: ").append(getS3Uri()).append(",");
if (getTuningDataS3Uri() != null)
sb.append("TuningDataS3Uri: ").append(getTuningDataS3Uri()).append(",");
if (getDataAccessRoleArn() != null)
sb.append("DataAccessRoleArn: ").append(getDataAccessRoleArn());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof InputDataConfig == false)
return false;
InputDataConfig other = (InputDataConfig) obj;
if (other.getS3Uri() == null ^ this.getS3Uri() == null)
return false;
if (other.getS3Uri() != null && other.getS3Uri().equals(this.getS3Uri()) == false)
return false;
if (other.getTuningDataS3Uri() == null ^ this.getTuningDataS3Uri() == null)
return false;
if (other.getTuningDataS3Uri() != null && other.getTuningDataS3Uri().equals(this.getTuningDataS3Uri()) == false)
return false;
if (other.getDataAccessRoleArn() == null ^ this.getDataAccessRoleArn() == null)
return false;
if (other.getDataAccessRoleArn() != null && other.getDataAccessRoleArn().equals(this.getDataAccessRoleArn()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getS3Uri() == null) ? 0 : getS3Uri().hashCode());
hashCode = prime * hashCode + ((getTuningDataS3Uri() == null) ? 0 : getTuningDataS3Uri().hashCode());
hashCode = prime * hashCode + ((getDataAccessRoleArn() == null) ? 0 : getDataAccessRoleArn().hashCode());
return hashCode;
}
@Override
public InputDataConfig clone() {
try {
return (InputDataConfig) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.transcribe.model.transform.InputDataConfigMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}