com.amazonaws.services.sagemaker.model.KernelGatewayAppSettings 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;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The KernelGateway app settings.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class KernelGatewayAppSettings implements Serializable, Cloneable, StructuredPojo {
/**
*
* The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the
* KernelGateway app.
*
*
*
* The Amazon SageMaker Studio UI does not use the default instance type value set here. The default instance type
* set here is used when Apps are created using the CLI or CloudFormation and the instance type parameter value is
* not passed.
*
*
*/
private ResourceSpec defaultResourceSpec;
/**
*
* A list of custom SageMaker images that are configured to run as a KernelGateway app.
*
*/
private java.util.List customImages;
/**
*
* The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.
*
*
*
* To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
*
*
*/
private java.util.List lifecycleConfigArns;
/**
*
* The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the
* KernelGateway app.
*
*
*
* The Amazon SageMaker Studio UI does not use the default instance type value set here. The default instance type
* set here is used when Apps are created using the CLI or CloudFormation and the instance type parameter value is
* not passed.
*
*
*
* @param defaultResourceSpec
* The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the
* KernelGateway app.
*
* The Amazon SageMaker Studio UI does not use the default instance type value set here. The default instance
* type set here is used when Apps are created using the CLI or CloudFormation and the instance type
* parameter value is not passed.
*
*/
public void setDefaultResourceSpec(ResourceSpec defaultResourceSpec) {
this.defaultResourceSpec = defaultResourceSpec;
}
/**
*
* The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the
* KernelGateway app.
*
*
*
* The Amazon SageMaker Studio UI does not use the default instance type value set here. The default instance type
* set here is used when Apps are created using the CLI or CloudFormation and the instance type parameter value is
* not passed.
*
*
*
* @return The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the
* KernelGateway app.
*
* The Amazon SageMaker Studio UI does not use the default instance type value set here. The default
* instance type set here is used when Apps are created using the CLI or CloudFormation and the instance
* type parameter value is not passed.
*
*/
public ResourceSpec getDefaultResourceSpec() {
return this.defaultResourceSpec;
}
/**
*
* The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the
* KernelGateway app.
*
*
*
* The Amazon SageMaker Studio UI does not use the default instance type value set here. The default instance type
* set here is used when Apps are created using the CLI or CloudFormation and the instance type parameter value is
* not passed.
*
*
*
* @param defaultResourceSpec
* The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the
* KernelGateway app.
*
* The Amazon SageMaker Studio UI does not use the default instance type value set here. The default instance
* type set here is used when Apps are created using the CLI or CloudFormation and the instance type
* parameter value is not passed.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KernelGatewayAppSettings withDefaultResourceSpec(ResourceSpec defaultResourceSpec) {
setDefaultResourceSpec(defaultResourceSpec);
return this;
}
/**
*
* A list of custom SageMaker images that are configured to run as a KernelGateway app.
*
*
* @return A list of custom SageMaker images that are configured to run as a KernelGateway app.
*/
public java.util.List getCustomImages() {
return customImages;
}
/**
*
* A list of custom SageMaker images that are configured to run as a KernelGateway app.
*
*
* @param customImages
* A list of custom SageMaker images that are configured to run as a KernelGateway app.
*/
public void setCustomImages(java.util.Collection customImages) {
if (customImages == null) {
this.customImages = null;
return;
}
this.customImages = new java.util.ArrayList(customImages);
}
/**
*
* A list of custom SageMaker images that are configured to run as a KernelGateway app.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setCustomImages(java.util.Collection)} or {@link #withCustomImages(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param customImages
* A list of custom SageMaker images that are configured to run as a KernelGateway app.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KernelGatewayAppSettings withCustomImages(CustomImage... customImages) {
if (this.customImages == null) {
setCustomImages(new java.util.ArrayList(customImages.length));
}
for (CustomImage ele : customImages) {
this.customImages.add(ele);
}
return this;
}
/**
*
* A list of custom SageMaker images that are configured to run as a KernelGateway app.
*
*
* @param customImages
* A list of custom SageMaker images that are configured to run as a KernelGateway app.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KernelGatewayAppSettings withCustomImages(java.util.Collection customImages) {
setCustomImages(customImages);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.
*
*
*
* To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
*
*
*
* @return The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or
* domain.
*
* To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
*
*/
public java.util.List getLifecycleConfigArns() {
return lifecycleConfigArns;
}
/**
*
* The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.
*
*
*
* To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
*
*
*
* @param lifecycleConfigArns
* The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or
* domain.
*
* To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
*
*/
public void setLifecycleConfigArns(java.util.Collection lifecycleConfigArns) {
if (lifecycleConfigArns == null) {
this.lifecycleConfigArns = null;
return;
}
this.lifecycleConfigArns = new java.util.ArrayList(lifecycleConfigArns);
}
/**
*
* The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.
*
*
*
* To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setLifecycleConfigArns(java.util.Collection)} or {@link #withLifecycleConfigArns(java.util.Collection)}
* if you want to override the existing values.
*
*
* @param lifecycleConfigArns
* The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or
* domain.
*
* To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KernelGatewayAppSettings withLifecycleConfigArns(String... lifecycleConfigArns) {
if (this.lifecycleConfigArns == null) {
setLifecycleConfigArns(new java.util.ArrayList(lifecycleConfigArns.length));
}
for (String ele : lifecycleConfigArns) {
this.lifecycleConfigArns.add(ele);
}
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.
*
*
*
* To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
*
*
*
* @param lifecycleConfigArns
* The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or
* domain.
*
* To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KernelGatewayAppSettings withLifecycleConfigArns(java.util.Collection lifecycleConfigArns) {
setLifecycleConfigArns(lifecycleConfigArns);
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 (getDefaultResourceSpec() != null)
sb.append("DefaultResourceSpec: ").append(getDefaultResourceSpec()).append(",");
if (getCustomImages() != null)
sb.append("CustomImages: ").append(getCustomImages()).append(",");
if (getLifecycleConfigArns() != null)
sb.append("LifecycleConfigArns: ").append(getLifecycleConfigArns());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof KernelGatewayAppSettings == false)
return false;
KernelGatewayAppSettings other = (KernelGatewayAppSettings) obj;
if (other.getDefaultResourceSpec() == null ^ this.getDefaultResourceSpec() == null)
return false;
if (other.getDefaultResourceSpec() != null && other.getDefaultResourceSpec().equals(this.getDefaultResourceSpec()) == false)
return false;
if (other.getCustomImages() == null ^ this.getCustomImages() == null)
return false;
if (other.getCustomImages() != null && other.getCustomImages().equals(this.getCustomImages()) == false)
return false;
if (other.getLifecycleConfigArns() == null ^ this.getLifecycleConfigArns() == null)
return false;
if (other.getLifecycleConfigArns() != null && other.getLifecycleConfigArns().equals(this.getLifecycleConfigArns()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDefaultResourceSpec() == null) ? 0 : getDefaultResourceSpec().hashCode());
hashCode = prime * hashCode + ((getCustomImages() == null) ? 0 : getCustomImages().hashCode());
hashCode = prime * hashCode + ((getLifecycleConfigArns() == null) ? 0 : getLifecycleConfigArns().hashCode());
return hashCode;
}
@Override
public KernelGatewayAppSettings clone() {
try {
return (KernelGatewayAppSettings) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.sagemaker.model.transform.KernelGatewayAppSettingsMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}