com.google.api.services.cloudchannel.v1.model.GoogleCloudChannelV1FetchReportResultsRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-cloudchannel Show documentation
There is a newer version: v1-rev20241202-2.0.0
Show newest version
/*
 * 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.cloudchannel.v1.model;

/**
 * Request message for CloudChannelReportsService.FetchReportResults.
 *
 *  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 Cloud Channel API. For a detailed explanation see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class GoogleCloudChannelV1FetchReportResultsRequest extends com.google.api.client.json.GenericJson {

  /**
   * Optional. Requested page size of the report. The server may return fewer results than
   * requested. If you don't specify a page size, the server uses a sensible default (may change
   * over time). The maximum value is 30,000; the server will change larger values to 30,000.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer pageSize;

  /**
   * Optional. A token that specifies a page of results beyond the first page. Obtained through
   * FetchReportResultsResponse.next_page_token of the previous
   * CloudChannelReportsService.FetchReportResults call.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String pageToken;

  /**
   * Optional. List of keys specifying which report partitions to return. If empty, returns all
   * partitions.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List partitionKeys;

  /**
   * Optional. Requested page size of the report. The server may return fewer results than
   * requested. If you don't specify a page size, the server uses a sensible default (may change
   * over time). The maximum value is 30,000; the server will change larger values to 30,000.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getPageSize() {
    return pageSize;
  }

  /**
   * Optional. Requested page size of the report. The server may return fewer results than
   * requested. If you don't specify a page size, the server uses a sensible default (may change
   * over time). The maximum value is 30,000; the server will change larger values to 30,000.
   * @param pageSize pageSize or {@code null} for none
   */
  public GoogleCloudChannelV1FetchReportResultsRequest setPageSize(java.lang.Integer pageSize) {
    this.pageSize = pageSize;
    return this;
  }

  /**
   * Optional. A token that specifies a page of results beyond the first page. Obtained through
   * FetchReportResultsResponse.next_page_token of the previous
   * CloudChannelReportsService.FetchReportResults call.
   * @return value or {@code null} for none
   */
  public java.lang.String getPageToken() {
    return pageToken;
  }

  /**
   * Optional. A token that specifies a page of results beyond the first page. Obtained through
   * FetchReportResultsResponse.next_page_token of the previous
   * CloudChannelReportsService.FetchReportResults call.
   * @param pageToken pageToken or {@code null} for none
   */
  public GoogleCloudChannelV1FetchReportResultsRequest setPageToken(java.lang.String pageToken) {
    this.pageToken = pageToken;
    return this;
  }

  /**
   * Optional. List of keys specifying which report partitions to return. If empty, returns all
   * partitions.
   * @return value or {@code null} for none
   */
  public java.util.List getPartitionKeys() {
    return partitionKeys;
  }

  /**
   * Optional. List of keys specifying which report partitions to return. If empty, returns all
   * partitions.
   * @param partitionKeys partitionKeys or {@code null} for none
   */
  public GoogleCloudChannelV1FetchReportResultsRequest setPartitionKeys(java.util.List partitionKeys) {
    this.partitionKeys = partitionKeys;
    return this;
  }

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

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

}