com.google.api.services.cloudresourcemanager.model.ListProjectsResponse 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://github.com/google/apis-client-generator/
 * (build: 2018-05-04 17:28:03 UTC)
 * on 2018-09-26 at 05:29:24 UTC 
 * Modify at your own risk.
 */

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

/**
 * A page of the response received from the ListProjects method.
 *
 * A paginated response where more pages are available has `next_page_token` set. This token can be
 * used in a subsequent request to retrieve the next request page.
 *
 *  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 Resource Manager 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 ListProjectsResponse extends com.google.api.client.json.GenericJson {

  /**
   * Pagination token.
   *
   * If the result set is too large to fit in a single response, this token is returned. It encodes
   * the position of the current result cursor. Feeding this value into a new list request with the
   * `page_token` parameter gives the next page of the results.
   *
   * When `next_page_token` is not filled in, there is no next page and the list returned is the
   * last page in the result set.
   *
   * Pagination tokens have a limited lifetime.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String nextPageToken;

  /**
   * The list of Projects that matched the list filter. This list can be paginated.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List projects;

  /**
   * Pagination token.
   *
   * If the result set is too large to fit in a single response, this token is returned. It encodes
   * the position of the current result cursor. Feeding this value into a new list request with the
   * `page_token` parameter gives the next page of the results.
   *
   * When `next_page_token` is not filled in, there is no next page and the list returned is the
   * last page in the result set.
   *
   * Pagination tokens have a limited lifetime.
   * @return value or {@code null} for none
   */
  public java.lang.String getNextPageToken() {
    return nextPageToken;
  }

  /**
   * Pagination token.
   *
   * If the result set is too large to fit in a single response, this token is returned. It encodes
   * the position of the current result cursor. Feeding this value into a new list request with the
   * `page_token` parameter gives the next page of the results.
   *
   * When `next_page_token` is not filled in, there is no next page and the list returned is the
   * last page in the result set.
   *
   * Pagination tokens have a limited lifetime.
   * @param nextPageToken nextPageToken or {@code null} for none
   */
  public ListProjectsResponse setNextPageToken(java.lang.String nextPageToken) {
    this.nextPageToken = nextPageToken;
    return this;
  }

  /**
   * The list of Projects that matched the list filter. This list can be paginated.
   * @return value or {@code null} for none
   */
  public java.util.List getProjects() {
    return projects;
  }

  /**
   * The list of Projects that matched the list filter. This list can be paginated.
   * @param projects projects or {@code null} for none
   */
  public ListProjectsResponse setProjects(java.util.List projects) {
    this.projects = projects;
    return this;
  }

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

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

}