Class PlaybackRestrictionPolicySummary
- java.lang.Object
-
- software.amazon.awssdk.services.ivs.model.PlaybackRestrictionPolicySummary
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<PlaybackRestrictionPolicySummary.Builder,PlaybackRestrictionPolicySummary>
@Generated("software.amazon.awssdk:codegen") public final class PlaybackRestrictionPolicySummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PlaybackRestrictionPolicySummary.Builder,PlaybackRestrictionPolicySummary>
Summary information about a PlaybackRestrictionPolicy.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfacePlaybackRestrictionPolicySummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<String>allowedCountries()A list of country codes that control geoblocking restriction.List<String>allowedOrigins()A list of origin sites that control CORS restriction.Stringarn()Playback-restriction-policy ARNstatic PlaybackRestrictionPolicySummary.Builderbuilder()BooleanenableStrictOriginEnforcement()Whether channel playback is constrained by origin site.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAllowedCountries()For responses, this returns true if the service returned a value for the AllowedCountries property.booleanhasAllowedOrigins()For responses, this returns true if the service returned a value for the AllowedOrigins property.inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.Stringname()Playback-restriction-policy name.List<SdkField<?>>sdkFields()static Class<? extends PlaybackRestrictionPolicySummary.Builder>serializableBuilderClass()Map<String,String>tags()Tags attached to the resource.PlaybackRestrictionPolicySummary.BuildertoBuilder()StringtoString()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
-
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 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.
-
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 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.
-
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 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.
-
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 Tagging Amazon Web Services Resources for more information, 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 Tagging Amazon Web Services Resources for more information, 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 PlaybackRestrictionPolicySummary.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<PlaybackRestrictionPolicySummary.Builder,PlaybackRestrictionPolicySummary>
-
builder
public static PlaybackRestrictionPolicySummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends PlaybackRestrictionPolicySummary.Builder> serializableBuilderClass()
-
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.
-
-