com.google.api.services.batch.v1.model.JobNotification Maven / Gradle / Ivy

Go to download
/*
 * 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/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.batch.v1.model;

/**
 * Notification configurations.
 *
 *  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 Batch 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 JobNotification extends com.google.api.client.json.GenericJson {

  /**
   * The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no
   * message will be sent.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private Message message;

  /**
   * The Pub/Sub topic where notifications for the job, like state changes, will be published. If
   * undefined, no Pub/Sub notifications are sent for this job. Specify the topic using the
   * following format: `projects/{project}/topics/{topic}`. Notably, if you want to specify a
   * Pub/Sub topic that is in a different project than the job, your administrator must grant your
   * project's Batch service agent permission to publish to that topic. For more information about
   * configuring Pub/Sub notifications for a job, see https://cloud.google.com/batch/docs/enable-
   * notifications.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String pubsubTopic;

  /**
   * The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no
   * message will be sent.
   * @return value or {@code null} for none
   */
  public Message getMessage() {
    return message;
  }

  /**
   * The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no
   * message will be sent.
   * @param message message or {@code null} for none
   */
  public JobNotification setMessage(Message message) {
    this.message = message;
    return this;
  }

  /**
   * The Pub/Sub topic where notifications for the job, like state changes, will be published. If
   * undefined, no Pub/Sub notifications are sent for this job. Specify the topic using the
   * following format: `projects/{project}/topics/{topic}`. Notably, if you want to specify a
   * Pub/Sub topic that is in a different project than the job, your administrator must grant your
   * project's Batch service agent permission to publish to that topic. For more information about
   * configuring Pub/Sub notifications for a job, see https://cloud.google.com/batch/docs/enable-
   * notifications.
   * @return value or {@code null} for none
   */
  public java.lang.String getPubsubTopic() {
    return pubsubTopic;
  }

  /**
   * The Pub/Sub topic where notifications for the job, like state changes, will be published. If
   * undefined, no Pub/Sub notifications are sent for this job. Specify the topic using the
   * following format: `projects/{project}/topics/{topic}`. Notably, if you want to specify a
   * Pub/Sub topic that is in a different project than the job, your administrator must grant your
   * project's Batch service agent permission to publish to that topic. For more information about
   * configuring Pub/Sub notifications for a job, see https://cloud.google.com/batch/docs/enable-
   * notifications.
   * @param pubsubTopic pubsubTopic or {@code null} for none
   */
  public JobNotification setPubsubTopic(java.lang.String pubsubTopic) {
    this.pubsubTopic = pubsubTopic;
    return this;
  }

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

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

}