com.microsoft.bing.websearch.models.TimeZone Maven / Gradle / Ivy

/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for
 * license information.
 *
 * Code generated by Microsoft (R) AutoRest Code Generator.
 */

package com.microsoft.bing.websearch.models;

import java.util.List;
import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * Defines the data and time of one or more geographic locations.
 */
public class TimeZone extends SearchResultsAnswer {
    /**
     * The data and time, in UTC, of the geographic location specified in the
     * query. If the query specified a specific geographic location (for
     * example, a city), this object contains the name of the geographic
     * location and the current date and time of the location, in UTC. If the
     * query specified a general geographic location, such as a state or
     * country, this object contains the date and time of the primary city or
     * state found in the specified state or country. If the location contains
     * additional time zones, the otherCityTimes field contains the data and
     * time of cities or states located in the other time zones.
     */
    @JsonProperty(value = "primaryCityTime", required = true)
    private TimeZoneTimeZoneInformation primaryCityTime;

    /**
     * A list of dates and times of nearby time zones.
     */
    @JsonProperty(value = "otherCityTimes", access = JsonProperty.Access.WRITE_ONLY)
    private List otherCityTimes;

    /**
     * Get the data and time, in UTC, of the geographic location specified in the query. If the query specified a specific geographic location (for example, a city), this object contains the name of the geographic location and the current date and time of the location, in UTC. If the query specified a general geographic location, such as a state or country, this object contains the date and time of the primary city or state found in the specified state or country. If the location contains additional time zones, the otherCityTimes field contains the data and time of cities or states located in the other time zones.
     *
     * @return the primaryCityTime value
     */
    public TimeZoneTimeZoneInformation primaryCityTime() {
        return this.primaryCityTime;
    }

    /**
     * Set the data and time, in UTC, of the geographic location specified in the query. If the query specified a specific geographic location (for example, a city), this object contains the name of the geographic location and the current date and time of the location, in UTC. If the query specified a general geographic location, such as a state or country, this object contains the date and time of the primary city or state found in the specified state or country. If the location contains additional time zones, the otherCityTimes field contains the data and time of cities or states located in the other time zones.
     *
     * @param primaryCityTime the primaryCityTime value to set
     * @return the TimeZone object itself.
     */
    public TimeZone withPrimaryCityTime(TimeZoneTimeZoneInformation primaryCityTime) {
        this.primaryCityTime = primaryCityTime;
        return this;
    }

    /**
     * Get a list of dates and times of nearby time zones.
     *
     * @return the otherCityTimes value
     */
    public List otherCityTimes() {
        return this.otherCityTimes;
    }

}