Class GetObjectRequest.Builder (2.12.0)

public static final class GetObjectRequest.Builder extends GeneratedMessageV3.Builder<GetObjectRequest.Builder> implements GetObjectRequestOrBuilder

Request message for GetObject.

Protobuf type google.storage.v2.GetObjectRequest

Inheritance

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

Implements

GetObjectRequestOrBuilder

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)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

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

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

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 GetObjectRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
GetObjectRequest.Builder

Overrides

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

build()

public GetObjectRequest build()

Returns

Type	Description
GetObjectRequest

buildPartial()

public GetObjectRequest buildPartial()

Returns

Type	Description
GetObjectRequest

clear()

public GetObjectRequest.Builder clear()

Returns

Type	Description
GetObjectRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearBucket()

public GetObjectRequest.Builder clearBucket()

Required. Name of the bucket in which the object resides.

string bucket = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
GetObjectRequest.Builder	This builder for chaining.

clearCommonObjectRequestParams()

public GetObjectRequest.Builder clearCommonObjectRequestParams()

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

Returns

Type	Description
GetObjectRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public GetObjectRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	`FieldDescriptor`

Returns

Type	Description
GetObjectRequest.Builder

Overrides

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

clearGeneration()

public GetObjectRequest.Builder clearGeneration()

If present, selects a specific revision of this object (as opposed to the latest version, the default).

int64 generation = 3;

Returns

Type	Description
GetObjectRequest.Builder	This builder for chaining.

clearIfGenerationMatch()

public GetObjectRequest.Builder clearIfGenerationMatch()

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

Returns

Type	Description
GetObjectRequest.Builder	This builder for chaining.

clearIfGenerationNotMatch()

public GetObjectRequest.Builder clearIfGenerationNotMatch()

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

Returns

Type	Description
GetObjectRequest.Builder	This builder for chaining.

clearIfMetagenerationMatch()

public GetObjectRequest.Builder clearIfMetagenerationMatch()

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

optional int64 if_metageneration_match = 6;

Returns

Type	Description
GetObjectRequest.Builder	This builder for chaining.

clearIfMetagenerationNotMatch()

public GetObjectRequest.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 = 7;

Returns

Type	Description
GetObjectRequest.Builder	This builder for chaining.

clearObject()

public GetObjectRequest.Builder clearObject()

Required. Name of the object.

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

Returns

Type	Description
GetObjectRequest.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public GetObjectRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	`OneofDescriptor`

Returns

Type	Description
GetObjectRequest.Builder

Overrides

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

clearReadMask()

public GetObjectRequest.Builder clearReadMask()

Mask specifying which fields to read. If no mask is specified, will default to all fields except metadata.acl and metadata.owner.

may be used to mean "all fields".

optional .google.protobuf.FieldMask read_mask = 10;

Returns

Type	Description
GetObjectRequest.Builder

clone()

public GetObjectRequest.Builder clone()

Returns

Type	Description
GetObjectRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getBucket()

public String getBucket()

Required. Name of the bucket in which the object resides.

string bucket = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
String	The bucket.

getBucketBytes()

public ByteString getBucketBytes()

Required. Name of the bucket in which the object resides.

string bucket = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
ByteString	The bytes for bucket.

getCommonObjectRequestParams()

public CommonObjectRequestParams getCommonObjectRequestParams()

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

Returns

Type	Description
CommonObjectRequestParams	The commonObjectRequestParams.

getCommonObjectRequestParamsBuilder()

public CommonObjectRequestParams.Builder getCommonObjectRequestParamsBuilder()

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

Returns

Type	Description
CommonObjectRequestParams.Builder

getCommonObjectRequestParamsOrBuilder()

public CommonObjectRequestParamsOrBuilder getCommonObjectRequestParamsOrBuilder()

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

Returns

Type	Description
CommonObjectRequestParamsOrBuilder

getDefaultInstanceForType()

public GetObjectRequest getDefaultInstanceForType()

Returns

Type	Description
GetObjectRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getGeneration()

