com.amazonaws.services.lookoutforvision.model.UpdateDatasetEntriesRequest Maven / Gradle / Ivy
/*
* 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.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class UpdateDatasetEntriesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the project that contains the dataset that you want to update.
*
*/
private String projectName;
/**
*
* The type of the dataset that you want to update. Specify train to update the training dataset.
* Specify test to update the test dataset. If you have a single dataset project, specify
* train.
*
*/
private String datasetType;
/**
*
* The entries to add to the dataset.
*
*/
private java.nio.ByteBuffer changes;
/**
*
* ClientToken is an idempotency token that ensures a call to UpdateDatasetEntries completes only once.
* You choose the value to pass. For example, An issue might prevent you from getting a response from
* UpdateDatasetEntries. In this case, safely retry your call to UpdateDatasetEntries 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 updates with the same dataset entries. 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 UpdateDatasetEntries. An idempotency token
* is active for 8 hours.
*
*/
private String clientToken;
/**
*
* The name of the project that contains the dataset that you want to update.
*
*
* @param projectName
* The name of the project that contains the dataset that you want to update.
*/
public void setProjectName(String projectName) {
this.projectName = projectName;
}
/**
*
* The name of the project that contains the dataset that you want to update.
*
*
* @return The name of the project that contains the dataset that you want to update.
*/
public String getProjectName() {
return this.projectName;
}
/**
*
* The name of the project that contains the dataset that you want to update.
*
*
* @param projectName
* The name of the project that contains the dataset that you want to update.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateDatasetEntriesRequest withProjectName(String projectName) {
setProjectName(projectName);
return this;
}
/**
*
* The type of the dataset that you want to update. Specify train to update the training dataset.
* Specify test to update the test dataset. If you have a single dataset project, specify
* train.
*
*
* @param datasetType
* The type of the dataset that you want to update. Specify train to update the training
* dataset. Specify test to update the test dataset. If you have a single dataset project,
* specify train.
*/
public void setDatasetType(String datasetType) {
this.datasetType = datasetType;
}
/**
*
* The type of the dataset that you want to update. Specify train to update the training dataset.
* Specify test to update the test dataset. If you have a single dataset project, specify
* train.
*
*
* @return The type of the dataset that you want to update. Specify train to update the training
* dataset. Specify test to update the test dataset. If you have a single dataset project,
* specify train.
*/
public String getDatasetType() {
return this.datasetType;
}
/**
*
* The type of the dataset that you want to update. Specify train to update the training dataset.
* Specify test to update the test dataset. If you have a single dataset project, specify
* train.
*
*
* @param datasetType
* The type of the dataset that you want to update. Specify train to update the training
* dataset. Specify test to update the test dataset. If you have a single dataset project,
* specify train.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateDatasetEntriesRequest withDatasetType(String datasetType) {
setDatasetType(datasetType);
return this;
}
/**
*
* The entries to add to the dataset.
*
*
* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service.
* Users of the SDK should not perform Base64 encoding on this field.
*
*
* Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will
* be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or
* ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future
* major version of the SDK.
*
*
* @param changes
* The entries to add to the dataset.
*/
public void setChanges(java.nio.ByteBuffer changes) {
this.changes = changes;
}
/**
*
* The entries to add to the dataset.
*
*
* {@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend
* using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent
* {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}.
* Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the
* {@code position}.
*
*
* @return The entries to add to the dataset.
*/
public java.nio.ByteBuffer getChanges() {
return this.changes;
}
/**
*
* The entries to add to the dataset.
*
*
* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service.
* Users of the SDK should not perform Base64 encoding on this field.
*
*
* Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will
* be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or
* ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future
* major version of the SDK.
*
*
* @param changes
* The entries to add to the dataset.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateDatasetEntriesRequest withChanges(java.nio.ByteBuffer changes) {
setChanges(changes);
return this;
}
/**
*
* ClientToken is an idempotency token that ensures a call to UpdateDatasetEntries completes only once.
* You choose the value to pass. For example, An issue might prevent you from getting a response from
* UpdateDatasetEntries. In this case, safely retry your call to UpdateDatasetEntries 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 updates with the same dataset entries. 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 UpdateDatasetEntries. An idempotency token
* is active for 8 hours.
*
*
* @param clientToken
* ClientToken is an idempotency token that ensures a call to UpdateDatasetEntries completes
* only once. You choose the value to pass. For example, An issue might prevent you from getting a response
* from UpdateDatasetEntries. In this case, safely retry your call to
* UpdateDatasetEntries 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 updates with the same dataset
* entries. 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 UpdateDatasetEntries. 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 UpdateDatasetEntries completes only once.
* You choose the value to pass. For example, An issue might prevent you from getting a response from
* UpdateDatasetEntries. In this case, safely retry your call to UpdateDatasetEntries 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 updates with the same dataset entries. 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 UpdateDatasetEntries. An idempotency token
* is active for 8 hours.
*
*
* @return ClientToken is an idempotency token that ensures a call to UpdateDatasetEntries completes
* only once. You choose the value to pass. For example, An issue might prevent you from getting a response
* from UpdateDatasetEntries. In this case, safely retry your call to
* UpdateDatasetEntries 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 updates with the same dataset
* entries. 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 UpdateDatasetEntries. An
* idempotency token is active for 8 hours.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* ClientToken is an idempotency token that ensures a call to UpdateDatasetEntries completes only once.
* You choose the value to pass. For example, An issue might prevent you from getting a response from
* UpdateDatasetEntries. In this case, safely retry your call to UpdateDatasetEntries 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 updates with the same dataset entries. 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 UpdateDatasetEntries. An idempotency token
* is active for 8 hours.
*
*
* @param clientToken
* ClientToken is an idempotency token that ensures a call to UpdateDatasetEntries completes
* only once. You choose the value to pass. For example, An issue might prevent you from getting a response
* from UpdateDatasetEntries. In this case, safely retry your call to
* UpdateDatasetEntries 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 updates with the same dataset
* entries. 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 UpdateDatasetEntries. An
* idempotency token is active for 8 hours.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateDatasetEntriesRequest 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 (getChanges() != null)
sb.append("Changes: ").append(getChanges()).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 UpdateDatasetEntriesRequest == false)
return false;
UpdateDatasetEntriesRequest other = (UpdateDatasetEntriesRequest) 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.getChanges() == null ^ this.getChanges() == null)
return false;
if (other.getChanges() != null && other.getChanges().equals(this.getChanges()) == 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 + ((getChanges() == null) ? 0 : getChanges().hashCode());
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
return hashCode;
}
@Override
public UpdateDatasetEntriesRequest clone() {
return (UpdateDatasetEntriesRequest) super.clone();
}
}