software.amazon.awssdk.services.signer.model.AddProfilePermissionRequest Maven / Gradle / Ivy
Show all versions of signer 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.signer.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 AddProfilePermissionRequest extends SignerRequest implements
ToCopyableBuilder {
private static final SdkField PROFILE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("profileName").getter(getter(AddProfilePermissionRequest::profileName))
.setter(setter(Builder::profileName))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("profileName").build()).build();
private static final SdkField PROFILE_VERSION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("profileVersion").getter(getter(AddProfilePermissionRequest::profileVersion))
.setter(setter(Builder::profileVersion))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("profileVersion").build()).build();
private static final SdkField ACTION_FIELD = SdkField. builder(MarshallingType.STRING).memberName("action")
.getter(getter(AddProfilePermissionRequest::action)).setter(setter(Builder::action))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("action").build()).build();
private static final SdkField PRINCIPAL_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("principal").getter(getter(AddProfilePermissionRequest::principal)).setter(setter(Builder::principal))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("principal").build()).build();
private static final SdkField REVISION_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("revisionId").getter(getter(AddProfilePermissionRequest::revisionId)).setter(setter(Builder::revisionId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("revisionId").build()).build();
private static final SdkField STATEMENT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("statementId").getter(getter(AddProfilePermissionRequest::statementId))
.setter(setter(Builder::statementId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("statementId").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PROFILE_NAME_FIELD,
PROFILE_VERSION_FIELD, ACTION_FIELD, PRINCIPAL_FIELD, REVISION_ID_FIELD, STATEMENT_ID_FIELD));
private final String profileName;
private final String profileVersion;
private final String action;
private final String principal;
private final String revisionId;
private final String statementId;
private AddProfilePermissionRequest(BuilderImpl builder) {
super(builder);
this.profileName = builder.profileName;
this.profileVersion = builder.profileVersion;
this.action = builder.action;
this.principal = builder.principal;
this.revisionId = builder.revisionId;
this.statementId = builder.statementId;
}
/**
*
* The human-readable name of the signing profile.
*
*
* @return The human-readable name of the signing profile.
*/
public final String profileName() {
return profileName;
}
/**
*
* The version of the signing profile.
*
*
* @return The version of the signing profile.
*/
public final String profileVersion() {
return profileVersion;
}
/**
*
* For cross-account signing. Grant a designated account permission to perform one or more of the following actions.
* Each action is associated with a specific API's operations. For more information about cross-account signing, see
* Using
* cross-account signing with signing profiles in the AWS Signer Developer Guide.
*
*
* You can designate the following actions to an account.
*
*
* -
*
* signer:StartSigningJob. This action isn't supported for container image workflows. For details, see
* StartSigningJob.
*
*
* -
*
* signer:SignPayload. This action isn't supported for AWS Lambda workflows. For details, see
* SignPayload
*
*
* -
*
* signer:GetSigningProfile. For details, see GetSigningProfile.
*
*
* -
*
* signer:RevokeSignature. For details, see RevokeSignature.
*
*
*
*
* @return For cross-account signing. Grant a designated account permission to perform one or more of the following
* actions. Each action is associated with a specific API's operations. For more information about
* cross-account signing, see Using
* cross-account signing with signing profiles in the AWS Signer Developer Guide.
*
* You can designate the following actions to an account.
*
*
* -
*
* signer:StartSigningJob. This action isn't supported for container image workflows. For
* details, see StartSigningJob.
*
*
* -
*
* signer:SignPayload. This action isn't supported for AWS Lambda workflows. For details, see
* SignPayload
*
*
* -
*
* signer:GetSigningProfile. For details, see GetSigningProfile.
*
*
* -
*
* signer:RevokeSignature. For details, see RevokeSignature.
*
*
*/
public final String action() {
return action;
}
/**
*
* The AWS principal receiving cross-account permissions. This may be an IAM role or another AWS account ID.
*
*
* @return The AWS principal receiving cross-account permissions. This may be an IAM role or another AWS account ID.
*/
public final String principal() {
return principal;
}
/**
*
* A unique identifier for the current profile revision.
*
*
* @return A unique identifier for the current profile revision.
*/
public final String revisionId() {
return revisionId;
}
/**
*
* A unique identifier for the cross-account permission statement.
*
*
* @return A unique identifier for the cross-account permission statement.
*/
public final String statementId() {
return statementId;
}
@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(profileName());
hashCode = 31 * hashCode + Objects.hashCode(profileVersion());
hashCode = 31 * hashCode + Objects.hashCode(action());
hashCode = 31 * hashCode + Objects.hashCode(principal());
hashCode = 31 * hashCode + Objects.hashCode(revisionId());
hashCode = 31 * hashCode + Objects.hashCode(statementId());
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 AddProfilePermissionRequest)) {
return false;
}
AddProfilePermissionRequest other = (AddProfilePermissionRequest) obj;
return Objects.equals(profileName(), other.profileName()) && Objects.equals(profileVersion(), other.profileVersion())
&& Objects.equals(action(), other.action()) && Objects.equals(principal(), other.principal())
&& Objects.equals(revisionId(), other.revisionId()) && Objects.equals(statementId(), other.statementId());
}
/**
* 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("AddProfilePermissionRequest").add("ProfileName", profileName())
.add("ProfileVersion", profileVersion()).add("Action", action()).add("Principal", principal())
.add("RevisionId", revisionId()).add("StatementId", statementId()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "profileName":
return Optional.ofNullable(clazz.cast(profileName()));
case "profileVersion":
return Optional.ofNullable(clazz.cast(profileVersion()));
case "action":
return Optional.ofNullable(clazz.cast(action()));
case "principal":
return Optional.ofNullable(clazz.cast(principal()));
case "revisionId":
return Optional.ofNullable(clazz.cast(revisionId()));
case "statementId":
return Optional.ofNullable(clazz.cast(statementId()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AddProfilePermissionRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SignerRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The human-readable name of the signing profile.
*
*
* @param profileName
* The human-readable name of the signing profile.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder profileName(String profileName);
/**
*
* The version of the signing profile.
*
*
* @param profileVersion
* The version of the signing profile.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder profileVersion(String profileVersion);
/**
*
* For cross-account signing. Grant a designated account permission to perform one or more of the following
* actions. Each action is associated with a specific API's operations. For more information about cross-account
* signing, see Using
* cross-account signing with signing profiles in the AWS Signer Developer Guide.
*
*
* You can designate the following actions to an account.
*
*
* -
*
* signer:StartSigningJob. This action isn't supported for container image workflows. For details,
* see StartSigningJob.
*
*
* -
*
* signer:SignPayload. This action isn't supported for AWS Lambda workflows. For details, see
* SignPayload
*
*
* -
*
* signer:GetSigningProfile. For details, see GetSigningProfile.
*
*
* -
*
* signer:RevokeSignature. For details, see RevokeSignature.
*
*
*
*
* @param action
* For cross-account signing. Grant a designated account permission to perform one or more of the
* following actions. Each action is associated with a specific API's operations. For more information
* about cross-account signing, see Using cross-account signing with signing profiles in the AWS Signer Developer Guide.
*
* You can designate the following actions to an account.
*
*
* -
*
* signer:StartSigningJob. This action isn't supported for container image workflows. For
* details, see StartSigningJob.
*
*
* -
*
* signer:SignPayload. This action isn't supported for AWS Lambda workflows. For details,
* see SignPayload
*
*
* -
*
* signer:GetSigningProfile. For details, see GetSigningProfile.
*
*
* -
*
* signer:RevokeSignature. For details, see RevokeSignature.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder action(String action);
/**
*
* The AWS principal receiving cross-account permissions. This may be an IAM role or another AWS account ID.
*
*
* @param principal
* The AWS principal receiving cross-account permissions. This may be an IAM role or another AWS account
* ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder principal(String principal);
/**
*
* A unique identifier for the current profile revision.
*
*
* @param revisionId
* A unique identifier for the current profile revision.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder revisionId(String revisionId);
/**
*
* A unique identifier for the cross-account permission statement.
*
*
* @param statementId
* A unique identifier for the cross-account permission statement.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder statementId(String statementId);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends SignerRequest.BuilderImpl implements Builder {
private String profileName;
private String profileVersion;
private String action;
private String principal;
private String revisionId;
private String statementId;
private BuilderImpl() {
}
private BuilderImpl(AddProfilePermissionRequest model) {
super(model);
profileName(model.profileName);
profileVersion(model.profileVersion);
action(model.action);
principal(model.principal);
revisionId(model.revisionId);
statementId(model.statementId);
}
public final String getProfileName() {
return profileName;
}
public final void setProfileName(String profileName) {
this.profileName = profileName;
}
@Override
public final Builder profileName(String profileName) {
this.profileName = profileName;
return this;
}
public final String getProfileVersion() {
return profileVersion;
}
public final void setProfileVersion(String profileVersion) {
this.profileVersion = profileVersion;
}
@Override
public final Builder profileVersion(String profileVersion) {
this.profileVersion = profileVersion;
return this;
}
public final String getAction() {
return action;
}
public final void setAction(String action) {
this.action = action;
}
@Override
public final Builder action(String action) {
this.action = action;
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 getRevisionId() {
return revisionId;
}
public final void setRevisionId(String revisionId) {
this.revisionId = revisionId;
}
@Override
public final Builder revisionId(String revisionId) {
this.revisionId = revisionId;
return this;
}
public final String getStatementId() {
return statementId;
}
public final void setStatementId(String statementId) {
this.statementId = statementId;
}
@Override
public final Builder statementId(String statementId) {
this.statementId = statementId;
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 AddProfilePermissionRequest build() {
return new AddProfilePermissionRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}