software.amazon.awssdk.services.mediaconnect.model

Class GrantEntitlementRequest

java.lang.Object

software.amazon.awssdk.services.mediaconnect.model.GrantEntitlementRequest

All Implemented Interfaces:

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

@Generated(value="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 and Description
static interface	GrantEntitlementRequest.Builder

Method Summary

Modifier and Type	Method and 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() 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 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.

Returns:

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

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

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

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