com.google.api.services.storagetransfer.model.HttpData Maven / Gradle / Ivy

Go to download
/*
 * 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: 2015-07-16 18:28:29 UTC)
 * on 2015-07-22 at 02:28:25 UTC 
 * Modify at your own risk.
 */

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

/**
 * An HttpData specifies a list of objects on the WEB to be transferred over HTTP. The information
 * of the objects to be transferred is contained in a file which is referenced by a URL. The first
 * line in the file must be "TsvHttpData-1.0" which specifies the format of the file. Subsequent
 * lines specify the information of the list of objects, one object per list entry. Each entry has
 * the following tab-delimited fields: * HTTP URL * Length * MD5 - This field is base64-encoded MD5
 * hash of the object An HTTP URL points to the object to be transferred. It must be a valid URL
 * with URL scheme HTTP or HTTPS. When an object with URL http(s)://hostname:port/ is transfered to
 * the data sink, the name of the object at the data sink is /. Length and MD5 provide the size and
 * the base64-encoded MD5 hash of the object. If Length does not match the actual length of the
 * object fetched, the object will not be transferred. If MD5 does not match the MD5 computed from
 * the transferred bytes, the object transfer will fail. `lastModificationTime` is not available in
 * HttpData objects. The objects pointed by the URL list need to allow public access. The Storage
 * Transfer service obeys robots.txt rules and requires that the HTTP server support Range requests
 * and return a Content-Length header in each response.
 *
 *  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 Storage Transfer 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 HttpData extends com.google.api.client.json.GenericJson {

  /**
   * The URL that points to the file that stores the object list entries. This file must allow
   * public access. Currently, only URLs of HTTP or HTTPS scheme are supported. Required.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String listUrl;

  /**
   * The URL that points to the file that stores the object list entries. This file must allow
   * public access. Currently, only URLs of HTTP or HTTPS scheme are supported. Required.
   * @return value or {@code null} for none
   */
  public java.lang.String getListUrl() {
    return listUrl;
  }

  /**
   * The URL that points to the file that stores the object list entries. This file must allow
   * public access. Currently, only URLs of HTTP or HTTPS scheme are supported. Required.
   * @param listUrl listUrl or {@code null} for none
   */
  public HttpData setListUrl(java.lang.String listUrl) {
    this.listUrl = listUrl;
    return this;
  }

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

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

}