Class GeoLocation

    • Constructor Detail

      • GeoLocation

        public GeoLocation()
    • Method Detail

      • setContinentCode

        public void setContinentCode​(String continentCode)

        The code for a continent geo location. Note: only continent locations have a continent code.

        Valid values: AF | AN | AS | EU | OC | NA | SA

        Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

        Parameters:
        continentCode - The code for a continent geo location. Note: only continent locations have a continent code.

        Valid values: AF | AN | AS | EU | OC | NA | SA

        Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

      • getContinentCode

        public String getContinentCode()

        The code for a continent geo location. Note: only continent locations have a continent code.

        Valid values: AF | AN | AS | EU | OC | NA | SA

        Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

        Returns:
        The code for a continent geo location. Note: only continent locations have a continent code.

        Valid values: AF | AN | AS | EU | OC | NA | SA

        Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

      • withContinentCode

        public GeoLocation withContinentCode​(String continentCode)

        The code for a continent geo location. Note: only continent locations have a continent code.

        Valid values: AF | AN | AS | EU | OC | NA | SA

        Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

        Parameters:
        continentCode - The code for a continent geo location. Note: only continent locations have a continent code.

        Valid values: AF | AN | AS | EU | OC | NA | SA

        Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setCountryCode

        public void setCountryCode​(String countryCode)

        The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.

        The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

        Parameters:
        countryCode - The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.

        The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

      • getCountryCode

        public String getCountryCode()

        The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.

        The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

        Returns:
        The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.

        The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

      • withCountryCode

        public GeoLocation withCountryCode​(String countryCode)

        The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.

        The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

        Parameters:
        countryCode - The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.

        The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setSubdivisionCode

        public void setSubdivisionCode​(String subdivisionCode)

        The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.

        Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.

        Parameters:
        subdivisionCode - The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.

        Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.

      • getSubdivisionCode

        public String getSubdivisionCode()

        The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.

        Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.

        Returns:
        The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.

        Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.

      • withSubdivisionCode

        public GeoLocation withSubdivisionCode​(String subdivisionCode)

        The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.

        Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.

        Parameters:
        subdivisionCode - The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.

        Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • toString

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object