Class AppendObjectSpec.Builder (2.48.1)

public static final class AppendObjectSpec.Builder extends GeneratedMessageV3.Builder<AppendObjectSpec.Builder> implements AppendObjectSpecOrBuilder

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

Protobuf type google.storage.v2.AppendObjectSpec

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AppendObjectSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AppendObjectSpec.Builder
Overrides

build()

public AppendObjectSpec build()
Returns
Type Description
AppendObjectSpec

buildPartial()

public AppendObjectSpec buildPartial()
Returns
Type Description
AppendObjectSpec

clear()

public AppendObjectSpec.Builder clear()
Returns
Type Description
AppendObjectSpec.Builder
Overrides

clearBucket()

public AppendObjectSpec.Builder clearBucket()

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
AppendObjectSpec.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public AppendObjectSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AppendObjectSpec.Builder
Overrides

clearGeneration()

public AppendObjectSpec.Builder clearGeneration()

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

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

Returns
Type Description
AppendObjectSpec.Builder

This builder for chaining.

clearIfMetagenerationMatch()

public AppendObjectSpec.Builder clearIfMetagenerationMatch()

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

optional int64 if_metageneration_match = 4;

Returns
Type Description
AppendObjectSpec.Builder

This builder for chaining.

clearIfMetagenerationNotMatch()

public AppendObjectSpec.Builder clearIfMetagenerationNotMatch()

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
AppendObjectSpec.Builder

This builder for chaining.

clearObject()

public AppendObjectSpec.Builder clearObject()

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

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

Returns
Type Description
AppendObjectSpec.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AppendObjectSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AppendObjectSpec.Builder
Overrides

clearRoutingToken()

public AppendObjectSpec.Builder clearRoutingToken()

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
AppendObjectSpec.Builder

This builder for chaining.

clearWriteHandle()

public AppendObjectSpec.Builder clearWriteHandle()

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
AppendObjectSpec.Builder

clone()

public AppendObjectSpec.Builder clone()
Returns
Type Description
AppendObjectSpec.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

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.

getWriteHandleBuilder()

public BidiWriteHandle.Builder getWriteHandleBuilder()

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AppendObjectSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AppendObjectSpec.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AppendObjectSpec.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AppendObjectSpec.Builder
Overrides

mergeFrom(AppendObjectSpec other)

public AppendObjectSpec.Builder mergeFrom(AppendObjectSpec other)
Parameter
Name Description
other AppendObjectSpec
Returns
Type Description
AppendObjectSpec.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AppendObjectSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AppendObjectSpec.Builder
Overrides

mergeWriteHandle(BidiWriteHandle value)

public AppendObjectSpec.Builder mergeWriteHandle(BidiWriteHandle value)

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

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

Parameter
Name Description
value BidiWriteHandle
Returns
Type Description
AppendObjectSpec.Builder

setBucket(String value)

public AppendObjectSpec.Builder setBucket(String value)

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

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

Parameter
Name Description
value String

The bucket to set.

Returns
Type Description
AppendObjectSpec.Builder

This builder for chaining.

setBucketBytes(ByteString value)

public AppendObjectSpec.Builder setBucketBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for bucket to set.

Returns
Type Description
AppendObjectSpec.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public AppendObjectSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AppendObjectSpec.Builder
Overrides

setGeneration(long value)

public AppendObjectSpec.Builder setGeneration(long value)

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

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

Parameter
Name Description
value long

The generation to set.

Returns
Type Description
AppendObjectSpec.Builder

This builder for chaining.

setIfMetagenerationMatch(long value)

public AppendObjectSpec.Builder setIfMetagenerationMatch(long value)

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

optional int64 if_metageneration_match = 4;

Parameter
Name Description
value long

The ifMetagenerationMatch to set.

Returns
Type Description
AppendObjectSpec.Builder

This builder for chaining.

setIfMetagenerationNotMatch(long value)

public AppendObjectSpec.Builder setIfMetagenerationNotMatch(long value)

Makes the operation conditional on whether the object's current metageneration does not match the given value.

optional int64 if_metageneration_not_match = 5;

Parameter
Name Description
value long

The ifMetagenerationNotMatch to set.

Returns
Type Description
AppendObjectSpec.Builder

This builder for chaining.

setObject(String value)

public AppendObjectSpec.Builder setObject(String value)

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

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

Parameter
Name Description
value String

The object to set.

Returns
Type Description
AppendObjectSpec.Builder

This builder for chaining.

setObjectBytes(ByteString value)

public AppendObjectSpec.Builder setObjectBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for object to set.

Returns
Type Description
AppendObjectSpec.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AppendObjectSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AppendObjectSpec.Builder
Overrides

setRoutingToken(String value)

public AppendObjectSpec.Builder setRoutingToken(String value)

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

optional string routing_token = 6;

Parameter
Name Description
value String

The routingToken to set.

Returns
Type Description
AppendObjectSpec.Builder

This builder for chaining.

setRoutingTokenBytes(ByteString value)

public AppendObjectSpec.Builder setRoutingTokenBytes(ByteString value)

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

optional string routing_token = 6;

Parameter
Name Description
value ByteString

The bytes for routingToken to set.

Returns
Type Description
AppendObjectSpec.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final AppendObjectSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AppendObjectSpec.Builder
Overrides

setWriteHandle(BidiWriteHandle value)

public AppendObjectSpec.Builder setWriteHandle(BidiWriteHandle value)

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

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

Parameter
Name Description
value BidiWriteHandle
Returns
Type Description
AppendObjectSpec.Builder

setWriteHandle(BidiWriteHandle.Builder builderForValue)

public AppendObjectSpec.Builder setWriteHandle(BidiWriteHandle.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue BidiWriteHandle.Builder
Returns
Type Description
AppendObjectSpec.Builder