software.amazon.awssdk.services.acmpca.model.CreatePermissionRequest Maven / Gradle / Ivy
Show all versions of acmpca 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.acmpca.model;
import java.util.Arrays;
import java.util.Collection;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
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 CreatePermissionRequest extends AcmPcaRequest implements
ToCopyableBuilder {
private static final SdkField CERTIFICATE_AUTHORITY_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("CertificateAuthorityArn").getter(getter(CreatePermissionRequest::certificateAuthorityArn))
.setter(setter(Builder::certificateAuthorityArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CertificateAuthorityArn").build())
.build();
private static final SdkField PRINCIPAL_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Principal").getter(getter(CreatePermissionRequest::principal)).setter(setter(Builder::principal))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Principal").build()).build();
private static final SdkField SOURCE_ACCOUNT_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SourceAccount").getter(getter(CreatePermissionRequest::sourceAccount))
.setter(setter(Builder::sourceAccount))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SourceAccount").build()).build();
private static final SdkField> ACTIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Actions")
.getter(getter(CreatePermissionRequest::actionsAsStrings))
.setter(setter(Builder::actionsWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Actions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
CERTIFICATE_AUTHORITY_ARN_FIELD, PRINCIPAL_FIELD, SOURCE_ACCOUNT_FIELD, ACTIONS_FIELD));
private final String certificateAuthorityArn;
private final String principal;
private final String sourceAccount;
private final List actions;
private CreatePermissionRequest(BuilderImpl builder) {
super(builder);
this.certificateAuthorityArn = builder.certificateAuthorityArn;
this.principal = builder.principal;
this.sourceAccount = builder.sourceAccount;
this.actions = builder.actions;
}
/**
*
* The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the ARN by calling the
* ListCertificateAuthorities action. This must have the following form:
*
*
* arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
* .
*
*
* @return The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the ARN by calling the
*
* ListCertificateAuthorities action. This must have the following form:
*
* arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
*/
public final String certificateAuthorityArn() {
return certificateAuthorityArn;
}
/**
*
* The Amazon Web Services service or identity that receives the permission. At this time, the only valid principal
* is acm.amazonaws.com.
*
*
* @return The Amazon Web Services service or identity that receives the permission. At this time, the only valid
* principal is acm.amazonaws.com.
*/
public final String principal() {
return principal;
}
/**
*
* The ID of the calling account.
*
*
* @return The ID of the calling account.
*/
public final String sourceAccount() {
return sourceAccount;
}
/**
*
* The actions that the specified Amazon Web Services service principal can use. These include
* IssueCertificate, GetCertificate, and ListPermissions.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasActions} method.
*
*
* @return The actions that the specified Amazon Web Services service principal can use. These include
* IssueCertificate, GetCertificate, and ListPermissions.
*/
public final List actions() {
return ActionListCopier.copyStringToEnum(actions);
}
/**
* For responses, this returns true if the service returned a value for the Actions property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is
* useful because the SDK will never return a null collection or map, but you may need to differentiate between the
* service returning nothing (or null) and the service returning an empty collection or map. For requests, this
* returns true if a value for the property was specified in the request builder, and false if a value was not
* specified.
*/
public final boolean hasActions() {
return actions != null && !(actions instanceof SdkAutoConstructList);
}
/**
*
* The actions that the specified Amazon Web Services service principal can use. These include
* IssueCertificate, GetCertificate, and ListPermissions.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasActions} method.
*
*
* @return The actions that the specified Amazon Web Services service principal can use. These include
* IssueCertificate, GetCertificate, and ListPermissions.
*/
public final List actionsAsStrings() {
return actions;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(certificateAuthorityArn());
hashCode = 31 * hashCode + Objects.hashCode(principal());
hashCode = 31 * hashCode + Objects.hashCode(sourceAccount());
hashCode = 31 * hashCode + Objects.hashCode(hasActions() ? actionsAsStrings() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreatePermissionRequest)) {
return false;
}
CreatePermissionRequest other = (CreatePermissionRequest) obj;
return Objects.equals(certificateAuthorityArn(), other.certificateAuthorityArn())
&& Objects.equals(principal(), other.principal()) && Objects.equals(sourceAccount(), other.sourceAccount())
&& hasActions() == other.hasActions() && Objects.equals(actionsAsStrings(), other.actionsAsStrings());
}
/**
* 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 final String toString() {
return ToString.builder("CreatePermissionRequest").add("CertificateAuthorityArn", certificateAuthorityArn())
.add("Principal", principal()).add("SourceAccount", sourceAccount())
.add("Actions", hasActions() ? actionsAsStrings() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "CertificateAuthorityArn":
return Optional.ofNullable(clazz.cast(certificateAuthorityArn()));
case "Principal":
return Optional.ofNullable(clazz.cast(principal()));
case "SourceAccount":
return Optional.ofNullable(clazz.cast(sourceAccount()));
case "Actions":
return Optional.ofNullable(clazz.cast(actionsAsStrings()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreatePermissionRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends AcmPcaRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the ARN by calling the
* ListCertificateAuthorities action. This must have the following form:
*
*
* arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
* .
*
*
* @param certificateAuthorityArn
* The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the ARN by calling
* the ListCertificateAuthorities action. This must have the following form:
*
* arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder certificateAuthorityArn(String certificateAuthorityArn);
/**
*
* The Amazon Web Services service or identity that receives the permission. At this time, the only valid
* principal is acm.amazonaws.com.
*
*
* @param principal
* The Amazon Web Services service or identity that receives the permission. At this time, the only valid
* principal is acm.amazonaws.com.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder principal(String principal);
/**
*
* The ID of the calling account.
*
*
* @param sourceAccount
* The ID of the calling account.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sourceAccount(String sourceAccount);
/**
*
* The actions that the specified Amazon Web Services service principal can use. These include
* IssueCertificate, GetCertificate, and ListPermissions.
*
*
* @param actions
* The actions that the specified Amazon Web Services service principal can use. These include
* IssueCertificate, GetCertificate, and ListPermissions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder actionsWithStrings(Collection actions);
/**
*
* The actions that the specified Amazon Web Services service principal can use. These include
* IssueCertificate, GetCertificate, and ListPermissions.
*
*
* @param actions
* The actions that the specified Amazon Web Services service principal can use. These include
* IssueCertificate, GetCertificate, and ListPermissions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder actionsWithStrings(String... actions);
/**
*
* The actions that the specified Amazon Web Services service principal can use. These include
* IssueCertificate, GetCertificate, and ListPermissions.
*
*
* @param actions
* The actions that the specified Amazon Web Services service principal can use. These include
* IssueCertificate, GetCertificate, and ListPermissions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder actions(Collection actions);
/**
*
* The actions that the specified Amazon Web Services service principal can use. These include
* IssueCertificate, GetCertificate, and ListPermissions.
*
*
* @param actions
* The actions that the specified Amazon Web Services service principal can use. These include
* IssueCertificate, GetCertificate, and ListPermissions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder actions(ActionType... actions);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends AcmPcaRequest.BuilderImpl implements Builder {
private String certificateAuthorityArn;
private String principal;
private String sourceAccount;
private List actions = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreatePermissionRequest model) {
super(model);
certificateAuthorityArn(model.certificateAuthorityArn);
principal(model.principal);
sourceAccount(model.sourceAccount);
actionsWithStrings(model.actions);
}
public final String getCertificateAuthorityArn() {
return certificateAuthorityArn;
}
public final void setCertificateAuthorityArn(String certificateAuthorityArn) {
this.certificateAuthorityArn = certificateAuthorityArn;
}
@Override
public final Builder certificateAuthorityArn(String certificateAuthorityArn) {
this.certificateAuthorityArn = certificateAuthorityArn;
return this;
}
public final String getPrincipal() {
return principal;
}
public final void setPrincipal(String principal) {
this.principal = principal;
}
@Override
public final Builder principal(String principal) {
this.principal = principal;
return this;
}
public final String getSourceAccount() {
return sourceAccount;
}
public final void setSourceAccount(String sourceAccount) {
this.sourceAccount = sourceAccount;
}
@Override
public final Builder sourceAccount(String sourceAccount) {
this.sourceAccount = sourceAccount;
return this;
}
public final Collection getActions() {
if (actions instanceof SdkAutoConstructList) {
return null;
}
return actions;
}
public final void setActions(Collection actions) {
this.actions = ActionListCopier.copy(actions);
}
@Override
public final Builder actionsWithStrings(Collection actions) {
this.actions = ActionListCopier.copy(actions);
return this;
}
@Override
@SafeVarargs
public final Builder actionsWithStrings(String... actions) {
actionsWithStrings(Arrays.asList(actions));
return this;
}
@Override
public final Builder actions(Collection actions) {
this.actions = ActionListCopier.copyEnumToString(actions);
return this;
}
@Override
@SafeVarargs
public final Builder actions(ActionType... actions) {
actions(Arrays.asList(actions));
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreatePermissionRequest build() {
return new CreatePermissionRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}