com.vk.api.sdk.queries.database.DatabaseGetMetroStationsQuery Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk Show documentation
Java library for VK API interaction, includes OAuth 2.0 authorization and API methods.
The newest version!
// Autogenerated from vk-api-schema. Please don't edit it manually.
package com.vk.api.sdk.queries.database;

import com.vk.api.sdk.client.AbstractQueryBuilder;
import com.vk.api.sdk.client.VkApiClient;
import com.vk.api.sdk.client.actors.ServiceActor;
import com.vk.api.sdk.client.actors.UserActor;
import com.vk.api.sdk.objects.annotations.ApiParam;
import com.vk.api.sdk.objects.database.responses.GetMetroStationsResponse;

import java.util.Arrays;
import java.util.List;

/**
 * Query for Database.getMetroStations method
 */
public class DatabaseGetMetroStationsQuery extends AbstractQueryBuilder {
    /**
     * Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
     *
     * @param client VK API client
     * @param actor actor with access token
     * @param cityId value of "city id" parameter. Minimum is 0.
     */
    public DatabaseGetMetroStationsQuery(VkApiClient client, ServiceActor actor, Integer cityId) {
        super(client, "database.getMetroStations", GetMetroStationsResponse.class);
        accessToken(actor.getAccessToken());
        clientSecret(actor.getClientSecret());
        cityId(cityId);
    }

    /**
     * Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
     *
     * @param client VK API client
     * @param actor actor with access token
     */
    public DatabaseGetMetroStationsQuery(VkApiClient client, ServiceActor actor) {
        super(client, "database.getMetroStations", GetMetroStationsResponse.class);
        accessToken(actor.getAccessToken());
        clientSecret(actor.getClientSecret());
    }

    /**
     * Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
     *
     * @param client VK API client
     * @param actor actor with access token
     * @param cityId value of "city id" parameter. Minimum is 0.
     */
    public DatabaseGetMetroStationsQuery(VkApiClient client, UserActor actor, Integer cityId) {
        super(client, "database.getMetroStations", GetMetroStationsResponse.class);
        accessToken(actor.getAccessToken());
        cityId(cityId);
    }

    /**
     * Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
     *
     * @param client VK API client
     * @param actor actor with access token
     */
    public DatabaseGetMetroStationsQuery(VkApiClient client, UserActor actor) {
        super(client, "database.getMetroStations", GetMetroStationsResponse.class);
        accessToken(actor.getAccessToken());
    }

    /**
     * Set city id
     *
     * @param value value of "city id" parameter. Minimum is 0.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("city_id")
    public DatabaseGetMetroStationsQuery cityId(Integer value) {
        return unsafeParam("city_id", value);
    }

    /**
     * Set offset
     *
     * @param value value of "offset" parameter. Minimum is 0.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("offset")
    public DatabaseGetMetroStationsQuery offset(Integer value) {
        return unsafeParam("offset", value);
    }

    /**
     * Set count
     *
     * @param value value of "count" parameter. Maximum is 500. Minimum is 0. By default 100.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("count")
    public DatabaseGetMetroStationsQuery count(Integer value) {
        return unsafeParam("count", value);
    }

    /**
     * Set extended
     *
     * @param value value of "extended" parameter. By default false.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    @ApiParam("extended")
    public DatabaseGetMetroStationsQuery extended(Boolean value) {
        return unsafeParam("extended", value);
    }

    @Override
    protected DatabaseGetMetroStationsQuery getThis() {
        return this;
    }

    @Override
    protected List essentialKeys() {
        return Arrays.asList("city_id", "access_token");
    }
}