All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.bandwidth.phonenumberlookup.models.Result Maven / Gradle / Ivy

Go to download

The official client SDK for Bandwidth's Voice, Messaging, MFA, and WebRTC APIs

There is a newer version: 12.0.1
Show newest version
/*
 * BandwidthLib
 *
 * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
 */

package com.bandwidth.phonenumberlookup.models;

import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonSetter;

/**
 * This is a model class for Result type.
 */
public class Result {
    @JsonInclude(JsonInclude.Include.NON_NULL)
    private Integer responseCode;
    @JsonInclude(JsonInclude.Include.NON_NULL)
    private String message;
    @JsonInclude(JsonInclude.Include.NON_NULL)
    private String e164Format;
    @JsonInclude(JsonInclude.Include.NON_NULL)
    private String formatted;
    @JsonInclude(JsonInclude.Include.NON_NULL)
    private String country;
    @JsonInclude(JsonInclude.Include.NON_NULL)
    private String lineType;
    @JsonInclude(JsonInclude.Include.NON_NULL)
    private String lineProvider;
    @JsonInclude(JsonInclude.Include.NON_NULL)
    private String mobileCountryCode;
    @JsonInclude(JsonInclude.Include.NON_NULL)
    private String mobileNetworkCode;

    /**
     * Default constructor.
     */
    public Result() {
    }

    /**
     * Initialization constructor.
     * @param  responseCode  Integer value for responseCode.
     * @param  message  String value for message.
     * @param  e164Format  String value for e164Format.
     * @param  formatted  String value for formatted.
     * @param  country  String value for country.
     * @param  lineType  String value for lineType.
     * @param  lineProvider  String value for lineProvider.
     * @param  mobileCountryCode  String value for mobileCountryCode.
     * @param  mobileNetworkCode  String value for mobileNetworkCode.
     */
    public Result(
            Integer responseCode,
            String message,
            String e164Format,
            String formatted,
            String country,
            String lineType,
            String lineProvider,
            String mobileCountryCode,
            String mobileNetworkCode) {
        this.responseCode = responseCode;
        this.message = message;
        this.e164Format = e164Format;
        this.formatted = formatted;
        this.country = country;
        this.lineType = lineType;
        this.lineProvider = lineProvider;
        this.mobileCountryCode = mobileCountryCode;
        this.mobileNetworkCode = mobileNetworkCode;
    }

    /**
     * Getter for ResponseCode.
     * Our vendor's response code.
     * @return Returns the Integer
     */
    @JsonGetter("Response Code")
    public Integer getResponseCode() {
        return responseCode;
    }

    /**
     * Setter for ResponseCode.
     * Our vendor's response code.
     * @param responseCode Value for Integer
     */
    @JsonSetter("Response Code")
    public void setResponseCode(Integer responseCode) {
        this.responseCode = responseCode;
    }

    /**
     * Getter for Message.
     * Message associated with the response code.
     * @return Returns the String
     */
    @JsonGetter("Message")
    public String getMessage() {
        return message;
    }

    /**
     * Setter for Message.
     * Message associated with the response code.
     * @param message Value for String
     */
    @JsonSetter("Message")
    public void setMessage(String message) {
        this.message = message;
    }

    /**
     * Getter for E164Format.
     * The telephone number in E.164 format.
     * @return Returns the String
     */
    @JsonGetter("E.164 Format")
    public String getE164Format() {
        return e164Format;
    }

    /**
     * Setter for E164Format.
     * The telephone number in E.164 format.
     * @param e164Format Value for String
     */
    @JsonSetter("E.164 Format")
    public void setE164Format(String e164Format) {
        this.e164Format = e164Format;
    }

    /**
     * Getter for Formatted.
     * The formatted version of the telephone number.
     * @return Returns the String
     */
    @JsonGetter("Formatted")
    public String getFormatted() {
        return formatted;
    }

    /**
     * Setter for Formatted.
     * The formatted version of the telephone number.
     * @param formatted Value for String
     */
    @JsonSetter("Formatted")
    public void setFormatted(String formatted) {
        this.formatted = formatted;
    }

    /**
     * Getter for Country.
     * The country of the telephone number.
     * @return Returns the String
     */
    @JsonGetter("Country")
    public String getCountry() {
        return country;
    }

    /**
     * Setter for Country.
     * The country of the telephone number.
     * @param country Value for String
     */
    @JsonSetter("Country")
    public void setCountry(String country) {
        this.country = country;
    }

    /**
     * Getter for LineType.
     * The line type of the telephone number.
     * @return Returns the String
     */
    @JsonGetter("Line Type")
    public String getLineType() {
        return lineType;
    }

    /**
     * Setter for LineType.
     * The line type of the telephone number.
     * @param lineType Value for String
     */
    @JsonSetter("Line Type")
    public void setLineType(String lineType) {
        this.lineType = lineType;
    }

    /**
     * Getter for LineProvider.
     * The service provider of the telephone number.
     * @return Returns the String
     */
    @JsonGetter("Line Provider")
    public String getLineProvider() {
        return lineProvider;
    }

