com.google.api.services.safebrowsing.model.MetadataEntry 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://github.com/google/apis-client-generator/
 * (build: 2017-11-07 19:12:12 UTC)
 * on 2017-11-29 at 22:37:57 UTC 
 * Modify at your own risk.
 */

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

/**
 * A single metadata entry.
 *
 *  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:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class MetadataEntry extends com.google.api.client.json.GenericJson {

  /**
   * The metadata entry key. For JSON requests, the key is base64-encoded.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String key;

  /**
   * The metadata entry value. For JSON requests, the value is base64-encoded.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String value;

  /**
   * The metadata entry key. For JSON requests, the key is base64-encoded.
   * @see #decodeKey()
   * @return value or {@code null} for none
   */
  public java.lang.String getKey() {
    return key;
  }

  /**
   * The metadata entry key. For JSON requests, the key is base64-encoded.
   * @see #getKey()
   * @return Base64 decoded value or {@code null} for none
   *
   * @since 1.14
   */
  public byte[] decodeKey() {
    return com.google.api.client.util.Base64.decodeBase64(key);
  }

  /**
   * The metadata entry key. For JSON requests, the key is base64-encoded.
   * @see #encodeKey()
   * @param key key or {@code null} for none
   */
  public MetadataEntry setKey(java.lang.String key) {
    this.key = key;
    return this;
  }

  /**
   * The metadata entry key. For JSON requests, the key is base64-encoded.
   * @see #setKey()
   *
   * 
   * The value is encoded Base64 or {@code null} for none.
   * 
   *
   * @since 1.14
   */
  public MetadataEntry encodeKey(byte[] key) {
    this.key = com.google.api.client.util.Base64.encodeBase64URLSafeString(key);
    return this;
  }

  /**
   * The metadata entry value. For JSON requests, the value is base64-encoded.
   * @see #decodeValue()
   * @return value or {@code null} for none
   */
  public java.lang.String getValue() {
    return value;
  }

  /**
   * The metadata entry value. For JSON requests, the value is base64-encoded.
   * @see #getValue()
   * @return Base64 decoded value or {@code null} for none
   *
   * @since 1.14
   */
  public byte[] decodeValue() {
    return com.google.api.client.util.Base64.decodeBase64(value);
  }

  /**
   * The metadata entry value. For JSON requests, the value is base64-encoded.
   * @see #encodeValue()
   * @param value value or {@code null} for none
   */
  public MetadataEntry setValue(java.lang.String value) {
    this.value = value;
    return this;
  }

  /**
   * The metadata entry value. For JSON requests, the value is base64-encoded.
   * @see #setValue()
   *
   * 
   * The value is encoded Base64 or {@code null} for none.
   * 
   *
   * @since 1.14
   */
  public MetadataEntry encodeValue(byte[] value) {
    this.value = com.google.api.client.util.Base64.encodeBase64URLSafeString(value);
    return this;
  }

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

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

}