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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceUpdateFlowEntitlementRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static UpdateFlowEntitlementRequest.Builderbuilder()Stringdescription()A description of the entitlement.UpdateEncryptionencryption()The type of encryption that will be used on the output associated with this entitlement.StringentitlementArn()The ARN of the entitlement that you want to update.EntitlementStatusentitlementStatus()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.StringentitlementStatusAsString()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.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringflowArn()The flow that is associated with the entitlement that you want to update.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasSubscribers()For responses, this returns true if the service returned a value for the Subscribers property.List<SdkField<?>>sdkFields()static Class<? extends UpdateFlowEntitlementRequest.Builder>serializableBuilderClass()List<String>subscribers()The AWS account IDs that you want to share your content with.UpdateFlowEntitlementRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
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,
entitlementStatuswill returnEntitlementStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromentitlementStatusAsString().- 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:
EntitlementStatus
-
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,
entitlementStatuswill returnEntitlementStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromentitlementStatusAsString().- 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:
EntitlementStatus
-
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 theisEmpty()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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<UpdateFlowEntitlementRequest.Builder,UpdateFlowEntitlementRequest>- Specified by:
toBuilderin classMediaConnectRequest
-
builder
public static UpdateFlowEntitlementRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdateFlowEntitlementRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-