Interface WriteObjectSpecOrBuilder (2.34.0)

Version 2.34.0

• 2.46.0 (latest)
• 2.45.0
• 2.44.1
• 2.43.2
• 2.42.0
• 2.41.0
• 2.40.1
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.1
• 2.34.0
• 2.33.0
• 2.32.1
• 2.30.1
• 2.29.1
• 2.28.0
• 2.27.1
• 2.24.0
• 2.23.0
• 2.22.6
• 2.21.0
• 2.20.2
• 2.19.0
• 2.18.0
• 2.17.2
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.3
• 2.10.0
• 2.9.3
• 2.8.1
• 2.7.1
• 2.6.1
• 2.5.1
• 2.4.5
• 2.3.0
• 2.2.3
• 2.1.10

public interface WriteObjectSpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getIfGenerationMatch()

public abstract 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 = 3;

Returns
Type	Description
long	The ifGenerationMatch.

getIfGenerationNotMatch()

public abstract 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 = 4;

Returns
Type	Description
long	The ifGenerationNotMatch.

getIfMetagenerationMatch()

public abstract long getIfMetagenerationMatch()

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

optional int64 if_metageneration_match = 5;

Returns
Type	Description
long	The ifMetagenerationMatch.

getIfMetagenerationNotMatch()

public abstract 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 = 6;

Returns
Type	Description
long	The ifMetagenerationNotMatch.

getObjectSize()

public abstract long getObjectSize()

The expected final object size being uploaded. If this value is set, closing the stream after writing fewer or more than object_size bytes will result in an OUT_OF_RANGE error.

This situation is considered a client error, and if such an error occurs you must start the upload over from scratch, this time sending the correct number of bytes.

optional int64 object_size = 8;

Returns
Type	Description
long	The objectSize.

getPredefinedAcl()

public abstract 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 = 7;

Returns
Type	Description
String	The predefinedAcl.

getPredefinedAclBytes()

public abstract 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 = 7;

Returns
Type	Description
ByteString	The bytes for predefinedAcl.

getResource()

public abstract Object getResource()

Required. Destination object, including its name and its metadata.

.google.storage.v2.Object resource = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Object	The resource.

getResourceOrBuilder()

public abstract ObjectOrBuilder getResourceOrBuilder()

Required. Destination object, including its name and its metadata.

.google.storage.v2.Object resource = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ObjectOrBuilder

hasIfGenerationMatch()

public abstract 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 = 3;

Returns
Type	Description
boolean	Whether the ifGenerationMatch field is set.

hasIfGenerationNotMatch()

public abstract 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 = 4;

Returns
Type	Description
boolean	Whether the ifGenerationNotMatch field is set.

hasIfMetagenerationMatch()

public abstract boolean hasIfMetagenerationMatch()

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

optional int64 if_metageneration_match = 5;

Returns
Type	Description
boolean	Whether the ifMetagenerationMatch field is set.

hasIfMetagenerationNotMatch()

public abstract 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 = 6;

Returns
Type	Description
boolean	Whether the ifMetagenerationNotMatch field is set.

hasObjectSize()

public abstract boolean hasObjectSize()

The expected final object size being uploaded. If this value is set, closing the stream after writing fewer or more than object_size bytes will result in an OUT_OF_RANGE error.

This situation is considered a client error, and if such an error occurs you must start the upload over from scratch, this time sending the correct number of bytes.

optional int64 object_size = 8;

Returns
Type	Description
boolean	Whether the objectSize field is set.

hasResource()

public abstract boolean hasResource()

Required. Destination object, including its name and its metadata.

.google.storage.v2.Object resource = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the resource field is set.