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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-storagetransfer Show documentation
There is a newer version: v1-rev20241005-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: 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;

/**
 * Request passed to UpdateTransferJob.
 *
 *  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 UpdateTransferJobRequest extends com.google.api.client.json.GenericJson {

  /**
   * The ID of the Google Developers Console project that owns the job. Required.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String projectId;

  /**
   * The job to update. Required.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private TransferJob transferJob;

  /**
   * The field mask of the fields in transfer_job that are to be updated in this request. Fields in
   * transfer_job that are allowed to be updated are: 'description', 'transfer_spec', and 'status'.
   * To update the transfer_spec of the job, a complete transfer specification has to be provided
   * and an incomplete specification which misses any required fields will be rejected with error
   * INVALID_ARGUMENT.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String updateTransferJobFieldMask;

  /**
   * The ID of the Google Developers Console project that owns the job. Required.
   * @return value or {@code null} for none
   */
  public java.lang.String getProjectId() {
    return projectId;
  }

  /**
   * The ID of the Google Developers Console project that owns the job. Required.
   * @param projectId projectId or {@code null} for none
   */
  public UpdateTransferJobRequest setProjectId(java.lang.String projectId) {
    this.projectId = projectId;
    return this;
  }

  /**
   * The job to update. Required.
   * @return value or {@code null} for none
   */
  public TransferJob getTransferJob() {
    return transferJob;
  }

  /**
   * The job to update. Required.
   * @param transferJob transferJob or {@code null} for none
   */
  public UpdateTransferJobRequest setTransferJob(TransferJob transferJob) {
    this.transferJob = transferJob;
    return this;
  }

  /**
   * The field mask of the fields in transfer_job that are to be updated in this request. Fields in
   * transfer_job that are allowed to be updated are: 'description', 'transfer_spec', and 'status'.
   * To update the transfer_spec of the job, a complete transfer specification has to be provided
   * and an incomplete specification which misses any required fields will be rejected with error
   * INVALID_ARGUMENT.
   * @return value or {@code null} for none
   */
  public java.lang.String getUpdateTransferJobFieldMask() {
    return updateTransferJobFieldMask;
  }

  /**
   * The field mask of the fields in transfer_job that are to be updated in this request. Fields in
   * transfer_job that are allowed to be updated are: 'description', 'transfer_spec', and 'status'.
   * To update the transfer_spec of the job, a complete transfer specification has to be provided
   * and an incomplete specification which misses any required fields will be rejected with error
   * INVALID_ARGUMENT.
   * @param updateTransferJobFieldMask updateTransferJobFieldMask or {@code null} for none
   */
  public UpdateTransferJobRequest setUpdateTransferJobFieldMask(java.lang.String updateTransferJobFieldMask) {
    this.updateTransferJobFieldMask = updateTransferJobFieldMask;
    return this;
  }

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

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

}