Package software.amazon.awssdk.services.cloudfront.model

Class GeoRestrictionCustomization

java.lang.Object

software.amazon.awssdk.services.cloudfront.model.GeoRestrictionCustomization

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<GeoRestrictionCustomization.Builder,GeoRestrictionCustomization>

@Generated("software.amazon.awssdk:codegen")
public final class GeoRestrictionCustomization
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<GeoRestrictionCustomization.Builder,GeoRestrictionCustomization>

The customizations that you specified for the distribution tenant for geographic restrictions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GeoRestrictionCustomization.Builder

Method Summary

Modifier and Type	Method	Description
static GeoRestrictionCustomization.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLocations()	For responses, this returns true if the service returned a value for the Locations property.
List<String>	locations()	The locations for geographic restrictions.
GeoRestrictionType	restrictionType()	The method that you want to use to restrict distribution of your content by country:
String	restrictionTypeAsString()	The method that you want to use to restrict distribution of your content by country:
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GeoRestrictionCustomization.Builder>	serializableBuilderClass()
GeoRestrictionCustomization.Builder	toBuilder()
String	toString()	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

restrictionType

public final GeoRestrictionType restrictionType()

The method that you want to use to restrict distribution of your content by country:

• none: No geographic restriction is enabled, meaning access to content is not restricted by client geo location.

• blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.

• whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

If the service returns an enum value that is not available in the current SDK version, restrictionType will return GeoRestrictionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from restrictionTypeAsString().

Returns:

The method that you want to use to restrict distribution of your content by country:

• none: No geographic restriction is enabled, meaning access to content is not restricted by client geo location.

• blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.

• whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

See Also:

GeoRestrictionType

restrictionTypeAsString

public final String restrictionTypeAsString()

The method that you want to use to restrict distribution of your content by country:

• none: No geographic restriction is enabled, meaning access to content is not restricted by client geo location.

• blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.

• whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

If the service returns an enum value that is not available in the current SDK version, restrictionType will return GeoRestrictionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from restrictionTypeAsString().

Returns:

The method that you want to use to restrict distribution of your content by country:

• none: No geographic restriction is enabled, meaning access to content is not restricted by client geo location.

• blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.

• whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

See Also:

GeoRestrictionType

hasLocations

public final boolean hasLocations()

For responses, this returns true if the service returned a value for the Locations 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.

locations

public final List<String> locations()

The locations for geographic restrictions.

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

Returns:

The locations for geographic restrictions.

toBuilder

public GeoRestrictionCustomization.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GeoRestrictionCustomization.Builder,GeoRestrictionCustomization>

builder

public static GeoRestrictionCustomization.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo