Class GrantEntitlementRequest

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:

  • Method Details

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

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

    • 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 Amazon Web Services 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 Amazon Web Services 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.

    • hasEntitlementTags

      public final boolean hasEntitlementTags()
      For responses, this returns true if the service returned a value for the EntitlementTags 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.

    • entitlementTags

      public final Map<String,String> entitlementTags()

      The key-value pairs that can be used to tag and organize 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 hasEntitlementTags() method.

      Returns:
      The key-value pairs that can be used to tag and organize the entitlement.

    • toBuilder

      public GrantEntitlementRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GrantEntitlementRequest.Builder,GrantEntitlementRequest>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.