com.amazonaws.services.sagemaker.model.CreateWorkforceRequest 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.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateWorkforceRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using
* and corresponds to a single Amazon Cognito
* user pool.
*
*
* Do not use OidcConfig if you specify values for CognitoConfig.
*
*/
private CognitoConfig cognitoConfig;
/**
*
* Use this parameter to configure a private workforce using your own OIDC Identity Provider.
*
*
* Do not use CognitoConfig if you specify values for OidcConfig.
*
*/
private OidcConfig oidcConfig;
private SourceIpConfig sourceIpConfig;
/**
*
* The name of the private workforce.
*
*/
private String workforceName;
/**
*
* An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag
* consists of a key and a value, both of which you define.
*
*/
private java.util.List tags;
/**
*
* Use this parameter to configure a workforce using VPC.
*
*/
private WorkforceVpcConfigRequest workforceVpcConfig;
/**
*
* Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using
* and corresponds to a single Amazon Cognito
* user pool.
*
*
* Do not use OidcConfig if you specify values for CognitoConfig.
*
*
* @param cognitoConfig
* Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created
* using and corresponds to a single Amazon
* Cognito user pool.
*
* Do not use OidcConfig if you specify values for CognitoConfig.
*/
public void setCognitoConfig(CognitoConfig cognitoConfig) {
this.cognitoConfig = cognitoConfig;
}
/**
*
* Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using
* and corresponds to a single Amazon Cognito
* user pool.
*
*
* Do not use OidcConfig if you specify values for CognitoConfig.
*
*
* @return Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is
* created using and corresponds to a single Amazon
* Cognito user pool.
*
* Do not use OidcConfig if you specify values for CognitoConfig.
*/
public CognitoConfig getCognitoConfig() {
return this.cognitoConfig;
}
/**
*
* Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using
* and corresponds to a single Amazon Cognito
* user pool.
*
*
* Do not use OidcConfig if you specify values for CognitoConfig.
*
*
* @param cognitoConfig
* Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created
* using and corresponds to a single Amazon
* Cognito user pool.
*
* Do not use OidcConfig if you specify values for CognitoConfig.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateWorkforceRequest withCognitoConfig(CognitoConfig cognitoConfig) {
setCognitoConfig(cognitoConfig);
return this;
}
/**
*
* Use this parameter to configure a private workforce using your own OIDC Identity Provider.
*
*
* Do not use CognitoConfig if you specify values for OidcConfig.
*
*
* @param oidcConfig
* Use this parameter to configure a private workforce using your own OIDC Identity Provider.
*
* Do not use CognitoConfig if you specify values for OidcConfig.
*/
public void setOidcConfig(OidcConfig oidcConfig) {
this.oidcConfig = oidcConfig;
}
/**
*
* Use this parameter to configure a private workforce using your own OIDC Identity Provider.
*
*
* Do not use CognitoConfig if you specify values for OidcConfig.
*
*
* @return Use this parameter to configure a private workforce using your own OIDC Identity Provider.
*
* Do not use CognitoConfig if you specify values for OidcConfig.
*/
public OidcConfig getOidcConfig() {
return this.oidcConfig;
}
/**
*
* Use this parameter to configure a private workforce using your own OIDC Identity Provider.
*
*
* Do not use CognitoConfig if you specify values for OidcConfig.
*
*
* @param oidcConfig
* Use this parameter to configure a private workforce using your own OIDC Identity Provider.
*
* Do not use CognitoConfig if you specify values for OidcConfig.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateWorkforceRequest withOidcConfig(OidcConfig oidcConfig) {
setOidcConfig(oidcConfig);
return this;
}
/**
* @param sourceIpConfig
*/
public void setSourceIpConfig(SourceIpConfig sourceIpConfig) {
this.sourceIpConfig = sourceIpConfig;
}
/**
* @return
*/
public SourceIpConfig getSourceIpConfig() {
return this.sourceIpConfig;
}
/**
* @param sourceIpConfig
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateWorkforceRequest withSourceIpConfig(SourceIpConfig sourceIpConfig) {
setSourceIpConfig(sourceIpConfig);
return this;
}
/**
*
* The name of the private workforce.
*
*
* @param workforceName
* The name of the private workforce.
*/
public void setWorkforceName(String workforceName) {
this.workforceName = workforceName;
}
/**
*
* The name of the private workforce.
*
*
* @return The name of the private workforce.
*/
public String getWorkforceName() {
return this.workforceName;
}
/**
*
* The name of the private workforce.
*
*
* @param workforceName
* The name of the private workforce.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateWorkforceRequest withWorkforceName(String workforceName) {
setWorkforceName(workforceName);
return this;
}
/**
*
* An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag
* consists of a key and a value, both of which you define.
*
*
* @return An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each
* tag consists of a key and a value, both of which you define.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag
* consists of a key and a value, both of which you define.
*
*
* @param tags
* An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each
* tag consists of a key and a value, both of which you define.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag
* consists of a key and a value, both of which you define.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each
* tag consists of a key and a value, both of which you define.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateWorkforceRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag
* consists of a key and a value, both of which you define.
*
*
* @param tags
* An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each
* tag consists of a key and a value, both of which you define.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateWorkforceRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* Use this parameter to configure a workforce using VPC.
*
*
* @param workforceVpcConfig
* Use this parameter to configure a workforce using VPC.
*/
public void setWorkforceVpcConfig(WorkforceVpcConfigRequest workforceVpcConfig) {
this.workforceVpcConfig = workforceVpcConfig;
}
/**
*
* Use this parameter to configure a workforce using VPC.
*
*
* @return Use this parameter to configure a workforce using VPC.
*/
public WorkforceVpcConfigRequest getWorkforceVpcConfig() {
return this.workforceVpcConfig;
}
/**
*
* Use this parameter to configure a workforce using VPC.
*
*
* @param workforceVpcConfig
* Use this parameter to configure a workforce using VPC.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateWorkforceRequest withWorkforceVpcConfig(WorkforceVpcConfigRequest workforceVpcConfig) {
setWorkforceVpcConfig(workforceVpcConfig);
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 (getCognitoConfig() != null)
sb.append("CognitoConfig: ").append(getCognitoConfig()).append(",");
if (getOidcConfig() != null)
sb.append("OidcConfig: ").append(getOidcConfig()).append(",");
if (getSourceIpConfig() != null)
sb.append("SourceIpConfig: ").append(getSourceIpConfig()).append(",");
if (getWorkforceName() != null)
sb.append("WorkforceName: ").append(getWorkforceName()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getWorkforceVpcConfig() != null)
sb.append("WorkforceVpcConfig: ").append(getWorkforceVpcConfig());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateWorkforceRequest == false)
return false;
CreateWorkforceRequest other = (CreateWorkforceRequest) obj;
if (other.getCognitoConfig() == null ^ this.getCognitoConfig() == null)
return false;
if (other.getCognitoConfig() != null && other.getCognitoConfig().equals(this.getCognitoConfig()) == false)
return false;
if (other.getOidcConfig() == null ^ this.getOidcConfig() == null)
return false;
if (other.getOidcConfig() != null && other.getOidcConfig().equals(this.getOidcConfig()) == false)
return false;
if (other.getSourceIpConfig() == null ^ this.getSourceIpConfig() == null)
return false;
if (other.getSourceIpConfig() != null && other.getSourceIpConfig().equals(this.getSourceIpConfig()) == false)
return false;
if (other.getWorkforceName() == null ^ this.getWorkforceName() == null)
return false;
if (other.getWorkforceName() != null && other.getWorkforceName().equals(this.getWorkforceName()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getWorkforceVpcConfig() == null ^ this.getWorkforceVpcConfig() == null)
return false;
if (other.getWorkforceVpcConfig() != null && other.getWorkforceVpcConfig().equals(this.getWorkforceVpcConfig()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCognitoConfig() == null) ? 0 : getCognitoConfig().hashCode());
hashCode = prime * hashCode + ((getOidcConfig() == null) ? 0 : getOidcConfig().hashCode());
hashCode = prime * hashCode + ((getSourceIpConfig() == null) ? 0 : getSourceIpConfig().hashCode());
hashCode = prime * hashCode + ((getWorkforceName() == null) ? 0 : getWorkforceName().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getWorkforceVpcConfig() == null) ? 0 : getWorkforceVpcConfig().hashCode());
return hashCode;
}
@Override
public CreateWorkforceRequest clone() {
return (CreateWorkforceRequest) super.clone();
}
}