• Home
• com.google.api.grpc
• proto-google-cloud-storage-v2
• 2.36.1-alpha
• source code
• UpdateObjectRequestOrBuilder.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.google.storage.v2.UpdateObjectRequestOrBuilder Maven / Gradle / Ivy

/*
 * Copyright 2024 Google LLC
 *
 * 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
 *
 *     https://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.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/storage/v2/storage.proto

// Protobuf Java Version: 3.25.2
package com.google.storage.v2;

public interface UpdateObjectRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.storage.v2.UpdateObjectRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   * 
   * Required. The object to update.
   * The object's bucket and name fields are used to identify the object to
   * update. If present, the object's generation field selects a specific
   * revision of this object whose metadata should be updated. Otherwise,
   * assumes the live version of the object.
   * 
   *
   * .google.storage.v2.Object object = 1 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return Whether the object field is set.
   */
  boolean hasObject();
  /**
   *
   *
   * 
   * Required. The object to update.
   * The object's bucket and name fields are used to identify the object to
   * update. If present, the object's generation field selects a specific
   * revision of this object whose metadata should be updated. Otherwise,
   * assumes the live version of the object.
   * 
   *
   * .google.storage.v2.Object object = 1 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The object.
   */
  com.google.storage.v2.Object getObject();
  /**
   *
   *
   * 
   * Required. The object to update.
   * The object's bucket and name fields are used to identify the object to
   * update. If present, the object's generation field selects a specific
   * revision of this object whose metadata should be updated. Otherwise,
   * assumes the live version of the object.
   * 
   *
   * .google.storage.v2.Object object = 1 [(.google.api.field_behavior) = REQUIRED];
   */
  com.google.storage.v2.ObjectOrBuilder getObjectOrBuilder();

  /**
   *
   *
   * 
   * Makes the operation conditional on whether the object's current generation
   * matches the given value. Setting to 0 makes the operation succeed only if
   * there are no live versions of the object.
   * 
   *
   * optional int64 if_generation_match = 2;
   *
   * @return Whether the ifGenerationMatch field is set.
   */
  boolean hasIfGenerationMatch();
  /**
   *
   *
   * 
   * Makes the operation conditional on whether the object's current generation
   * matches the given value. Setting to 0 makes the operation succeed only if
   * there are no live versions of the object.
   * 
   *
   * optional int64 if_generation_match = 2;
   *
   * @return The ifGenerationMatch.
   */
  long getIfGenerationMatch();

  /**
   *
   *
   * 
   * Makes the operation conditional on whether the object's live generation
   * does not match the given value. If no live object exists, the precondition
   * fails. Setting to 0 makes the operation succeed only if there is a live
   * version of the object.
   * 
   *
   * optional int64 if_generation_not_match = 3;
   *
   * @return Whether the ifGenerationNotMatch field is set.
   */
  boolean hasIfGenerationNotMatch();
  /**
   *
   *
   * 
   * Makes the operation conditional on whether the object's live generation
   * does not match the given value. If no live object exists, the precondition
   * fails. Setting to 0 makes the operation succeed only if there is a live
   * version of the object.
   * 
   *
   * optional int64 if_generation_not_match = 3;
   *
   * @return The ifGenerationNotMatch.
   */
  long getIfGenerationNotMatch();

  /**
   *
   *
   * 
   * Makes the operation conditional on whether the object's current
   * metageneration matches the given value.
   * 
   *
   * optional int64 if_metageneration_match = 4;
   *
   * @return Whether the ifMetagenerationMatch field is set.
   */
  boolean hasIfMetagenerationMatch();
  /**
   *
   *
   * 
   * Makes the operation conditional on whether the object's current
   * metageneration matches the given value.
   * 
   *
   * optional int64 if_metageneration_match = 4;
   *
   * @return The ifMetagenerationMatch.
   */
  long getIfMetagenerationMatch();

  /**
   *
   *
   * 
   * Makes the operation conditional on whether the object's current
   * metageneration does not match the given value.
   * 
   *
   * optional int64 if_metageneration_not_match = 5;
   *
   * @return Whether the ifMetagenerationNotMatch field is set.
   */
  boolean hasIfMetagenerationNotMatch();
  /**
   *
   *
   * 
   * Makes the operation conditional on whether the object's current
   * metageneration does not match the given value.
   * 
   *
   * optional int64 if_metageneration_not_match = 5;
   *
   * @return The ifMetagenerationNotMatch.
   */
  long getIfMetagenerationNotMatch();

  /**
   *
   *
   * 
   * Apply a predefined set of access controls to this object.
   * Valid values are "authenticatedRead", "bucketOwnerFullControl",
   * "bucketOwnerRead", "private", "projectPrivate", or "publicRead".
   * 
   *
   * string predefined_acl = 10;
   *
   * @return The predefinedAcl.
   */
  java.lang.String getPredefinedAcl();
  /**
   *
   *
   * 
   * Apply a predefined set of access controls to this object.
   * Valid values are "authenticatedRead", "bucketOwnerFullControl",
   * "bucketOwnerRead", "private", "projectPrivate", or "publicRead".
   * 
   *
   * string predefined_acl = 10;
   *
   * @return The bytes for predefinedAcl.
   */
  com.google.protobuf.ByteString getPredefinedAclBytes();

  /**
   *
   *
   * 
   * Required. List of fields to be updated.
   *
   * To specify ALL fields, equivalent to the JSON API's "update" function,
   * specify a single field with the value `*`. Note: not recommended. If a new
   * field is introduced at a later time, an older client updating with the `*`
   * may accidentally reset the new field's value.
   *
   * Not specifying any fields is an error.
   * 
   *
   * .google.protobuf.FieldMask update_mask = 7 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return Whether the updateMask field is set.
   */
  boolean hasUpdateMask();
  /**
   *
   *
   * 
   * Required. List of fields to be updated.
   *
   * To specify ALL fields, equivalent to the JSON API's "update" function,
   * specify a single field with the value `*`. Note: not recommended. If a new
   * field is introduced at a later time, an older client updating with the `*`
   * may accidentally reset the new field's value.
   *
   * Not specifying any fields is an error.
   * 
   *
   * .google.protobuf.FieldMask update_mask = 7 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return The updateMask.
   */
  com.google.protobuf.FieldMask getUpdateMask();
  /**
   *
   *
   * 
   * Required. List of fields to be updated.
   *
   * To specify ALL fields, equivalent to the JSON API's "update" function,
   * specify a single field with the value `*`. Note: not recommended. If a new
   * field is introduced at a later time, an older client updating with the `*`
   * may accidentally reset the new field's value.
   *
   * Not specifying any fields is an error.
   * 
   *
   * .google.protobuf.FieldMask update_mask = 7 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  com.google.protobuf.FieldMaskOrBuilder getUpdateMaskOrBuilder();

  /**
   *
   *
   * 
   * A set of parameters common to Storage API requests concerning an object.
   * 
   *
   * .google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;
   *
   * @return Whether the commonObjectRequestParams field is set.
   */
  boolean hasCommonObjectRequestParams();
  /**
   *
   *
   * 
   * A set of parameters common to Storage API requests concerning an object.
   * 
   *
   * .google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;
   *
   * @return The commonObjectRequestParams.
   */
  com.google.storage.v2.CommonObjectRequestParams getCommonObjectRequestParams();
  /**
   *
   *
   * 
   * A set of parameters common to Storage API requests concerning an object.
   * 
   *
   * .google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;
   */
  com.google.storage.v2.CommonObjectRequestParamsOrBuilder getCommonObjectRequestParamsOrBuilder();
}