software.amazon.awssdk.services.mediaconnect.model

Class Entitlement

java.lang.Object

software.amazon.awssdk.services.mediaconnect.model.Entitlement

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Entitlement.Builder,Entitlement>

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

The settings for a flow entitlement.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Entitlement.Builder

Method Summary

Modifier and Type	Method and Description
static Entitlement.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.
String	entitlementArn() The ARN of the entitlement.
EntitlementStatus	entitlementStatus() An indication of whether the entitlement is enabled.
String	entitlementStatusAsString() An indication of whether the entitlement is enabled.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSubscribers() Returns true if the Subscribers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	name() The name of the entitlement.
List<SdkField<?>>	sdkFields()
static Class<? extends Entitlement.Builder>	serializableBuilderClass()
List<String>	subscribers() The AWS account IDs that you want to share your content with.
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

dataTransferSubscriberFeePercent

public 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 String description()

A description of the entitlement.

Returns:

A description of the entitlement.

encryption

public Encryption encryption()

The type of encryption that will be used on the output that is associated with this entitlement.

Returns:

The type of encryption that will be used on the output that is associated with this entitlement.

entitlementArn

public String entitlementArn()

The ARN of the entitlement.

Returns:

The ARN of the entitlement.

entitlementStatus

public EntitlementStatus entitlementStatus()

An indication of whether the entitlement is 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 entitlement is enabled.

See Also:

EntitlementStatus

entitlementStatusAsString

public String entitlementStatusAsString()

An indication of whether the entitlement is 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 entitlement is enabled.

See Also:

EntitlementStatus

name

public String name()

The name of the entitlement.

Returns:

The name of the entitlement.

hasSubscribers

public boolean hasSubscribers()

Returns true if the Subscribers 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.

subscribers

public 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 flow using your content as the source.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasSubscribers() to see if a value was sent in this field.

Returns:

The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo