
com.amazonaws.services.sagemaker.model.CreateModelExplainabilityJobDefinitionRequest 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;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateModelExplainabilityJobDefinitionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the model explainability job definition. The name must be unique within an AWS Region in the AWS
* account.
*
*/
private String jobDefinitionName;
/**
*
* The baseline configuration for a model explainability job.
*
*/
private ModelExplainabilityBaselineConfig modelExplainabilityBaselineConfig;
/**
*
* Configures the model explainability job to run a specified Docker container image.
*
*/
private ModelExplainabilityAppSpecification modelExplainabilityAppSpecification;
/**
*
* Inputs for the model explainability job.
*
*/
private ModelExplainabilityJobInput modelExplainabilityJobInput;
private MonitoringOutputConfig modelExplainabilityJobOutputConfig;
private MonitoringResources jobResources;
/**
*
* Networking options for a model explainability job.
*
*/
private MonitoringNetworkConfig networkConfig;
/**
*
* The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
*
*/
private String roleArn;
private MonitoringStoppingCondition stoppingCondition;
/**
*
* (Optional) An array of key-value pairs. For more information, see Using
* Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
*
*/
private java.util.List tags;
/**
*
* The name of the model explainability job definition. The name must be unique within an AWS Region in the AWS
* account.
*
*
* @param jobDefinitionName
* The name of the model explainability job definition. The name must be unique within an AWS Region in the
* AWS account.
*/
public void setJobDefinitionName(String jobDefinitionName) {
this.jobDefinitionName = jobDefinitionName;
}
/**
*
* The name of the model explainability job definition. The name must be unique within an AWS Region in the AWS
* account.
*
*
* @return The name of the model explainability job definition. The name must be unique within an AWS Region in the
* AWS account.
*/
public String getJobDefinitionName() {
return this.jobDefinitionName;
}
/**
*
* The name of the model explainability job definition. The name must be unique within an AWS Region in the AWS
* account.
*
*
* @param jobDefinitionName
* The name of the model explainability job definition. The name must be unique within an AWS Region in the
* AWS account.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateModelExplainabilityJobDefinitionRequest withJobDefinitionName(String jobDefinitionName) {
setJobDefinitionName(jobDefinitionName);
return this;
}
/**
*
* The baseline configuration for a model explainability job.
*
*
* @param modelExplainabilityBaselineConfig
* The baseline configuration for a model explainability job.
*/
public void setModelExplainabilityBaselineConfig(ModelExplainabilityBaselineConfig modelExplainabilityBaselineConfig) {
this.modelExplainabilityBaselineConfig = modelExplainabilityBaselineConfig;
}
/**
*
* The baseline configuration for a model explainability job.
*
*
* @return The baseline configuration for a model explainability job.
*/
public ModelExplainabilityBaselineConfig getModelExplainabilityBaselineConfig() {
return this.modelExplainabilityBaselineConfig;
}
/**
*
* The baseline configuration for a model explainability job.
*
*
* @param modelExplainabilityBaselineConfig
* The baseline configuration for a model explainability job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateModelExplainabilityJobDefinitionRequest withModelExplainabilityBaselineConfig(
ModelExplainabilityBaselineConfig modelExplainabilityBaselineConfig) {
setModelExplainabilityBaselineConfig(modelExplainabilityBaselineConfig);
return this;
}
/**
*
* Configures the model explainability job to run a specified Docker container image.
*
*
* @param modelExplainabilityAppSpecification
* Configures the model explainability job to run a specified Docker container image.
*/
public void setModelExplainabilityAppSpecification(ModelExplainabilityAppSpecification modelExplainabilityAppSpecification) {
this.modelExplainabilityAppSpecification = modelExplainabilityAppSpecification;
}
/**
*
* Configures the model explainability job to run a specified Docker container image.
*
*
* @return Configures the model explainability job to run a specified Docker container image.
*/
public ModelExplainabilityAppSpecification getModelExplainabilityAppSpecification() {
return this.modelExplainabilityAppSpecification;
}
/**
*
* Configures the model explainability job to run a specified Docker container image.
*
*
* @param modelExplainabilityAppSpecification
* Configures the model explainability job to run a specified Docker container image.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateModelExplainabilityJobDefinitionRequest withModelExplainabilityAppSpecification(
ModelExplainabilityAppSpecification modelExplainabilityAppSpecification) {
setModelExplainabilityAppSpecification(modelExplainabilityAppSpecification);
return this;
}
/**
*
* Inputs for the model explainability job.
*
*
* @param modelExplainabilityJobInput
* Inputs for the model explainability job.
*/
public void setModelExplainabilityJobInput(ModelExplainabilityJobInput modelExplainabilityJobInput) {
this.modelExplainabilityJobInput = modelExplainabilityJobInput;
}
/**
*
* Inputs for the model explainability job.
*
*
* @return Inputs for the model explainability job.
*/
public ModelExplainabilityJobInput getModelExplainabilityJobInput() {
return this.modelExplainabilityJobInput;
}
/**
*
* Inputs for the model explainability job.
*
*
* @param modelExplainabilityJobInput
* Inputs for the model explainability job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateModelExplainabilityJobDefinitionRequest withModelExplainabilityJobInput(ModelExplainabilityJobInput modelExplainabilityJobInput) {
setModelExplainabilityJobInput(modelExplainabilityJobInput);
return this;
}
/**
* @param modelExplainabilityJobOutputConfig
*/
public void setModelExplainabilityJobOutputConfig(MonitoringOutputConfig modelExplainabilityJobOutputConfig) {
this.modelExplainabilityJobOutputConfig = modelExplainabilityJobOutputConfig;
}
/**
* @return
*/
public MonitoringOutputConfig getModelExplainabilityJobOutputConfig() {
return this.modelExplainabilityJobOutputConfig;
}
/**
* @param modelExplainabilityJobOutputConfig
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateModelExplainabilityJobDefinitionRequest withModelExplainabilityJobOutputConfig(MonitoringOutputConfig modelExplainabilityJobOutputConfig) {
setModelExplainabilityJobOutputConfig(modelExplainabilityJobOutputConfig);
return this;
}
/**
* @param jobResources
*/
public void setJobResources(MonitoringResources jobResources) {
this.jobResources = jobResources;
}
/**
* @return
*/
public MonitoringResources getJobResources() {
return this.jobResources;
}
/**
* @param jobResources
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateModelExplainabilityJobDefinitionRequest withJobResources(MonitoringResources jobResources) {
setJobResources(jobResources);
return this;
}
/**
*
* Networking options for a model explainability job.
*
*
* @param networkConfig
* Networking options for a model explainability job.
*/
public void setNetworkConfig(MonitoringNetworkConfig networkConfig) {
this.networkConfig = networkConfig;
}
/**
*
* Networking options for a model explainability job.
*
*
* @return Networking options for a model explainability job.
*/
public MonitoringNetworkConfig getNetworkConfig() {
return this.networkConfig;
}
/**
*
* Networking options for a model explainability job.
*
*
* @param networkConfig
* Networking options for a model explainability job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateModelExplainabilityJobDefinitionRequest withNetworkConfig(MonitoringNetworkConfig networkConfig) {
setNetworkConfig(networkConfig);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
*
*
* @param roleArn
* The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your
* behalf.
*/
public void setRoleArn(String roleArn) {
this.roleArn = roleArn;
}
/**
*
* The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
*
*
* @return The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your
* behalf.
*/
public String getRoleArn() {
return this.roleArn;
}
/**
*
* The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
*
*
* @param roleArn
* The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your
* behalf.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateModelExplainabilityJobDefinitionRequest withRoleArn(String roleArn) {
setRoleArn(roleArn);
return this;
}
/**
* @param stoppingCondition
*/
public void setStoppingCondition(MonitoringStoppingCondition stoppingCondition) {
this.stoppingCondition = stoppingCondition;
}
/**
* @return
*/
public MonitoringStoppingCondition getStoppingCondition() {
return this.stoppingCondition;
}
/**
* @param stoppingCondition
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateModelExplainabilityJobDefinitionRequest withStoppingCondition(MonitoringStoppingCondition stoppingCondition) {
setStoppingCondition(stoppingCondition);
return this;
}
/**
*
* (Optional) An array of key-value pairs. For more information, see Using
* Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
*
*
* @return (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* (Optional) An array of key-value pairs. For more information, see Using
* Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
*
*
* @param tags
* (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* (Optional) An array of key-value pairs. For more information, see Using
* Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
*
*
* 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
* (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateModelExplainabilityJobDefinitionRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* (Optional) An array of key-value pairs. For more information, see Using
* Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
*
*
* @param tags
* (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateModelExplainabilityJobDefinitionRequest 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 (getJobDefinitionName() != null)
sb.append("JobDefinitionName: ").append(getJobDefinitionName()).append(",");
if (getModelExplainabilityBaselineConfig() != null)
sb.append("ModelExplainabilityBaselineConfig: ").append(getModelExplainabilityBaselineConfig()).append(",");
if (getModelExplainabilityAppSpecification() != null)
sb.append("ModelExplainabilityAppSpecification: ").append(getModelExplainabilityAppSpecification()).append(",");
if (getModelExplainabilityJobInput() != null)
sb.append("ModelExplainabilityJobInput: ").append(getModelExplainabilityJobInput()).append(",");
if (getModelExplainabilityJobOutputConfig() != null)
sb.append("ModelExplainabilityJobOutputConfig: ").append(getModelExplainabilityJobOutputConfig()).append(",");
if (getJobResources() != null)
sb.append("JobResources: ").append(getJobResources()).append(",");
if (getNetworkConfig() != null)
sb.append("NetworkConfig: ").append(getNetworkConfig()).append(",");
if (getRoleArn() != null)
sb.append("RoleArn: ").append(getRoleArn()).append(",");
if (getStoppingCondition() != null)
sb.append("StoppingCondition: ").append(getStoppingCondition()).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 CreateModelExplainabilityJobDefinitionRequest == false)
return false;
CreateModelExplainabilityJobDefinitionRequest other = (CreateModelExplainabilityJobDefinitionRequest) obj;
if (other.getJobDefinitionName() == null ^ this.getJobDefinitionName() == null)
return false;
if (other.getJobDefinitionName() != null && other.getJobDefinitionName().equals(this.getJobDefinitionName()) == false)
return false;
if (other.getModelExplainabilityBaselineConfig() == null ^ this.getModelExplainabilityBaselineConfig() == null)
return false;
if (other.getModelExplainabilityBaselineConfig() != null
&& other.getModelExplainabilityBaselineConfig().equals(this.getModelExplainabilityBaselineConfig()) == false)
return false;
if (other.getModelExplainabilityAppSpecification() == null ^ this.getModelExplainabilityAppSpecification() == null)
return false;
if (other.getModelExplainabilityAppSpecification() != null
&& other.getModelExplainabilityAppSpecification().equals(this.getModelExplainabilityAppSpecification()) == false)
return false;
if (other.getModelExplainabilityJobInput() == null ^ this.getModelExplainabilityJobInput() == null)
return false;
if (other.getModelExplainabilityJobInput() != null && other.getModelExplainabilityJobInput().equals(this.getModelExplainabilityJobInput()) == false)
return false;
if (other.getModelExplainabilityJobOutputConfig() == null ^ this.getModelExplainabilityJobOutputConfig() == null)
return false;
if (other.getModelExplainabilityJobOutputConfig() != null
&& other.getModelExplainabilityJobOutputConfig().equals(this.getModelExplainabilityJobOutputConfig()) == false)
return false;
if (other.getJobResources() == null ^ this.getJobResources() == null)
return false;
if (other.getJobResources() != null && other.getJobResources().equals(this.getJobResources()) == false)
return false;
if (other.getNetworkConfig() == null ^ this.getNetworkConfig() == null)
return false;
if (other.getNetworkConfig() != null && other.getNetworkConfig().equals(this.getNetworkConfig()) == 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.getStoppingCondition() == null ^ this.getStoppingCondition() == null)
return false;
if (other.getStoppingCondition() != null && other.getStoppingCondition().equals(this.getStoppingCondition()) == 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 + ((getJobDefinitionName() == null) ? 0 : getJobDefinitionName().hashCode());
hashCode = prime * hashCode + ((getModelExplainabilityBaselineConfig() == null) ? 0 : getModelExplainabilityBaselineConfig().hashCode());
hashCode = prime * hashCode + ((getModelExplainabilityAppSpecification() == null) ? 0 : getModelExplainabilityAppSpecification().hashCode());
hashCode = prime * hashCode + ((getModelExplainabilityJobInput() == null) ? 0 : getModelExplainabilityJobInput().hashCode());
hashCode = prime * hashCode + ((getModelExplainabilityJobOutputConfig() == null) ? 0 : getModelExplainabilityJobOutputConfig().hashCode());
hashCode = prime * hashCode + ((getJobResources() == null) ? 0 : getJobResources().hashCode());
hashCode = prime * hashCode + ((getNetworkConfig() == null) ? 0 : getNetworkConfig().hashCode());
hashCode = prime * hashCode + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode());
hashCode = prime * hashCode + ((getStoppingCondition() == null) ? 0 : getStoppingCondition().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateModelExplainabilityJobDefinitionRequest clone() {
return (CreateModelExplainabilityJobDefinitionRequest) super.clone();
}
}