com.amazonaws.services.organizations.model.CreateOrganizationalUnitRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-organizations 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.organizations.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 CreateOrganizationalUnitRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The unique identifier (ID) of the parent root or OU that you want to create the new OU in.
*
*
* The regex pattern for a parent ID string requires one of the
* following:
*
*
* -
*
* Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
*
*
* -
*
* Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or
* digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32
* additional lowercase letters or digits.
*
*
*
*/
private String parentId;
/**
*
* The friendly name to assign to the new OU.
*
*/
private String name;
/**
*
* A list of tags that you want to attach to the newly created OU. For each tag in the list, you must specify both a
* tag key and a value. You can set the value to an empty string, but you can't set it to null. For
* more information about tagging, see Tagging Organizations
* resources in the Organizations User Guide.
*
*
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for an OU, then the entire
* request fails and the OU is not created.
*
*
*/
private java.util.List tags;
/**
*
* The unique identifier (ID) of the parent root or OU that you want to create the new OU in.
*
*
* The regex pattern for a parent ID string requires one of the
* following:
*
*
* -
*
* Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
*
*
* -
*
* Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or
* digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32
* additional lowercase letters or digits.
*
*
*
*
* @param parentId
* The unique identifier (ID) of the parent root or OU that you want to create the new OU in.
*
* The regex pattern for a parent ID string requires one of the
* following:
*
*
* -
*
* Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
*
*
* -
*
* Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase
* letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and
* from 8 to 32 additional lowercase letters or digits.
*
*
*/
public void setParentId(String parentId) {
this.parentId = parentId;
}
/**
*
* The unique identifier (ID) of the parent root or OU that you want to create the new OU in.
*
*
* The regex pattern for a parent ID string requires one of the
* following:
*
*
* -
*
* Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
*
*
* -
*
* Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or
* digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32
* additional lowercase letters or digits.
*
*
*
*
* @return The unique identifier (ID) of the parent root or OU that you want to create the new OU in.
*
* The regex pattern for a parent ID string requires one of
* the following:
*
*
* -
*
* Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
*
*
* -
*
* Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase
* letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash
* and from 8 to 32 additional lowercase letters or digits.
*
*
*/
public String getParentId() {
return this.parentId;
}
/**
*
* The unique identifier (ID) of the parent root or OU that you want to create the new OU in.
*
*
* The regex pattern for a parent ID string requires one of the
* following:
*
*
* -
*
* Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
*
*
* -
*
* Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or
* digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32
* additional lowercase letters or digits.
*
*
*
*
* @param parentId
* The unique identifier (ID) of the parent root or OU that you want to create the new OU in.
*
* The regex pattern for a parent ID string requires one of the
* following:
*
*
* -
*
* Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
*
*
* -
*
* Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase
* letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and
* from 8 to 32 additional lowercase letters or digits.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateOrganizationalUnitRequest withParentId(String parentId) {
setParentId(parentId);
return this;
}
/**
*
* The friendly name to assign to the new OU.
*
*
* @param name
* The friendly name to assign to the new OU.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The friendly name to assign to the new OU.
*
*
* @return The friendly name to assign to the new OU.
*/
public String getName() {
return this.name;
}
/**
*
* The friendly name to assign to the new OU.
*
*
* @param name
* The friendly name to assign to the new OU.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateOrganizationalUnitRequest withName(String name) {
setName(name);
return this;
}
/**
*
* A list of tags that you want to attach to the newly created OU. For each tag in the list, you must specify both a
* tag key and a value. You can set the value to an empty string, but you can't set it to null. For
* more information about tagging, see Tagging Organizations
* resources in the Organizations User Guide.
*
*
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for an OU, then the entire
* request fails and the OU is not created.
*
*
*
* @return A list of tags that you want to attach to the newly created OU. For each tag in the list, you must
* specify both a tag key and a value. You can set the value to an empty string, but you can't set it to
* null. For more information about tagging, see Tagging Organizations
* resources in the Organizations User Guide.
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for an OU, then the
* entire request fails and the OU is not created.
*
*/
public java.util.List getTags() {
return tags;
}
/**
*
* A list of tags that you want to attach to the newly created OU. For each tag in the list, you must specify both a
* tag key and a value. You can set the value to an empty string, but you can't set it to null. For
* more information about tagging, see Tagging Organizations
* resources in the Organizations User Guide.
*
*
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for an OU, then the entire
* request fails and the OU is not created.
*
*
*
* @param tags
* A list of tags that you want to attach to the newly created OU. For each tag in the list, you must specify
* both a tag key and a value. You can set the value to an empty string, but you can't set it to
* null. For more information about tagging, see Tagging Organizations
* resources in the Organizations User Guide.
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for an OU, then the entire
* request fails and the OU is not created.
*
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* A list of tags that you want to attach to the newly created OU. For each tag in the list, you must specify both a
* tag key and a value. You can set the value to an empty string, but you can't set it to null. For
* more information about tagging, see Tagging Organizations
* resources in the Organizations User Guide.
*
*
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for an OU, then the entire
* request fails and the OU is not created.
*
*
*
* 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
* A list of tags that you want to attach to the newly created OU. For each tag in the list, you must specify
* both a tag key and a value. You can set the value to an empty string, but you can't set it to
* null. For more information about tagging, see Tagging Organizations
* resources in the Organizations User Guide.
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for an OU, then the entire
* request fails and the OU is not created.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateOrganizationalUnitRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* A list of tags that you want to attach to the newly created OU. For each tag in the list, you must specify both a
* tag key and a value. You can set the value to an empty string, but you can't set it to null. For
* more information about tagging, see Tagging Organizations
* resources in the Organizations User Guide.
*
*
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for an OU, then the entire
* request fails and the OU is not created.
*
*
*
* @param tags
* A list of tags that you want to attach to the newly created OU. For each tag in the list, you must specify
* both a tag key and a value. You can set the value to an empty string, but you can't set it to
* null. For more information about tagging, see Tagging Organizations
* resources in the Organizations User Guide.
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for an OU, then the entire
* request fails and the OU is not created.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateOrganizationalUnitRequest withTags(java.util.Collection tags) {
setTags(tags);
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 (getParentId() != null)
sb.append("ParentId: ").append(getParentId()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateOrganizationalUnitRequest == false)
return false;
CreateOrganizationalUnitRequest other = (CreateOrganizationalUnitRequest) obj;
if (other.getParentId() == null ^ this.getParentId() == null)
return false;
if (other.getParentId() != null && other.getParentId().equals(this.getParentId()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getParentId() == null) ? 0 : getParentId().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateOrganizationalUnitRequest clone() {
return (CreateOrganizationalUnitRequest) super.clone();
}
}