com.amazonaws.services.sagemaker.model.ProcessingS3Output Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sagemaker 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.sagemaker.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Configuration for uploading output data to Amazon S3 from the processing container.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ProcessingS3Output implements Serializable, Cloneable, StructuredPojo {
/**
*
* A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing
* job.
*
*/
private String s3Uri;
/**
*
* The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3.
* LocalPath is an absolute path to a directory containing output files. This directory will be created
* by the platform and exist when your container's entrypoint is invoked.
*
*/
private String localPath;
/**
*
* Whether to upload the results of the processing job continuously or after the job completes.
*
*/
private String s3UploadMode;
/**
*
* A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing
* job.
*
*
* @param s3Uri
* A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a
* processing job.
*/
public void setS3Uri(String s3Uri) {
this.s3Uri = s3Uri;
}
/**
*
* A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing
* job.
*
*
* @return A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a
* processing job.
*/
public String getS3Uri() {
return this.s3Uri;
}
/**
*
* A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing
* job.
*
*
* @param s3Uri
* A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a
* processing job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ProcessingS3Output withS3Uri(String s3Uri) {
setS3Uri(s3Uri);
return this;
}
/**
*
* The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3.
* LocalPath is an absolute path to a directory containing output files. This directory will be created
* by the platform and exist when your container's entrypoint is invoked.
*
*
* @param localPath
* The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3.
* LocalPath is an absolute path to a directory containing output files. This directory will be
* created by the platform and exist when your container's entrypoint is invoked.
*/
public void setLocalPath(String localPath) {
this.localPath = localPath;
}
/**
*
* The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3.
* LocalPath is an absolute path to a directory containing output files. This directory will be created
* by the platform and exist when your container's entrypoint is invoked.
*
*
* @return The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3.
* LocalPath is an absolute path to a directory containing output files. This directory will be
* created by the platform and exist when your container's entrypoint is invoked.
*/
public String getLocalPath() {
return this.localPath;
}
/**
*
* The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3.
* LocalPath is an absolute path to a directory containing output files. This directory will be created
* by the platform and exist when your container's entrypoint is invoked.
*
*
* @param localPath
* The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3.
* LocalPath is an absolute path to a directory containing output files. This directory will be
* created by the platform and exist when your container's entrypoint is invoked.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ProcessingS3Output withLocalPath(String localPath) {
setLocalPath(localPath);
return this;
}
/**
*
* Whether to upload the results of the processing job continuously or after the job completes.
*
*
* @param s3UploadMode
* Whether to upload the results of the processing job continuously or after the job completes.
* @see ProcessingS3UploadMode
*/
public void setS3UploadMode(String s3UploadMode) {
this.s3UploadMode = s3UploadMode;
}
/**
*
* Whether to upload the results of the processing job continuously or after the job completes.
*
*
* @return Whether to upload the results of the processing job continuously or after the job completes.
* @see ProcessingS3UploadMode
*/
public String getS3UploadMode() {
return this.s3UploadMode;
}
/**
*
* Whether to upload the results of the processing job continuously or after the job completes.
*
*
* @param s3UploadMode
* Whether to upload the results of the processing job continuously or after the job completes.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ProcessingS3UploadMode
*/
public ProcessingS3Output withS3UploadMode(String s3UploadMode) {
setS3UploadMode(s3UploadMode);
return this;
}
/**
*
* Whether to upload the results of the processing job continuously or after the job completes.
*
*
* @param s3UploadMode
* Whether to upload the results of the processing job continuously or after the job completes.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ProcessingS3UploadMode
*/
public ProcessingS3Output withS3UploadMode(ProcessingS3UploadMode s3UploadMode) {
this.s3UploadMode = s3UploadMode.toString();
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 (getLocalPath() != null)
sb.append("LocalPath: ").append(getLocalPath()).append(",");
if (getS3UploadMode() != null)
sb.append("S3UploadMode: ").append(getS3UploadMode());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ProcessingS3Output == false)
return false;
ProcessingS3Output other = (ProcessingS3Output) obj;
if (other.getS3Uri() == null ^ this.getS3Uri() == null)
return false;
if (other.getS3Uri() != null && other.getS3Uri().equals(this.getS3Uri()) == false)
return false;
if (other.getLocalPath() == null ^ this.getLocalPath() == null)
return false;
if (other.getLocalPath() != null && other.getLocalPath().equals(this.getLocalPath()) == false)
return false;
if (other.getS3UploadMode() == null ^ this.getS3UploadMode() == null)
return false;
if (other.getS3UploadMode() != null && other.getS3UploadMode().equals(this.getS3UploadMode()) == 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 + ((getLocalPath() == null) ? 0 : getLocalPath().hashCode());
hashCode = prime * hashCode + ((getS3UploadMode() == null) ? 0 : getS3UploadMode().hashCode());
return hashCode;
}
@Override
public ProcessingS3Output clone() {
try {
return (ProcessingS3Output) 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.ProcessingS3OutputMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}