Class AppendObjectSpec.Builder (2.58.1)

Version latest

• 2.58.1 (latest)
• 2.58.0
• 2.57.0
• 2.56.0
• 2.55.0
• 2.54.0
• 2.53.3
• 2.52.3
• 2.50.0
• 2.49.0
• 2.48.2
• 2.47.0
• 2.46.0
• 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 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AppendObjectSpec.Builder

Implements

AppendObjectSpecOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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.

Note that metageneration preconditions are only checked if write_handle is empty.

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.

Note that metageneration preconditions are only checked if write_handle is empty.

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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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.

Note that metageneration preconditions are only checked if write_handle is empty.

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

Returns
Type	Description
AppendObjectSpec.Builder

clone()

public AppendObjectSpec.Builder clone()

Returns
Type	Description
AppendObjectSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

Note that metageneration preconditions are only checked if write_handle is empty.

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.

Note that metageneration preconditions are only checked if write_handle is empty.

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.

Note that metageneration preconditions are only checked if write_handle is empty.

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.

Note that metageneration preconditions are only checked if write_handle is empty.

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.

Note that metageneration preconditions are only checked if write_handle is empty.

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.

Note that metageneration preconditions are only checked if write_handle is empty.

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.

Note that metageneration preconditions are only checked if write_handle is empty.

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.

Note that metageneration preconditions are only checked if write_handle is empty.

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public AppendObjectSpec.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
AppendObjectSpec.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeWriteHandle(BidiWriteHandle value)

public AppendObjectSpec.Builder mergeWriteHandle(BidiWriteHandle value)

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

Note that metageneration preconditions are only checked if write_handle is empty.

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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.

Note that metageneration preconditions are only checked if write_handle is empty.

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.

Note that metageneration preconditions are only checked if write_handle is empty.

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setWriteHandle(BidiWriteHandle value)

public AppendObjectSpec.Builder setWriteHandle(BidiWriteHandle value)

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

Note that metageneration preconditions are only checked if write_handle is empty.

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.

Note that metageneration preconditions are only checked if write_handle is empty.

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

Parameter
Name	Description
builderForValue	BidiWriteHandle.Builder

Returns
Type	Description
AppendObjectSpec.Builder