software.amazon.awssdk.services.workdocs.model.Principal Maven / Gradle / Ivy
Show all versions of workdocs 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.workdocs.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;
/**
*
* Describes a resource.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Principal implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Id")
.getter(getter(Principal::id)).setter(setter(Builder::id))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Id").build()).build();
private static final SdkField TYPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Type")
.getter(getter(Principal::typeAsString)).setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Type").build()).build();
private static final SdkField> ROLES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Roles")
.getter(getter(Principal::roles))
.setter(setter(Builder::roles))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Roles").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(PermissionInfo::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ID_FIELD, TYPE_FIELD,
ROLES_FIELD));
private static final long serialVersionUID = 1L;
private final String id;
private final String type;
private final List roles;
private Principal(BuilderImpl builder) {
this.id = builder.id;
this.type = builder.type;
this.roles = builder.roles;
}
/**
*
* The ID of the resource.
*
*
* @return The ID of the resource.
*/
public final String id() {
return id;
}
/**
*
* The type of resource.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link PrincipalType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The type of resource.
* @see PrincipalType
*/
public final PrincipalType type() {
return PrincipalType.fromValue(type);
}
/**
*
* The type of resource.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link PrincipalType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The type of resource.
* @see PrincipalType
*/
public final String typeAsString() {
return type;
}
/**
* For responses, this returns true if the service returned a value for the Roles 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 hasRoles() {
return roles != null && !(roles instanceof SdkAutoConstructList);
}
/**
*
* The permission information for the resource.
*
*
* 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 #hasRoles} method.
*
*
* @return The permission information for the resource.
*/
public final List roles() {
return roles;
}
@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(id());
hashCode = 31 * hashCode + Objects.hashCode(typeAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasRoles() ? roles() : null);
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 Principal)) {
return false;
}
Principal other = (Principal) obj;
return Objects.equals(id(), other.id()) && Objects.equals(typeAsString(), other.typeAsString())
&& hasRoles() == other.hasRoles() && Objects.equals(roles(), other.roles());
}
/**
* 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("Principal").add("Id", id()).add("Type", typeAsString())
.add("Roles", hasRoles() ? roles() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Id":
return Optional.ofNullable(clazz.cast(id()));
case "Type":
return Optional.ofNullable(clazz.cast(typeAsString()));
case "Roles":
return Optional.ofNullable(clazz.cast(roles()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Principal) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The ID of the resource.
*
*
* @param id
* The ID of the resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder id(String id);
/**
*
* The type of resource.
*
*
* @param type
* The type of resource.
* @see PrincipalType
* @return Returns a reference to this object so that method calls can be chained together.
* @see PrincipalType
*/
Builder type(String type);
/**
*
* The type of resource.
*
*
* @param type
* The type of resource.
* @see PrincipalType
* @return Returns a reference to this object so that method calls can be chained together.
* @see PrincipalType
*/
Builder type(PrincipalType type);
/**
*
* The permission information for the resource.
*
*
* @param roles
* The permission information for the resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder roles(Collection roles);
/**
*
* The permission information for the resource.
*
*
* @param roles
* The permission information for the resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder roles(PermissionInfo... roles);
/**
*
* The permission information for the resource.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.workdocs.model.PermissionInfo.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.workdocs.model.PermissionInfo#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.workdocs.model.PermissionInfo.Builder#build()} is called immediately
* and its result is passed to {@link #roles(List)}.
*
* @param roles
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.workdocs.model.PermissionInfo.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #roles(java.util.Collection)
*/
Builder roles(Consumer... roles);
}
static final class BuilderImpl implements Builder {
private String id;
private String type;
private List roles = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(Principal model) {
id(model.id);
type(model.type);
roles(model.roles);
}
public final String getId() {
return id;
}
public final void setId(String id) {
this.id = id;
}
@Override
public final Builder id(String id) {
this.id = id;
return this;
}
public final String getType() {
return type;
}
public final void setType(String type) {
this.type = type;
}
@Override
public final Builder type(String type) {
this.type = type;
return this;
}
@Override
public final Builder type(PrincipalType type) {
this.type(type == null ? null : type.toString());
return this;
}
public final List getRoles() {
List result = PermissionInfoListCopier.copyToBuilder(this.roles);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setRoles(Collection roles) {
this.roles = PermissionInfoListCopier.copyFromBuilder(roles);
}
@Override
public final Builder roles(Collection roles) {
this.roles = PermissionInfoListCopier.copy(roles);
return this;
}
@Override
@SafeVarargs
public final Builder roles(PermissionInfo... roles) {
roles(Arrays.asList(roles));
return this;
}
@Override
@SafeVarargs
public final Builder roles(Consumer... roles) {
roles(Stream.of(roles).map(c -> PermissionInfo.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public Principal build() {
return new Principal(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}