Class AppendObjectSpec (2.49.0)

public final class AppendObjectSpec extends GeneratedMessageV3 implements AppendObjectSpecOrBuilder

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

Protobuf type google.storage.v2.AppendObjectSpec

Static Fields

BUCKET_FIELD_NUMBER

public static final int BUCKET_FIELD_NUMBER
Field Value
TypeDescription
int

GENERATION_FIELD_NUMBER

public static final int GENERATION_FIELD_NUMBER
Field Value
TypeDescription
int

IF_METAGENERATION_MATCH_FIELD_NUMBER

public static final int IF_METAGENERATION_MATCH_FIELD_NUMBER
Field Value
TypeDescription
int

IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER

public static final int IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER
Field Value
TypeDescription
int

OBJECT_FIELD_NUMBER

public static final int OBJECT_FIELD_NUMBER
Field Value
TypeDescription
int

ROUTING_TOKEN_FIELD_NUMBER

public static final int ROUTING_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

WRITE_HANDLE_FIELD_NUMBER

public static final int WRITE_HANDLE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AppendObjectSpec getDefaultInstance()
Returns
TypeDescription
AppendObjectSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static AppendObjectSpec.Builder newBuilder()
Returns
TypeDescription
AppendObjectSpec.Builder

newBuilder(AppendObjectSpec )

public static AppendObjectSpec.Builder newBuilder(AppendObjectSpec )
Parameter
NameDescription
AppendObjectSpec
Returns
TypeDescription
AppendObjectSpec.Builder

parseDelimitedFrom(InputStream input)

public static AppendObjectSpec parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AppendObjectSpec
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AppendObjectSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AppendObjectSpec
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static AppendObjectSpec parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
AppendObjectSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AppendObjectSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AppendObjectSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AppendObjectSpec parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
AppendObjectSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AppendObjectSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AppendObjectSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AppendObjectSpec parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
AppendObjectSpec
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AppendObjectSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AppendObjectSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static AppendObjectSpec parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AppendObjectSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AppendObjectSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AppendObjectSpec
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static AppendObjectSpec parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
AppendObjectSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AppendObjectSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AppendObjectSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<AppendObjectSpec> parser()
Returns
TypeDescription
Parser<AppendObjectSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getBucket()

public String getBucket()

Required. The name of the bucket containing the object to write.

string bucket = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The bucket.

getBucketBytes()

public ByteString getBucketBytes()

Required. The name of the bucket containing the object to write.

string bucket = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for bucket.

getDefaultInstanceForType()

public AppendObjectSpec getDefaultInstanceForType()
Returns
TypeDescription
AppendObjectSpec

getGeneration()

public long getGeneration()

Required. The generation number of the object to open for writing.

int64 generation = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
long

The generation.

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;

Returns
TypeDescription
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 = 5;

Returns
TypeDescription
long

The ifMetagenerationNotMatch.

getObject()

public String getObject()

Required. The name of the object to open for writing.

string object = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The object.

getObjectBytes()

public ByteString getObjectBytes()

Required. The name of the object to open for writing.

string object = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for object.

getParserForType()

public Parser<AppendObjectSpec> getParserForType()
Returns
TypeDescription
Parser<AppendObjectSpec>
Overrides

getRoutingToken()

public String getRoutingToken()

An optional routing token that influences request routing for the stream. Must be provided if a BidiWriteObjectRedirectedError is returned.

optional string routing_token = 6;

Returns
TypeDescription
String

The routingToken.

getRoutingTokenBytes()

public ByteString getRoutingTokenBytes()

An optional routing token that influences request routing for the stream. Must be provided if a BidiWriteObjectRedirectedError is returned.

optional string routing_token = 6;

Returns
TypeDescription
ByteString

The bytes for routingToken.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getWriteHandle()

public BidiWriteHandle getWriteHandle()

An optional write handle returned from a previous BidiWriteObjectResponse message or a BidiWriteObjectRedirectedError error.

optional .google.storage.v2.BidiWriteHandle write_handle = 7;

Returns
TypeDescription
BidiWriteHandle

The writeHandle.

getWriteHandleOrBuilder()

public BidiWriteHandleOrBuilder getWriteHandleOrBuilder()

An optional write handle returned from a previous BidiWriteObjectResponse message or a BidiWriteObjectRedirectedError error.

optional .google.storage.v2.BidiWriteHandle write_handle = 7;

Returns
TypeDescription
BidiWriteHandleOrBuilder

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;

Returns
TypeDescription
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 = 5;

Returns
TypeDescription
boolean

Whether the ifMetagenerationNotMatch field is set.

hasRoutingToken()

public boolean hasRoutingToken()

An optional routing token that influences request routing for the stream. Must be provided if a BidiWriteObjectRedirectedError is returned.

optional string routing_token = 6;

Returns
TypeDescription
boolean

Whether the routingToken field is set.

hasWriteHandle()

public boolean hasWriteHandle()

An optional write handle returned from a previous BidiWriteObjectResponse message or a BidiWriteObjectRedirectedError error.

optional .google.storage.v2.BidiWriteHandle write_handle = 7;

Returns
TypeDescription
boolean

Whether the writeHandle field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public AppendObjectSpec.Builder newBuilderForType()
Returns
TypeDescription
AppendObjectSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AppendObjectSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
AppendObjectSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public AppendObjectSpec.Builder toBuilder()
Returns
TypeDescription
AppendObjectSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException