com.maxmind.geoip2.record.Subdivision Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of geoip2 Show documentation

GeoIP2 webservice client and database reader

There is a newer version: 4.2.1

package com.maxmind.geoip2.record;

import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * 
 * Contains data for the subdivisions associated with an IP address.
 * 
 * 
 * This record is returned by all the end points except the Country end point.
 * 
 */
public final class Subdivision extends AbstractNamedRecord {
    @JsonProperty
    private Integer confidence;

    @JsonProperty("iso_code")
    private String isoCode;

    /**
     * @return This is a value from 0-100 indicating MaxMind's confidence that
     * the subdivision is correct. This attribute is only available from
     * the Insights end point.
     */
    public Integer getConfidence() {
        return this.confidence;
    }

    /**
     * @return This is a string up to three characters long contain the
     * subdivision portion of the ISO
     * 3166-2code. This attribute is returned by all end points
     * except Country.
     */
    public String getIsoCode() {
        return this.isoCode;
    }
}