com.amazonaws.services.organizations.model.PolicyTargetSummary 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.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Contains information about a root, OU, or account that a policy is attached to.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PolicyTargetSummary implements Serializable, Cloneable, StructuredPojo {
/**
*
* The unique identifier (ID) of the policy target.
*
*
* The regex pattern for a target ID string requires one of the
* following:
*
*
* -
*
* Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
*
*
* -
*
* Account - A string that consists of exactly 12 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 targetId;
/**
*
* The Amazon Resource Name (ARN) of the policy target.
*
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
*
*/
private String arn;
/**
*
* The friendly name of the policy target.
*
*
* The regex pattern that is used to validate this parameter is a
* string of any of the characters in the ASCII character range.
*
*/
private String name;
/**
*
* The type of the policy target.
*
*/
private String type;
/**
*
* The unique identifier (ID) of the policy target.
*
*
* The regex pattern for a target ID string requires one of the
* following:
*
*
* -
*
* Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
*
*
* -
*
* Account - A string that consists of exactly 12 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 targetId
* The unique identifier (ID) of the policy target.
*
* The regex pattern for a target ID string requires one of the
* following:
*
*
* -
*
* Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
*
*
* -
*
* Account - A string that consists of exactly 12 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 setTargetId(String targetId) {
this.targetId = targetId;
}
/**
*
* The unique identifier (ID) of the policy target.
*
*
* The regex pattern for a target ID string requires one of the
* following:
*
*
* -
*
* Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
*
*
* -
*
* Account - A string that consists of exactly 12 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 policy target.
*
* The regex pattern for a target ID string requires one of
* the following:
*
*
* -
*
* Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
*
*
* -
*
* Account - A string that consists of exactly 12 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 getTargetId() {
return this.targetId;
}
/**
*
* The unique identifier (ID) of the policy target.
*
*
* The regex pattern for a target ID string requires one of the
* following:
*
*
* -
*
* Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
*
*
* -
*
* Account - A string that consists of exactly 12 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 targetId
* The unique identifier (ID) of the policy target.
*
* The regex pattern for a target ID string requires one of the
* following:
*
*
* -
*
* Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
*
*
* -
*
* Account - A string that consists of exactly 12 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 PolicyTargetSummary withTargetId(String targetId) {
setTargetId(targetId);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the policy target.
*
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the policy target.
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization
* Reference.
*/
public void setArn(String arn) {
this.arn = arn;
}
/**
*
* The Amazon Resource Name (ARN) of the policy target.
*
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
*
*
* @return The Amazon Resource Name (ARN) of the policy target.
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization
* Reference.
*/
public String getArn() {
return this.arn;
}
/**
*
* The Amazon Resource Name (ARN) of the policy target.
*
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the policy target.
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization
* Reference.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PolicyTargetSummary withArn(String arn) {
setArn(arn);
return this;
}
/**
*
* The friendly name of the policy target.
*
*
* The regex pattern that is used to validate this parameter is a
* string of any of the characters in the ASCII character range.
*
*
* @param name
* The friendly name of the policy target.
*
* The regex pattern that is used to validate this parameter is
* a string of any of the characters in the ASCII character range.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The friendly name of the policy target.
*
*
* The regex pattern that is used to validate this parameter is a
* string of any of the characters in the ASCII character range.
*
*
* @return The friendly name of the policy target.
*
* The regex pattern that is used to validate this parameter
* is a string of any of the characters in the ASCII character range.
*/
public String getName() {
return this.name;
}
/**
*
* The friendly name of the policy target.
*
*
* The regex pattern that is used to validate this parameter is a
* string of any of the characters in the ASCII character range.
*
*
* @param name
* The friendly name of the policy target.
*
* The regex pattern that is used to validate this parameter is
* a string of any of the characters in the ASCII character range.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PolicyTargetSummary withName(String name) {
setName(name);
return this;
}
/**
*
* The type of the policy target.
*
*
* @param type
* The type of the policy target.
* @see TargetType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* The type of the policy target.
*
*
* @return The type of the policy target.
* @see TargetType
*/
public String getType() {
return this.type;
}
/**
*
* The type of the policy target.
*
*
* @param type
* The type of the policy target.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TargetType
*/
public PolicyTargetSummary withType(String type) {
setType(type);
return this;
}
/**
*
* The type of the policy target.
*
*
* @param type
* The type of the policy target.
* @see TargetType
*/
public void setType(TargetType type) {
withType(type);
}
/**
*
* The type of the policy target.
*
*
* @param type
* The type of the policy target.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TargetType
*/
public PolicyTargetSummary withType(TargetType type) {
this.type = type.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 (getTargetId() != null)
sb.append("TargetId: ").append(getTargetId()).append(",");
if (getArn() != null)
sb.append("Arn: ").append(getArn()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getType() != null)
sb.append("Type: ").append(getType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PolicyTargetSummary == false)
return false;
PolicyTargetSummary other = (PolicyTargetSummary) obj;
if (other.getTargetId() == null ^ this.getTargetId() == null)
return false;
if (other.getTargetId() != null && other.getTargetId().equals(this.getTargetId()) == false)
return false;
if (other.getArn() == null ^ this.getArn() == null)
return false;
if (other.getArn() != null && other.getArn().equals(this.getArn()) == 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.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTargetId() == null) ? 0 : getTargetId().hashCode());
hashCode = prime * hashCode + ((getArn() == null) ? 0 : getArn().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
return hashCode;
}
@Override
public PolicyTargetSummary clone() {
try {
return (PolicyTargetSummary) 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.organizations.model.transform.PolicyTargetSummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}