Class PlaybackRestrictionPolicy

java.lang.Object
software.amazon.awssdk.services.ivs.model.PlaybackRestrictionPolicy
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PlaybackRestrictionPolicy.Builder,PlaybackRestrictionPolicy>
@Generated("software.amazon.awssdk:codegen") public final class PlaybackRestrictionPolicy extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PlaybackRestrictionPolicy.Builder,PlaybackRestrictionPolicy>

An object representing a policy to constrain playback by country and/or origin sites.

See Also:

  • Method Details

    • hasAllowedCountries

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

    • allowedCountries

      public final List<String> allowedCountries()

      A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).

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

      Returns:
      A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).

    • hasAllowedOrigins

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

    • allowedOrigins

      public final List<String> allowedOrigins()

      A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla .org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).

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

      Returns:
      A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https: //developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).

    • arn

      public final String arn()

      Playback-restriction-policy ARN

      Returns:
      Playback-restriction-policy ARN

    • enableStrictOriginEnforcement

      public final Boolean enableStrictOriginEnforcement()

      Whether channel playback is constrained by origin site. Default: false.

      Returns:
      Whether channel playback is constrained by origin site. Default: false.

    • name

      public final String name()

      Playback-restriction-policy name. The value does not need to be unique.

      Returns:
      Playback-restriction-policy name. The value does not need to be unique.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

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

      Returns:
      Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

    • toBuilder

      public PlaybackRestrictionPolicy.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<PlaybackRestrictionPolicy.Builder,PlaybackRestrictionPolicy>
      Returns:
      a builder for type T

    • builder

      public static PlaybackRestrictionPolicy.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PlaybackRestrictionPolicy.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.