software.amazon.awssdk.services.appstream.model.Entitlement Maven / Gradle / Ivy
Show all versions of appstream 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.appstream.model;
import java.io.Serializable;
import java.time.Instant;
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;
/**
*
* Specifies an entitlement. Entitlements control access to specific applications within a stack, based on user
* attributes. Entitlements apply to SAML 2.0 federated user identities. Amazon AppStream 2.0 user pool and streaming
* URL users are entitled to all applications in a stack. Entitlements don't apply to the desktop stream view
* application, or to applications managed by a dynamic app provider using the Dynamic Application Framework.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Entitlement implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(Entitlement::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField STACK_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StackName").getter(getter(Entitlement::stackName)).setter(setter(Builder::stackName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StackName").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(Entitlement::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField APP_VISIBILITY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AppVisibility").getter(getter(Entitlement::appVisibilityAsString))
.setter(setter(Builder::appVisibility))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AppVisibility").build()).build();
private static final SdkField> ATTRIBUTES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Attributes")
.getter(getter(Entitlement::attributes))
.setter(setter(Builder::attributes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Attributes").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(EntitlementAttribute::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField CREATED_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreatedTime").getter(getter(Entitlement::createdTime)).setter(setter(Builder::createdTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreatedTime").build()).build();
private static final SdkField LAST_MODIFIED_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("LastModifiedTime").getter(getter(Entitlement::lastModifiedTime))
.setter(setter(Builder::lastModifiedTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastModifiedTime").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, STACK_NAME_FIELD,
DESCRIPTION_FIELD, APP_VISIBILITY_FIELD, ATTRIBUTES_FIELD, CREATED_TIME_FIELD, LAST_MODIFIED_TIME_FIELD));
private static final long serialVersionUID = 1L;
private final String name;
private final String stackName;
private final String description;
private final String appVisibility;
private final List attributes;
private final Instant createdTime;
private final Instant lastModifiedTime;
private Entitlement(BuilderImpl builder) {
this.name = builder.name;
this.stackName = builder.stackName;
this.description = builder.description;
this.appVisibility = builder.appVisibility;
this.attributes = builder.attributes;
this.createdTime = builder.createdTime;
this.lastModifiedTime = builder.lastModifiedTime;
}
/**
*
* The name of the entitlement.
*
*
* @return The name of the entitlement.
*/
public final String name() {
return name;
}
/**
*
* The name of the stack with which the entitlement is associated.
*
*
* @return The name of the stack with which the entitlement is associated.
*/
public final String stackName() {
return stackName;
}
/**
*
* The description of the entitlement.
*
*
* @return The description of the entitlement.
*/
public final String description() {
return description;
}
/**
*
* Specifies whether all or selected apps are entitled.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #appVisibility}
* will return {@link AppVisibility#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #appVisibilityAsString}.
*
*
* @return Specifies whether all or selected apps are entitled.
* @see AppVisibility
*/
public final AppVisibility appVisibility() {
return AppVisibility.fromValue(appVisibility);
}
/**
*
* Specifies whether all or selected apps are entitled.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #appVisibility}
* will return {@link AppVisibility#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #appVisibilityAsString}.
*
*
* @return Specifies whether all or selected apps are entitled.
* @see AppVisibility
*/
public final String appVisibilityAsString() {
return appVisibility;
}
/**
* For responses, this returns true if the service returned a value for the Attributes 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 hasAttributes() {
return attributes != null && !(attributes instanceof SdkAutoConstructList);
}
/**
*
* The attributes of the entitlement.
*
*
* 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 #hasAttributes} method.
*
*
* @return The attributes of the entitlement.
*/
public final List attributes() {
return attributes;
}
/**
*
* The time when the entitlement was created.
*
*
* @return The time when the entitlement was created.
*/
public final Instant createdTime() {
return createdTime;
}
/**
*
* The time when the entitlement was last modified.
*
*
* @return The time when the entitlement was last modified.
*/
public final Instant lastModifiedTime() {
return lastModifiedTime;
}
@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(name());
hashCode = 31 * hashCode + Objects.hashCode(stackName());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(appVisibilityAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasAttributes() ? attributes() : null);
hashCode = 31 * hashCode + Objects.hashCode(createdTime());
hashCode = 31 * hashCode + Objects.hashCode(lastModifiedTime());
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 Entitlement)) {
return false;
}
Entitlement other = (Entitlement) obj;
return Objects.equals(name(), other.name()) && Objects.equals(stackName(), other.stackName())
&& Objects.equals(description(), other.description())
&& Objects.equals(appVisibilityAsString(), other.appVisibilityAsString())
&& hasAttributes() == other.hasAttributes() && Objects.equals(attributes(), other.attributes())
&& Objects.equals(createdTime(), other.createdTime())
&& Objects.equals(lastModifiedTime(), other.lastModifiedTime());
}
/**
* 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("Entitlement").add("Name", name()).add("StackName", stackName())
.add("Description", description()).add("AppVisibility", appVisibilityAsString())
.add("Attributes", hasAttributes() ? attributes() : null).add("CreatedTime", createdTime())
.add("LastModifiedTime", lastModifiedTime()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "StackName":
return Optional.ofNullable(clazz.cast(stackName()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "AppVisibility":
return Optional.ofNullable(clazz.cast(appVisibilityAsString()));
case "Attributes":
return Optional.ofNullable(clazz.cast(attributes()));
case "CreatedTime":
return Optional.ofNullable(clazz.cast(createdTime()));
case "LastModifiedTime":
return Optional.ofNullable(clazz.cast(lastModifiedTime()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Entitlement) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of the entitlement.
*
*
* @param name
* The name of the entitlement.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The name of the stack with which the entitlement is associated.
*
*
* @param stackName
* The name of the stack with which the entitlement is associated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stackName(String stackName);
/**
*
* The description of the entitlement.
*
*
* @param description
* The description of the entitlement.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* Specifies whether all or selected apps are entitled.
*
*
* @param appVisibility
* Specifies whether all or selected apps are entitled.
* @see AppVisibility
* @return Returns a reference to this object so that method calls can be chained together.
* @see AppVisibility
*/
Builder appVisibility(String appVisibility);
/**
*
* Specifies whether all or selected apps are entitled.
*
*
* @param appVisibility
* Specifies whether all or selected apps are entitled.
* @see AppVisibility
* @return Returns a reference to this object so that method calls can be chained together.
* @see AppVisibility
*/
Builder appVisibility(AppVisibility appVisibility);
/**
*
* The attributes of the entitlement.
*
*
* @param attributes
* The attributes of the entitlement.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attributes(Collection attributes);
/**
*
* The attributes of the entitlement.
*
*
* @param attributes
* The attributes of the entitlement.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attributes(EntitlementAttribute... attributes);
/**
*
* The attributes of the entitlement.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.appstream.model.EntitlementAttribute.Builder} avoiding the need to
* create one manually via
* {@link software.amazon.awssdk.services.appstream.model.EntitlementAttribute#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.appstream.model.EntitlementAttribute.Builder#build()} is called
* immediately and its result is passed to {@link #attributes(List)}.
*
* @param attributes
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.appstream.model.EntitlementAttribute.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #attributes(java.util.Collection)
*/
Builder attributes(Consumer... attributes);
/**
*
* The time when the entitlement was created.
*
*
* @param createdTime
* The time when the entitlement was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder createdTime(Instant createdTime);
/**
*
* The time when the entitlement was last modified.
*
*
* @param lastModifiedTime
* The time when the entitlement was last modified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lastModifiedTime(Instant lastModifiedTime);
}
static final class BuilderImpl implements Builder {
private String name;
private String stackName;
private String description;
private String appVisibility;
private List attributes = DefaultSdkAutoConstructList.getInstance();
private Instant createdTime;
private Instant lastModifiedTime;
private BuilderImpl() {
}
private BuilderImpl(Entitlement model) {
name(model.name);
stackName(model.stackName);
description(model.description);
appVisibility(model.appVisibility);
attributes(model.attributes);
createdTime(model.createdTime);
lastModifiedTime(model.lastModifiedTime);
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getStackName() {
return stackName;
}
public final void setStackName(String stackName) {
this.stackName = stackName;
}
@Override
public final Builder stackName(String stackName) {
this.stackName = stackName;
return this;
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final String getAppVisibility() {
return appVisibility;
}
public final void setAppVisibility(String appVisibility) {
this.appVisibility = appVisibility;
}
@Override
public final Builder appVisibility(String appVisibility) {
this.appVisibility = appVisibility;
return this;
}
@Override
public final Builder appVisibility(AppVisibility appVisibility) {
this.appVisibility(appVisibility == null ? null : appVisibility.toString());
return this;
}
public final List getAttributes() {
List result = EntitlementAttributeListCopier.copyToBuilder(this.attributes);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setAttributes(Collection attributes) {
this.attributes = EntitlementAttributeListCopier.copyFromBuilder(attributes);
}
@Override
public final Builder attributes(Collection attributes) {
this.attributes = EntitlementAttributeListCopier.copy(attributes);
return this;
}
@Override
@SafeVarargs
public final Builder attributes(EntitlementAttribute... attributes) {
attributes(Arrays.asList(attributes));
return this;
}
@Override
@SafeVarargs
public final Builder attributes(Consumer... attributes) {
attributes(Stream.of(attributes).map(c -> EntitlementAttribute.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final Instant getCreatedTime() {
return createdTime;
}
public final void setCreatedTime(Instant createdTime) {
this.createdTime = createdTime;
}
@Override
public final Builder createdTime(Instant createdTime) {
this.createdTime = createdTime;
return this;
}
public final Instant getLastModifiedTime() {
return lastModifiedTime;
}
public final void setLastModifiedTime(Instant lastModifiedTime) {
this.lastModifiedTime = lastModifiedTime;
}
@Override
public final Builder lastModifiedTime(Instant lastModifiedTime) {
this.lastModifiedTime = lastModifiedTime;
return this;
}
@Override
public Entitlement build() {
return new Entitlement(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}