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() 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 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 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.

Returns:

A description of the entitlement.

encryption

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

The ARN of the entitlement.

Returns:

The ARN of the entitlement.

entitlementStatus

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

The name of the entitlement.

Returns:

The name of the entitlement.

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 flow 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 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 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