public long getGeneration()

If present, selects a specific revision of this object (as opposed to the latest version, the default).

int64 generation = 3;

Returns

Type	Description
long	The generation.

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

Returns

Type	Description
long	The ifGenerationMatch.

getIfGenerationNotMatch()

public long getIfGenerationNotMatch()

optional int64 if_generation_not_match = 5;

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

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

Returns

Type	Description
long	The ifMetagenerationNotMatch.

getObject()

public String getObject()

Required. Name of the object.

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

Returns

Type	Description
String	The object.

getObjectBytes()

public ByteString getObjectBytes()

Required. Name of the object.

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

Returns

Type	Description
ByteString	The bytes for object.

getReadMask()

public FieldMask getReadMask()

Mask specifying which fields to read. If no mask is specified, will default to all fields except metadata.acl and metadata.owner.

may be used to mean "all fields".

optional .google.protobuf.FieldMask read_mask = 10;

Returns

Type	Description
FieldMask	The readMask.

getReadMaskBuilder()

public FieldMask.Builder getReadMaskBuilder()

Mask specifying which fields to read. If no mask is specified, will default to all fields except metadata.acl and metadata.owner.

may be used to mean "all fields".

optional .google.protobuf.FieldMask read_mask = 10;

Returns

Type	Description
Builder

getReadMaskOrBuilder()

public FieldMaskOrBuilder getReadMaskOrBuilder()

Mask specifying which fields to read. If no mask is specified, will default to all fields except metadata.acl and metadata.owner.

may be used to mean "all fields".

optional .google.protobuf.FieldMask read_mask = 10;

Returns

Type	Description
FieldMaskOrBuilder

hasCommonObjectRequestParams()

public boolean hasCommonObjectRequestParams()

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

Returns

Type	Description
boolean	Whether the commonObjectRequestParams field is set.

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

Returns

Type	Description
boolean	Whether the ifGenerationMatch field is set.

hasIfGenerationNotMatch()

public boolean hasIfGenerationNotMatch()

optional int64 if_generation_not_match = 5;

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

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

Returns

Type	Description
boolean	Whether the ifMetagenerationNotMatch field is set.

hasReadMask()

public boolean hasReadMask()

Mask specifying which fields to read. If no mask is specified, will default to all fields except metadata.acl and metadata.owner.

may be used to mean "all fields".

optional .google.protobuf.FieldMask read_mask = 10;

Returns

Type	Description
boolean	Whether the readMask 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()

mergeCommonObjectRequestParams(CommonObjectRequestParams value)

public GetObjectRequest.Builder mergeCommonObjectRequestParams(CommonObjectRequestParams value)

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

Parameter

Name	Description
value	`CommonObjectRequestParams`

Returns

Type	Description
GetObjectRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GetObjectRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
GetObjectRequest.Builder

Overrides

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

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public GetObjectRequest.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
GetObjectRequest.Builder

Overrides

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

mergeFrom(GetObjectRequest other)

public GetObjectRequest.Builder mergeFrom(GetObjectRequest other)

Parameter

Name	Description
other	`GetObjectRequest`

Returns

Type	Description
GetObjectRequest.Builder

mergeReadMask(FieldMask value)

public GetObjectRequest.Builder mergeReadMask(FieldMask value)

Mask specifying which fields to read. If no mask is specified, will default to all fields except metadata.acl and metadata.owner.

may be used to mean "all fields".

optional .google.protobuf.FieldMask read_mask = 10;

Parameter

Name	Description
value	`FieldMask`

Returns

Type	Description
GetObjectRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GetObjectRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
GetObjectRequest.Builder

Overrides

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

setBucket(String value)

public GetObjectRequest.Builder setBucket(String value)

Required. Name of the bucket in which the object resides.

string bucket = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	`String` The bucket to set.

Returns

Type	Description
GetObjectRequest.Builder	This builder for chaining.

setBucketBytes(ByteString value)

public GetObjectRequest.Builder setBucketBytes(ByteString value)

Required. Name of the bucket in which the object resides.

