com.amazonaws.services.sagemaker.model.JupyterServerAppSettings 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 JupyterServer app settings.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class JupyterServerAppSettings implements Serializable, Cloneable, StructuredPojo {
/**
*
* The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the
* JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also
* required.
*
*/
private ResourceSpec defaultResourceSpec;
/**
*
* The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this
* parameter, the DefaultResourceSpec parameter is also required.
*
*
*
* To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
*
*
*/
private java.util.List lifecycleConfigArns;
/**
*
* A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer
* application.
*
*/
private java.util.List codeRepositories;
/**
*
* The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the
* JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also
* required.
*
*
* @param defaultResourceSpec
* The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the
* JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also
* required.
*/
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
* JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also
* required.
*
*
* @return The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the
* JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also
* required.
*/
public ResourceSpec getDefaultResourceSpec() {
return this.defaultResourceSpec;
}
/**
*
* The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the
* JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also
* required.
*
*
* @param defaultResourceSpec
* The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the
* JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also
* required.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JupyterServerAppSettings withDefaultResourceSpec(ResourceSpec defaultResourceSpec) {
setDefaultResourceSpec(defaultResourceSpec);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this
* parameter, the DefaultResourceSpec parameter is also required.
*
*
*
* 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 JupyterServerApp. If you
* use this parameter, the DefaultResourceSpec parameter is also required.
*
* 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 JupyterServerApp. If you use this
* parameter, the DefaultResourceSpec parameter is also required.
*
*
*
* 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 JupyterServerApp. If you
* use this parameter, the DefaultResourceSpec parameter is also required.
*
* 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 JupyterServerApp. If you use this
* parameter, the DefaultResourceSpec parameter is also required.
*
*
*
* 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 JupyterServerApp. If you
* use this parameter, the DefaultResourceSpec parameter is also required.
*
* 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 JupyterServerAppSettings 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 JupyterServerApp. If you use this
* parameter, the DefaultResourceSpec parameter is also required.
*
*
*
* 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 JupyterServerApp. If you
* use this parameter, the DefaultResourceSpec parameter is also required.
*
* 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 JupyterServerAppSettings withLifecycleConfigArns(java.util.Collection lifecycleConfigArns) {
setLifecycleConfigArns(lifecycleConfigArns);
return this;
}
/**
*
* A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer
* application.
*
*
* @return A list of Git repositories that SageMaker automatically displays to users for cloning in the
* JupyterServer application.
*/
public java.util.List getCodeRepositories() {
return codeRepositories;
}
/**
*
* A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer
* application.
*
*
* @param codeRepositories
* A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer
* application.
*/
public void setCodeRepositories(java.util.Collection codeRepositories) {
if (codeRepositories == null) {
this.codeRepositories = null;
return;
}
this.codeRepositories = new java.util.ArrayList(codeRepositories);
}
/**
*
* A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer
* application.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setCodeRepositories(java.util.Collection)} or {@link #withCodeRepositories(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param codeRepositories
* A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer
* application.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JupyterServerAppSettings withCodeRepositories(CodeRepository... codeRepositories) {
if (this.codeRepositories == null) {
setCodeRepositories(new java.util.ArrayList(codeRepositories.length));
}
for (CodeRepository ele : codeRepositories) {
this.codeRepositories.add(ele);
}
return this;
}
/**
*
* A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer
* application.
*
*
* @param codeRepositories
* A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer
* application.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JupyterServerAppSettings withCodeRepositories(java.util.Collection codeRepositories) {
setCodeRepositories(codeRepositories);
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 (getLifecycleConfigArns() != null)
sb.append("LifecycleConfigArns: ").append(getLifecycleConfigArns()).append(",");
if (getCodeRepositories() != null)
sb.append("CodeRepositories: ").append(getCodeRepositories());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof JupyterServerAppSettings == false)
return false;
JupyterServerAppSettings other = (JupyterServerAppSettings) obj;
if (other.getDefaultResourceSpec() == null ^ this.getDefaultResourceSpec() == null)
return false;
if (other.getDefaultResourceSpec() != null && other.getDefaultResourceSpec().equals(this.getDefaultResourceSpec()) == false)
return false;
if (other.getLifecycleConfigArns() == null ^ this.getLifecycleConfigArns() == null)
return false;
if (other.getLifecycleConfigArns() != null && other.getLifecycleConfigArns().equals(this.getLifecycleConfigArns()) == false)
return false;
if (other.getCodeRepositories() == null ^ this.getCodeRepositories() == null)
return false;
if (other.getCodeRepositories() != null && other.getCodeRepositories().equals(this.getCodeRepositories()) == 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 + ((getLifecycleConfigArns() == null) ? 0 : getLifecycleConfigArns().hashCode());
hashCode = prime * hashCode + ((getCodeRepositories() == null) ? 0 : getCodeRepositories().hashCode());
return hashCode;
}
@Override
public JupyterServerAppSettings clone() {
try {
return (JupyterServerAppSettings) 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.JupyterServerAppSettingsMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}