com.amazonaws.services.sagemaker.model.DescribeModelResult Maven / Gradle / Ivy
/*
* Copyright 2015-2020 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;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeModelResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* Name of the Amazon SageMaker model.
*
*/
private String modelName;
/**
*
* The location of the primary inference code, associated artifacts, and custom environment map that the inference
* code uses when it is deployed in production.
*
*/
private ContainerDefinition primaryContainer;
/**
*
* The containers in the inference pipeline.
*
*/
private java.util.List containers;
/**
*
* The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
*
*/
private String executionRoleArn;
/**
*
* A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual
* Private Cloud
*
*/
private VpcConfig vpcConfig;
/**
*
* A timestamp that shows when the model was created.
*
*/
private java.util.Date creationTime;
/**
*
* The Amazon Resource Name (ARN) of the model.
*
*/
private String modelArn;
/**
*
* If True, no inbound or outbound network calls can be made to or from the model container.
*
*/
private Boolean enableNetworkIsolation;
/**
*
* Name of the Amazon SageMaker model.
*
*
* @param modelName
* Name of the Amazon SageMaker model.
*/
public void setModelName(String modelName) {
this.modelName = modelName;
}
/**
*
* Name of the Amazon SageMaker model.
*
*
* @return Name of the Amazon SageMaker model.
*/
public String getModelName() {
return this.modelName;
}
/**
*
* Name of the Amazon SageMaker model.
*
*
* @param modelName
* Name of the Amazon SageMaker model.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeModelResult withModelName(String modelName) {
setModelName(modelName);
return this;
}
/**
*
* The location of the primary inference code, associated artifacts, and custom environment map that the inference
* code uses when it is deployed in production.
*
*
* @param primaryContainer
* The location of the primary inference code, associated artifacts, and custom environment map that the
* inference code uses when it is deployed in production.
*/
public void setPrimaryContainer(ContainerDefinition primaryContainer) {
this.primaryContainer = primaryContainer;
}
/**
*
* The location of the primary inference code, associated artifacts, and custom environment map that the inference
* code uses when it is deployed in production.
*
*
* @return The location of the primary inference code, associated artifacts, and custom environment map that the
* inference code uses when it is deployed in production.
*/
public ContainerDefinition getPrimaryContainer() {
return this.primaryContainer;
}
/**
*
* The location of the primary inference code, associated artifacts, and custom environment map that the inference
* code uses when it is deployed in production.
*
*
* @param primaryContainer
* The location of the primary inference code, associated artifacts, and custom environment map that the
* inference code uses when it is deployed in production.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeModelResult withPrimaryContainer(ContainerDefinition primaryContainer) {
setPrimaryContainer(primaryContainer);
return this;
}
/**
*
* The containers in the inference pipeline.
*
*
* @return The containers in the inference pipeline.
*/
public java.util.List getContainers() {
return containers;
}
/**
*
* The containers in the inference pipeline.
*
*
* @param containers
* The containers in the inference pipeline.
*/
public void setContainers(java.util.Collection containers) {
if (containers == null) {
this.containers = null;
return;
}
this.containers = new java.util.ArrayList(containers);
}
/**
*
* The containers in the inference pipeline.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setContainers(java.util.Collection)} or {@link #withContainers(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param containers
* The containers in the inference pipeline.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeModelResult withContainers(ContainerDefinition... containers) {
if (this.containers == null) {
setContainers(new java.util.ArrayList(containers.length));
}
for (ContainerDefinition ele : containers) {
this.containers.add(ele);
}
return this;
}
/**
*
* The containers in the inference pipeline.
*
*
* @param containers
* The containers in the inference pipeline.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeModelResult withContainers(java.util.Collection containers) {
setContainers(containers);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
*
*
* @param executionRoleArn
* The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
*/
public void setExecutionRoleArn(String executionRoleArn) {
this.executionRoleArn = executionRoleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
*
*
* @return The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
*/
public String getExecutionRoleArn() {
return this.executionRoleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
*
*
* @param executionRoleArn
* The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeModelResult withExecutionRoleArn(String executionRoleArn) {
setExecutionRoleArn(executionRoleArn);
return this;
}
/**
*
* A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual
* Private Cloud
*
*
* @param vpcConfig
* A VpcConfig object that specifies the VPC that this model has access to. For more information, see
* Protect Endpoints by Using an
* Amazon Virtual Private Cloud
*/
public void setVpcConfig(VpcConfig vpcConfig) {
this.vpcConfig = vpcConfig;
}
/**
*
* A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual
* Private Cloud
*
*
* @return A VpcConfig object that specifies the VPC that this model has access to. For more information, see
* Protect Endpoints by Using an
* Amazon Virtual Private Cloud
*/
public VpcConfig getVpcConfig() {
return this.vpcConfig;
}
/**
*
* A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual
* Private Cloud
*
*
* @param vpcConfig
* A VpcConfig object that specifies the VPC that this model has access to. For more information, see
* Protect Endpoints by Using an
* Amazon Virtual Private Cloud
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeModelResult withVpcConfig(VpcConfig vpcConfig) {
setVpcConfig(vpcConfig);
return this;
}
/**
*
* A timestamp that shows when the model was created.
*
*
* @param creationTime
* A timestamp that shows when the model was created.
*/
public void setCreationTime(java.util.Date creationTime) {
this.creationTime = creationTime;
}
/**
*
* A timestamp that shows when the model was created.
*
*
* @return A timestamp that shows when the model was created.
*/
public java.util.Date getCreationTime() {
return this.creationTime;
}
/**
*
* A timestamp that shows when the model was created.
*
*
* @param creationTime
* A timestamp that shows when the model was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeModelResult withCreationTime(java.util.Date creationTime) {
setCreationTime(creationTime);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the model.
*
*
* @param modelArn
* The Amazon Resource Name (ARN) of the model.
*/
public void setModelArn(String modelArn) {
this.modelArn = modelArn;
}
/**
*
* The Amazon Resource Name (ARN) of the model.
*
*
* @return The Amazon Resource Name (ARN) of the model.
*/
public String getModelArn() {
return this.modelArn;
}
/**
*
* The Amazon Resource Name (ARN) of the model.
*
*
* @param modelArn
* The Amazon Resource Name (ARN) of the model.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeModelResult withModelArn(String modelArn) {
setModelArn(modelArn);
return this;
}
/**
*
* If True, no inbound or outbound network calls can be made to or from the model container.
*
*
* @param enableNetworkIsolation
* If True, no inbound or outbound network calls can be made to or from the model container.
*/
public void setEnableNetworkIsolation(Boolean enableNetworkIsolation) {
this.enableNetworkIsolation = enableNetworkIsolation;
}
/**
*
* If True, no inbound or outbound network calls can be made to or from the model container.
*
*
* @return If True, no inbound or outbound network calls can be made to or from the model container.
*/
public Boolean getEnableNetworkIsolation() {
return this.enableNetworkIsolation;
}
/**
*
* If True, no inbound or outbound network calls can be made to or from the model container.
*
*
* @param enableNetworkIsolation
* If True, no inbound or outbound network calls can be made to or from the model container.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeModelResult withEnableNetworkIsolation(Boolean enableNetworkIsolation) {
setEnableNetworkIsolation(enableNetworkIsolation);
return this;
}
/**
*
* If True, no inbound or outbound network calls can be made to or from the model container.
*
*
* @return If True, no inbound or outbound network calls can be made to or from the model container.
*/
public Boolean isEnableNetworkIsolation() {
return this.enableNetworkIsolation;
}
/**
* 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 (getModelName() != null)
sb.append("ModelName: ").append(getModelName()).append(",");
if (getPrimaryContainer() != null)
sb.append("PrimaryContainer: ").append(getPrimaryContainer()).append(",");
if (getContainers() != null)
sb.append("Containers: ").append(getContainers()).append(",");
if (getExecutionRoleArn() != null)
sb.append("ExecutionRoleArn: ").append(getExecutionRoleArn()).append(",");
if (getVpcConfig() != null)
sb.append("VpcConfig: ").append(getVpcConfig()).append(",");
if (getCreationTime() != null)
sb.append("CreationTime: ").append(getCreationTime()).append(",");
if (getModelArn() != null)
sb.append("ModelArn: ").append(getModelArn()).append(",");
if (getEnableNetworkIsolation() != null)
sb.append("EnableNetworkIsolation: ").append(getEnableNetworkIsolation());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeModelResult == false)
return false;
DescribeModelResult other = (DescribeModelResult) obj;
if (other.getModelName() == null ^ this.getModelName() == null)
return false;
if (other.getModelName() != null && other.getModelName().equals(this.getModelName()) == false)
return false;
if (other.getPrimaryContainer() == null ^ this.getPrimaryContainer() == null)
return false;
if (other.getPrimaryContainer() != null && other.getPrimaryContainer().equals(this.getPrimaryContainer()) == false)
return false;
if (other.getContainers() == null ^ this.getContainers() == null)
return false;
if (other.getContainers() != null && other.getContainers().equals(this.getContainers()) == false)
return false;
if (other.getExecutionRoleArn() == null ^ this.getExecutionRoleArn() == null)
return false;
if (other.getExecutionRoleArn() != null && other.getExecutionRoleArn().equals(this.getExecutionRoleArn()) == false)
return false;
if (other.getVpcConfig() == null ^ this.getVpcConfig() == null)
return false;
if (other.getVpcConfig() != null && other.getVpcConfig().equals(this.getVpcConfig()) == false)
return false;
if (other.getCreationTime() == null ^ this.getCreationTime() == null)
return false;
if (other.getCreationTime() != null && other.getCreationTime().equals(this.getCreationTime()) == false)
return false;
if (other.getModelArn() == null ^ this.getModelArn() == null)
return false;
if (other.getModelArn() != null && other.getModelArn().equals(this.getModelArn()) == false)
return false;
if (other.getEnableNetworkIsolation() == null ^ this.getEnableNetworkIsolation() == null)
return false;
if (other.getEnableNetworkIsolation() != null && other.getEnableNetworkIsolation().equals(this.getEnableNetworkIsolation()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getModelName() == null) ? 0 : getModelName().hashCode());
hashCode = prime * hashCode + ((getPrimaryContainer() == null) ? 0 : getPrimaryContainer().hashCode());
hashCode = prime * hashCode + ((getContainers() == null) ? 0 : getContainers().hashCode());
hashCode = prime * hashCode + ((getExecutionRoleArn() == null) ? 0 : getExecutionRoleArn().hashCode());
hashCode = prime * hashCode + ((getVpcConfig() == null) ? 0 : getVpcConfig().hashCode());
hashCode = prime * hashCode + ((getCreationTime() == null) ? 0 : getCreationTime().hashCode());
hashCode = prime * hashCode + ((getModelArn() == null) ? 0 : getModelArn().hashCode());
hashCode = prime * hashCode + ((getEnableNetworkIsolation() == null) ? 0 : getEnableNetworkIsolation().hashCode());
return hashCode;
}
@Override
public DescribeModelResult clone() {
try {
return (DescribeModelResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}