com.google.api.services.storagetransfer.model.AwsS3Data 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 AwsS3Data can be a data source but not a data sink. In an AwsS3Data, an object's name is the
 * S3 object's key name.
 *
 *  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 AwsS3Data extends com.google.api.client.json.GenericJson {

  /**
   * AWS access key used to sign the API requests to the AWS S3 bucket. Permissions on the bucket
   * must be granted to the access ID of the AWS access key. Required.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private AwsAccessKey awsAccessKey;

  /**
   * S3 Bucket name (see [Creating a bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-
   * bucket-get-location-example.html)). Required.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String bucketName;

  /**
   * AWS access key used to sign the API requests to the AWS S3 bucket. Permissions on the bucket
   * must be granted to the access ID of the AWS access key. Required.
   * @return value or {@code null} for none
   */
  public AwsAccessKey getAwsAccessKey() {
    return awsAccessKey;
  }

  /**
   * AWS access key used to sign the API requests to the AWS S3 bucket. Permissions on the bucket
   * must be granted to the access ID of the AWS access key. Required.
   * @param awsAccessKey awsAccessKey or {@code null} for none
   */
  public AwsS3Data setAwsAccessKey(AwsAccessKey awsAccessKey) {
    this.awsAccessKey = awsAccessKey;
    return this;
  }

  /**
   * S3 Bucket name (see [Creating a bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-
   * bucket-get-location-example.html)). Required.
   * @return value or {@code null} for none
   */
  public java.lang.String getBucketName() {
    return bucketName;
  }

  /**
   * S3 Bucket name (see [Creating a bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-
   * bucket-get-location-example.html)). Required.
   * @param bucketName bucketName or {@code null} for none
   */
  public AwsS3Data setBucketName(java.lang.String bucketName) {
    this.bucketName = bucketName;
    return this;
  }

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

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

}