software.amazon.awssdk.services.redshift.model.AuthorizeSnapshotAccessRequest Maven / Gradle / Ivy
Show all versions of redshift 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.redshift.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 AuthorizeSnapshotAccessRequest extends RedshiftRequest implements
ToCopyableBuilder {
private static final SdkField SNAPSHOT_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SnapshotIdentifier").getter(getter(AuthorizeSnapshotAccessRequest::snapshotIdentifier))
.setter(setter(Builder::snapshotIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SnapshotIdentifier").build())
.build();
private static final SdkField SNAPSHOT_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SnapshotArn").getter(getter(AuthorizeSnapshotAccessRequest::snapshotArn))
.setter(setter(Builder::snapshotArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SnapshotArn").build()).build();
private static final SdkField SNAPSHOT_CLUSTER_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SnapshotClusterIdentifier").getter(getter(AuthorizeSnapshotAccessRequest::snapshotClusterIdentifier))
.setter(setter(Builder::snapshotClusterIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SnapshotClusterIdentifier").build())
.build();
private static final SdkField ACCOUNT_WITH_RESTORE_ACCESS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AccountWithRestoreAccess").getter(getter(AuthorizeSnapshotAccessRequest::accountWithRestoreAccess))
.setter(setter(Builder::accountWithRestoreAccess))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AccountWithRestoreAccess").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SNAPSHOT_IDENTIFIER_FIELD,
SNAPSHOT_ARN_FIELD, SNAPSHOT_CLUSTER_IDENTIFIER_FIELD, ACCOUNT_WITH_RESTORE_ACCESS_FIELD));
private final String snapshotIdentifier;
private final String snapshotArn;
private final String snapshotClusterIdentifier;
private final String accountWithRestoreAccess;
private AuthorizeSnapshotAccessRequest(BuilderImpl builder) {
super(builder);
this.snapshotIdentifier = builder.snapshotIdentifier;
this.snapshotArn = builder.snapshotArn;
this.snapshotClusterIdentifier = builder.snapshotClusterIdentifier;
this.accountWithRestoreAccess = builder.accountWithRestoreAccess;
}
/**
*
* The identifier of the snapshot the account is authorized to restore.
*
*
* @return The identifier of the snapshot the account is authorized to restore.
*/
public final String snapshotIdentifier() {
return snapshotIdentifier;
}
/**
*
* The Amazon Resource Name (ARN) of the snapshot to authorize access to.
*
*
* @return The Amazon Resource Name (ARN) of the snapshot to authorize access to.
*/
public final String snapshotArn() {
return snapshotArn;
}
/**
*
* The identifier of the cluster the snapshot was created from.
*
*
* -
*
* If the snapshot to access doesn't exist and the associated IAM policy doesn't allow access to all (*)
* snapshots - This parameter is required. Otherwise, permissions aren't available to check if the snapshot
* exists.
*
*
* -
*
* If the snapshot to access exists - This parameter isn't required. Redshift can retrieve the cluster
* identifier and use it to validate snapshot authorization.
*
*
*
*
* @return The identifier of the cluster the snapshot was created from.
*
* -
*
* If the snapshot to access doesn't exist and the associated IAM policy doesn't allow access to all (*)
* snapshots - This parameter is required. Otherwise, permissions aren't available to check if the
* snapshot exists.
*
*
* -
*
* If the snapshot to access exists - This parameter isn't required. Redshift can retrieve the
* cluster identifier and use it to validate snapshot authorization.
*
*
*/
public final String snapshotClusterIdentifier() {
return snapshotClusterIdentifier;
}
/**
*
* The identifier of the Amazon Web Services account authorized to restore the specified snapshot.
*
*
* To share a snapshot with Amazon Web Services Support, specify amazon-redshift-support.
*
*
* @return The identifier of the Amazon Web Services account authorized to restore the specified snapshot.
*
* To share a snapshot with Amazon Web Services Support, specify amazon-redshift-support.
*/
public final String accountWithRestoreAccess() {
return accountWithRestoreAccess;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(snapshotIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(snapshotArn());
hashCode = 31 * hashCode + Objects.hashCode(snapshotClusterIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(accountWithRestoreAccess());
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 AuthorizeSnapshotAccessRequest)) {
return false;
}
AuthorizeSnapshotAccessRequest other = (AuthorizeSnapshotAccessRequest) obj;
return Objects.equals(snapshotIdentifier(), other.snapshotIdentifier())
&& Objects.equals(snapshotArn(), other.snapshotArn())
&& Objects.equals(snapshotClusterIdentifier(), other.snapshotClusterIdentifier())
&& Objects.equals(accountWithRestoreAccess(), other.accountWithRestoreAccess());
}
/**
* 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("AuthorizeSnapshotAccessRequest").add("SnapshotIdentifier", snapshotIdentifier())
.add("SnapshotArn", snapshotArn()).add("SnapshotClusterIdentifier", snapshotClusterIdentifier())
.add("AccountWithRestoreAccess", accountWithRestoreAccess()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "SnapshotIdentifier":
return Optional.ofNullable(clazz.cast(snapshotIdentifier()));
case "SnapshotArn":
return Optional.ofNullable(clazz.cast(snapshotArn()));
case "SnapshotClusterIdentifier":
return Optional.ofNullable(clazz.cast(snapshotClusterIdentifier()));
case "AccountWithRestoreAccess":
return Optional.ofNullable(clazz.cast(accountWithRestoreAccess()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function
*
* -
*
* If the snapshot to access doesn't exist and the associated IAM policy doesn't allow access to all
* (*) snapshots - This parameter is required. Otherwise, permissions aren't available to check if
* the snapshot exists.
*
*
* -
*
* If the snapshot to access exists - This parameter isn't required. Redshift can retrieve the
* cluster identifier and use it to validate snapshot authorization.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder snapshotClusterIdentifier(String snapshotClusterIdentifier);
/**
*
* The identifier of the Amazon Web Services account authorized to restore the specified snapshot.
*
*
* To share a snapshot with Amazon Web Services Support, specify amazon-redshift-support.
*
*
* @param accountWithRestoreAccess
* The identifier of the Amazon Web Services account authorized to restore the specified snapshot.
*
* To share a snapshot with Amazon Web Services Support, specify amazon-redshift-support.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder accountWithRestoreAccess(String accountWithRestoreAccess);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends RedshiftRequest.BuilderImpl implements Builder {
private String snapshotIdentifier;
private String snapshotArn;
private String snapshotClusterIdentifier;
private String accountWithRestoreAccess;
private BuilderImpl() {
}
private BuilderImpl(AuthorizeSnapshotAccessRequest model) {
super(model);
snapshotIdentifier(model.snapshotIdentifier);
snapshotArn(model.snapshotArn);
snapshotClusterIdentifier(model.snapshotClusterIdentifier);
accountWithRestoreAccess(model.accountWithRestoreAccess);
}
public final String getSnapshotIdentifier() {
return snapshotIdentifier;
}
public final void setSnapshotIdentifier(String snapshotIdentifier) {
this.snapshotIdentifier = snapshotIdentifier;
}
@Override
public final Builder snapshotIdentifier(String snapshotIdentifier) {
this.snapshotIdentifier = snapshotIdentifier;
return this;
}
public final String getSnapshotArn() {
return snapshotArn;
}
public final void setSnapshotArn(String snapshotArn) {
this.snapshotArn = snapshotArn;
}
@Override
public final Builder snapshotArn(String snapshotArn) {
this.snapshotArn = snapshotArn;
return this;
}
public final String getSnapshotClusterIdentifier() {
return snapshotClusterIdentifier;
}
public final void setSnapshotClusterIdentifier(String snapshotClusterIdentifier) {
this.snapshotClusterIdentifier = snapshotClusterIdentifier;
}
@Override
public final Builder snapshotClusterIdentifier(String snapshotClusterIdentifier) {
this.snapshotClusterIdentifier = snapshotClusterIdentifier;
return this;
}
public final String getAccountWithRestoreAccess() {
return accountWithRestoreAccess;
}
public final void setAccountWithRestoreAccess(String accountWithRestoreAccess) {
this.accountWithRestoreAccess = accountWithRestoreAccess;
}
@Override
public final Builder accountWithRestoreAccess(String accountWithRestoreAccess) {
this.accountWithRestoreAccess = accountWithRestoreAccess;
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 AuthorizeSnapshotAccessRequest build() {
return new AuthorizeSnapshotAccessRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}