com.amazonaws.services.lookoutforvision.model.CreateDatasetRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-lookoutforvision Show documentation
/*
* Copyright 2018-2023 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.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateDatasetRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the project in which you want to create a dataset.
*
*/
private String projectName;
/**
*
* The type of the dataset. Specify train for a training dataset. Specify test for a test
* dataset.
*
*/
private String datasetType;
/**
*
* The location of the manifest file that Amazon Lookout for Vision uses to create the dataset.
*
*
* If you don't specify DatasetSource, an empty dataset is created and the operation synchronously
* returns. Later, you can add JSON Lines by calling UpdateDatasetEntries.
*
*
* If you specify a value for DataSource, the manifest at the S3 location is validated and used to
* create the dataset. The call to CreateDataset is asynchronous and might take a while to complete. To
* find out the current status, Check the value of Status returned in a call to DescribeDataset.
*
*/
private DatasetSource datasetSource;
/**
*
* ClientToken is an idempotency token that ensures a call to CreateDataset completes only once. You
* choose the value to pass. For example, An issue might prevent you from getting a response from
* CreateDataset. In this case, safely retry your call to CreateDataset by using the same
* ClientToken parameter value.
*
*
* If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This
* prevents retries after a network error from making multiple dataset creation requests. You'll need to provide
* your own value for other use cases.
*
*
* An error occurs if the other input parameters are not the same as in the first request. Using a different value
* for ClientToken is considered a new call to CreateDataset. An idempotency token is
* active for 8 hours.
*
*/
private String clientToken;
/**
*
* The name of the project in which you want to create a dataset.
*
*
* @param projectName
* The name of the project in which you want to create a dataset.
*/
public void setProjectName(String projectName) {
this.projectName = projectName;
}
/**
*
* The name of the project in which you want to create a dataset.
*
*
* @return The name of the project in which you want to create a dataset.
*/
public String getProjectName() {
return this.projectName;
}
/**
*
* The name of the project in which you want to create a dataset.
*
*
* @param projectName
* The name of the project in which you want to create a dataset.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDatasetRequest withProjectName(String projectName) {
setProjectName(projectName);
return this;
}
/**
*
* The type of the dataset. Specify train for a training dataset. Specify test for a test
* dataset.
*
*
* @param datasetType
* The type of the dataset. Specify train for a training dataset. Specify test for
* a test dataset.
*/
public void setDatasetType(String datasetType) {
this.datasetType = datasetType;
}
/**
*
* The type of the dataset. Specify train for a training dataset. Specify test for a test
* dataset.
*
*
* @return The type of the dataset. Specify train for a training dataset. Specify test for
* a test dataset.
*/
public String getDatasetType() {
return this.datasetType;
}
/**
*
* The type of the dataset. Specify train for a training dataset. Specify test for a test
* dataset.
*
*
* @param datasetType
* The type of the dataset. Specify train for a training dataset. Specify test for
* a test dataset.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDatasetRequest withDatasetType(String datasetType) {
setDatasetType(datasetType);
return this;
}
/**
*
* The location of the manifest file that Amazon Lookout for Vision uses to create the dataset.
*
*
* If you don't specify DatasetSource, an empty dataset is created and the operation synchronously
* returns. Later, you can add JSON Lines by calling UpdateDatasetEntries.
*
*
* If you specify a value for DataSource, the manifest at the S3 location is validated and used to
* create the dataset. The call to CreateDataset is asynchronous and might take a while to complete. To
* find out the current status, Check the value of Status returned in a call to DescribeDataset.
*
*
* @param datasetSource
* The location of the manifest file that Amazon Lookout for Vision uses to create the dataset.
*
* If you don't specify DatasetSource, an empty dataset is created and the operation
* synchronously returns. Later, you can add JSON Lines by calling UpdateDatasetEntries.
*
*
* If you specify a value for DataSource, the manifest at the S3 location is validated and used
* to create the dataset. The call to CreateDataset is asynchronous and might take a while to
* complete. To find out the current status, Check the value of Status returned in a call to
* DescribeDataset.
*/
public void setDatasetSource(DatasetSource datasetSource) {
this.datasetSource = datasetSource;
}
/**
*
* The location of the manifest file that Amazon Lookout for Vision uses to create the dataset.
*
*
* If you don't specify DatasetSource, an empty dataset is created and the operation synchronously
* returns. Later, you can add JSON Lines by calling UpdateDatasetEntries.
*
*
* If you specify a value for DataSource, the manifest at the S3 location is validated and used to
* create the dataset. The call to CreateDataset is asynchronous and might take a while to complete. To
* find out the current status, Check the value of Status returned in a call to DescribeDataset.
*
*
* @return The location of the manifest file that Amazon Lookout for Vision uses to create the dataset.
*
* If you don't specify DatasetSource, an empty dataset is created and the operation
* synchronously returns. Later, you can add JSON Lines by calling UpdateDatasetEntries.
*
*
* If you specify a value for DataSource, the manifest at the S3 location is validated and used
* to create the dataset. The call to CreateDataset is asynchronous and might take a while to
* complete. To find out the current status, Check the value of Status returned in a call to
* DescribeDataset.
*/
public DatasetSource getDatasetSource() {
return this.datasetSource;
}
/**
*
* The location of the manifest file that Amazon Lookout for Vision uses to create the dataset.
*
*
* If you don't specify DatasetSource, an empty dataset is created and the operation synchronously
* returns. Later, you can add JSON Lines by calling UpdateDatasetEntries.
*
*
* If you specify a value for DataSource, the manifest at the S3 location is validated and used to
* create the dataset. The call to CreateDataset is asynchronous and might take a while to complete. To
* find out the current status, Check the value of Status returned in a call to DescribeDataset.
*
*
* @param datasetSource
* The location of the manifest file that Amazon Lookout for Vision uses to create the dataset.
*
* If you don't specify DatasetSource, an empty dataset is created and the operation
* synchronously returns. Later, you can add JSON Lines by calling UpdateDatasetEntries.
*
*
* If you specify a value for DataSource, the manifest at the S3 location is validated and used
* to create the dataset. The call to CreateDataset is asynchronous and might take a while to
* complete. To find out the current status, Check the value of Status returned in a call to
* DescribeDataset.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDatasetRequest withDatasetSource(DatasetSource datasetSource) {
setDatasetSource(datasetSource);
return this;
}
/**
*
* ClientToken is an idempotency token that ensures a call to CreateDataset completes only once. You
* choose the value to pass. For example, An issue might prevent you from getting a response from
* CreateDataset. In this case, safely retry your call to CreateDataset by using the same
* ClientToken parameter value.
*
*
* If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This
* prevents retries after a network error from making multiple dataset creation requests. You'll need to provide
* your own value for other use cases.
*
*
* An error occurs if the other input parameters are not the same as in the first request. Using a different value
* for ClientToken is considered a new call to CreateDataset. An idempotency token is
* active for 8 hours.
*
*
* @param clientToken
* ClientToken is an idempotency token that ensures a call to CreateDataset completes only once.
* You choose the value to pass. For example, An issue might prevent you from getting a response from
* CreateDataset. In this case, safely retry your call to CreateDataset by using
* the same ClientToken parameter value.
*
* If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for
* you. This prevents retries after a network error from making multiple dataset creation requests. You'll
* need to provide your own value for other use cases.
*
*
* An error occurs if the other input parameters are not the same as in the first request. Using a different
* value for ClientToken is considered a new call to CreateDataset. An idempotency
* token is active for 8 hours.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* ClientToken is an idempotency token that ensures a call to CreateDataset completes only once. You
* choose the value to pass. For example, An issue might prevent you from getting a response from
* CreateDataset. In this case, safely retry your call to CreateDataset by using the same
* ClientToken parameter value.
*
*
* If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This
* prevents retries after a network error from making multiple dataset creation requests. You'll need to provide
* your own value for other use cases.
*
*
* An error occurs if the other input parameters are not the same as in the first request. Using a different value
* for ClientToken is considered a new call to CreateDataset. An idempotency token is
* active for 8 hours.
*
*
* @return ClientToken is an idempotency token that ensures a call to CreateDataset completes only
* once. You choose the value to pass. For example, An issue might prevent you from getting a response from
* CreateDataset. In this case, safely retry your call to CreateDataset by using
* the same ClientToken parameter value.
*
* If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for
* you. This prevents retries after a network error from making multiple dataset creation requests. You'll
* need to provide your own value for other use cases.
*
*
* An error occurs if the other input parameters are not the same as in the first request. Using a different
* value for ClientToken is considered a new call to CreateDataset. An idempotency
* token is active for 8 hours.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* ClientToken is an idempotency token that ensures a call to CreateDataset completes only once. You
* choose the value to pass. For example, An issue might prevent you from getting a response from
* CreateDataset. In this case, safely retry your call to CreateDataset by using the same
* ClientToken parameter value.
*
*
* If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This
* prevents retries after a network error from making multiple dataset creation requests. You'll need to provide
* your own value for other use cases.
*
*
* An error occurs if the other input parameters are not the same as in the first request. Using a different value
* for ClientToken is considered a new call to CreateDataset. An idempotency token is
* active for 8 hours.
*
*
* @param clientToken
* ClientToken is an idempotency token that ensures a call to CreateDataset completes only once.
* You choose the value to pass. For example, An issue might prevent you from getting a response from
* CreateDataset. In this case, safely retry your call to CreateDataset by using
* the same ClientToken parameter value.
*
* If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for
* you. This prevents retries after a network error from making multiple dataset creation requests. You'll
* need to provide your own value for other use cases.
*
*
* An error occurs if the other input parameters are not the same as in the first request. Using a different
* value for ClientToken is considered a new call to CreateDataset. An idempotency
* token is active for 8 hours.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDatasetRequest withClientToken(String clientToken) {
setClientToken(clientToken);
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 (getProjectName() != null)
sb.append("ProjectName: ").append(getProjectName()).append(",");
if (getDatasetType() != null)
sb.append("DatasetType: ").append(getDatasetType()).append(",");
if (getDatasetSource() != null)
sb.append("DatasetSource: ").append(getDatasetSource()).append(",");
if (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateDatasetRequest == false)
return false;
CreateDatasetRequest other = (CreateDatasetRequest) obj;
if (other.getProjectName() == null ^ this.getProjectName() == null)
return false;
if (other.getProjectName() != null && other.getProjectName().equals(this.getProjectName()) == false)
return false;
if (other.getDatasetType() == null ^ this.getDatasetType() == null)
return false;
if (other.getDatasetType() != null && other.getDatasetType().equals(this.getDatasetType()) == false)
return false;
if (other.getDatasetSource() == null ^ this.getDatasetSource() == null)
return false;
if (other.getDatasetSource() != null && other.getDatasetSource().equals(this.getDatasetSource()) == false)
return false;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getProjectName() == null) ? 0 : getProjectName().hashCode());
hashCode = prime * hashCode + ((getDatasetType() == null) ? 0 : getDatasetType().hashCode());
hashCode = prime * hashCode + ((getDatasetSource() == null) ? 0 : getDatasetSource().hashCode());
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
return hashCode;
}
@Override
public CreateDatasetRequest clone() {
return (CreateDatasetRequest) super.clone();
}
}