software.amazon.awssdk.services.ivs.model.PlaybackRestrictionPolicySummary Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ivs Show documentation
Show all versions of ivs Show documentation
The AWS Java SDK for Ivs module holds the client classes that are used for
communicating with Ivs.
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.ivs.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Summary information about a PlaybackRestrictionPolicy.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class PlaybackRestrictionPolicySummary implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("arn")
.getter(getter(PlaybackRestrictionPolicySummary::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("arn").build()).build();
private static final SdkField> ALLOWED_COUNTRIES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("allowedCountries")
.getter(getter(PlaybackRestrictionPolicySummary::allowedCountries))
.setter(setter(Builder::allowedCountries))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("allowedCountries").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> ALLOWED_ORIGINS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("allowedOrigins")
.getter(getter(PlaybackRestrictionPolicySummary::allowedOrigins))
.setter(setter(Builder::allowedOrigins))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("allowedOrigins").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField ENABLE_STRICT_ORIGIN_ENFORCEMENT_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("enableStrictOriginEnforcement")
.getter(getter(PlaybackRestrictionPolicySummary::enableStrictOriginEnforcement))
.setter(setter(Builder::enableStrictOriginEnforcement))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("enableStrictOriginEnforcement")
.build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(PlaybackRestrictionPolicySummary::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("tags")
.getter(getter(PlaybackRestrictionPolicySummary::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tags").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ARN_FIELD,
ALLOWED_COUNTRIES_FIELD, ALLOWED_ORIGINS_FIELD, ENABLE_STRICT_ORIGIN_ENFORCEMENT_FIELD, NAME_FIELD, TAGS_FIELD));
private static final long serialVersionUID = 1L;
private final String arn;
private final List allowedCountries;
private final List allowedOrigins;
private final Boolean enableStrictOriginEnforcement;
private final String name;
private final Map tags;
private PlaybackRestrictionPolicySummary(BuilderImpl builder) {
this.arn = builder.arn;
this.allowedCountries = builder.allowedCountries;
this.allowedOrigins = builder.allowedOrigins;
this.enableStrictOriginEnforcement = builder.enableStrictOriginEnforcement;
this.name = builder.name;
this.tags = builder.tags;
}
/**
*
* Playback-restriction-policy ARN
*
*
* @return Playback-restriction-policy ARN
*/
public final String arn() {
return arn;
}
/**
* 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 {@code 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.
*/
public final boolean hasAllowedCountries() {
return allowedCountries != null && !(allowedCountries instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasAllowedCountries} method.
*
*
* @return 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).
*/
public final List allowedCountries() {
return allowedCountries;
}
/**
* 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 {@code 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.
*/
public final boolean hasAllowedOrigins() {
return allowedOrigins != null && !(allowedOrigins instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasAllowedOrigins} method.
*
*
* @return 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).
*/
public final List allowedOrigins() {
return allowedOrigins;
}
/**
*
* Whether channel playback is constrained by origin site. Default: false.
*
*
* @return Whether channel playback is constrained by origin site. Default: false.
*/
public final Boolean enableStrictOriginEnforcement() {
return enableStrictOriginEnforcement;
}
/**
*
* Playback-restriction-policy name. The value does not need to be unique.
*
*
* @return Playback-restriction-policy name. The value does not need to be unique.
*/
public final String name() {
return name;
}
/**
* 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 {@code 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.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructMap);
}
/**
*
* 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 {@link #hasTags} method.
*
*
* @return 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.
*/
public final Map tags() {
return tags;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(arn());
hashCode = 31 * hashCode + Objects.hashCode(hasAllowedCountries() ? allowedCountries() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasAllowedOrigins() ? allowedOrigins() : null);
hashCode = 31 * hashCode + Objects.hashCode(enableStrictOriginEnforcement());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof PlaybackRestrictionPolicySummary)) {
return false;
}
PlaybackRestrictionPolicySummary other = (PlaybackRestrictionPolicySummary) obj;
return Objects.equals(arn(), other.arn()) && hasAllowedCountries() == other.hasAllowedCountries()
&& Objects.equals(allowedCountries(), other.allowedCountries())
&& hasAllowedOrigins() == other.hasAllowedOrigins() && Objects.equals(allowedOrigins(), other.allowedOrigins())
&& Objects.equals(enableStrictOriginEnforcement(), other.enableStrictOriginEnforcement())
&& Objects.equals(name(), other.name()) && hasTags() == other.hasTags() && Objects.equals(tags(), other.tags());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("PlaybackRestrictionPolicySummary").add("Arn", arn())
.add("AllowedCountries", hasAllowedCountries() ? allowedCountries() : null)
.add("AllowedOrigins", hasAllowedOrigins() ? allowedOrigins() : null)
.add("EnableStrictOriginEnforcement", enableStrictOriginEnforcement()).add("Name", name())
.add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "arn":
return Optional.ofNullable(clazz.cast(arn()));
case "allowedCountries":
return Optional.ofNullable(clazz.cast(allowedCountries()));
case "allowedOrigins":
return Optional.ofNullable(clazz.cast(allowedOrigins()));
case "enableStrictOriginEnforcement":
return Optional.ofNullable(clazz.cast(enableStrictOriginEnforcement()));
case "name":
return Optional.ofNullable(clazz.cast(name()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PlaybackRestrictionPolicySummary) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Playback-restriction-policy ARN
*
*
* @param arn
* Playback-restriction-policy ARN
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arn(String arn);
/**
*
* 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).
*
*
* @param 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).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder allowedCountries(Collection 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).
*
*
* @param 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).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder allowedCountries(String... allowedCountries);
/**
*
* 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).
*
*
* @param 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).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder allowedOrigins(Collection 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).
*
*
* @param 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).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder allowedOrigins(String... allowedOrigins);
/**
*
* Whether channel playback is constrained by origin site. Default: false.
*
*
* @param enableStrictOriginEnforcement
* Whether channel playback is constrained by origin site. Default: false.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder enableStrictOriginEnforcement(Boolean enableStrictOriginEnforcement);
/**
*
* Playback-restriction-policy name. The value does not need to be unique.
*
*
* @param name
* Playback-restriction-policy name. The value does not need to be unique.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
}
static final class BuilderImpl implements Builder {
private String arn;
private List allowedCountries = DefaultSdkAutoConstructList.getInstance();
private List allowedOrigins = DefaultSdkAutoConstructList.getInstance();
private Boolean enableStrictOriginEnforcement;
private String name;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(PlaybackRestrictionPolicySummary model) {
arn(model.arn);
allowedCountries(model.allowedCountries);
allowedOrigins(model.allowedOrigins);
enableStrictOriginEnforcement(model.enableStrictOriginEnforcement);
name(model.name);
tags(model.tags);
}
public final String getArn() {
return arn;
}
public final void setArn(String arn) {
this.arn = arn;
}
@Override
public final Builder arn(String arn) {
this.arn = arn;
return this;
}
public final Collection getAllowedCountries() {
if (allowedCountries instanceof SdkAutoConstructList) {
return null;
}
return allowedCountries;
}
public final void setAllowedCountries(Collection allowedCountries) {
this.allowedCountries = PlaybackRestrictionPolicyAllowedCountryListCopier.copy(allowedCountries);
}
@Override
public final Builder allowedCountries(Collection allowedCountries) {
this.allowedCountries = PlaybackRestrictionPolicyAllowedCountryListCopier.copy(allowedCountries);
return this;
}
@Override
@SafeVarargs
public final Builder allowedCountries(String... allowedCountries) {
allowedCountries(Arrays.asList(allowedCountries));
return this;
}
public final Collection getAllowedOrigins() {
if (allowedOrigins instanceof SdkAutoConstructList) {
return null;
}
return allowedOrigins;
}
public final void setAllowedOrigins(Collection allowedOrigins) {
this.allowedOrigins = PlaybackRestrictionPolicyAllowedOriginListCopier.copy(allowedOrigins);
}
@Override
public final Builder allowedOrigins(Collection allowedOrigins) {
this.allowedOrigins = PlaybackRestrictionPolicyAllowedOriginListCopier.copy(allowedOrigins);
return this;
}
@Override
@SafeVarargs
public final Builder allowedOrigins(String... allowedOrigins) {
allowedOrigins(Arrays.asList(allowedOrigins));
return this;
}
public final Boolean getEnableStrictOriginEnforcement() {
return enableStrictOriginEnforcement;
}
public final void setEnableStrictOriginEnforcement(Boolean enableStrictOriginEnforcement) {
this.enableStrictOriginEnforcement = enableStrictOriginEnforcement;
}
@Override
public final Builder enableStrictOriginEnforcement(Boolean enableStrictOriginEnforcement) {
this.enableStrictOriginEnforcement = enableStrictOriginEnforcement;
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final Map getTags() {
if (tags instanceof SdkAutoConstructMap) {
return null;
}
return tags;
}
public final void setTags(Map tags) {
this.tags = TagsCopier.copy(tags);
}
@Override
public final Builder tags(Map tags) {
this.tags = TagsCopier.copy(tags);
return this;
}
@Override
public PlaybackRestrictionPolicySummary build() {
return new PlaybackRestrictionPolicySummary(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}