Class AppendObjectSpec (2.48.1)

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
Type Description
int

GENERATION_FIELD_NUMBER

public static final int GENERATION_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_FIELD_NUMBER

public static final int OBJECT_FIELD_NUMBER
Field Value
Type Description
int

ROUTING_TOKEN_FIELD_NUMBER

public static final int ROUTING_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

WRITE_HANDLE_FIELD_NUMBER

public static final int WRITE_HANDLE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AppendObjectSpec getDefaultInstance()
Returns
Type Description
AppendObjectSpec

getDescriptor()

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

newBuilder()

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

newBuilder(AppendObjectSpec prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for bucket.

getDefaultInstanceForType()

public AppendObjectSpec getDefaultInstanceForType()
Returns
Type Description
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
Type Description
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
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 = 5;

Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for object.

getParserForType()

public Parser<AppendObjectSpec> getParserForType()
Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for routingToken.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
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
Type Description
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
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 = 5;

Returns
Type Description
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
Type Description
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
Type Description
boolean

Whether the writeHandle 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 AppendObjectSpec.Builder newBuilderForType()
Returns
Type Description
AppendObjectSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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