com.amazonaws.services.sagemaker.model.CreateImageRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-sagemaker Show documentation
Show all versions of aws-java-sdk-sagemaker Show documentation
The AWS Java SDK for Amazon SageMaker module holds the client classes that are used for communicating with Amazon SageMaker Service
/*
* 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.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateImageRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The description of the image.
*
*/
private String description;
/**
*
* The display name of the image. If not provided, ImageName is displayed.
*
*/
private String displayName;
/**
*
* The name of the image. Must be unique to your account.
*
*/
private String imageName;
/**
*
* The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
*
*/
private String roleArn;
/**
*
* A list of tags to apply to the image.
*
*/
private java.util.List tags;
/**
*
* The description of the image.
*
*
* @param description
* The description of the image.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The description of the image.
*
*
* @return The description of the image.
*/
public String getDescription() {
return this.description;
}
/**
*
* The description of the image.
*
*
* @param description
* The description of the image.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateImageRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The display name of the image. If not provided, ImageName is displayed.
*
*
* @param displayName
* The display name of the image. If not provided, ImageName is displayed.
*/
public void setDisplayName(String displayName) {
this.displayName = displayName;
}
/**
*
* The display name of the image. If not provided, ImageName is displayed.
*
*
* @return The display name of the image. If not provided, ImageName is displayed.
*/
public String getDisplayName() {
return this.displayName;
}
/**
*
* The display name of the image. If not provided, ImageName is displayed.
*
*
* @param displayName
* The display name of the image. If not provided, ImageName is displayed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateImageRequest withDisplayName(String displayName) {
setDisplayName(displayName);
return this;
}
/**
*
* The name of the image. Must be unique to your account.
*
*
* @param imageName
* The name of the image. Must be unique to your account.
*/
public void setImageName(String imageName) {
this.imageName = imageName;
}
/**
*
* The name of the image. Must be unique to your account.
*
*
* @return The name of the image. Must be unique to your account.
*/
public String getImageName() {
return this.imageName;
}
/**
*
* The name of the image. Must be unique to your account.
*
*
* @param imageName
* The name of the image. Must be unique to your account.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateImageRequest withImageName(String imageName) {
setImageName(imageName);
return this;
}
/**
*
* The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
*
*
* @param roleArn
* The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
*/
public void setRoleArn(String roleArn) {
this.roleArn = roleArn;
}
/**
*
* The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
*
*
* @return The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
*/
public String getRoleArn() {
return this.roleArn;
}
/**
*
* The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
*
*
* @param roleArn
* The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateImageRequest withRoleArn(String roleArn) {
setRoleArn(roleArn);
return this;
}
/**
*
* A list of tags to apply to the image.
*
*
* @return A list of tags to apply to the image.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* A list of tags to apply to the image.
*
*
* @param tags
* A list of tags to apply to the image.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* A list of tags to apply to the image.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* A list of tags to apply to the image.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateImageRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* A list of tags to apply to the image.
*
*
* @param tags
* A list of tags to apply to the image.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateImageRequest withTags(java.util.Collection tags) {
setTags(tags);
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 (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getDisplayName() != null)
sb.append("DisplayName: ").append(getDisplayName()).append(",");
if (getImageName() != null)
sb.append("ImageName: ").append(getImageName()).append(",");
if (getRoleArn() != null)
sb.append("RoleArn: ").append(getRoleArn()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateImageRequest == false)
return false;
CreateImageRequest other = (CreateImageRequest) obj;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getDisplayName() == null ^ this.getDisplayName() == null)
return false;
if (other.getDisplayName() != null && other.getDisplayName().equals(this.getDisplayName()) == false)
return false;
if (other.getImageName() == null ^ this.getImageName() == null)
return false;
if (other.getImageName() != null && other.getImageName().equals(this.getImageName()) == false)
return false;
if (other.getRoleArn() == null ^ this.getRoleArn() == null)
return false;
if (other.getRoleArn() != null && other.getRoleArn().equals(this.getRoleArn()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getDisplayName() == null) ? 0 : getDisplayName().hashCode());
hashCode = prime * hashCode + ((getImageName() == null) ? 0 : getImageName().hashCode());
hashCode = prime * hashCode + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateImageRequest clone() {
return (CreateImageRequest) super.clone();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy