com.amazonaws.services.sagemaker.model.DescribeNotebookInstanceResult 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 DescribeNotebookInstanceResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The Amazon Resource Name (ARN) of the notebook instance.
*
*/
private String notebookInstanceArn;
/**
*
* The name of the Amazon SageMaker notebook instance.
*
*/
private String notebookInstanceName;
/**
*
* The status of the notebook instance.
*
*/
private String notebookInstanceStatus;
/**
*
* If status is Failed, the reason it failed.
*
*/
private String failureReason;
/**
*
* The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
*
*/
private String url;
/**
*
* The type of ML compute instance running on the notebook instance.
*
*/
private String instanceType;
/**
*
* The ID of the VPC subnet.
*
*/
private String subnetId;
/**
*
* The IDs of the VPC security groups.
*
*/
private java.util.List securityGroups;
/**
*
* The Amazon Resource Name (ARN) of the IAM role associated with the instance.
*
*/
private String roleArn;
/**
*
* The AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the
* instance.
*
*/
private String kmsKeyId;
/**
*
* The network interface IDs that Amazon SageMaker created at the time of creating the instance.
*
*/
private String networkInterfaceId;
/**
*
* A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
*
*/
private java.util.Date lastModifiedTime;
/**
*
* A timestamp. Use this parameter to return the time when the notebook instance was created
*
*/
private java.util.Date creationTime;
/**
*
* Returns the name of a notebook instance lifecycle configuration.
*
*
* For information about notebook instance lifestyle configurations, see Step 2.1: (Optional)
* Customize a Notebook Instance
*
*/
private String notebookInstanceLifecycleConfigName;
/**
*
* Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set to
* Disabled, the notebook instance does not have internet access, and cannot connect to Amazon SageMaker
* training and endpoint services.
*
*
* For more information, see Notebook Instances Are Internet-Enabled by Default.
*
*/
private String directInternetAccess;
/**
*
* The size, in GB, of the ML storage volume attached to the notebook instance.
*
*/
private Integer volumeSizeInGB;
/**
*
* A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently only one EI
* instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.
*
*/
private java.util.List acceleratorTypes;
/**
*
* The Git repository associated with the notebook instance as its default code repository. This can be either the
* name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other
* Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For
* more information, see Associating Git
* Repositories with Amazon SageMaker Notebook Instances.
*
*/
private String defaultCodeRepository;
/**
*
* An array of up to three Git repositories associated with the notebook instance. These can be either the names of
* Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other
* Git repository. These repositories are cloned at the same level as the default repository of your notebook
* instance. For more information, see Associating Git Repositories with Amazon
* SageMaker Notebook Instances.
*
*/
private java.util.List additionalCodeRepositories;
/**
*
* Whether root access is enabled or disabled for users of the notebook instance.
*
*
*
* Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle
* configurations associated with a notebook instance always run with root access even if you disable root access
* for users.
*
*
*/
private String rootAccess;
/**
*
* The Amazon Resource Name (ARN) of the notebook instance.
*
*
* @param notebookInstanceArn
* The Amazon Resource Name (ARN) of the notebook instance.
*/
public void setNotebookInstanceArn(String notebookInstanceArn) {
this.notebookInstanceArn = notebookInstanceArn;
}
/**
*
* The Amazon Resource Name (ARN) of the notebook instance.
*
*
* @return The Amazon Resource Name (ARN) of the notebook instance.
*/
public String getNotebookInstanceArn() {
return this.notebookInstanceArn;
}
/**
*
* The Amazon Resource Name (ARN) of the notebook instance.
*
*
* @param notebookInstanceArn
* The Amazon Resource Name (ARN) of the notebook instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNotebookInstanceResult withNotebookInstanceArn(String notebookInstanceArn) {
setNotebookInstanceArn(notebookInstanceArn);
return this;
}
/**
*
* The name of the Amazon SageMaker notebook instance.
*
*
* @param notebookInstanceName
* The name of the Amazon SageMaker notebook instance.
*/
public void setNotebookInstanceName(String notebookInstanceName) {
this.notebookInstanceName = notebookInstanceName;
}
/**
*
* The name of the Amazon SageMaker notebook instance.
*
*
* @return The name of the Amazon SageMaker notebook instance.
*/
public String getNotebookInstanceName() {
return this.notebookInstanceName;
}
/**
*
* The name of the Amazon SageMaker notebook instance.
*
*
* @param notebookInstanceName
* The name of the Amazon SageMaker notebook instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNotebookInstanceResult withNotebookInstanceName(String notebookInstanceName) {
setNotebookInstanceName(notebookInstanceName);
return this;
}
/**
*
* The status of the notebook instance.
*
*
* @param notebookInstanceStatus
* The status of the notebook instance.
* @see NotebookInstanceStatus
*/
public void setNotebookInstanceStatus(String notebookInstanceStatus) {
this.notebookInstanceStatus = notebookInstanceStatus;
}
/**
*
* The status of the notebook instance.
*
*
* @return The status of the notebook instance.
* @see NotebookInstanceStatus
*/
public String getNotebookInstanceStatus() {
return this.notebookInstanceStatus;
}
/**
*
* The status of the notebook instance.
*
*
* @param notebookInstanceStatus
* The status of the notebook instance.
* @return Returns a reference to this object so that method calls can be chained together.
* @see NotebookInstanceStatus
*/
public DescribeNotebookInstanceResult withNotebookInstanceStatus(String notebookInstanceStatus) {
setNotebookInstanceStatus(notebookInstanceStatus);
return this;
}
/**
*
* The status of the notebook instance.
*
*
* @param notebookInstanceStatus
* The status of the notebook instance.
* @return Returns a reference to this object so that method calls can be chained together.
* @see NotebookInstanceStatus
*/
public DescribeNotebookInstanceResult withNotebookInstanceStatus(NotebookInstanceStatus notebookInstanceStatus) {
this.notebookInstanceStatus = notebookInstanceStatus.toString();
return this;
}
/**
*
* If status is Failed, the reason it failed.
*
*
* @param failureReason
* If status is Failed, the reason it failed.
*/
public void setFailureReason(String failureReason) {
this.failureReason = failureReason;
}
/**
*
* If status is Failed, the reason it failed.
*
*
* @return If status is Failed, the reason it failed.
*/
public String getFailureReason() {
return this.failureReason;
}
/**
*
* If status is Failed, the reason it failed.
*
*
* @param failureReason
* If status is Failed, the reason it failed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNotebookInstanceResult withFailureReason(String failureReason) {
setFailureReason(failureReason);
return this;
}
/**
*
* The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
*
*
* @param url
* The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
*/
public void setUrl(String url) {
this.url = url;
}
/**
*
* The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
*
*
* @return The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
*/
public String getUrl() {
return this.url;
}
/**
*
* The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
*
*
* @param url
* The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNotebookInstanceResult withUrl(String url) {
setUrl(url);
return this;
}
/**
*
* The type of ML compute instance running on the notebook instance.
*
*
* @param instanceType
* The type of ML compute instance running on the notebook instance.
* @see InstanceType
*/
public void setInstanceType(String instanceType) {
this.instanceType = instanceType;
}
/**
*
* The type of ML compute instance running on the notebook instance.
*
*
* @return The type of ML compute instance running on the notebook instance.
* @see InstanceType
*/
public String getInstanceType() {
return this.instanceType;
}
/**
*
* The type of ML compute instance running on the notebook instance.
*
*
* @param instanceType
* The type of ML compute instance running on the notebook instance.
* @return Returns a reference to this object so that method calls can be chained together.
* @see InstanceType
*/
public DescribeNotebookInstanceResult withInstanceType(String instanceType) {
setInstanceType(instanceType);
return this;
}
/**
*
* The type of ML compute instance running on the notebook instance.
*
*
* @param instanceType
* The type of ML compute instance running on the notebook instance.
* @return Returns a reference to this object so that method calls can be chained together.
* @see InstanceType
*/
public DescribeNotebookInstanceResult withInstanceType(InstanceType instanceType) {
this.instanceType = instanceType.toString();
return this;
}
/**
*
* The ID of the VPC subnet.
*
*
* @param subnetId
* The ID of the VPC subnet.
*/
public void setSubnetId(String subnetId) {
this.subnetId = subnetId;
}
/**
*
* The ID of the VPC subnet.
*
*
* @return The ID of the VPC subnet.
*/
public String getSubnetId() {
return this.subnetId;
}
/**
*
* The ID of the VPC subnet.
*
*
* @param subnetId
* The ID of the VPC subnet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNotebookInstanceResult withSubnetId(String subnetId) {
setSubnetId(subnetId);
return this;
}
/**
*
* The IDs of the VPC security groups.
*
*
* @return The IDs of the VPC security groups.
*/
public java.util.List getSecurityGroups() {
return securityGroups;
}
/**
*
* The IDs of the VPC security groups.
*
*
* @param securityGroups
* The IDs of the VPC security groups.
*/
public void setSecurityGroups(java.util.Collection securityGroups) {
if (securityGroups == null) {
this.securityGroups = null;
return;
}
this.securityGroups = new java.util.ArrayList(securityGroups);
}
/**
*
* The IDs of the VPC security groups.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSecurityGroups(java.util.Collection)} or {@link #withSecurityGroups(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param securityGroups
* The IDs of the VPC security groups.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNotebookInstanceResult withSecurityGroups(String... securityGroups) {
if (this.securityGroups == null) {
setSecurityGroups(new java.util.ArrayList(securityGroups.length));
}
for (String ele : securityGroups) {
this.securityGroups.add(ele);
}
return this;
}
/**
*
* The IDs of the VPC security groups.
*
*
* @param securityGroups
* The IDs of the VPC security groups.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNotebookInstanceResult withSecurityGroups(java.util.Collection securityGroups) {
setSecurityGroups(securityGroups);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM role associated with the instance.
*
*
* @param roleArn
* The Amazon Resource Name (ARN) of the IAM role associated with the instance.
*/
public void setRoleArn(String roleArn) {
this.roleArn = roleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM role associated with the instance.
*
*
* @return The Amazon Resource Name (ARN) of the IAM role associated with the instance.
*/
public String getRoleArn() {
return this.roleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM role associated with the instance.
*
*
* @param roleArn
* The Amazon Resource Name (ARN) of the IAM role associated with the instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNotebookInstanceResult withRoleArn(String roleArn) {
setRoleArn(roleArn);
return this;
}
/**
*
* The AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the
* instance.
*
*
* @param kmsKeyId
* The AWS 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;
}
/**
*
* The AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the
* instance.
*
*
* @return The AWS 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;
}
/**
*
* The AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the
* instance.
*
*
* @param kmsKeyId
* The AWS 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 DescribeNotebookInstanceResult withKmsKeyId(String kmsKeyId) {
setKmsKeyId(kmsKeyId);
return this;
}
/**
*
* The network interface IDs that Amazon SageMaker created at the time of creating the instance.
*
*
* @param networkInterfaceId
* The network interface IDs that Amazon SageMaker created at the time of creating the instance.
*/
public void setNetworkInterfaceId(String networkInterfaceId) {
this.networkInterfaceId = networkInterfaceId;
}
/**
*
* The network interface IDs that Amazon SageMaker created at the time of creating the instance.
*
*
* @return The network interface IDs that Amazon SageMaker created at the time of creating the instance.
*/
public String getNetworkInterfaceId() {
return this.networkInterfaceId;
}
/**
*
* The network interface IDs that Amazon SageMaker created at the time of creating the instance.
*
*
* @param networkInterfaceId
* The network interface IDs that Amazon SageMaker created at the time of creating the instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNotebookInstanceResult withNetworkInterfaceId(String networkInterfaceId) {
setNetworkInterfaceId(networkInterfaceId);
return this;
}
/**
*
* A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
*
*
* @param lastModifiedTime
* A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
*/
public void setLastModifiedTime(java.util.Date lastModifiedTime) {
this.lastModifiedTime = lastModifiedTime;
}
/**
*
* A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
*
*
* @return A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
*/
public java.util.Date getLastModifiedTime() {
return this.lastModifiedTime;
}
/**
*
* A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
*
*
* @param lastModifiedTime
* A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNotebookInstanceResult withLastModifiedTime(java.util.Date lastModifiedTime) {
setLastModifiedTime(lastModifiedTime);
return this;
}
/**
*
* A timestamp. Use this parameter to return the time when the notebook instance was created
*
*
* @param creationTime
* A timestamp. Use this parameter to return the time when the notebook instance was created
*/
public void setCreationTime(java.util.Date creationTime) {
this.creationTime = creationTime;
}
/**
*
* A timestamp. Use this parameter to return the time when the notebook instance was created
*
*
* @return A timestamp. Use this parameter to return the time when the notebook instance was created
*/
public java.util.Date getCreationTime() {
return this.creationTime;
}
/**
*
* A timestamp. Use this parameter to return the time when the notebook instance was created
*
*
* @param creationTime
* A timestamp. Use this parameter to return the time when the notebook instance was created
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNotebookInstanceResult withCreationTime(java.util.Date creationTime) {
setCreationTime(creationTime);
return this;
}
/**
*
* Returns the name of a notebook instance lifecycle configuration.
*
*
* For information about notebook instance lifestyle configurations, see Step 2.1: (Optional)
* Customize a Notebook Instance
*
*
* @param notebookInstanceLifecycleConfigName
* Returns the name of a notebook instance lifecycle configuration.
*
* For information about notebook instance lifestyle configurations, see Step 2.1: (Optional)
* Customize a Notebook Instance
*/
public void setNotebookInstanceLifecycleConfigName(String notebookInstanceLifecycleConfigName) {
this.notebookInstanceLifecycleConfigName = notebookInstanceLifecycleConfigName;
}
/**
*
* Returns the name of a notebook instance lifecycle configuration.
*
*
* For information about notebook instance lifestyle configurations, see Step 2.1: (Optional)
* Customize a Notebook Instance
*
*
* @return Returns the name of a notebook instance lifecycle configuration.
*
* For information about notebook instance lifestyle configurations, see Step 2.1:
* (Optional) Customize a Notebook Instance
*/
public String getNotebookInstanceLifecycleConfigName() {
return this.notebookInstanceLifecycleConfigName;
}
/**
*
* Returns the name of a notebook instance lifecycle configuration.
*
*
* For information about notebook instance lifestyle configurations, see Step 2.1: (Optional)
* Customize a Notebook Instance
*
*
* @param notebookInstanceLifecycleConfigName
* Returns the name of a notebook instance lifecycle configuration.
*
* For information about notebook instance lifestyle configurations, see Step 2.1: (Optional)
* Customize a Notebook Instance
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNotebookInstanceResult withNotebookInstanceLifecycleConfigName(String notebookInstanceLifecycleConfigName) {
setNotebookInstanceLifecycleConfigName(notebookInstanceLifecycleConfigName);
return this;
}
/**
*
* Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set to
* Disabled, the notebook instance does not have internet access, and cannot connect to Amazon SageMaker
* training and endpoint services.
*
*
* For more information, see Notebook Instances Are Internet-Enabled by Default.
*
*
* @param directInternetAccess
* Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set
* to Disabled, the notebook instance does not have internet access, and cannot connect to Amazon
* SageMaker training and endpoint services.
*
* For more information, see Notebook Instances Are Internet-Enabled by Default.
* @see DirectInternetAccess
*/
public void setDirectInternetAccess(String directInternetAccess) {
this.directInternetAccess = directInternetAccess;
}
/**
*
* Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set to
* Disabled, the notebook instance does not have internet access, and cannot connect to Amazon SageMaker
* training and endpoint services.
*
*
* For more information, see Notebook Instances Are Internet-Enabled by Default.
*
*
* @return Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is
* set to Disabled, the notebook instance does not have internet access, and cannot connect to Amazon
* SageMaker training and endpoint services.
*
* For more information, see Notebook Instances Are Internet-Enabled by Default.
* @see DirectInternetAccess
*/
public String getDirectInternetAccess() {
return this.directInternetAccess;
}
/**
*
* Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set to
* Disabled, the notebook instance does not have internet access, and cannot connect to Amazon SageMaker
* training and endpoint services.
*
*
* For more information, see Notebook Instances Are Internet-Enabled by Default.
*
*
* @param directInternetAccess
* Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set
* to Disabled, the notebook instance does not have internet access, and cannot connect to Amazon
* SageMaker training and endpoint services.
*
* For more information, see Notebook Instances Are Internet-Enabled by Default.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DirectInternetAccess
*/
public DescribeNotebookInstanceResult withDirectInternetAccess(String directInternetAccess) {
setDirectInternetAccess(directInternetAccess);
return this;
}
/**
*
* Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set to
* Disabled, the notebook instance does not have internet access, and cannot connect to Amazon SageMaker
* training and endpoint services.
*
*
* For more information, see Notebook Instances Are Internet-Enabled by Default.
*
*
* @param directInternetAccess
* Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set
* to Disabled, the notebook instance does not have internet access, and cannot connect to Amazon
* SageMaker training and endpoint services.
*
* For more information, see Notebook Instances Are Internet-Enabled by Default.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DirectInternetAccess
*/
public DescribeNotebookInstanceResult withDirectInternetAccess(DirectInternetAccess directInternetAccess) {
this.directInternetAccess = directInternetAccess.toString();
return this;
}
/**
*
* The size, in GB, of the ML storage volume attached to the notebook instance.
*
*
* @param volumeSizeInGB
* The size, in GB, of the ML storage volume attached to the notebook instance.
*/
public void setVolumeSizeInGB(Integer volumeSizeInGB) {
this.volumeSizeInGB = volumeSizeInGB;
}
/**
*
* The size, in GB, of the ML storage volume attached to the notebook instance.
*
*
* @return The size, in GB, of the ML storage volume attached to the notebook instance.
*/
public Integer getVolumeSizeInGB() {
return this.volumeSizeInGB;
}
/**
*
* The size, in GB, of the ML storage volume attached to the notebook instance.
*
*
* @param volumeSizeInGB
* The size, in GB, of the ML storage volume attached to the notebook instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNotebookInstanceResult withVolumeSizeInGB(Integer volumeSizeInGB) {
setVolumeSizeInGB(volumeSizeInGB);
return this;
}
/**
*
* A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently only one EI
* instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.
*
*
* @return A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently
* only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon
* SageMaker.
* @see NotebookInstanceAcceleratorType
*/
public java.util.List getAcceleratorTypes() {
return acceleratorTypes;
}
/**
*
* A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently only one EI
* instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.
*
*
* @param acceleratorTypes
* A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently only
* one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon
* SageMaker.
* @see NotebookInstanceAcceleratorType
*/
public void setAcceleratorTypes(java.util.Collection acceleratorTypes) {
if (acceleratorTypes == null) {
this.acceleratorTypes = null;
return;
}
this.acceleratorTypes = new java.util.ArrayList(acceleratorTypes);
}
/**
*
* A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently only one EI
* instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setAcceleratorTypes(java.util.Collection)} or {@link #withAcceleratorTypes(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param acceleratorTypes
* A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently only
* one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon
* SageMaker.
* @return Returns a reference to this object so that method calls can be chained together.
* @see NotebookInstanceAcceleratorType
*/
public DescribeNotebookInstanceResult withAcceleratorTypes(String... acceleratorTypes) {
if (this.acceleratorTypes == null) {
setAcceleratorTypes(new java.util.ArrayList(acceleratorTypes.length));
}
for (String ele : acceleratorTypes) {
this.acceleratorTypes.add(ele);
}
return this;
}
/**
*
* A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently only one EI
* instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.
*
*
* @param acceleratorTypes
* A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently only
* one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon
* SageMaker.
* @return Returns a reference to this object so that method calls can be chained together.
* @see NotebookInstanceAcceleratorType
*/
public DescribeNotebookInstanceResult withAcceleratorTypes(java.util.Collection acceleratorTypes) {
setAcceleratorTypes(acceleratorTypes);
return this;
}
/**
*
* A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently only one EI
* instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.
*
*
* @param acceleratorTypes
* A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently only
* one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon
* SageMaker.
* @return Returns a reference to this object so that method calls can be chained together.
* @see NotebookInstanceAcceleratorType
*/
public DescribeNotebookInstanceResult withAcceleratorTypes(NotebookInstanceAcceleratorType... acceleratorTypes) {
java.util.ArrayList acceleratorTypesCopy = new java.util.ArrayList(acceleratorTypes.length);
for (NotebookInstanceAcceleratorType value : acceleratorTypes) {
acceleratorTypesCopy.add(value.toString());
}
if (getAcceleratorTypes() == null) {
setAcceleratorTypes(acceleratorTypesCopy);
} else {
getAcceleratorTypes().addAll(acceleratorTypesCopy);
}
return this;
}
/**
*
* The Git repository associated with the notebook instance as its default code repository. This can be either the
* name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other
* Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For
* more information, see Associating Git
* Repositories with Amazon SageMaker Notebook Instances.
*
*
* @param defaultCodeRepository
* The Git repository associated with the notebook instance as its default code repository. This can be
* either the name of a Git repository stored as a resource in your account, or the URL of a Git repository
* in AWS CodeCommit or in
* any other Git repository. When you open a notebook instance, it opens in the directory that contains this
* repository. For more information, see Associating Git Repositories with
* Amazon SageMaker Notebook Instances.
*/
public void setDefaultCodeRepository(String defaultCodeRepository) {
this.defaultCodeRepository = defaultCodeRepository;
}
/**
*
* The Git repository associated with the notebook instance as its default code repository. This can be either the
* name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other
* Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For
* more information, see Associating Git
* Repositories with Amazon SageMaker Notebook Instances.
*
*
* @return The Git repository associated with the notebook instance as its default code repository. This can be
* either the name of a Git repository stored as a resource in your account, or the URL of a Git repository
* in AWS CodeCommit or
* in any other Git repository. When you open a notebook instance, it opens in the directory that contains
* this repository. For more information, see Associating Git Repositories
* with Amazon SageMaker Notebook Instances.
*/
public String getDefaultCodeRepository() {
return this.defaultCodeRepository;
}
/**
*
* The Git repository associated with the notebook instance as its default code repository. This can be either the
* name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other
* Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For
* more information, see Associating Git
* Repositories with Amazon SageMaker Notebook Instances.
*
*
* @param defaultCodeRepository
* The Git repository associated with the notebook instance as its default code repository. This can be
* either the name of a Git repository stored as a resource in your account, or the URL of a Git repository
* in AWS CodeCommit or in
* any other Git repository. When you open a notebook instance, it opens in the directory that contains this
* repository. For more information, see Associating Git Repositories with
* Amazon SageMaker Notebook Instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNotebookInstanceResult withDefaultCodeRepository(String defaultCodeRepository) {
setDefaultCodeRepository(defaultCodeRepository);
return this;
}
/**
*
* An array of up to three Git repositories associated with the notebook instance. These can be either the names of
* Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other
* Git repository. These repositories are cloned at the same level as the default repository of your notebook
* instance. For more information, see Associating Git Repositories with Amazon
* SageMaker Notebook Instances.
*
*
* @return An array of up to three Git repositories associated with the notebook instance. These can be either the
* names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any
* other Git repository. These repositories are cloned at the same level as the default repository of your
* notebook instance. For more information, see Associating Git Repositories
* with Amazon SageMaker Notebook Instances.
*/
public java.util.List getAdditionalCodeRepositories() {
return additionalCodeRepositories;
}
/**
*
* An array of up to three Git repositories associated with the notebook instance. These can be either the names of
* Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other
* Git repository. These repositories are cloned at the same level as the default repository of your notebook
* instance. For more information, see Associating Git Repositories with Amazon
* SageMaker Notebook Instances.
*
*
* @param additionalCodeRepositories
* An array of up to three Git repositories associated with the notebook instance. These can be either the
* names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any
* other Git repository. These repositories are cloned at the same level as the default repository of your
* notebook instance. For more information, see Associating Git Repositories with
* Amazon SageMaker Notebook Instances.
*/
public void setAdditionalCodeRepositories(java.util.Collection additionalCodeRepositories) {
if (additionalCodeRepositories == null) {
this.additionalCodeRepositories = null;
return;
}
this.additionalCodeRepositories = new java.util.ArrayList(additionalCodeRepositories);
}
/**
*
* An array of up to three Git repositories associated with the notebook instance. These can be either the names of
* Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other
* Git repository. These repositories are cloned at the same level as the default repository of your notebook
* instance. For more information, see Associating Git Repositories with Amazon
* SageMaker Notebook Instances.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setAdditionalCodeRepositories(java.util.Collection)} or
* {@link #withAdditionalCodeRepositories(java.util.Collection)} if you want to override the existing values.
*
*
* @param additionalCodeRepositories
* An array of up to three Git repositories associated with the notebook instance. These can be either the
* names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any
* other Git repository. These repositories are cloned at the same level as the default repository of your
* notebook instance. For more information, see Associating Git Repositories with
* Amazon SageMaker Notebook Instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNotebookInstanceResult withAdditionalCodeRepositories(String... additionalCodeRepositories) {
if (this.additionalCodeRepositories == null) {
setAdditionalCodeRepositories(new java.util.ArrayList(additionalCodeRepositories.length));
}
for (String ele : additionalCodeRepositories) {
this.additionalCodeRepositories.add(ele);
}
return this;
}
/**
*
* An array of up to three Git repositories associated with the notebook instance. These can be either the names of
* Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other
* Git repository. These repositories are cloned at the same level as the default repository of your notebook
* instance. For more information, see Associating Git Repositories with Amazon
* SageMaker Notebook Instances.
*
*
* @param additionalCodeRepositories
* An array of up to three Git repositories associated with the notebook instance. These can be either the
* names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any
* other Git repository. These repositories are cloned at the same level as the default repository of your
* notebook instance. For more information, see Associating Git Repositories with
* Amazon SageMaker Notebook Instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNotebookInstanceResult withAdditionalCodeRepositories(java.util.Collection additionalCodeRepositories) {
setAdditionalCodeRepositories(additionalCodeRepositories);
return this;
}
/**
*
* Whether root access is enabled or disabled for users of the notebook instance.
*
*
*
* Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle
* configurations associated with a notebook instance always run with root access even if you disable root access
* for users.
*
*
*
* @param rootAccess
* Whether root access is enabled or disabled for users of the notebook instance.
*
* Lifecycle configurations need root access to be able to set up a notebook instance. Because of this,
* lifecycle configurations associated with a notebook instance always run with root access even if you
* disable root access for users.
*
* @see RootAccess
*/
public void setRootAccess(String rootAccess) {
this.rootAccess = rootAccess;
}
/**
*
* Whether root access is enabled or disabled for users of the notebook instance.
*
*
*
* Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle
* configurations associated with a notebook instance always run with root access even if you disable root access
* for users.
*
*
*
* @return Whether root access is enabled or disabled for users of the notebook instance.
*
* Lifecycle configurations need root access to be able to set up a notebook instance. Because of this,
* lifecycle configurations associated with a notebook instance always run with root access even if you
* disable root access for users.
*
* @see RootAccess
*/
public String getRootAccess() {
return this.rootAccess;
}
/**
*
* Whether root access is enabled or disabled for users of the notebook instance.
*
*
*
* Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle
* configurations associated with a notebook instance always run with root access even if you disable root access
* for users.
*
*
*
* @param rootAccess
* Whether root access is enabled or disabled for users of the notebook instance.
*
* Lifecycle configurations need root access to be able to set up a notebook instance. Because of this,
* lifecycle configurations associated with a notebook instance always run with root access even if you
* disable root access for users.
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see RootAccess
*/
public DescribeNotebookInstanceResult withRootAccess(String rootAccess) {
setRootAccess(rootAccess);
return this;
}
/**
*
* Whether root access is enabled or disabled for users of the notebook instance.
*
*
*
* Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle
* configurations associated with a notebook instance always run with root access even if you disable root access
* for users.
*
*
*
* @param rootAccess
* Whether root access is enabled or disabled for users of the notebook instance.
*
* Lifecycle configurations need root access to be able to set up a notebook instance. Because of this,
* lifecycle configurations associated with a notebook instance always run with root access even if you
* disable root access for users.
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see RootAccess
*/
public DescribeNotebookInstanceResult withRootAccess(RootAccess rootAccess) {
this.rootAccess = rootAccess.toString();
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 (getNotebookInstanceArn() != null)
sb.append("NotebookInstanceArn: ").append(getNotebookInstanceArn()).append(",");
if (getNotebookInstanceName() != null)
sb.append("NotebookInstanceName: ").append(getNotebookInstanceName()).append(",");
if (getNotebookInstanceStatus() != null)
sb.append("NotebookInstanceStatus: ").append(getNotebookInstanceStatus()).append(",");
if (getFailureReason() != null)
sb.append("FailureReason: ").append(getFailureReason()).append(",");
if (getUrl() != null)
sb.append("Url: ").append(getUrl()).append(",");
if (getInstanceType() != null)
sb.append("InstanceType: ").append(getInstanceType()).append(",");
if (getSubnetId() != null)
sb.append("SubnetId: ").append(getSubnetId()).append(",");
if (getSecurityGroups() != null)
sb.append("SecurityGroups: ").append(getSecurityGroups()).append(",");
if (getRoleArn() != null)
sb.append("RoleArn: ").append(getRoleArn()).append(",");
if (getKmsKeyId() != null)
sb.append("KmsKeyId: ").append(getKmsKeyId()).append(",");
if (getNetworkInterfaceId() != null)
sb.append("NetworkInterfaceId: ").append(getNetworkInterfaceId()).append(",");
if (getLastModifiedTime() != null)
sb.append("LastModifiedTime: ").append(getLastModifiedTime()).append(",");
if (getCreationTime() != null)
sb.append("CreationTime: ").append(getCreationTime()).append(",");
if (getNotebookInstanceLifecycleConfigName() != null)
sb.append("NotebookInstanceLifecycleConfigName: ").append(getNotebookInstanceLifecycleConfigName()).append(",");
if (getDirectInternetAccess() != null)
sb.append("DirectInternetAccess: ").append(getDirectInternetAccess()).append(",");
if (getVolumeSizeInGB() != null)
sb.append("VolumeSizeInGB: ").append(getVolumeSizeInGB()).append(",");
if (getAcceleratorTypes() != null)
sb.append("AcceleratorTypes: ").append(getAcceleratorTypes()).append(",");
if (getDefaultCodeRepository() != null)
sb.append("DefaultCodeRepository: ").append(getDefaultCodeRepository()).append(",");
if (getAdditionalCodeRepositories() != null)
sb.append("AdditionalCodeRepositories: ").append(getAdditionalCodeRepositories()).append(",");
if (getRootAccess() != null)
sb.append("RootAccess: ").append(getRootAccess());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeNotebookInstanceResult == false)
return false;
DescribeNotebookInstanceResult other = (DescribeNotebookInstanceResult) obj;
if (other.getNotebookInstanceArn() == null ^ this.getNotebookInstanceArn() == null)
return false;
if (other.getNotebookInstanceArn() != null && other.getNotebookInstanceArn().equals(this.getNotebookInstanceArn()) == false)
return false;
if (other.getNotebookInstanceName() == null ^ this.getNotebookInstanceName() == null)
return false;
if (other.getNotebookInstanceName() != null && other.getNotebookInstanceName().equals(this.getNotebookInstanceName()) == false)
return false;
if (other.getNotebookInstanceStatus() == null ^ this.getNotebookInstanceStatus() == null)
return false;
if (other.getNotebookInstanceStatus() != null && other.getNotebookInstanceStatus().equals(this.getNotebookInstanceStatus()) == false)
return false;
if (other.getFailureReason() == null ^ this.getFailureReason() == null)
return false;
if (other.getFailureReason() != null && other.getFailureReason().equals(this.getFailureReason()) == false)
return false;
if (other.getUrl() == null ^ this.getUrl() == null)
return false;
if (other.getUrl() != null && other.getUrl().equals(this.getUrl()) == false)
return false;
if (other.getInstanceType() == null ^ this.getInstanceType() == null)
return false;
if (other.getInstanceType() != null && other.getInstanceType().equals(this.getInstanceType()) == false)
return false;
if (other.getSubnetId() == null ^ this.getSubnetId() == null)
return false;
if (other.getSubnetId() != null && other.getSubnetId().equals(this.getSubnetId()) == false)
return false;
if (other.getSecurityGroups() == null ^ this.getSecurityGroups() == null)
return false;
if (other.getSecurityGroups() != null && other.getSecurityGroups().equals(this.getSecurityGroups()) == 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.getKmsKeyId() == null ^ this.getKmsKeyId() == null)
return false;
if (other.getKmsKeyId() != null && other.getKmsKeyId().equals(this.getKmsKeyId()) == false)
return false;
if (other.getNetworkInterfaceId() == null ^ this.getNetworkInterfaceId() == null)
return false;
if (other.getNetworkInterfaceId() != null && other.getNetworkInterfaceId().equals(this.getNetworkInterfaceId()) == false)
return false;
if (other.getLastModifiedTime() == null ^ this.getLastModifiedTime() == null)
return false;
if (other.getLastModifiedTime() != null && other.getLastModifiedTime().equals(this.getLastModifiedTime()) == 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.getNotebookInstanceLifecycleConfigName() == null ^ this.getNotebookInstanceLifecycleConfigName() == null)
return false;
if (other.getNotebookInstanceLifecycleConfigName() != null
&& other.getNotebookInstanceLifecycleConfigName().equals(this.getNotebookInstanceLifecycleConfigName()) == false)
return false;
if (other.getDirectInternetAccess() == null ^ this.getDirectInternetAccess() == null)
return false;
if (other.getDirectInternetAccess() != null && other.getDirectInternetAccess().equals(this.getDirectInternetAccess()) == false)
return false;
if (other.getVolumeSizeInGB() == null ^ this.getVolumeSizeInGB() == null)
return false;
if (other.getVolumeSizeInGB() != null && other.getVolumeSizeInGB().equals(this.getVolumeSizeInGB()) == false)
return false;
if (other.getAcceleratorTypes() == null ^ this.getAcceleratorTypes() == null)
return false;
if (other.getAcceleratorTypes() != null && other.getAcceleratorTypes().equals(this.getAcceleratorTypes()) == false)
return false;
if (other.getDefaultCodeRepository() == null ^ this.getDefaultCodeRepository() == null)
return false;
if (other.getDefaultCodeRepository() != null && other.getDefaultCodeRepository().equals(this.getDefaultCodeRepository()) == false)
return false;
if (other.getAdditionalCodeRepositories() == null ^ this.getAdditionalCodeRepositories() == null)
return false;
if (other.getAdditionalCodeRepositories() != null && other.getAdditionalCodeRepositories().equals(this.getAdditionalCodeRepositories()) == false)
return false;
if (other.getRootAccess() == null ^ this.getRootAccess() == null)
return false;
if (other.getRootAccess() != null && other.getRootAccess().equals(this.getRootAccess()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getNotebookInstanceArn() == null) ? 0 : getNotebookInstanceArn().hashCode());
hashCode = prime * hashCode + ((getNotebookInstanceName() == null) ? 0 : getNotebookInstanceName().hashCode());
hashCode = prime * hashCode + ((getNotebookInstanceStatus() == null) ? 0 : getNotebookInstanceStatus().hashCode());
hashCode = prime * hashCode + ((getFailureReason() == null) ? 0 : getFailureReason().hashCode());
hashCode = prime * hashCode + ((getUrl() == null) ? 0 : getUrl().hashCode());
hashCode = prime * hashCode + ((getInstanceType() == null) ? 0 : getInstanceType().hashCode());
hashCode = prime * hashCode + ((getSubnetId() == null) ? 0 : getSubnetId().hashCode());
hashCode = prime * hashCode + ((getSecurityGroups() == null) ? 0 : getSecurityGroups().hashCode());
hashCode = prime * hashCode + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode());
hashCode = prime * hashCode + ((getKmsKeyId() == null) ? 0 : getKmsKeyId().hashCode());
hashCode = prime * hashCode + ((getNetworkInterfaceId() == null) ? 0 : getNetworkInterfaceId().hashCode());
hashCode = prime * hashCode + ((getLastModifiedTime() == null) ? 0 : getLastModifiedTime().hashCode());
hashCode = prime * hashCode + ((getCreationTime() == null) ? 0 : getCreationTime().hashCode());
hashCode = prime * hashCode + ((getNotebookInstanceLifecycleConfigName() == null) ? 0 : getNotebookInstanceLifecycleConfigName().hashCode());
hashCode = prime * hashCode + ((getDirectInternetAccess() == null) ? 0 : getDirectInternetAccess().hashCode());
hashCode = prime * hashCode + ((getVolumeSizeInGB() == null) ? 0 : getVolumeSizeInGB().hashCode());
hashCode = prime * hashCode + ((getAcceleratorTypes() == null) ? 0 : getAcceleratorTypes().hashCode());
hashCode = prime * hashCode + ((getDefaultCodeRepository() == null) ? 0 : getDefaultCodeRepository().hashCode());
hashCode = prime * hashCode + ((getAdditionalCodeRepositories() == null) ? 0 : getAdditionalCodeRepositories().hashCode());
hashCode = prime * hashCode + ((getRootAccess() == null) ? 0 : getRootAccess().hashCode());
return hashCode;
}
@Override
public DescribeNotebookInstanceResult clone() {
try {
return (DescribeNotebookInstanceResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}