com.amazonaws.services.sagemaker.model.TransformS3DataSource Maven / Gradle / Ivy
/*
* Copyright 2015-2020 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.sagemaker.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Describes the S3 data source.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class TransformS3DataSource implements Serializable, Cloneable, StructuredPojo {
/**
*
* If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all
* objects with the specified key name prefix for batch transform.
*
*
* If you choose ManifestFile, S3Uri identifies an object that is a manifest file
* containing a list of object keys that you want Amazon SageMaker to use for batch transform.
*
*
* The following values are compatible: ManifestFile, S3Prefix
*
*
* The following value is not compatible: AugmentedManifestFile
*
*/
private String s3DataType;
/**
*
* Depending on the value specified for the S3DataType, identifies either a key name prefix or a
* manifest. For example:
*
*
* -
*
* A key name prefix might look like this: s3://bucketname/exampleprefix.
*
*
* -
*
* A manifest might look like this: s3://bucketname/example.manifest
*
*
* The manifest is an S3 object which is a JSON file with the following format:
*
*
* [ {"prefix": "s3://customer_bucket/some/prefix/"},
*
*
* "relative/path/to/custdata-1",
*
*
* "relative/path/custdata-2",
*
*
* ...
*
*
* "relative/path/custdata-N"
*
*
* ]
*
*
* The preceding JSON matches the following S3Uris:
*
*
* s3://customer_bucket/some/prefix/relative/path/to/custdata-1
*
*
* s3://customer_bucket/some/prefix/relative/path/custdata-2
*
*
* ...
*
*
* s3://customer_bucket/some/prefix/relative/path/custdata-N
*
*
* The complete set of S3Uris in this manifest constitutes the input data for the channel for this
* datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon
* SageMaker uses to perform tasks on your behalf.
*
*
*
*/
private String s3Uri;
/**
*
* If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all
* objects with the specified key name prefix for batch transform.
*
*
* If you choose ManifestFile, S3Uri identifies an object that is a manifest file
* containing a list of object keys that you want Amazon SageMaker to use for batch transform.
*
*
* The following values are compatible: ManifestFile, S3Prefix
*
*
* The following value is not compatible: AugmentedManifestFile
*
*
* @param s3DataType
* If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker
* uses all objects with the specified key name prefix for batch transform.
*
* If you choose ManifestFile, S3Uri identifies an object that is a manifest file
* containing a list of object keys that you want Amazon SageMaker to use for batch transform.
*
*
* The following values are compatible: ManifestFile, S3Prefix
*
*
* The following value is not compatible: AugmentedManifestFile
* @see S3DataType
*/
public void setS3DataType(String s3DataType) {
this.s3DataType = s3DataType;
}
/**
*
* If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all
* objects with the specified key name prefix for batch transform.
*
*
* If you choose ManifestFile, S3Uri identifies an object that is a manifest file
* containing a list of object keys that you want Amazon SageMaker to use for batch transform.
*
*
* The following values are compatible: ManifestFile, S3Prefix
*
*
* The following value is not compatible: AugmentedManifestFile
*
*
* @return If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker
* uses all objects with the specified key name prefix for batch transform.
*
* If you choose ManifestFile, S3Uri identifies an object that is a manifest file
* containing a list of object keys that you want Amazon SageMaker to use for batch transform.
*
*
* The following values are compatible: ManifestFile, S3Prefix
*
*
* The following value is not compatible: AugmentedManifestFile
* @see S3DataType
*/
public String getS3DataType() {
return this.s3DataType;
}
/**
*
* If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all
* objects with the specified key name prefix for batch transform.
*
*
* If you choose ManifestFile, S3Uri identifies an object that is a manifest file
* containing a list of object keys that you want Amazon SageMaker to use for batch transform.
*
*
* The following values are compatible: ManifestFile, S3Prefix
*
*
* The following value is not compatible: AugmentedManifestFile
*
*
* @param s3DataType
* If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker
* uses all objects with the specified key name prefix for batch transform.
*
* If you choose ManifestFile, S3Uri identifies an object that is a manifest file
* containing a list of object keys that you want Amazon SageMaker to use for batch transform.
*
*
* The following values are compatible: ManifestFile, S3Prefix
*
*
* The following value is not compatible: AugmentedManifestFile
* @return Returns a reference to this object so that method calls can be chained together.
* @see S3DataType
*/
public TransformS3DataSource withS3DataType(String s3DataType) {
setS3DataType(s3DataType);
return this;
}
/**
*
* If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all
* objects with the specified key name prefix for batch transform.
*
*
* If you choose ManifestFile, S3Uri identifies an object that is a manifest file
* containing a list of object keys that you want Amazon SageMaker to use for batch transform.
*
*
* The following values are compatible: ManifestFile, S3Prefix
*
*
* The following value is not compatible: AugmentedManifestFile
*
*
* @param s3DataType
* If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker
* uses all objects with the specified key name prefix for batch transform.
*
* If you choose ManifestFile, S3Uri identifies an object that is a manifest file
* containing a list of object keys that you want Amazon SageMaker to use for batch transform.
*
*
* The following values are compatible: ManifestFile, S3Prefix
*
*
* The following value is not compatible: AugmentedManifestFile
* @return Returns a reference to this object so that method calls can be chained together.
* @see S3DataType
*/
public TransformS3DataSource withS3DataType(S3DataType s3DataType) {
this.s3DataType = s3DataType.toString();
return this;
}
/**
*
* Depending on the value specified for the S3DataType, identifies either a key name prefix or a
* manifest. For example:
*
*
* -
*
* A key name prefix might look like this: s3://bucketname/exampleprefix.
*
*
* -
*
* A manifest might look like this: s3://bucketname/example.manifest
*
*
* The manifest is an S3 object which is a JSON file with the following format:
*
*
* [ {"prefix": "s3://customer_bucket/some/prefix/"},
*
*
* "relative/path/to/custdata-1",
*
*
* "relative/path/custdata-2",
*
*
* ...
*
*
* "relative/path/custdata-N"
*
*
* ]
*
*
* The preceding JSON matches the following S3Uris:
*
*
* s3://customer_bucket/some/prefix/relative/path/to/custdata-1
*
*
* s3://customer_bucket/some/prefix/relative/path/custdata-2
*
*
* ...
*
*
* s3://customer_bucket/some/prefix/relative/path/custdata-N
*
*
* The complete set of S3Uris in this manifest constitutes the input data for the channel for this
* datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon
* SageMaker uses to perform tasks on your behalf.
*
*
*
*
* @param s3Uri
* Depending on the value specified for the S3DataType, identifies either a key name prefix or a
* manifest. For example:
*
* -
*
* A key name prefix might look like this: s3://bucketname/exampleprefix.
*
*
* -
*
* A manifest might look like this: s3://bucketname/example.manifest
*
*
* The manifest is an S3 object which is a JSON file with the following format:
*
*
* [ {"prefix": "s3://customer_bucket/some/prefix/"},
*
*
* "relative/path/to/custdata-1",
*
*
* "relative/path/custdata-2",
*
*
* ...
*
*
* "relative/path/custdata-N"
*
*
* ]
*
*
* The preceding JSON matches the following S3Uris:
*
*
* s3://customer_bucket/some/prefix/relative/path/to/custdata-1
*
*
* s3://customer_bucket/some/prefix/relative/path/custdata-2
*
*
* ...
*
*
* s3://customer_bucket/some/prefix/relative/path/custdata-N
*
*
* The complete set of S3Uris in this manifest constitutes the input data for the channel for
* this datasource. The object that each S3Uris points to must be readable by the IAM role that
* Amazon SageMaker uses to perform tasks on your behalf.
*
*
*/
public void setS3Uri(String s3Uri) {
this.s3Uri = s3Uri;
}
/**
*
* Depending on the value specified for the S3DataType, identifies either a key name prefix or a
* manifest. For example:
*
*
* -
*
* A key name prefix might look like this: s3://bucketname/exampleprefix.
*
*
* -
*
* A manifest might look like this: s3://bucketname/example.manifest
*
*
* The manifest is an S3 object which is a JSON file with the following format:
*
*
* [ {"prefix": "s3://customer_bucket/some/prefix/"},
*
*
* "relative/path/to/custdata-1",
*
*
* "relative/path/custdata-2",
*
*
* ...
*
*
* "relative/path/custdata-N"
*
*
* ]
*
*
* The preceding JSON matches the following S3Uris:
*
*
* s3://customer_bucket/some/prefix/relative/path/to/custdata-1
*
*
* s3://customer_bucket/some/prefix/relative/path/custdata-2
*
*
* ...
*
*
* s3://customer_bucket/some/prefix/relative/path/custdata-N
*
*
* The complete set of S3Uris in this manifest constitutes the input data for the channel for this
* datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon
* SageMaker uses to perform tasks on your behalf.
*
*
*
*
* @return Depending on the value specified for the S3DataType, identifies either a key name prefix or
* a manifest. For example:
*
* -
*
* A key name prefix might look like this: s3://bucketname/exampleprefix.
*
*
* -
*
* A manifest might look like this: s3://bucketname/example.manifest
*
*
* The manifest is an S3 object which is a JSON file with the following format:
*
*
* [ {"prefix": "s3://customer_bucket/some/prefix/"},
*
*
* "relative/path/to/custdata-1",
*
*
* "relative/path/custdata-2",
*
*
* ...
*
*
* "relative/path/custdata-N"
*
*
* ]
*
*
* The preceding JSON matches the following S3Uris:
*
*
* s3://customer_bucket/some/prefix/relative/path/to/custdata-1
*
*
* s3://customer_bucket/some/prefix/relative/path/custdata-2
*
*
* ...
*
*
* s3://customer_bucket/some/prefix/relative/path/custdata-N
*
*
* The complete set of S3Uris in this manifest constitutes the input data for the channel for
* this datasource. The object that each S3Uris points to must be readable by the IAM role that
* Amazon SageMaker uses to perform tasks on your behalf.
*
*
*/
public String getS3Uri() {
return this.s3Uri;
}
/**
*
* Depending on the value specified for the S3DataType, identifies either a key name prefix or a
* manifest. For example:
*
*
* -
*
* A key name prefix might look like this: s3://bucketname/exampleprefix.
*
*
* -
*
* A manifest might look like this: s3://bucketname/example.manifest
*
*
* The manifest is an S3 object which is a JSON file with the following format:
*
*
* [ {"prefix": "s3://customer_bucket/some/prefix/"},
*
*
* "relative/path/to/custdata-1",
*
*
* "relative/path/custdata-2",
*
*
* ...
*
*
* "relative/path/custdata-N"
*
*
* ]
*
*
* The preceding JSON matches the following S3Uris:
*
*
* s3://customer_bucket/some/prefix/relative/path/to/custdata-1
*
*
* s3://customer_bucket/some/prefix/relative/path/custdata-2
*
*
* ...
*
*
* s3://customer_bucket/some/prefix/relative/path/custdata-N
*
*
* The complete set of S3Uris in this manifest constitutes the input data for the channel for this
* datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon
* SageMaker uses to perform tasks on your behalf.
*
*
*
*
* @param s3Uri
* Depending on the value specified for the S3DataType, identifies either a key name prefix or a
* manifest. For example:
*
* -
*
* A key name prefix might look like this: s3://bucketname/exampleprefix.
*
*
* -
*
* A manifest might look like this: s3://bucketname/example.manifest
*
*
* The manifest is an S3 object which is a JSON file with the following format:
*
*
* [ {"prefix": "s3://customer_bucket/some/prefix/"},
*
*
* "relative/path/to/custdata-1",
*
*
* "relative/path/custdata-2",
*
*
* ...
*
*
* "relative/path/custdata-N"
*
*
* ]
*
*
* The preceding JSON matches the following S3Uris:
*
*
* s3://customer_bucket/some/prefix/relative/path/to/custdata-1
*
*
* s3://customer_bucket/some/prefix/relative/path/custdata-2
*
*
* ...
*
*
* s3://customer_bucket/some/prefix/relative/path/custdata-N
*
*
* The complete set of S3Uris in this manifest constitutes the input data for the channel for
* this datasource. The object that each S3Uris points to must be readable by the IAM role that
* Amazon SageMaker uses to perform tasks on your behalf.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TransformS3DataSource withS3Uri(String s3Uri) {
setS3Uri(s3Uri);
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 (getS3DataType() != null)
sb.append("S3DataType: ").append(getS3DataType()).append(",");
if (getS3Uri() != null)
sb.append("S3Uri: ").append(getS3Uri());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof TransformS3DataSource == false)
return false;
TransformS3DataSource other = (TransformS3DataSource) obj;
if (other.getS3DataType() == null ^ this.getS3DataType() == null)
return false;
if (other.getS3DataType() != null && other.getS3DataType().equals(this.getS3DataType()) == false)
return false;
if (other.getS3Uri() == null ^ this.getS3Uri() == null)
return false;
if (other.getS3Uri() != null && other.getS3Uri().equals(this.getS3Uri()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getS3DataType() == null) ? 0 : getS3DataType().hashCode());
hashCode = prime * hashCode + ((getS3Uri() == null) ? 0 : getS3Uri().hashCode());
return hashCode;
}
@Override
public TransformS3DataSource clone() {
try {
return (TransformS3DataSource) 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.sagemaker.model.transform.TransformS3DataSourceMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}