Class UpdateFlowEntitlementRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.mediaconnect.model.MediaConnectRequest
software.amazon.awssdk.services.mediaconnect.model.UpdateFlowEntitlementRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateFlowEntitlementRequest.Builder,UpdateFlowEntitlementRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateFlowEntitlementRequest extends MediaConnectRequest implements ToCopyableBuilder<UpdateFlowEntitlementRequest.Builder,UpdateFlowEntitlementRequest>
The entitlement fields that you want to update.

  • Method Details

    • 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 UpdateEncryption encryption()
      The type of encryption that will be used on the output associated with this entitlement. Allowable encryption types: static-key, speke.
      Returns:
      The type of encryption that will be used on the output associated with this entitlement. Allowable encryption types: static-key, speke.

    • entitlementArn

      public final String entitlementArn()
      The ARN of the entitlement that you want to update.
      Returns:
      The ARN of the entitlement that you want to update.

    • entitlementStatus

      public final EntitlementStatus entitlementStatus()
      An indication of whether you want to enable the entitlement to allow access, or disable it to stop streaming content to the subscriber’s flow temporarily. If you don’t specify the entitlementStatus field in your request, MediaConnect leaves the value unchanged.

      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 you want to enable the entitlement to allow access, or disable it to stop streaming content to the subscriber’s flow temporarily. If you don’t specify the entitlementStatus field in your request, MediaConnect leaves the value unchanged.
      See Also:

    • entitlementStatusAsString

      public final String entitlementStatusAsString()
      An indication of whether you want to enable the entitlement to allow access, or disable it to stop streaming content to the subscriber’s flow temporarily. If you don’t specify the entitlementStatus field in your request, MediaConnect leaves the value unchanged.

      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 you want to enable the entitlement to allow access, or disable it to stop streaming content to the subscriber’s flow temporarily. If you don’t specify the entitlementStatus field in your request, MediaConnect leaves the value unchanged.
      See Also:

    • flowArn

      public final String flowArn()
      The flow that is associated with the entitlement that you want to update.
      Returns:
      The flow that is associated with the entitlement that you want to update.

    • 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 UpdateFlowEntitlementRequest.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<UpdateFlowEntitlementRequest.Builder,UpdateFlowEntitlementRequest>
      Specified by:
      toBuilder in class MediaConnectRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateFlowEntitlementRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateFlowEntitlementRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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