    /**
     * Setter for LineProvider.
     * The service provider of the telephone number.
     * @param lineProvider Value for String
     */
    @JsonSetter("Line Provider")
    public void setLineProvider(String lineProvider) {
        this.lineProvider = lineProvider;
    }

    /**
     * Getter for MobileCountryCode.
     * The first half of the Home Network Identity (HNI).
     * @return Returns the String
     */
    @JsonGetter("Mobile Country Code")
    public String getMobileCountryCode() {
        return mobileCountryCode;
    }

    /**
     * Setter for MobileCountryCode.
     * The first half of the Home Network Identity (HNI).
     * @param mobileCountryCode Value for String
     */
    @JsonSetter("Mobile Country Code")
    public void setMobileCountryCode(String mobileCountryCode) {
        this.mobileCountryCode = mobileCountryCode;
    }

    /**
     * Getter for MobileNetworkCode.
     * The second half of the HNI.
     * @return Returns the String
     */
    @JsonGetter("Mobile Network Code")
    public String getMobileNetworkCode() {
        return mobileNetworkCode;
    }

    /**
     * Setter for MobileNetworkCode.
     * The second half of the HNI.
     * @param mobileNetworkCode Value for String
     */
    @JsonSetter("Mobile Network Code")
    public void setMobileNetworkCode(String mobileNetworkCode) {
        this.mobileNetworkCode = mobileNetworkCode;
    }

    /**
     * Converts this Result into string format.
     * @return String representation of this class
     */
    @Override
    public String toString() {
        return "Result [" + "responseCode=" + responseCode + ", message=" + message
                + ", e164Format=" + e164Format + ", formatted=" + formatted + ", country=" + country
                + ", lineType=" + lineType + ", lineProvider=" + lineProvider
                + ", mobileCountryCode=" + mobileCountryCode + ", mobileNetworkCode="
                + mobileNetworkCode + "]";
    }

    /**
     * Builds a new {@link Result.Builder} object.
     * Creates the instance with the state of the current model.
     * @return a new {@link Result.Builder} object
     */
    public Builder toBuilder() {
        Builder builder = new Builder()
                .responseCode(getResponseCode())
                .message(getMessage())
                .e164Format(getE164Format())
                .formatted(getFormatted())
                .country(getCountry())
                .lineType(getLineType())
                .lineProvider(getLineProvider())
                .mobileCountryCode(getMobileCountryCode())
                .mobileNetworkCode(getMobileNetworkCode());
        return builder;
    }

    /**
     * Class to build instances of {@link Result}.
     */
    public static class Builder {
        private Integer responseCode;
        private String message;
        private String e164Format;
        private String formatted;
        private String country;
        private String lineType;
        private String lineProvider;
        private String mobileCountryCode;
        private String mobileNetworkCode;



        /**
         * Setter for responseCode.
         * @param  responseCode  Integer value for responseCode.
         * @return Builder
         */
        public Builder responseCode(Integer responseCode) {
            this.responseCode = responseCode;
            return this;
        }

        /**
         * Setter for message.
         * @param  message  String value for message.
         * @return Builder
         */
        public Builder message(String message) {
            this.message = message;
            return this;
        }

        /**
         * Setter for e164Format.
         * @param  e164Format  String value for e164Format.
         * @return Builder
         */
        public Builder e164Format(String e164Format) {
            this.e164Format = e164Format;
            return this;
        }

        /**
         * Setter for formatted.
         * @param  formatted  String value for formatted.
         * @return Builder
         */
        public Builder formatted(String formatted) {
            this.formatted = formatted;
            return this;
        }

        /**
         * Setter for country.
         * @param  country  String value for country.
         * @return Builder
         */
        public Builder country(String country) {
            this.country = country;
            return this;
        }

        /**
         * Setter for lineType.
         * @param  lineType  String value for lineType.
         * @return Builder
         */
        public Builder lineType(String lineType) {
            this.lineType = lineType;
            return this;
        }

        /**
         * Setter for lineProvider.
         * @param  lineProvider  String value for lineProvider.
         * @return Builder
         */
        public Builder lineProvider(String lineProvider) {
            this.lineProvider = lineProvider;
            return this;
        }

        /**
         * Setter for mobileCountryCode.
         * @param  mobileCountryCode  String value for mobileCountryCode.
         * @return Builder
         */
        public Builder mobileCountryCode(String mobileCountryCode) {
            this.mobileCountryCode = mobileCountryCode;
            return this;
        }

        /**
         * Setter for mobileNetworkCode.
         * @param  mobileNetworkCode  String value for mobileNetworkCode.
         * @return Builder
         */
        public Builder mobileNetworkCode(String mobileNetworkCode) {
            this.mobileNetworkCode = mobileNetworkCode;
            return this;
        }

        /**
         * Builds a new {@link Result} object using the set fields.
         * @return {@link Result}
         */
        public Result build() {
            return new Result(responseCode, message, e164Format, formatted, country, lineType,
                    lineProvider, mobileCountryCode, mobileNetworkCode);
        }
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy