Class WriteObjectSpec (2.17.2)

public final class WriteObjectSpec extends GeneratedMessageV3 implements WriteObjectSpecOrBuilder

Describes an attempt to insert an object, possibly over multiple requests.

Protobuf type google.storage.v2.WriteObjectSpec

Static Fields

IF_GENERATION_MATCH_FIELD_NUMBER

public static final int IF_GENERATION_MATCH_FIELD_NUMBER
Field Value
Type Description
int

IF_GENERATION_NOT_MATCH_FIELD_NUMBER

public static final int IF_GENERATION_NOT_MATCH_FIELD_NUMBER
Field Value
Type Description
int

IF_METAGENERATION_MATCH_FIELD_NUMBER

public static final int IF_METAGENERATION_MATCH_FIELD_NUMBER
Field Value
Type Description
int

IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER

public static final int IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER
Field Value
Type Description
int

OBJECT_SIZE_FIELD_NUMBER

public static final int OBJECT_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PREDEFINED_ACL_FIELD_NUMBER

public static final int PREDEFINED_ACL_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_FIELD_NUMBER

public static final int RESOURCE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static WriteObjectSpec getDefaultInstance()
Returns
Type Description
WriteObjectSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static WriteObjectSpec.Builder newBuilder()
Returns
Type Description
WriteObjectSpec.Builder

newBuilder(WriteObjectSpec prototype)

public static WriteObjectSpec.Builder newBuilder(WriteObjectSpec prototype)
Parameter
Name Description
prototype WriteObjectSpec
Returns
Type Description
WriteObjectSpec.Builder

parseDelimitedFrom(InputStream input)

public static WriteObjectSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WriteObjectSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WriteObjectSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteObjectSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static WriteObjectSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
WriteObjectSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static WriteObjectSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteObjectSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static WriteObjectSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
WriteObjectSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static WriteObjectSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteObjectSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static WriteObjectSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
WriteObjectSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static WriteObjectSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteObjectSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static WriteObjectSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WriteObjectSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WriteObjectSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteObjectSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static WriteObjectSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
WriteObjectSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static WriteObjectSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteObjectSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<WriteObjectSpec> parser()
Returns
Type Description
Parser<WriteObjectSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public WriteObjectSpec getDefaultInstanceForType()
Returns
Type Description
WriteObjectSpec

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

Returns
Type Description
long

The ifGenerationMatch.

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

Returns
Type Description
long

The ifGenerationNotMatch.

getIfMetagenerationMatch()

public 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 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 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. The object_size value is ignored for one-shot (non-resumable) writes.

optional int64 object_size = 8;

Returns
Type Description
long

The objectSize.

getParserForType()

public Parser<WriteObjectSpec> getParserForType()
Returns
Type Description
Parser<WriteObjectSpec>
Overrides

getPredefinedAcl()

public 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 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 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 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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

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

Returns
Type Description
boolean

Whether the ifGenerationMatch field is set.

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

Returns
Type Description
boolean

Whether the ifGenerationNotMatch field is set.

hasIfMetagenerationMatch()

public 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 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 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. The object_size value is ignored for one-shot (non-resumable) writes.

optional int64 object_size = 8;

Returns
Type Description
boolean

Whether the objectSize field is set.

hasResource()

public 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public WriteObjectSpec.Builder newBuilderForType()
Returns
Type Description
WriteObjectSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected WriteObjectSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
WriteObjectSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public WriteObjectSpec.Builder toBuilder()
Returns
Type Description
WriteObjectSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException