com.google.api.services.safebrowsing.model.ListUpdateRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-safebrowsing Show documentation
There is a newer version: v5-rev20240505-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-10 at 14:58:27 UTC 
 * Modify at your own risk.
 */

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

/**
 * A single list update request.
 *
 *  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 Safe Browsing 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 ListUpdateRequest extends com.google.api.client.json.GenericJson {

  /**
   * The constraints associated with this request.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private Constraints constraints;

  /**
   * The type of platform at risk by entries present in the list.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String platformType;

  /**
   * The current state of the client for the requested list (the encrypted client state that was
   * received from the last successful list update).
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String state;

  /**
   * The types of entries present in the list.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String threatEntryType;

  /**
   * The type of threat posed by entries present in the list.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String threatType;

  /**
   * The constraints associated with this request.
   * @return value or {@code null} for none
   */
  public Constraints getConstraints() {
    return constraints;
  }

  /**
   * The constraints associated with this request.
   * @param constraints constraints or {@code null} for none
   */
  public ListUpdateRequest setConstraints(Constraints constraints) {
    this.constraints = constraints;
    return this;
  }

  /**
   * The type of platform at risk by entries present in the list.
   * @return value or {@code null} for none
   */
  public java.lang.String getPlatformType() {
    return platformType;
  }

  /**
   * The type of platform at risk by entries present in the list.
   * @param platformType platformType or {@code null} for none
   */
  public ListUpdateRequest setPlatformType(java.lang.String platformType) {
    this.platformType = platformType;
    return this;
  }

  /**
   * The current state of the client for the requested list (the encrypted client state that was
   * received from the last successful list update).
   * @see #decodeState()
   * @return value or {@code null} for none
   */
  public java.lang.String getState() {
    return state;
  }

  /**
   * The current state of the client for the requested list (the encrypted client state that was
   * received from the last successful list update).
   * @see #getState()
   * @return Base64 decoded value or {@code null} for none
   *
   * @since 1.14
   */
  public byte[] decodeState() {
    return com.google.api.client.util.Base64.decodeBase64(state);
  }

  /**
   * The current state of the client for the requested list (the encrypted client state that was
   * received from the last successful list update).
   * @see #encodeState()
   * @param state state or {@code null} for none
   */
  public ListUpdateRequest setState(java.lang.String state) {
    this.state = state;
    return this;
  }

  /**
   * The current state of the client for the requested list (the encrypted client state that was
   * received from the last successful list update).
   * @see #setState()
   *
   * 
   * The value is encoded Base64 or {@code null} for none.
   * 
   *
   * @since 1.14
   */
  public ListUpdateRequest encodeState(byte[] state) {
    this.state = com.google.api.client.util.Base64.encodeBase64URLSafeString(state);
    return this;
  }

  /**
   * The types of entries present in the list.
   * @return value or {@code null} for none
   */
  public java.lang.String getThreatEntryType() {
    return threatEntryType;
  }

  /**
   * The types of entries present in the list.
   * @param threatEntryType threatEntryType or {@code null} for none
   */
  public ListUpdateRequest setThreatEntryType(java.lang.String threatEntryType) {
    this.threatEntryType = threatEntryType;
    return this;
  }

  /**
   * The type of threat posed by entries present in the list.
   * @return value or {@code null} for none
   */
  public java.lang.String getThreatType() {
    return threatType;
  }

  /**
   * The type of threat posed by entries present in the list.
   * @param threatType threatType or {@code null} for none
   */
  public ListUpdateRequest setThreatType(java.lang.String threatType) {
    this.threatType = threatType;
    return this;
  }

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

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

}