com.amazonaws.services.sagemaker.model.DomainSettingsForUpdate 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;
/**
*
* A collection of Domain configuration settings to update.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DomainSettingsForUpdate implements Serializable, Cloneable, StructuredPojo {
/**
*
* A collection of RStudioServerPro Domain-level app settings to update. A single
* RStudioServerPro application is created for a domain.
*
*/
private RStudioServerProDomainSettingsForUpdate rStudioServerProDomainSettingsForUpdate;
/**
*
* The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the
* InService or Pending state.
*
*/
private String executionRoleIdentityConfig;
/**
*
* The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication
* between Domain-level apps and user apps.
*
*/
private java.util.List securityGroupIds;
/**
*
* A collection of settings that configure the domain's Docker interaction.
*
*/
private DockerSettings dockerSettings;
/**
*
* A collection of settings that configure the Amazon Q experience within the domain.
*
*/
private AmazonQSettings amazonQSettings;
/**
*
* A collection of RStudioServerPro Domain-level app settings to update. A single
* RStudioServerPro application is created for a domain.
*
*
* @param rStudioServerProDomainSettingsForUpdate
* A collection of RStudioServerPro Domain-level app settings to update. A single
* RStudioServerPro application is created for a domain.
*/
public void setRStudioServerProDomainSettingsForUpdate(RStudioServerProDomainSettingsForUpdate rStudioServerProDomainSettingsForUpdate) {
this.rStudioServerProDomainSettingsForUpdate = rStudioServerProDomainSettingsForUpdate;
}
/**
*
* A collection of RStudioServerPro Domain-level app settings to update. A single
* RStudioServerPro application is created for a domain.
*
*
* @return A collection of RStudioServerPro Domain-level app settings to update. A single
* RStudioServerPro application is created for a domain.
*/
public RStudioServerProDomainSettingsForUpdate getRStudioServerProDomainSettingsForUpdate() {
return this.rStudioServerProDomainSettingsForUpdate;
}
/**
*
* A collection of RStudioServerPro Domain-level app settings to update. A single
* RStudioServerPro application is created for a domain.
*
*
* @param rStudioServerProDomainSettingsForUpdate
* A collection of RStudioServerPro Domain-level app settings to update. A single
* RStudioServerPro application is created for a domain.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DomainSettingsForUpdate withRStudioServerProDomainSettingsForUpdate(RStudioServerProDomainSettingsForUpdate rStudioServerProDomainSettingsForUpdate) {
setRStudioServerProDomainSettingsForUpdate(rStudioServerProDomainSettingsForUpdate);
return this;
}
/**
*
* The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the
* InService or Pending state.
*
*
* @param executionRoleIdentityConfig
* The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the
* InService or Pending state.
* @see ExecutionRoleIdentityConfig
*/
public void setExecutionRoleIdentityConfig(String executionRoleIdentityConfig) {
this.executionRoleIdentityConfig = executionRoleIdentityConfig;
}
/**
*
* The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the
* InService or Pending state.
*
*
* @return The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the
* InService or Pending state.
* @see ExecutionRoleIdentityConfig
*/
public String getExecutionRoleIdentityConfig() {
return this.executionRoleIdentityConfig;
}
/**
*
* The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the
* InService or Pending state.
*
*
* @param executionRoleIdentityConfig
* The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the
* InService or Pending state.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ExecutionRoleIdentityConfig
*/
public DomainSettingsForUpdate withExecutionRoleIdentityConfig(String executionRoleIdentityConfig) {
setExecutionRoleIdentityConfig(executionRoleIdentityConfig);
return this;
}
/**
*
* The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the
* InService or Pending state.
*
*
* @param executionRoleIdentityConfig
* The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the
* InService or Pending state.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ExecutionRoleIdentityConfig
*/
public DomainSettingsForUpdate withExecutionRoleIdentityConfig(ExecutionRoleIdentityConfig executionRoleIdentityConfig) {
this.executionRoleIdentityConfig = executionRoleIdentityConfig.toString();
return this;
}
/**
*
* The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication
* between Domain-level apps and user apps.
*
*
* @return The security groups for the Amazon Virtual Private Cloud that the Domain uses for
* communication between Domain-level apps and user apps.
*/
public java.util.List getSecurityGroupIds() {
return securityGroupIds;
}
/**
*
* The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication
* between Domain-level apps and user apps.
*
*
* @param securityGroupIds
* The security groups for the Amazon Virtual Private Cloud that the Domain uses for
* communication between Domain-level apps and user apps.
*/
public void setSecurityGroupIds(java.util.Collection securityGroupIds) {
if (securityGroupIds == null) {
this.securityGroupIds = null;
return;
}
this.securityGroupIds = new java.util.ArrayList(securityGroupIds);
}
/**
*
* The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication
* between Domain-level apps and user apps.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSecurityGroupIds(java.util.Collection)} or {@link #withSecurityGroupIds(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param securityGroupIds
* The security groups for the Amazon Virtual Private Cloud that the Domain uses for
* communication between Domain-level apps and user apps.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DomainSettingsForUpdate withSecurityGroupIds(String... securityGroupIds) {
if (this.securityGroupIds == null) {
setSecurityGroupIds(new java.util.ArrayList(securityGroupIds.length));
}
for (String ele : securityGroupIds) {
this.securityGroupIds.add(ele);
}
return this;
}
/**
*
* The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication
* between Domain-level apps and user apps.
*
*
* @param securityGroupIds
* The security groups for the Amazon Virtual Private Cloud that the Domain uses for
* communication between Domain-level apps and user apps.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DomainSettingsForUpdate withSecurityGroupIds(java.util.Collection securityGroupIds) {
setSecurityGroupIds(securityGroupIds);
return this;
}
/**
*
* A collection of settings that configure the domain's Docker interaction.
*
*
* @param dockerSettings
* A collection of settings that configure the domain's Docker interaction.
*/
public void setDockerSettings(DockerSettings dockerSettings) {
this.dockerSettings = dockerSettings;
}
/**
*
* A collection of settings that configure the domain's Docker interaction.
*
*
* @return A collection of settings that configure the domain's Docker interaction.
*/
public DockerSettings getDockerSettings() {
return this.dockerSettings;
}
/**
*
* A collection of settings that configure the domain's Docker interaction.
*
*
* @param dockerSettings
* A collection of settings that configure the domain's Docker interaction.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DomainSettingsForUpdate withDockerSettings(DockerSettings dockerSettings) {
setDockerSettings(dockerSettings);
return this;
}
/**
*
* A collection of settings that configure the Amazon Q experience within the domain.
*
*
* @param amazonQSettings
* A collection of settings that configure the Amazon Q experience within the domain.
*/
public void setAmazonQSettings(AmazonQSettings amazonQSettings) {
this.amazonQSettings = amazonQSettings;
}
/**
*
* A collection of settings that configure the Amazon Q experience within the domain.
*
*
* @return A collection of settings that configure the Amazon Q experience within the domain.
*/
public AmazonQSettings getAmazonQSettings() {
return this.amazonQSettings;
}
/**
*
* A collection of settings that configure the Amazon Q experience within the domain.
*
*
* @param amazonQSettings
* A collection of settings that configure the Amazon Q experience within the domain.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DomainSettingsForUpdate withAmazonQSettings(AmazonQSettings amazonQSettings) {
setAmazonQSettings(amazonQSettings);
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 (getRStudioServerProDomainSettingsForUpdate() != null)
sb.append("RStudioServerProDomainSettingsForUpdate: ").append(getRStudioServerProDomainSettingsForUpdate()).append(",");
if (getExecutionRoleIdentityConfig() != null)
sb.append("ExecutionRoleIdentityConfig: ").append(getExecutionRoleIdentityConfig()).append(",");
if (getSecurityGroupIds() != null)
sb.append("SecurityGroupIds: ").append(getSecurityGroupIds()).append(",");
if (getDockerSettings() != null)
sb.append("DockerSettings: ").append(getDockerSettings()).append(",");
if (getAmazonQSettings() != null)
sb.append("AmazonQSettings: ").append(getAmazonQSettings());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DomainSettingsForUpdate == false)
return false;
DomainSettingsForUpdate other = (DomainSettingsForUpdate) obj;
if (other.getRStudioServerProDomainSettingsForUpdate() == null ^ this.getRStudioServerProDomainSettingsForUpdate() == null)
return false;
if (other.getRStudioServerProDomainSettingsForUpdate() != null
&& other.getRStudioServerProDomainSettingsForUpdate().equals(this.getRStudioServerProDomainSettingsForUpdate()) == false)
return false;
if (other.getExecutionRoleIdentityConfig() == null ^ this.getExecutionRoleIdentityConfig() == null)
return false;
if (other.getExecutionRoleIdentityConfig() != null && other.getExecutionRoleIdentityConfig().equals(this.getExecutionRoleIdentityConfig()) == false)
return false;
if (other.getSecurityGroupIds() == null ^ this.getSecurityGroupIds() == null)
return false;
if (other.getSecurityGroupIds() != null && other.getSecurityGroupIds().equals(this.getSecurityGroupIds()) == false)
return false;
if (other.getDockerSettings() == null ^ this.getDockerSettings() == null)
return false;
if (other.getDockerSettings() != null && other.getDockerSettings().equals(this.getDockerSettings()) == false)
return false;
if (other.getAmazonQSettings() == null ^ this.getAmazonQSettings() == null)
return false;
if (other.getAmazonQSettings() != null && other.getAmazonQSettings().equals(this.getAmazonQSettings()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getRStudioServerProDomainSettingsForUpdate() == null) ? 0 : getRStudioServerProDomainSettingsForUpdate().hashCode());
hashCode = prime * hashCode + ((getExecutionRoleIdentityConfig() == null) ? 0 : getExecutionRoleIdentityConfig().hashCode());
hashCode = prime * hashCode + ((getSecurityGroupIds() == null) ? 0 : getSecurityGroupIds().hashCode());
hashCode = prime * hashCode + ((getDockerSettings() == null) ? 0 : getDockerSettings().hashCode());
hashCode = prime * hashCode + ((getAmazonQSettings() == null) ? 0 : getAmazonQSettings().hashCode());
return hashCode;
}
@Override
public DomainSettingsForUpdate clone() {
try {
return (DomainSettingsForUpdate) 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.DomainSettingsForUpdateMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}