com.google.storage.v2

Interface UpdateObjectRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

UpdateObjectRequest, UpdateObjectRequest.Builder

public interface UpdateObjectRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
CommonObjectRequestParams	getCommonObjectRequestParams() A set of parameters common to Storage API requests concerning an object.
CommonObjectRequestParamsOrBuilder	getCommonObjectRequestParamsOrBuilder() A set of parameters common to Storage API requests concerning an object.
long	getIfGenerationMatch() Makes the operation conditional on whether the object's current generation matches the given value.
long	getIfGenerationNotMatch() Makes the operation conditional on whether the object's live generation does not match the given value.
long	getIfMetagenerationMatch() Makes the operation conditional on whether the object's current metageneration matches the given value.
long	getIfMetagenerationNotMatch() Makes the operation conditional on whether the object's current metageneration does not match the given value.
Object	getObject() Required.
ObjectOrBuilder	getObjectOrBuilder() Required.
String	getPredefinedAcl() Apply a predefined set of access controls to this object.
com.google.protobuf.ByteString	getPredefinedAclBytes() Apply a predefined set of access controls to this object.
com.google.protobuf.FieldMask	getUpdateMask() Required.
com.google.protobuf.FieldMaskOrBuilder	getUpdateMaskOrBuilder() Required.
boolean	hasCommonObjectRequestParams() A set of parameters common to Storage API requests concerning an object.
boolean	hasIfGenerationMatch() Makes the operation conditional on whether the object's current generation matches the given value.
boolean	hasIfGenerationNotMatch() Makes the operation conditional on whether the object's live generation does not match the given value.
boolean	hasIfMetagenerationMatch() Makes the operation conditional on whether the object's current metageneration matches the given value.
boolean	hasIfMetagenerationNotMatch() Makes the operation conditional on whether the object's current metageneration does not match the given value.
boolean	hasObject() Required.
boolean	hasUpdateMask() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasObject

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];

Returns:

Whether the object field is set.

getObject

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];

Returns:

The object.

getObjectOrBuilder

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];

hasIfGenerationMatch

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;

Returns:

Whether the ifGenerationMatch field is set.

getIfGenerationMatch

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;

Returns:

The ifGenerationMatch.

hasIfGenerationNotMatch

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;

Returns:

Whether the ifGenerationNotMatch field is set.

getIfGenerationNotMatch

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;

Returns:

The ifGenerationNotMatch.

hasIfMetagenerationMatch

boolean hasIfMetagenerationMatch()

 Makes the operation conditional on whether the object's current
 metageneration matches the given value.
 

optional int64 if_metageneration_match = 4;

Returns:

Whether the ifMetagenerationMatch field is set.

getIfMetagenerationMatch

long getIfMetagenerationMatch()

 Makes the operation conditional on whether the object's current
 metageneration matches the given value.
 

optional int64 if_metageneration_match = 4;

Returns:

The ifMetagenerationMatch.

hasIfMetagenerationNotMatch

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;

Returns:

Whether the ifMetagenerationNotMatch field is set.

getIfMetagenerationNotMatch

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;

Returns:

The ifMetagenerationNotMatch.

getPredefinedAcl

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;

Returns:

The predefinedAcl.

getPredefinedAclBytes

com.google.protobuf.ByteString getPredefinedAclBytes()

 Apply a predefined set of access controls to this object.
 Valid values are "authenticatedRead", "bucketOwnerFullControl",
 "bucketOwnerRead", "private", "projectPrivate", or "publicRead".
 

string predefined_acl = 10;

Returns:

The bytes for predefinedAcl.

hasUpdateMask

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];

Returns:

Whether the updateMask field is set.

getUpdateMask

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];

Returns:

The updateMask.

getUpdateMaskOrBuilder

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];

hasCommonObjectRequestParams

boolean hasCommonObjectRequestParams()

 A set of parameters common to Storage API requests concerning an object.
 

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

Returns:

Whether the commonObjectRequestParams field is set.

getCommonObjectRequestParams

CommonObjectRequestParams getCommonObjectRequestParams()

 A set of parameters common to Storage API requests concerning an object.
 

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

Returns:

The commonObjectRequestParams.

getCommonObjectRequestParamsOrBuilder

CommonObjectRequestParamsOrBuilder getCommonObjectRequestParamsOrBuilder()

 A set of parameters common to Storage API requests concerning an object.
 

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;