com.amazonaws.services.lookoutforvision.model.S3Location Maven / Gradle / Ivy
Show all versions of aws-java-sdk-lookoutforvision 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.lookoutforvision.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Information about the location of training output or the output of a model packaging job.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class S3Location implements Serializable, Cloneable, StructuredPojo {
/**
*
* The S3 bucket that contains the training or model packaging job output. If you are training a model, the bucket
* must in your AWS account. If you use an S3 bucket for a model packaging job, the S3 bucket must be in the same
* AWS Region and AWS account in which you use AWS IoT Greengrass.
*
*/
private String bucket;
/**
*
* The path of the folder, within the S3 bucket, that contains the output.
*
*/
private String prefix;
/**
*
* The S3 bucket that contains the training or model packaging job output. If you are training a model, the bucket
* must in your AWS account. If you use an S3 bucket for a model packaging job, the S3 bucket must be in the same
* AWS Region and AWS account in which you use AWS IoT Greengrass.
*
*
* @param bucket
* The S3 bucket that contains the training or model packaging job output. If you are training a model, the
* bucket must in your AWS account. If you use an S3 bucket for a model packaging job, the S3 bucket must be
* in the same AWS Region and AWS account in which you use AWS IoT Greengrass.
*/
public void setBucket(String bucket) {
this.bucket = bucket;
}
/**
*
* The S3 bucket that contains the training or model packaging job output. If you are training a model, the bucket
* must in your AWS account. If you use an S3 bucket for a model packaging job, the S3 bucket must be in the same
* AWS Region and AWS account in which you use AWS IoT Greengrass.
*
*
* @return The S3 bucket that contains the training or model packaging job output. If you are training a model, the
* bucket must in your AWS account. If you use an S3 bucket for a model packaging job, the S3 bucket must be
* in the same AWS Region and AWS account in which you use AWS IoT Greengrass.
*/
public String getBucket() {
return this.bucket;
}
/**
*
* The S3 bucket that contains the training or model packaging job output. If you are training a model, the bucket
* must in your AWS account. If you use an S3 bucket for a model packaging job, the S3 bucket must be in the same
* AWS Region and AWS account in which you use AWS IoT Greengrass.
*
*
* @param bucket
* The S3 bucket that contains the training or model packaging job output. If you are training a model, the
* bucket must in your AWS account. If you use an S3 bucket for a model packaging job, the S3 bucket must be
* in the same AWS Region and AWS account in which you use AWS IoT Greengrass.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public S3Location withBucket(String bucket) {
setBucket(bucket);
return this;
}
/**
*
* The path of the folder, within the S3 bucket, that contains the output.
*
*
* @param prefix
* The path of the folder, within the S3 bucket, that contains the output.
*/
public void setPrefix(String prefix) {
this.prefix = prefix;
}
/**
*
* The path of the folder, within the S3 bucket, that contains the output.
*
*
* @return The path of the folder, within the S3 bucket, that contains the output.
*/
public String getPrefix() {
return this.prefix;
}
/**
*
* The path of the folder, within the S3 bucket, that contains the output.
*
*
* @param prefix
* The path of the folder, within the S3 bucket, that contains the output.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public S3Location withPrefix(String prefix) {
setPrefix(prefix);
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 (getBucket() != null)
sb.append("Bucket: ").append(getBucket()).append(",");
if (getPrefix() != null)
sb.append("Prefix: ").append(getPrefix());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof S3Location == false)
return false;
S3Location other = (S3Location) obj;
if (other.getBucket() == null ^ this.getBucket() == null)
return false;
if (other.getBucket() != null && other.getBucket().equals(this.getBucket()) == false)
return false;
if (other.getPrefix() == null ^ this.getPrefix() == null)
return false;
if (other.getPrefix() != null && other.getPrefix().equals(this.getPrefix()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getBucket() == null) ? 0 : getBucket().hashCode());
hashCode = prime * hashCode + ((getPrefix() == null) ? 0 : getPrefix().hashCode());
return hashCode;
}
@Override
public S3Location clone() {
try {
return (S3Location) 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.lookoutforvision.model.transform.S3LocationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}