com.google.api.services.datastore.model.RunQueryRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-datastore Show documentation
There is a newer version: v1-rev20241204-2.0.0
Show newest version
/*
 * 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: 2016-01-08 17:48:37 UTC)
 * on 2016-01-12 at 04:49:09 UTC 
 * Modify at your own risk.
 */

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

/**
 * Model definition for RunQueryRequest.
 *
 *  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 Cloud Datastore 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 RunQueryRequest extends com.google.api.client.json.GenericJson {

  /**
   * The GQL query to run. Either this field or field query must be set, but not both.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GqlQuery gqlQuery;

  /**
   * Entities are partitioned into subsets, identified by a dataset (usually implicitly specified by
   * the project) and namespace ID. Queries are scoped to a single partition. This partition ID is
   * normalized with the standard default context partition ID, but all other partition IDs in
   * RunQueryRequest are normalized with this partition ID as the context partition ID.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private PartitionId partitionId;

  /**
   * The query to run. Either this field or field gql_query must be set, but not both.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private Query query;

  /**
   * The options for this query.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private ReadOptions readOptions;

  /**
   * The GQL query to run. Either this field or field query must be set, but not both.
   * @return value or {@code null} for none
   */
  public GqlQuery getGqlQuery() {
    return gqlQuery;
  }

  /**
   * The GQL query to run. Either this field or field query must be set, but not both.
   * @param gqlQuery gqlQuery or {@code null} for none
   */
  public RunQueryRequest setGqlQuery(GqlQuery gqlQuery) {
    this.gqlQuery = gqlQuery;
    return this;
  }

  /**
   * Entities are partitioned into subsets, identified by a dataset (usually implicitly specified by
   * the project) and namespace ID. Queries are scoped to a single partition. This partition ID is
   * normalized with the standard default context partition ID, but all other partition IDs in
   * RunQueryRequest are normalized with this partition ID as the context partition ID.
   * @return value or {@code null} for none
   */
  public PartitionId getPartitionId() {
    return partitionId;
  }

  /**
   * Entities are partitioned into subsets, identified by a dataset (usually implicitly specified by
   * the project) and namespace ID. Queries are scoped to a single partition. This partition ID is
   * normalized with the standard default context partition ID, but all other partition IDs in
   * RunQueryRequest are normalized with this partition ID as the context partition ID.
   * @param partitionId partitionId or {@code null} for none
   */
  public RunQueryRequest setPartitionId(PartitionId partitionId) {
    this.partitionId = partitionId;
    return this;
  }

  /**
   * The query to run. Either this field or field gql_query must be set, but not both.
   * @return value or {@code null} for none
   */
  public Query getQuery() {
    return query;
  }

  /**
   * The query to run. Either this field or field gql_query must be set, but not both.
   * @param query query or {@code null} for none
   */
  public RunQueryRequest setQuery(Query query) {
    this.query = query;
    return this;
  }

  /**
   * The options for this query.
   * @return value or {@code null} for none
   */
  public ReadOptions getReadOptions() {
    return readOptions;
  }

  /**
   * The options for this query.
   * @param readOptions readOptions or {@code null} for none
   */
  public RunQueryRequest setReadOptions(ReadOptions readOptions) {
    this.readOptions = readOptions;
    return this;
  }

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

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

}