com.google.api.services.pubsub.model.PullBatchRequest 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: 2017-02-15 17:18:02 UTC)
 * on 2017-08-08 at 23:36:27 UTC 
 * Modify at your own risk.
 */

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

/**
 * Request for the PullBatch method.
 *
 *  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 Pub/Sub 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 PullBatchRequest extends com.google.api.client.json.GenericJson {

  /**
   * The maximum number of PubsubEvents returned for this request. The Pub/Sub system may return
   * fewer than the number of events specified.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer maxEvents;

  /**
   * If this is specified as true the system will respond immediately even if it is not able to
   * return a message in the Pull response. Otherwise the system is allowed to wait until at least
   * one message is available rather than returning no messages. The client may cancel the request
   * if it does not wish to wait any longer for the response.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean returnImmediately;

  /**
   * The subscription from which messages should be pulled.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String subscription;

  /**
   * The maximum number of PubsubEvents returned for this request. The Pub/Sub system may return
   * fewer than the number of events specified.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getMaxEvents() {
    return maxEvents;
  }

  /**
   * The maximum number of PubsubEvents returned for this request. The Pub/Sub system may return
   * fewer than the number of events specified.
   * @param maxEvents maxEvents or {@code null} for none
   */
  public PullBatchRequest setMaxEvents(java.lang.Integer maxEvents) {
    this.maxEvents = maxEvents;
    return this;
  }

  /**
   * If this is specified as true the system will respond immediately even if it is not able to
   * return a message in the Pull response. Otherwise the system is allowed to wait until at least
   * one message is available rather than returning no messages. The client may cancel the request
   * if it does not wish to wait any longer for the response.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getReturnImmediately() {
    return returnImmediately;
  }

  /**
   * If this is specified as true the system will respond immediately even if it is not able to
   * return a message in the Pull response. Otherwise the system is allowed to wait until at least
   * one message is available rather than returning no messages. The client may cancel the request
   * if it does not wish to wait any longer for the response.
   * @param returnImmediately returnImmediately or {@code null} for none
   */
  public PullBatchRequest setReturnImmediately(java.lang.Boolean returnImmediately) {
    this.returnImmediately = returnImmediately;
    return this;
  }

  /**
   * The subscription from which messages should be pulled.
   * @return value or {@code null} for none
   */
  public java.lang.String getSubscription() {
    return subscription;
  }

  /**
   * The subscription from which messages should be pulled.
   * @param subscription subscription or {@code null} for none
   */
  public PullBatchRequest setSubscription(java.lang.String subscription) {
    this.subscription = subscription;
    return this;
  }

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

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

}