string bucket = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	`ByteString` The bytes for bucket to set.

Returns

Type	Description
GetObjectRequest.Builder	This builder for chaining.

setCommonObjectRequestParams(CommonObjectRequestParams value)

public GetObjectRequest.Builder setCommonObjectRequestParams(CommonObjectRequestParams value)

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

Parameter

Name	Description
value	`CommonObjectRequestParams`

Returns

Type	Description
GetObjectRequest.Builder

setCommonObjectRequestParams(CommonObjectRequestParams.Builder builderForValue)

public GetObjectRequest.Builder setCommonObjectRequestParams(CommonObjectRequestParams.Builder builderForValue)

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

Parameter

Name	Description
builderForValue	`CommonObjectRequestParams.Builder`

Returns

Type	Description
GetObjectRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public GetObjectRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
GetObjectRequest.Builder

Overrides

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

setGeneration(long value)

public GetObjectRequest.Builder setGeneration(long value)

If present, selects a specific revision of this object (as opposed to the latest version, the default).

int64 generation = 3;

Parameter

Name	Description
value	`long` The generation to set.

Returns

Type	Description
GetObjectRequest.Builder	This builder for chaining.

setIfGenerationMatch(long value)

public GetObjectRequest.Builder setIfGenerationMatch(long value)

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

Parameter

Name	Description
value	`long` The ifGenerationMatch to set.

Returns

Type	Description
GetObjectRequest.Builder	This builder for chaining.

setIfGenerationNotMatch(long value)

public GetObjectRequest.Builder setIfGenerationNotMatch(long value)

optional int64 if_generation_not_match = 5;

Parameter

Name	Description
value	`long` The ifGenerationNotMatch to set.

Returns

Type	Description
GetObjectRequest.Builder	This builder for chaining.

setIfMetagenerationMatch(long value)

public GetObjectRequest.Builder setIfMetagenerationMatch(long value)

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

optional int64 if_metageneration_match = 6;

Parameter

Name	Description
value	`long` The ifMetagenerationMatch to set.

Returns

Type	Description
GetObjectRequest.Builder	This builder for chaining.

setIfMetagenerationNotMatch(long value)

public GetObjectRequest.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 = 7;

Parameter

Name	Description
value	`long` The ifMetagenerationNotMatch to set.

Returns

Type	Description
GetObjectRequest.Builder	This builder for chaining.

setObject(String value)

public GetObjectRequest.Builder setObject(String value)

Required. Name of the object.

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

Parameter

Name	Description
value	`String` The object to set.

Returns

Type	Description
GetObjectRequest.Builder	This builder for chaining.

setObjectBytes(ByteString value)

public GetObjectRequest.Builder setObjectBytes(ByteString value)

Required. Name of the object.

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

Parameter

Name	Description
value	`ByteString` The bytes for object to set.

Returns

Type	Description
GetObjectRequest.Builder	This builder for chaining.

setReadMask(FieldMask value)

public GetObjectRequest.Builder setReadMask(FieldMask value)

Mask specifying which fields to read. If no mask is specified, will default to all fields except metadata.acl and metadata.owner.

may be used to mean "all fields".

optional .google.protobuf.FieldMask read_mask = 10;

Parameter

Name	Description
value	`FieldMask`

Returns

Type	Description
GetObjectRequest.Builder

setReadMask(FieldMask.Builder builderForValue)

public GetObjectRequest.Builder setReadMask(FieldMask.Builder builderForValue)

Mask specifying which fields to read. If no mask is specified, will default to all fields except metadata.acl and metadata.owner.

may be used to mean "all fields".

optional .google.protobuf.FieldMask read_mask = 10;

Parameter

Name	Description
builderForValue	`Builder`

Returns

Type	Description
GetObjectRequest.Builder

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

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

Parameters

Name	Description
field	`FieldDescriptor`
index	`int`
value	`Object`

Returns

Type	Description
GetObjectRequest.Builder

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final GetObjectRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
GetObjectRequest.Builder

Overrides

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