java.lang.Object
- software.amazon.awssdk.services.appstream.model.Entitlement

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Entitlement.Builder,Entitlement>
```
@Generated("software.amazon.awssdk:codegen")
public final class Entitlement
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Entitlement.Builder,Entitlement>
```
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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Entitlement.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AppVisibility`	`appVisibility()`	Specifies whether all or selected apps are entitled.
`String`	`appVisibilityAsString()`	Specifies whether all or selected apps are entitled.
`List<EntitlementAttribute>`	`attributes()`	The attributes of the entitlement.
`static Entitlement.Builder`	`builder()`
`Instant`	`createdTime()`	The time when the entitlement was created.
`String`	`description()`	The description of the entitlement.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttributes()`	For responses, this returns true if the service returned a value for the Attributes property.
`int`	`hashCode()`
`Instant`	`lastModifiedTime()`	The time when the entitlement was last modified.
`String`	`name()`	The name of the entitlement.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Entitlement.Builder>`	`serializableBuilderClass()`
`String`	`stackName()`	The name of the stack with which the entitlement is associated.
`Entitlement.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public final String name()
```
    The name of the entitlement.
    
    Returns:
    
    The name of the entitlement.
  - stackName
```
public final String stackName()
```
    The name of the stack with which the entitlement is associated.
    
    Returns:
    
    The name of the stack with which the entitlement is associated.
  - description
```
public final String description()
```
    The description of the entitlement.
    
    Returns:
    
    The description of the entitlement.
  - appVisibility
```
public final AppVisibility 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, appVisibility will return AppVisibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from appVisibilityAsString().
    
    Returns:
    
    Specifies whether all or selected apps are entitled.
    
    See Also:
    
    AppVisibility
  - appVisibilityAsString
```
public final String appVisibilityAsString()
```
    Specifies whether all or selected apps are entitled.
    
    If the service returns an enum value that is not available in the current SDK version, appVisibility will return AppVisibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from appVisibilityAsString().
    
    Returns:
    
    Specifies whether all or selected apps are entitled.
    
    See Also:
    
    AppVisibility
  - hasAttributes
```
public final boolean hasAttributes()
```
    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 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.
  - attributes
```
public final List<EntitlementAttribute> attributes()
```
    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 hasAttributes() method.
    
    Returns:
    
    The attributes of the entitlement.
  - createdTime
```
public final Instant createdTime()
```
    The time when the entitlement was created.
    
    Returns:
    
    The time when the entitlement was created.
  - lastModifiedTime
```
public final Instant lastModifiedTime()
```
    The time when the entitlement was last modified.
    
    Returns:
    
    The time when the entitlement was last modified.
  - toBuilder
```
public Entitlement.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Entitlement.Builder,Entitlement>
  - builder
```
public static Entitlement.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Entitlement.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class Entitlement

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

stackName

description

appVisibility

appVisibilityAsString

hasAttributes

attributes

createdTime

lastModifiedTime

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField