com.google.api.services.partners.model.ListCompaniesResponse Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2010 Google Inc.
 *
 * 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://code.google.com/p/google-apis-client-generator/
 * (build: 2015-08-03 17:34:38 UTC)
 * on 2015-09-08 at 21:42:21 UTC 
 * Modify at your own risk.
 */

package com.google.api.services.partners.model;

/**
 * Response message for [ListCompanies][google.partners.v2.Partner.ListCompanies].
 *
 *  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 Google Partners API. For a detailed explanation see:
 * http://code.google.com/p/google-http-java-client/wiki/JSON
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class ListCompaniesResponse extends com.google.api.client.json.GenericJson {

  /**
   * The list of companies.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List companies;

  /**
   * A token to retrieve next page of results. Pass this value in the
   * `ListCompaniesRequest.page_token` field in the subsequent call to
   * [ListCompanies][google.partners.v2.Partner.ListCompanies] to retrieve the next page of results.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String nextPageToken;

  /**
   * Current response metadata.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private ResponseMetadata responseMetadata;

  /**
   * The list of companies.
   * @return value or {@code null} for none
   */
  public java.util.List getCompanies() {
    return companies;
  }

  /**
   * The list of companies.
   * @param companies companies or {@code null} for none
   */
  public ListCompaniesResponse setCompanies(java.util.List companies) {
    this.companies = companies;
    return this;
  }

  /**
   * A token to retrieve next page of results. Pass this value in the
   * `ListCompaniesRequest.page_token` field in the subsequent call to
   * [ListCompanies][google.partners.v2.Partner.ListCompanies] to retrieve the next page of results.
   * @return value or {@code null} for none
   */
  public java.lang.String getNextPageToken() {
    return nextPageToken;
  }

  /**
   * A token to retrieve next page of results. Pass this value in the
   * `ListCompaniesRequest.page_token` field in the subsequent call to
   * [ListCompanies][google.partners.v2.Partner.ListCompanies] to retrieve the next page of results.
   * @param nextPageToken nextPageToken or {@code null} for none
   */
  public ListCompaniesResponse setNextPageToken(java.lang.String nextPageToken) {
    this.nextPageToken = nextPageToken;
    return this;
  }

  /**
   * Current response metadata.
   * @return value or {@code null} for none
   */
  public ResponseMetadata getResponseMetadata() {
    return responseMetadata;
  }

  /**
   * Current response metadata.
   * @param responseMetadata responseMetadata or {@code null} for none
   */
  public ListCompaniesResponse setResponseMetadata(ResponseMetadata responseMetadata) {
    this.responseMetadata = responseMetadata;
    return this;
  }

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

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

}