software.amazon.awssdk.services.s3.model.AccessControlPolicy Maven / Gradle / Ivy
/*
* 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.s3.model;
import java.io.Serializable;
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 java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
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;
/**
*
* Contains the elements that set the ACL permissions for an object per grantee.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AccessControlPolicy implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> GRANTS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Grants")
.getter(getter(AccessControlPolicy::grants))
.setter(setter(Builder::grants))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AccessControlList")
.unmarshallLocationName("AccessControlList").build(),
ListTrait
.builder()
.memberLocationName("Grant")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Grant::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Grant").unmarshallLocationName("Grant").build()).build())
.build()).build();
private static final SdkField OWNER_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("Owner")
.getter(getter(AccessControlPolicy::owner))
.setter(setter(Builder::owner))
.constructor(Owner::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Owner")
.unmarshallLocationName("Owner").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(GRANTS_FIELD, OWNER_FIELD));
private static final long serialVersionUID = 1L;
private final List grants;
private final Owner owner;
private AccessControlPolicy(BuilderImpl builder) {
this.grants = builder.grants;
this.owner = builder.owner;
}
/**
* Returns true if the Grants property was specified by the sender (it may be empty), or false if the sender did not
* specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public final boolean hasGrants() {
return grants != null && !(grants instanceof SdkAutoConstructList);
}
/**
*
* A list of grants.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasGrants()} to see if a value was sent in this field.
*
*
* @return A list of grants.
*/
public final List grants() {
return grants;
}
/**
*
* Container for the bucket owner's display name and ID.
*
*
* @return Container for the bucket owner's display name and ID.
*/
public final Owner owner() {
return owner;
}
@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 + Objects.hashCode(hasGrants() ? grants() : null);
hashCode = 31 * hashCode + Objects.hashCode(owner());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof AccessControlPolicy)) {
return false;
}
AccessControlPolicy other = (AccessControlPolicy) obj;
return hasGrants() == other.hasGrants() && Objects.equals(grants(), other.grants())
&& Objects.equals(owner(), other.owner());
}
/**
* 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("AccessControlPolicy").add("Grants", hasGrants() ? grants() : null).add("Owner", owner()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Grants":
return Optional.ofNullable(clazz.cast(grants()));
case "Owner":
return Optional.ofNullable(clazz.cast(owner()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AccessControlPolicy) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A list of grants.
*
*
* @param grants
* A list of grants.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder grants(Collection grants);
/**
*
* A list of grants.
*
*
* @param grants
* A list of grants.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder grants(Grant... grants);
/**
*
* A list of grants.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create
* one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result
* is passed to {@link #grants(List)}.
*
* @param grants
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #grants(List)
*/
Builder grants(Consumer... grants);
/**
*
* Container for the bucket owner's display name and ID.
*
*
* @param owner
* Container for the bucket owner's display name and ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder owner(Owner owner);
/**
*
* Container for the bucket owner's display name and ID.
*
* This is a convenience that creates an instance of the {@link Owner.Builder} avoiding the need to create one
* manually via {@link Owner#builder()}.
*
* When the {@link Consumer} completes, {@link Owner.Builder#build()} is called immediately and its result is
* passed to {@link #owner(Owner)}.
*
* @param owner
* a consumer that will call methods on {@link Owner.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #owner(Owner)
*/
default Builder owner(Consumer owner) {
return owner(Owner.builder().applyMutation(owner).build());
}
}
static final class BuilderImpl implements Builder {
private List grants = DefaultSdkAutoConstructList.getInstance();
private Owner owner;
private BuilderImpl() {
}
private BuilderImpl(AccessControlPolicy model) {
grants(model.grants);
owner(model.owner);
}
public final Collection getGrants() {
if (grants instanceof SdkAutoConstructList) {
return null;
}
return grants != null ? grants.stream().map(Grant::toBuilder).collect(Collectors.toList()) : null;
}
@Override
public final Builder grants(Collection grants) {
this.grants = GrantsCopier.copy(grants);
return this;
}
@Override
@SafeVarargs
public final Builder grants(Grant... grants) {
grants(Arrays.asList(grants));
return this;
}
@Override
@SafeVarargs
public final Builder grants(Consumer... grants) {
grants(Stream.of(grants).map(c -> Grant.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final void setGrants(Collection grants) {
this.grants = GrantsCopier.copyFromBuilder(grants);
}
public final Owner.Builder getOwner() {
return owner != null ? owner.toBuilder() : null;
}
@Override
public final Builder owner(Owner owner) {
this.owner = owner;
return this;
}
public final void setOwner(Owner.BuilderImpl owner) {
this.owner = owner != null ? owner.build() : null;
}
@Override
public AccessControlPolicy build() {
return new AccessControlPolicy(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy