com.google.api.services.pubsub.model.ModifyAckDeadlineRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-pubsub Show documentation
There is a newer version: v1-rev20250218-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: 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 ModifyAckDeadline 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 ModifyAckDeadlineRequest extends com.google.api.client.json.GenericJson {

  /**
   * The new ack deadline with respect to the time this request was sent to the Pub/Sub system. Must
   * be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after the
   * ModifyAckDeadline call was made. Specifying zero may immediately make the message available for
   * another pull request.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer ackDeadlineSeconds;

  /**
   * The acknowledgment ID. Either this or ack_ids must be populated, not both.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String ackId;

  /**
   * List of acknowledgment IDs. Either this field or ack_id should be populated, not both.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List ackIds;

  /**
   * Next Index: 5 The name of the subscription from which messages are being pulled.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String subscription;

  /**
   * The new ack deadline with respect to the time this request was sent to the Pub/Sub system. Must
   * be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after the
   * ModifyAckDeadline call was made. Specifying zero may immediately make the message available for
   * another pull request.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getAckDeadlineSeconds() {
    return ackDeadlineSeconds;
  }

  /**
   * The new ack deadline with respect to the time this request was sent to the Pub/Sub system. Must
   * be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after the
   * ModifyAckDeadline call was made. Specifying zero may immediately make the message available for
   * another pull request.
   * @param ackDeadlineSeconds ackDeadlineSeconds or {@code null} for none
   */
  public ModifyAckDeadlineRequest setAckDeadlineSeconds(java.lang.Integer ackDeadlineSeconds) {
    this.ackDeadlineSeconds = ackDeadlineSeconds;
    return this;
  }

  /**
   * The acknowledgment ID. Either this or ack_ids must be populated, not both.
   * @return value or {@code null} for none
   */
  public java.lang.String getAckId() {
    return ackId;
  }

  /**
   * The acknowledgment ID. Either this or ack_ids must be populated, not both.
   * @param ackId ackId or {@code null} for none
   */
  public ModifyAckDeadlineRequest setAckId(java.lang.String ackId) {
    this.ackId = ackId;
    return this;
  }

  /**
   * List of acknowledgment IDs. Either this field or ack_id should be populated, not both.
   * @return value or {@code null} for none
   */
  public java.util.List getAckIds() {
    return ackIds;
  }

  /**
   * List of acknowledgment IDs. Either this field or ack_id should be populated, not both.
   * @param ackIds ackIds or {@code null} for none
   */
  public ModifyAckDeadlineRequest setAckIds(java.util.List ackIds) {
    this.ackIds = ackIds;
    return this;
  }

  /**
   * Next Index: 5 The name of the subscription from which messages are being pulled.
   * @return value or {@code null} for none
   */
  public java.lang.String getSubscription() {
    return subscription;
  }

  /**
   * Next Index: 5 The name of the subscription from which messages are being pulled.
   * @param subscription subscription or {@code null} for none
   */
  public ModifyAckDeadlineRequest setSubscription(java.lang.String subscription) {
    this.subscription = subscription;
    return this;
  }

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

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

}