java.lang.Object
- software.amazon.awssdk.services.mediaconnect.model.GrantEntitlementRequest

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<GrantEntitlementRequest.Builder,GrantEntitlementRequest>

@Generated("software.amazon.awssdk:codegen")
public final class GrantEntitlementRequest
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<GrantEntitlementRequest.Builder,GrantEntitlementRequest>

The entitlements that you want to grant on a flow.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GrantEntitlementRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static GrantEntitlementRequest.Builder`	`builder()`
`Integer`	`dataTransferSubscriberFeePercent()`	Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
`String`	`description()`	A description of the entitlement.
`Encryption`	`encryption()`	The type of encryption that will be used on the output that is associated with this entitlement.
`EntitlementStatus`	`entitlementStatus()`	An indication of whether the new entitlement should be enabled or disabled as soon as it is created.
`String`	`entitlementStatusAsString()`	An indication of whether the new entitlement should be enabled or disabled as soon as it is created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSubscribers()`	For responses, this returns true if the service returned a value for the Subscribers property.
`String`	`name()`	The name of the entitlement.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GrantEntitlementRequest.Builder>`	`serializableBuilderClass()`
`List<String>`	`subscribers()`	The AWS account IDs that you want to share your content with.
`GrantEntitlementRequest.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
  - dataTransferSubscriberFeePercent
```
public final Integer dataTransferSubscriberFeePercent()
```
    Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
    
    Returns:
    
    Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
  - description
```
public final String description()
```
    A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user.
    
    Returns:
    
    A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user.
  - encryption
```
public final Encryption encryption()
```
    The type of encryption that will be used on the output that is associated with this entitlement. Allowable encryption types: static-key, speke.
    
    Returns:
    
    The type of encryption that will be used on the output that is associated with this entitlement. Allowable encryption types: static-key, speke.
  - entitlementStatus
```
public final EntitlementStatus entitlementStatus()
```
    An indication of whether the new entitlement should be enabled or disabled as soon as it is created. If you don’t specify the entitlementStatus field in your request, MediaConnect sets it to ENABLED.
    If the service returns an enum value that is not available in the current SDK version, entitlementStatus will return EntitlementStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from entitlementStatusAsString().
    
    Returns:
    
    An indication of whether the new entitlement should be enabled or disabled as soon as it is created. If you don’t specify the entitlementStatus field in your request, MediaConnect sets it to ENABLED.
    
    See Also:
    
    EntitlementStatus
  - entitlementStatusAsString
```
public final String entitlementStatusAsString()
```
    An indication of whether the new entitlement should be enabled or disabled as soon as it is created. If you don’t specify the entitlementStatus field in your request, MediaConnect sets it to ENABLED.
    If the service returns an enum value that is not available in the current SDK version, entitlementStatus will return EntitlementStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from entitlementStatusAsString().
    
    Returns:
    
    An indication of whether the new entitlement should be enabled or disabled as soon as it is created. If you don’t specify the entitlementStatus field in your request, MediaConnect sets it to ENABLED.
    
    See Also:
    
    EntitlementStatus
  - name
```
public final String name()
```
    The name of the entitlement. This value must be unique within the current flow.
    
    Returns:
    
    The name of the entitlement. This value must be unique within the current flow.
  - hasSubscribers
```
public final boolean hasSubscribers()
```
    For responses, this returns true if the service returned a value for the Subscribers 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.
  - subscribers
```
public final List<String> subscribers()
```
    The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flows using your content as the source.
    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 hasSubscribers() method.
    
    Returns:
    
    The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flows using your content as the source.
  - toBuilder
```
public GrantEntitlementRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GrantEntitlementRequest.Builder,GrantEntitlementRequest>
  - builder
```
public static GrantEntitlementRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GrantEntitlementRequest.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

Class GrantEntitlementRequest

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

dataTransferSubscriberFeePercent

description

encryption

entitlementStatus

entitlementStatusAsString

name

hasSubscribers

subscribers

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields