Package com.google.storage.v2

Class UpdateObjectRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.storage.v2.UpdateObjectRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, UpdateObjectRequestOrBuilder, Serializable
public final class UpdateObjectRequest extends com.google.protobuf.GeneratedMessageV3 implements UpdateObjectRequestOrBuilder
 Request message for UpdateObject.
Protobuf type google.storage.v2.UpdateObjectRequest
See Also:

  • Field Details

    • OBJECT_FIELD_NUMBER

      public static final int OBJECT_FIELD_NUMBER
      See Also:

    • IF_GENERATION_MATCH_FIELD_NUMBER

      public static final int IF_GENERATION_MATCH_FIELD_NUMBER
      See Also:

    • IF_GENERATION_NOT_MATCH_FIELD_NUMBER

      public static final int IF_GENERATION_NOT_MATCH_FIELD_NUMBER
      See Also:

    • IF_METAGENERATION_MATCH_FIELD_NUMBER

      public static final int IF_METAGENERATION_MATCH_FIELD_NUMBER
      See Also:

    • IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER

      public static final int IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER
      See Also:

    • PREDEFINED_ACL_FIELD_NUMBER

      public static final int PREDEFINED_ACL_FIELD_NUMBER
      See Also:

    • UPDATE_MASK_FIELD_NUMBER

      public static final int UPDATE_MASK_FIELD_NUMBER
      See Also:

    • COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER

      public static final int COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER
      See Also:

    • OVERRIDE_UNLOCKED_RETENTION_FIELD_NUMBER

      public static final int OVERRIDE_UNLOCKED_RETENTION_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • hasObject

      public 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];
      Specified by:
      hasObject in interface UpdateObjectRequestOrBuilder
      Returns:
      Whether the object field is set.

    • getObject

      public 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];
      Specified by:
      getObject in interface UpdateObjectRequestOrBuilder
      Returns:
      The object.

    • getObjectOrBuilder

      public ObjectOrBuilder getObjectOrBuilder()
       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];
      Specified by:
      getObjectOrBuilder in interface UpdateObjectRequestOrBuilder

    • hasIfGenerationMatch

      public 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;
      Specified by:
      hasIfGenerationMatch in interface UpdateObjectRequestOrBuilder
      Returns:
      Whether the ifGenerationMatch field is set.

    • getIfGenerationMatch

      public long getIfGenerationMatch()
       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;
      Specified by:
      getIfGenerationMatch in interface UpdateObjectRequestOrBuilder
      Returns:
      The ifGenerationMatch.

    • hasIfGenerationNotMatch

      public 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;
      Specified by:
      hasIfGenerationNotMatch in interface UpdateObjectRequestOrBuilder
      Returns:
      Whether the ifGenerationNotMatch field is set.

    • getIfGenerationNotMatch

      public long getIfGenerationNotMatch()
       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;
      Specified by:
      getIfGenerationNotMatch in interface UpdateObjectRequestOrBuilder
      Returns:
      The ifGenerationNotMatch.

    • hasIfMetagenerationMatch

      public boolean hasIfMetagenerationMatch()
       Makes the operation conditional on whether the object's current
 metageneration matches the given value.
      optional int64 if_metageneration_match = 4;
      Specified by:
      hasIfMetagenerationMatch in interface UpdateObjectRequestOrBuilder
      Returns:
      Whether the ifMetagenerationMatch field is set.

    • getIfMetagenerationMatch

      public long getIfMetagenerationMatch()
       Makes the operation conditional on whether the object's current
 metageneration matches the given value.
      optional int64 if_metageneration_match = 4;
      Specified by:
      getIfMetagenerationMatch in interface UpdateObjectRequestOrBuilder
      Returns:
      The ifMetagenerationMatch.

    • hasIfMetagenerationNotMatch

      public 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;
      Specified by:
      hasIfMetagenerationNotMatch in interface UpdateObjectRequestOrBuilder
      Returns:
      Whether the ifMetagenerationNotMatch field is set.

    • getIfMetagenerationNotMatch

      public long getIfMetagenerationNotMatch()
       Makes the operation conditional on whether the object's current
 metageneration does not match the given value.
      optional int64 if_metageneration_not_match = 5;
      Specified by:
      getIfMetagenerationNotMatch in interface UpdateObjectRequestOrBuilder
      Returns:
      The ifMetagenerationNotMatch.

    • getPredefinedAcl

      public String getPredefinedAcl()
       Optional. Apply a predefined set of access controls to this object.
 Valid values are "authenticatedRead", "bucketOwnerFullControl",
 "bucketOwnerRead", "private", "projectPrivate", or "publicRead".
      string predefined_acl = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPredefinedAcl in interface UpdateObjectRequestOrBuilder
      Returns:
      The predefinedAcl.

    • getPredefinedAclBytes

      public com.google.protobuf.ByteString getPredefinedAclBytes()
       Optional. Apply a predefined set of access controls to this object.
 Valid values are "authenticatedRead", "bucketOwnerFullControl",
 "bucketOwnerRead", "private", "projectPrivate", or "publicRead".
      string predefined_acl = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPredefinedAclBytes in interface UpdateObjectRequestOrBuilder
      Returns:
      The bytes for predefinedAcl.

    • hasUpdateMask

      public 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];
      Specified by:
      hasUpdateMask in interface UpdateObjectRequestOrBuilder
      Returns:
      Whether the updateMask field is set.

    • getUpdateMask

      public 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];
      Specified by:
      getUpdateMask in interface UpdateObjectRequestOrBuilder
      Returns:
      The updateMask.

    • getUpdateMaskOrBuilder

      public com.google.protobuf.FieldMaskOrBuilder getUpdateMaskOrBuilder()
       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];
      Specified by:
      getUpdateMaskOrBuilder in interface UpdateObjectRequestOrBuilder

    • hasCommonObjectRequestParams

      public boolean hasCommonObjectRequestParams()
       Optional. A set of parameters common to Storage API requests concerning an
 object.
      .google.storage.v2.CommonObjectRequestParams common_object_request_params = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasCommonObjectRequestParams in interface UpdateObjectRequestOrBuilder
      Returns:
      Whether the commonObjectRequestParams field is set.

    • getCommonObjectRequestParams

      public CommonObjectRequestParams getCommonObjectRequestParams()
       Optional. A set of parameters common to Storage API requests concerning an
 object.
      .google.storage.v2.CommonObjectRequestParams common_object_request_params = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCommonObjectRequestParams in interface UpdateObjectRequestOrBuilder
      Returns:
      The commonObjectRequestParams.

    • getCommonObjectRequestParamsOrBuilder

      public CommonObjectRequestParamsOrBuilder getCommonObjectRequestParamsOrBuilder()
       Optional. A set of parameters common to Storage API requests concerning an
 object.
      .google.storage.v2.CommonObjectRequestParams common_object_request_params = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCommonObjectRequestParamsOrBuilder in interface UpdateObjectRequestOrBuilder

    • getOverrideUnlockedRetention

      public boolean getOverrideUnlockedRetention()
       Optional. Overrides the unlocked retention config on the object.
      bool override_unlocked_retention = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOverrideUnlockedRetention in interface UpdateObjectRequestOrBuilder
      Returns:
      The overrideUnlockedRetention.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static UpdateObjectRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UpdateObjectRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UpdateObjectRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UpdateObjectRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UpdateObjectRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UpdateObjectRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UpdateObjectRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UpdateObjectRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static UpdateObjectRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static UpdateObjectRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UpdateObjectRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UpdateObjectRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public UpdateObjectRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static UpdateObjectRequest.Builder newBuilder()

    • newBuilder

      public static UpdateObjectRequest.Builder newBuilder(UpdateObjectRequest prototype)

    • toBuilder

      public UpdateObjectRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected UpdateObjectRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static UpdateObjectRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<UpdateObjectRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<UpdateObjectRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public UpdateObjectRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder