com.google.api.services.logging.v2.model.UpdateBucketRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-logging Show documentation
There is a newer version: v2-rev20241018-2.0.0
Show newest version
/*
 * 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/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.logging.v2.model;

/**
 * The parameters to UpdateBucket.
 *
 *  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 Cloud Logging 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 UpdateBucketRequest extends com.google.api.client.json.GenericJson {

  /**
   * Required. The updated bucket.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private LogBucket bucket;

  /**
   * Required. The full resource name of the bucket to update.
   * "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
   * "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
   * "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
   * "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" For example:"projects/my-
   * project/locations/global/buckets/my-bucket"
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String name;

  /**
   * Required. Field mask that specifies the fields in bucket that need an update. A bucket field
   * will be overwritten if, and only if, it is in the update mask. name and output only fields
   * cannot be updated.For a detailed FieldMask definition, see:
   * https://developers.google.com/protocol-
   * buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example:
   * updateMask=retention_days
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String updateMask;

  /**
   * Required. The updated bucket.
   * @return value or {@code null} for none
   */
  public LogBucket getBucket() {
    return bucket;
  }

  /**
   * Required. The updated bucket.
   * @param bucket bucket or {@code null} for none
   */
  public UpdateBucketRequest setBucket(LogBucket bucket) {
    this.bucket = bucket;
    return this;
  }

  /**
   * Required. The full resource name of the bucket to update.
   * "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
   * "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
   * "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
   * "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" For example:"projects/my-
   * project/locations/global/buckets/my-bucket"
   * @return value or {@code null} for none
   */
  public java.lang.String getName() {
    return name;
  }

  /**
   * Required. The full resource name of the bucket to update.
   * "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
   * "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
   * "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
   * "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" For example:"projects/my-
   * project/locations/global/buckets/my-bucket"
   * @param name name or {@code null} for none
   */
  public UpdateBucketRequest setName(java.lang.String name) {
    this.name = name;
    return this;
  }

  /**
   * Required. Field mask that specifies the fields in bucket that need an update. A bucket field
   * will be overwritten if, and only if, it is in the update mask. name and output only fields
   * cannot be updated.For a detailed FieldMask definition, see:
   * https://developers.google.com/protocol-
   * buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example:
   * updateMask=retention_days
   * @return value or {@code null} for none
   */
  public String getUpdateMask() {
    return updateMask;
  }

  /**
   * Required. Field mask that specifies the fields in bucket that need an update. A bucket field
   * will be overwritten if, and only if, it is in the update mask. name and output only fields
   * cannot be updated.For a detailed FieldMask definition, see:
   * https://developers.google.com/protocol-
   * buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example:
   * updateMask=retention_days
   * @param updateMask updateMask or {@code null} for none
   */
  public UpdateBucketRequest setUpdateMask(String updateMask) {
    this.updateMask = updateMask;
    return this;
  }

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

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

}