com.google.api.services.fcm.v1.model.WebpushConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-fcm Show documentation
There is a newer version: v1-rev20241112-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://github.com/google/apis-client-generator/
 * (build: 2018-10-08 17:45:39 UTC)
 * on 2019-06-11 at 00:20:04 UTC 
 * Modify at your own risk.
 */

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

/**
 * [Webpush protocol](https://tools.ietf.org/html/rfc8030) options.
 *
 *  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 Firebase Cloud Messaging 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 WebpushConfig extends com.google.api.client.json.GenericJson {

  /**
   * Arbitrary key/value payload. If present, it will override google.firebase.fcm.v1.Message.data.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map data;

  /**
   * Options for features provided by the FCM SDK for Web.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private WebpushFcmOptions fcmOptions;

  /**
   * HTTP headers defined in webpush protocol. Refer to [Webpush
   * protocol](https://tools.ietf.org/html/rfc8030#section-5) for supported headers, e.g. "TTL":
   * "15".
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map headers;

  /**
   * Web Notification options as a JSON object. Supports Notification instance properties as defined
   * in [Web Notification API](https://developer.mozilla.org/en-US/docs/Web/API/Notification). If
   * present, "title" and "body" fields override [google.firebase.fcm.v1.Notification.title] and
   * [google.firebase.fcm.v1.Notification.body].
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map notification;

  /**
   * Arbitrary key/value payload. If present, it will override google.firebase.fcm.v1.Message.data.
   * @return value or {@code null} for none
   */
  public java.util.Map getData() {
    return data;
  }

  /**
   * Arbitrary key/value payload. If present, it will override google.firebase.fcm.v1.Message.data.
   * @param data data or {@code null} for none
   */
  public WebpushConfig setData(java.util.Map data) {
    this.data = data;
    return this;
  }

  /**
   * Options for features provided by the FCM SDK for Web.
   * @return value or {@code null} for none
   */
  public WebpushFcmOptions getFcmOptions() {
    return fcmOptions;
  }

  /**
   * Options for features provided by the FCM SDK for Web.
   * @param fcmOptions fcmOptions or {@code null} for none
   */
  public WebpushConfig setFcmOptions(WebpushFcmOptions fcmOptions) {
    this.fcmOptions = fcmOptions;
    return this;
  }

  /**
   * HTTP headers defined in webpush protocol. Refer to [Webpush
   * protocol](https://tools.ietf.org/html/rfc8030#section-5) for supported headers, e.g. "TTL":
   * "15".
   * @return value or {@code null} for none
   */
  public java.util.Map getHeaders() {
    return headers;
  }

  /**
   * HTTP headers defined in webpush protocol. Refer to [Webpush
   * protocol](https://tools.ietf.org/html/rfc8030#section-5) for supported headers, e.g. "TTL":
   * "15".
   * @param headers headers or {@code null} for none
   */
  public WebpushConfig setHeaders(java.util.Map headers) {
    this.headers = headers;
    return this;
  }

  /**
   * Web Notification options as a JSON object. Supports Notification instance properties as defined
   * in [Web Notification API](https://developer.mozilla.org/en-US/docs/Web/API/Notification). If
   * present, "title" and "body" fields override [google.firebase.fcm.v1.Notification.title] and
   * [google.firebase.fcm.v1.Notification.body].
   * @return value or {@code null} for none
   */
  public java.util.Map getNotification() {
    return notification;
  }

  /**
   * Web Notification options as a JSON object. Supports Notification instance properties as defined
   * in [Web Notification API](https://developer.mozilla.org/en-US/docs/Web/API/Notification). If
   * present, "title" and "body" fields override [google.firebase.fcm.v1.Notification.title] and
   * [google.firebase.fcm.v1.Notification.body].
   * @param notification notification or {@code null} for none
   */
  public WebpushConfig setNotification(java.util.Map notification) {
    this.notification = notification;
    return this;
  }

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

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

}