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

Class GeoRestriction

    • Method Detail

      • restrictionType

        public final GeoRestrictionType restrictionType()

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

        • none: No geo 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 geo 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 geo 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 geo 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

      • quantity

        public final Integer quantity()

        When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.

        Returns:
        When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.

      • hasItems

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

      • items

        public final List<String> items()

        A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist).

        The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country.

        CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.

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

        Returns:
        A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content ( blacklist).

        The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country.

        CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • 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)