/*
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.searchads360.v0.model;

/**
 * Request message for SearchAds360Service.Search.
 *
 * <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Search Ads 360 Reporting API. For a detailed
 * explanation see:
 * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
 * </p>
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class GoogleAdsSearchads360V0ServicesSearchSearchAds360Request extends com.google.api.client.json.GenericJson {

  /**
   * Number of elements to retrieve in a single page. When too large a page is requested, the server
   * may decide to further limit the number of returned resources.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer pageSize;

  /**
   * Token of the page to retrieve. If not specified, the first page of results will be returned.
   * Use the value obtained from `next_page_token` in the previous response in order to request the
   * next page of results.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String pageToken;

  /**
   * Required. The query string.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String query;

  /**
   * If true, the total number of results that match the query ignoring the LIMIT clause will be
   * included in the response. Default is false.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean returnTotalResultsCount;

  /**
   * Determines whether a summary row will be returned. By default, summary row is not returned. If
   * requested, the summary row will be sent in a response by itself after all other query results
   * are returned.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String summaryRowSetting;

  /**
   * If true, the request is validated but not executed.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean validateOnly;

  /**
   * Number of elements to retrieve in a single page. When too large a page is requested, the server
   * may decide to further limit the number of returned resources.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getPageSize() {
    return pageSize;
  }

  /**
   * Number of elements to retrieve in a single page. When too large a page is requested, the server
   * may decide to further limit the number of returned resources.
   * @param pageSize pageSize or {@code null} for none
   */
  public GoogleAdsSearchads360V0ServicesSearchSearchAds360Request setPageSize(java.lang.Integer pageSize) {
    this.pageSize = pageSize;
    return this;
  }

  /**
   * Token of the page to retrieve. If not specified, the first page of results will be returned.
   * Use the value obtained from `next_page_token` in the previous response in order to request the
   * next page of results.
   * @return value or {@code null} for none
   */
  public java.lang.String getPageToken() {
    return pageToken;
  }

  /**
   * Token of the page to retrieve. If not specified, the first page of results will be returned.
   * Use the value obtained from `next_page_token` in the previous response in order to request the
   * next page of results.
   * @param pageToken pageToken or {@code null} for none
   */
  public GoogleAdsSearchads360V0ServicesSearchSearchAds360Request setPageToken(java.lang.String pageToken) {
    this.pageToken = pageToken;
    return this;
  }

  /**
   * Required. The query string.
   * @return value or {@code null} for none
   */
  public java.lang.String getQuery() {
    return query;
  }

  /**
   * Required. The query string.
   * @param query query or {@code null} for none
   */
  public GoogleAdsSearchads360V0ServicesSearchSearchAds360Request setQuery(java.lang.String query) {
    this.query = query;
    return this;
  }

  /**
   * If true, the total number of results that match the query ignoring the LIMIT clause will be
   * included in the response. Default is false.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getReturnTotalResultsCount() {
    return returnTotalResultsCount;
  }

  /**
   * If true, the total number of results that match the query ignoring the LIMIT clause will be
   * included in the response. Default is false.
   * @param returnTotalResultsCount returnTotalResultsCount or {@code null} for none
   */
  public GoogleAdsSearchads360V0ServicesSearchSearchAds360Request setReturnTotalResultsCount(java.lang.Boolean returnTotalResultsCount) {
    this.returnTotalResultsCount = returnTotalResultsCount;
    return this;
  }

  /**
   * Determines whether a summary row will be returned. By default, summary row is not returned. If
   * requested, the summary row will be sent in a response by itself after all other query results
   * are returned.
   * @return value or {@code null} for none
   */
  public java.lang.String getSummaryRowSetting() {
    return summaryRowSetting;
  }

  /**
   * Determines whether a summary row will be returned. By default, summary row is not returned. If
   * requested, the summary row will be sent in a response by itself after all other query results
   * are returned.
   * @param summaryRowSetting summaryRowSetting or {@code null} for none
   */
  public GoogleAdsSearchads360V0ServicesSearchSearchAds360Request setSummaryRowSetting(java.lang.String summaryRowSetting) {
    this.summaryRowSetting = summaryRowSetting;
    return this;
  }

  /**
   * If true, the request is validated but not executed.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getValidateOnly() {
    return validateOnly;
  }

  /**
   * If true, the request is validated but not executed.
   * @param validateOnly validateOnly or {@code null} for none
   */
  public GoogleAdsSearchads360V0ServicesSearchSearchAds360Request setValidateOnly(java.lang.Boolean validateOnly) {
    this.validateOnly = validateOnly;
    return this;
  }

  @Override
  public GoogleAdsSearchads360V0ServicesSearchSearchAds360Request set(String fieldName, Object value) {
    return (GoogleAdsSearchads360V0ServicesSearchSearchAds360Request) super.set(fieldName, value);
  }

  @Override
  public GoogleAdsSearchads360V0ServicesSearchSearchAds360Request clone() {
    return (GoogleAdsSearchads360V0ServicesSearchSearchAds360Request) super.clone();
  }

}
