software.amazon.awssdk.services.organizations.model.AttachPolicyRequest Maven / Gradle / Ivy
Show all versions of organizations Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.organizations.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class AttachPolicyRequest extends OrganizationsRequest implements
ToCopyableBuilder {
private static final SdkField POLICY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PolicyId").getter(getter(AttachPolicyRequest::policyId)).setter(setter(Builder::policyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PolicyId").build()).build();
private static final SdkField TARGET_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TargetId").getter(getter(AttachPolicyRequest::targetId)).setter(setter(Builder::targetId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TargetId").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(POLICY_ID_FIELD,
TARGET_ID_FIELD));
private final String policyId;
private final String targetId;
private AttachPolicyRequest(BuilderImpl builder) {
super(builder);
this.policyId = builder.policyId;
this.targetId = builder.targetId;
}
/**
*
* The unique identifier (ID) of the policy that you want to attach to the target. You can get the ID for the policy
* by calling the ListPolicies operation.
*
*
* The regex pattern for a policy ID string requires "p-" followed by
* from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
*
*
* @return The unique identifier (ID) of the policy that you want to attach to the target. You can get the ID for
* the policy by calling the ListPolicies operation.
*
* The regex pattern for a policy ID string requires "p-"
* followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
*/
public String policyId() {
return policyId;
}
/**
*
* The unique identifier (ID) of the root, OU, or account that you want to attach the policy to. You can get the ID
* by calling the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts operations.
*
*
* 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 root, OU, or account that you want to attach the policy to. You can get
* the ID by calling the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts
* operations.
*
* 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 targetId() {
return targetId;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(policyId());
hashCode = 31 * hashCode + Objects.hashCode(targetId());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof AttachPolicyRequest)) {
return false;
}
AttachPolicyRequest other = (AttachPolicyRequest) obj;
return Objects.equals(policyId(), other.policyId()) && Objects.equals(targetId(), other.targetId());
}
/**
* 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.
*/
@Override
public String toString() {
return ToString.builder("AttachPolicyRequest").add("PolicyId", policyId()).add("TargetId", targetId()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "PolicyId":
return Optional.ofNullable(clazz.cast(policyId()));
case "TargetId":
return Optional.ofNullable(clazz.cast(targetId()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AttachPolicyRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends OrganizationsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The unique identifier (ID) of the policy that you want to attach to the target. You can get the ID for the
* policy by calling the ListPolicies operation.
*
*
* The regex pattern for a policy ID string requires "p-" followed
* by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
*
*
* @param policyId
* The unique identifier (ID) of the policy that you want to attach to the target. You can get the ID for
* the policy by calling the ListPolicies operation.
*
* The regex pattern for a policy ID string requires "p-"
* followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder policyId(String policyId);
/**
*
* The unique identifier (ID) of the root, OU, or account that you want to attach the policy to. You can get the
* ID by calling the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts
* operations.
*
*
* 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 root, OU, or account that you want to attach the policy to. You can
* get the ID by calling the ListRoots, ListOrganizationalUnitsForParent, or
* ListAccounts operations.
*
* 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.
*/
Builder targetId(String targetId);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends OrganizationsRequest.BuilderImpl implements Builder {
private String policyId;
private String targetId;
private BuilderImpl() {
}
private BuilderImpl(AttachPolicyRequest model) {
super(model);
policyId(model.policyId);
targetId(model.targetId);
}
public final String getPolicyId() {
return policyId;
}
@Override
public final Builder policyId(String policyId) {
this.policyId = policyId;
return this;
}
public final void setPolicyId(String policyId) {
this.policyId = policyId;
}
public final String getTargetId() {
return targetId;
}
@Override
public final Builder targetId(String targetId) {
this.targetId = targetId;
return this;
}
public final void setTargetId(String targetId) {
this.targetId = targetId;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public AttachPolicyRequest build() {
return new AttachPolicyRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}