com.amazonaws.services.sagemaker.model.DescribeEndpointConfigResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sagemaker Show documentation
/*
* 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;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeEndpointConfigResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* Name of the SageMaker endpoint configuration.
*
*/
private String endpointConfigName;
/**
*
* The Amazon Resource Name (ARN) of the endpoint configuration.
*
*/
private String endpointConfigArn;
/**
*
* An array of ProductionVariant objects, one for each model that you want to host at this endpoint.
*
*/
private java.util.List productionVariants;
private DataCaptureConfig dataCaptureConfig;
/**
*
* Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume
* attached to the instance.
*
*/
private String kmsKeyId;
/**
*
* A timestamp that shows when the endpoint configuration was created.
*
*/
private java.util.Date creationTime;
/**
*
* Returns the description of an endpoint configuration created using the
* CreateEndpointConfig API.
*
*/
private AsyncInferenceConfig asyncInferenceConfig;
/**
*
* The configuration parameters for an explainer.
*
*/
private ExplainerConfig explainerConfig;
/**
*
* An array of ProductionVariant objects, one for each model that you want to host at this endpoint in
* shadow mode with production traffic replicated from the model specified on ProductionVariants.
*
*/
private java.util.List shadowProductionVariants;
/**
*
* The Amazon Resource Name (ARN) of the IAM role that you assigned to the endpoint configuration.
*
*/
private String executionRoleArn;
private VpcConfig vpcConfig;
/**
*
* Indicates whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound
* network calls can be made to or from the model containers.
*
*/
private Boolean enableNetworkIsolation;
/**
*
* Name of the SageMaker endpoint configuration.
*
*
* @param endpointConfigName
* Name of the SageMaker endpoint configuration.
*/
public void setEndpointConfigName(String endpointConfigName) {
this.endpointConfigName = endpointConfigName;
}
/**
*
* Name of the SageMaker endpoint configuration.
*
*
* @return Name of the SageMaker endpoint configuration.
*/
public String getEndpointConfigName() {
return this.endpointConfigName;
}
/**
*
* Name of the SageMaker endpoint configuration.
*
*
* @param endpointConfigName
* Name of the SageMaker endpoint configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEndpointConfigResult withEndpointConfigName(String endpointConfigName) {
setEndpointConfigName(endpointConfigName);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the endpoint configuration.
*
*
* @param endpointConfigArn
* The Amazon Resource Name (ARN) of the endpoint configuration.
*/
public void setEndpointConfigArn(String endpointConfigArn) {
this.endpointConfigArn = endpointConfigArn;
}
/**
*
* The Amazon Resource Name (ARN) of the endpoint configuration.
*
*
* @return The Amazon Resource Name (ARN) of the endpoint configuration.
*/
public String getEndpointConfigArn() {
return this.endpointConfigArn;
}
/**
*
* The Amazon Resource Name (ARN) of the endpoint configuration.
*
*
* @param endpointConfigArn
* The Amazon Resource Name (ARN) of the endpoint configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEndpointConfigResult withEndpointConfigArn(String endpointConfigArn) {
setEndpointConfigArn(endpointConfigArn);
return this;
}
/**
*
* An array of ProductionVariant objects, one for each model that you want to host at this endpoint.
*
*
* @return An array of ProductionVariant objects, one for each model that you want to host at this
* endpoint.
*/
public java.util.List getProductionVariants() {
return productionVariants;
}
/**
*
* An array of ProductionVariant objects, one for each model that you want to host at this endpoint.
*
*
* @param productionVariants
* An array of ProductionVariant objects, one for each model that you want to host at this
* endpoint.
*/
public void setProductionVariants(java.util.Collection productionVariants) {
if (productionVariants == null) {
this.productionVariants = null;
return;
}
this.productionVariants = new java.util.ArrayList(productionVariants);
}
/**
*
* An array of ProductionVariant objects, one for each model that you want to host at this endpoint.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setProductionVariants(java.util.Collection)} or {@link #withProductionVariants(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param productionVariants
* An array of ProductionVariant objects, one for each model that you want to host at this
* endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEndpointConfigResult withProductionVariants(ProductionVariant... productionVariants) {
if (this.productionVariants == null) {
setProductionVariants(new java.util.ArrayList(productionVariants.length));
}
for (ProductionVariant ele : productionVariants) {
this.productionVariants.add(ele);
}
return this;
}
/**
*
* An array of ProductionVariant objects, one for each model that you want to host at this endpoint.
*
*
* @param productionVariants
* An array of ProductionVariant objects, one for each model that you want to host at this
* endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEndpointConfigResult withProductionVariants(java.util.Collection productionVariants) {
setProductionVariants(productionVariants);
return this;
}
/**
* @param dataCaptureConfig
*/
public void setDataCaptureConfig(DataCaptureConfig dataCaptureConfig) {
this.dataCaptureConfig = dataCaptureConfig;
}
/**
* @return
*/
public DataCaptureConfig getDataCaptureConfig() {
return this.dataCaptureConfig;
}
/**
* @param dataCaptureConfig
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEndpointConfigResult withDataCaptureConfig(DataCaptureConfig dataCaptureConfig) {
setDataCaptureConfig(dataCaptureConfig);
return this;
}
/**
*
* Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume
* attached to the instance.
*
*
* @param kmsKeyId
* Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage
* volume attached to the instance.
*/
public void setKmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
}
/**
*
* Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume
* attached to the instance.
*
*
* @return Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage
* volume attached to the instance.
*/
public String getKmsKeyId() {
return this.kmsKeyId;
}
/**
*
* Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume
* attached to the instance.
*
*
* @param kmsKeyId
* Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage
* volume attached to the instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEndpointConfigResult withKmsKeyId(String kmsKeyId) {
setKmsKeyId(kmsKeyId);
return this;
}
/**
*
* A timestamp that shows when the endpoint configuration was created.
*
*
* @param creationTime
* A timestamp that shows when the endpoint configuration was created.
*/
public void setCreationTime(java.util.Date creationTime) {
this.creationTime = creationTime;
}
/**
*
* A timestamp that shows when the endpoint configuration was created.
*
*
* @return A timestamp that shows when the endpoint configuration was created.
*/
public java.util.Date getCreationTime() {
return this.creationTime;
}
/**
*
* A timestamp that shows when the endpoint configuration was created.
*
*
* @param creationTime
* A timestamp that shows when the endpoint configuration was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEndpointConfigResult withCreationTime(java.util.Date creationTime) {
setCreationTime(creationTime);
return this;
}
/**
*
* Returns the description of an endpoint configuration created using the
* CreateEndpointConfig API.
*
*
* @param asyncInferenceConfig
* Returns the description of an endpoint configuration created using the
* CreateEndpointConfig API.
*/
public void setAsyncInferenceConfig(AsyncInferenceConfig asyncInferenceConfig) {
this.asyncInferenceConfig = asyncInferenceConfig;
}
/**
*
* Returns the description of an endpoint configuration created using the
* CreateEndpointConfig API.
*
*
* @return Returns the description of an endpoint configuration created using the
* CreateEndpointConfig API.
*/
public AsyncInferenceConfig getAsyncInferenceConfig() {
return this.asyncInferenceConfig;
}
/**
*
* Returns the description of an endpoint configuration created using the
* CreateEndpointConfig API.
*
*
* @param asyncInferenceConfig
* Returns the description of an endpoint configuration created using the
* CreateEndpointConfig API.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEndpointConfigResult withAsyncInferenceConfig(AsyncInferenceConfig asyncInferenceConfig) {
setAsyncInferenceConfig(asyncInferenceConfig);
return this;
}
/**
*
* The configuration parameters for an explainer.
*
*
* @param explainerConfig
* The configuration parameters for an explainer.
*/
public void setExplainerConfig(ExplainerConfig explainerConfig) {
this.explainerConfig = explainerConfig;
}
/**
*
* The configuration parameters for an explainer.
*
*
* @return The configuration parameters for an explainer.
*/
public ExplainerConfig getExplainerConfig() {
return this.explainerConfig;
}
/**
*
* The configuration parameters for an explainer.
*
*
* @param explainerConfig
* The configuration parameters for an explainer.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEndpointConfigResult withExplainerConfig(ExplainerConfig explainerConfig) {
setExplainerConfig(explainerConfig);
return this;
}
/**
*
* An array of ProductionVariant objects, one for each model that you want to host at this endpoint in
* shadow mode with production traffic replicated from the model specified on ProductionVariants.
*
*
* @return An array of ProductionVariant objects, one for each model that you want to host at this
* endpoint in shadow mode with production traffic replicated from the model specified on
* ProductionVariants.
*/
public java.util.List getShadowProductionVariants() {
return shadowProductionVariants;
}
/**
*
* An array of ProductionVariant objects, one for each model that you want to host at this endpoint in
* shadow mode with production traffic replicated from the model specified on ProductionVariants.
*
*
* @param shadowProductionVariants
* An array of ProductionVariant objects, one for each model that you want to host at this
* endpoint in shadow mode with production traffic replicated from the model specified on
* ProductionVariants.
*/
public void setShadowProductionVariants(java.util.Collection shadowProductionVariants) {
if (shadowProductionVariants == null) {
this.shadowProductionVariants = null;
return;
}
this.shadowProductionVariants = new java.util.ArrayList(shadowProductionVariants);
}
/**
*
* An array of ProductionVariant objects, one for each model that you want to host at this endpoint in
* shadow mode with production traffic replicated from the model specified on ProductionVariants.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setShadowProductionVariants(java.util.Collection)} or
* {@link #withShadowProductionVariants(java.util.Collection)} if you want to override the existing values.
*
*
* @param shadowProductionVariants
* An array of ProductionVariant objects, one for each model that you want to host at this
* endpoint in shadow mode with production traffic replicated from the model specified on
* ProductionVariants.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEndpointConfigResult withShadowProductionVariants(ProductionVariant... shadowProductionVariants) {
if (this.shadowProductionVariants == null) {
setShadowProductionVariants(new java.util.ArrayList(shadowProductionVariants.length));
}
for (ProductionVariant ele : shadowProductionVariants) {
this.shadowProductionVariants.add(ele);
}
return this;
}
/**
*
* An array of ProductionVariant objects, one for each model that you want to host at this endpoint in
* shadow mode with production traffic replicated from the model specified on ProductionVariants.
*
*
* @param shadowProductionVariants
* An array of ProductionVariant objects, one for each model that you want to host at this
* endpoint in shadow mode with production traffic replicated from the model specified on
* ProductionVariants.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEndpointConfigResult withShadowProductionVariants(java.util.Collection shadowProductionVariants) {
setShadowProductionVariants(shadowProductionVariants);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM role that you assigned to the endpoint configuration.
*
*
* @param executionRoleArn
* The Amazon Resource Name (ARN) of the IAM role that you assigned to the endpoint configuration.
*/
public void setExecutionRoleArn(String executionRoleArn) {
this.executionRoleArn = executionRoleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM role that you assigned to the endpoint configuration.
*
*
* @return The Amazon Resource Name (ARN) of the IAM role that you assigned to the endpoint configuration.
*/
public String getExecutionRoleArn() {
return this.executionRoleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM role that you assigned to the endpoint configuration.
*
*
* @param executionRoleArn
* The Amazon Resource Name (ARN) of the IAM role that you assigned to the endpoint configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEndpointConfigResult withExecutionRoleArn(String executionRoleArn) {
setExecutionRoleArn(executionRoleArn);
return this;
}
/**
* @param vpcConfig
*/
public void setVpcConfig(VpcConfig vpcConfig) {
this.vpcConfig = vpcConfig;
}
/**
* @return
*/
public VpcConfig getVpcConfig() {
return this.vpcConfig;
}
/**
* @param vpcConfig
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEndpointConfigResult withVpcConfig(VpcConfig vpcConfig) {
setVpcConfig(vpcConfig);
return this;
}
/**
*
* Indicates whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound
* network calls can be made to or from the model containers.
*
*
* @param enableNetworkIsolation
* Indicates whether all model containers deployed to the endpoint are isolated. If they are, no inbound or
* outbound network calls can be made to or from the model containers.
*/
public void setEnableNetworkIsolation(Boolean enableNetworkIsolation) {
this.enableNetworkIsolation = enableNetworkIsolation;
}
/**
*
* Indicates whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound
* network calls can be made to or from the model containers.
*
*
* @return Indicates whether all model containers deployed to the endpoint are isolated. If they are, no inbound or
* outbound network calls can be made to or from the model containers.
*/
public Boolean getEnableNetworkIsolation() {
return this.enableNetworkIsolation;
}
/**
*
* Indicates whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound
* network calls can be made to or from the model containers.
*
*
* @param enableNetworkIsolation
* Indicates whether all model containers deployed to the endpoint are isolated. If they are, no inbound or
* outbound network calls can be made to or from the model containers.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEndpointConfigResult withEnableNetworkIsolation(Boolean enableNetworkIsolation) {
setEnableNetworkIsolation(enableNetworkIsolation);
return this;
}
/**
*
* Indicates whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound
* network calls can be made to or from the model containers.
*
*
* @return Indicates whether all model containers deployed to the endpoint are isolated. If they are, no inbound or
* outbound network calls can be made to or from the model containers.
*/
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 (getEndpointConfigName() != null)
sb.append("EndpointConfigName: ").append(getEndpointConfigName()).append(",");
if (getEndpointConfigArn() != null)
sb.append("EndpointConfigArn: ").append(getEndpointConfigArn()).append(",");
if (getProductionVariants() != null)
sb.append("ProductionVariants: ").append(getProductionVariants()).append(",");
if (getDataCaptureConfig() != null)
sb.append("DataCaptureConfig: ").append(getDataCaptureConfig()).append(",");
if (getKmsKeyId() != null)
sb.append("KmsKeyId: ").append(getKmsKeyId()).append(",");
if (getCreationTime() != null)
sb.append("CreationTime: ").append(getCreationTime()).append(",");
if (getAsyncInferenceConfig() != null)
sb.append("AsyncInferenceConfig: ").append(getAsyncInferenceConfig()).append(",");
if (getExplainerConfig() != null)
sb.append("ExplainerConfig: ").append(getExplainerConfig()).append(",");
if (getShadowProductionVariants() != null)
sb.append("ShadowProductionVariants: ").append(getShadowProductionVariants()).append(",");
if (getExecutionRoleArn() != null)
sb.append("ExecutionRoleArn: ").append(getExecutionRoleArn()).append(",");
if (getVpcConfig() != null)
sb.append("VpcConfig: ").append(getVpcConfig()).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 DescribeEndpointConfigResult == false)
return false;
DescribeEndpointConfigResult other = (DescribeEndpointConfigResult) obj;
if (other.getEndpointConfigName() == null ^ this.getEndpointConfigName() == null)
return false;
if (other.getEndpointConfigName() != null && other.getEndpointConfigName().equals(this.getEndpointConfigName()) == false)
return false;
if (other.getEndpointConfigArn() == null ^ this.getEndpointConfigArn() == null)
return false;
if (other.getEndpointConfigArn() != null && other.getEndpointConfigArn().equals(this.getEndpointConfigArn()) == false)
return false;
if (other.getProductionVariants() == null ^ this.getProductionVariants() == null)
return false;
if (other.getProductionVariants() != null && other.getProductionVariants().equals(this.getProductionVariants()) == false)
return false;
if (other.getDataCaptureConfig() == null ^ this.getDataCaptureConfig() == null)
return false;
if (other.getDataCaptureConfig() != null && other.getDataCaptureConfig().equals(this.getDataCaptureConfig()) == false)
return false;
if (other.getKmsKeyId() == null ^ this.getKmsKeyId() == null)
return false;
if (other.getKmsKeyId() != null && other.getKmsKeyId().equals(this.getKmsKeyId()) == 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.getAsyncInferenceConfig() == null ^ this.getAsyncInferenceConfig() == null)
return false;
if (other.getAsyncInferenceConfig() != null && other.getAsyncInferenceConfig().equals(this.getAsyncInferenceConfig()) == false)
return false;
if (other.getExplainerConfig() == null ^ this.getExplainerConfig() == null)
return false;
if (other.getExplainerConfig() != null && other.getExplainerConfig().equals(this.getExplainerConfig()) == false)
return false;
if (other.getShadowProductionVariants() == null ^ this.getShadowProductionVariants() == null)
return false;
if (other.getShadowProductionVariants() != null && other.getShadowProductionVariants().equals(this.getShadowProductionVariants()) == 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.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 + ((getEndpointConfigName() == null) ? 0 : getEndpointConfigName().hashCode());
hashCode = prime * hashCode + ((getEndpointConfigArn() == null) ? 0 : getEndpointConfigArn().hashCode());
hashCode = prime * hashCode + ((getProductionVariants() == null) ? 0 : getProductionVariants().hashCode());
hashCode = prime * hashCode + ((getDataCaptureConfig() == null) ? 0 : getDataCaptureConfig().hashCode());
hashCode = prime * hashCode + ((getKmsKeyId() == null) ? 0 : getKmsKeyId().hashCode());
hashCode = prime * hashCode + ((getCreationTime() == null) ? 0 : getCreationTime().hashCode());
hashCode = prime * hashCode + ((getAsyncInferenceConfig() == null) ? 0 : getAsyncInferenceConfig().hashCode());
hashCode = prime * hashCode + ((getExplainerConfig() == null) ? 0 : getExplainerConfig().hashCode());
hashCode = prime * hashCode + ((getShadowProductionVariants() == null) ? 0 : getShadowProductionVariants().hashCode());
hashCode = prime * hashCode + ((getExecutionRoleArn() == null) ? 0 : getExecutionRoleArn().hashCode());
hashCode = prime * hashCode + ((getVpcConfig() == null) ? 0 : getVpcConfig().hashCode());
hashCode = prime * hashCode + ((getEnableNetworkIsolation() == null) ? 0 : getEnableNetworkIsolation().hashCode());
return hashCode;
}
@Override
public DescribeEndpointConfigResult clone() {
try {
return (DescribeEndpointConfigResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}