public static final class ReadObjectRequest.Builder extends GeneratedMessageV3.Builder<ReadObjectRequest.Builder> implements ReadObjectRequestOrBuilderRequest message for ReadObject.
Protobuf type google.storage.v2.ReadObjectRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ReadObjectRequest.BuilderImplements
ReadObjectRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ReadObjectRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| ReadObjectRequest.Builder |
build()
public ReadObjectRequest build()| Type | Description |
| ReadObjectRequest |
buildPartial()
public ReadObjectRequest buildPartial()| Type | Description |
| ReadObjectRequest |
clear()
public ReadObjectRequest.Builder clear()| Type | Description |
| ReadObjectRequest.Builder |
clearBucket()
public ReadObjectRequest.Builder clearBucket()The name of the bucket containing the object to read.
string bucket = 1;
| Type | Description |
| ReadObjectRequest.Builder | This builder for chaining. |
clearCommonObjectRequestParams()
public ReadObjectRequest.Builder clearCommonObjectRequestParams()A set of parameters common to Storage API requests concerning an object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 10;
| Type | Description |
| ReadObjectRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public ReadObjectRequest.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| ReadObjectRequest.Builder |
clearGeneration()
public ReadObjectRequest.Builder clearGeneration()If present, selects a specific revision of this object (as opposed to the latest version, the default).
int64 generation = 3;
| Type | Description |
| ReadObjectRequest.Builder | This builder for chaining. |
clearIfGenerationMatch()
public ReadObjectRequest.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 = 6;
| Type | Description |
| ReadObjectRequest.Builder | This builder for chaining. |
clearIfGenerationNotMatch()
public ReadObjectRequest.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 = 7;
| Type | Description |
| ReadObjectRequest.Builder | This builder for chaining. |
clearIfMetagenerationMatch()
public ReadObjectRequest.Builder clearIfMetagenerationMatch()Makes the operation conditional on whether the object's current metageneration matches the given value.
optional int64 if_metageneration_match = 8;
| Type | Description |
| ReadObjectRequest.Builder | This builder for chaining. |
clearIfMetagenerationNotMatch()
public ReadObjectRequest.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 = 9;
| Type | Description |
| ReadObjectRequest.Builder | This builder for chaining. |
clearObject()
public ReadObjectRequest.Builder clearObject()The name of the object to read.
string object = 2;
| Type | Description |
| ReadObjectRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ReadObjectRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| ReadObjectRequest.Builder |
clearReadLimit()
public ReadObjectRequest.Builder clearReadLimit() The maximum number of data bytes the server is allowed to return in the
sum of all Object messages. A read_limit of zero indicates that there
is no limit, and a negative read_limit will cause an error.
If the stream returns fewer bytes than allowed by the read_limit and no
error occurred, the stream includes all data from the read_offset to the
end of the resource.
int64 read_limit = 5;
| Type | Description |
| ReadObjectRequest.Builder | This builder for chaining. |
clearReadMask()
public ReadObjectRequest.Builder clearReadMask()Mask specifying which fields to read. The checksummed_data field and its children will always be present. If no mask is specified, will default to all fields except metadata.owner and metadata.acl.
- may be used to mean "all fields".
optional .google.protobuf.FieldMask read_mask = 12;
| Type | Description |
| ReadObjectRequest.Builder |
clearReadOffset()
public ReadObjectRequest.Builder clearReadOffset() The offset for the first byte to return in the read, relative to the start
of the object.
A negative read_offset value will be interpreted as the number of bytes
back from the end of the object to be returned. For example, if an object's
length is 15 bytes, a ReadObjectRequest with read_offset = -5 and
read_limit = 3 would return bytes 10 through 12 of the object. Requesting
a negative offset with magnitude larger than the size of the object will
return the entire object.
int64 read_offset = 4;
| Type | Description |
| ReadObjectRequest.Builder | This builder for chaining. |
clone()
public ReadObjectRequest.Builder clone()| Type | Description |
| ReadObjectRequest.Builder |
getBucket()
public String getBucket()The name of the bucket containing the object to read.
string bucket = 1;
| Type | Description |
| String | The bucket. |
getBucketBytes()
public ByteString getBucketBytes()The name of the bucket containing the object to read.
string bucket = 1;
| 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 = 10;
| 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 = 10;
| 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 = 10;
| Type | Description |
| CommonObjectRequestParamsOrBuilder |
getDefaultInstanceForType()
public ReadObjectRequest getDefaultInstanceForType()| Type | Description |
| ReadObjectRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
getGeneration()
public long getGeneration()If present, selects a specific revision of this object (as opposed to the latest version, the default).
int64 generation = 3;
| 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 = 6;
| Type | Description |
| long | The ifGenerationMatch. |
getIfGenerationNotMatch()
public long getIfGenerationNotMatch()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 = 7;
| 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 = 8;
| 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 = 9;
| Type | Description |
| long | The ifMetagenerationNotMatch. |
getObject()
public String getObject()The name of the object to read.
string object = 2;
| Type | Description |
| String | The object. |
getObjectBytes()
public ByteString getObjectBytes()The name of the object to read.
string object = 2;
| Type | Description |
| ByteString | The bytes for object. |
getReadLimit()
public long getReadLimit() The maximum number of data bytes the server is allowed to return in the
sum of all Object messages. A read_limit of zero indicates that there
is no limit, and a negative read_limit will cause an error.
If the stream returns fewer bytes than allowed by the read_limit and no
error occurred, the stream includes all data from the read_offset to the
end of the resource.
int64 read_limit = 5;
| Type | Description |
| long | The readLimit. |
getReadMask()
public FieldMask getReadMask()Mask specifying which fields to read. The checksummed_data field and its children will always be present. If no mask is specified, will default to all fields except metadata.owner and metadata.acl.
- may be used to mean "all fields".
optional .google.protobuf.FieldMask read_mask = 12;
| Type | Description |
| FieldMask | The readMask. |
getReadMaskBuilder()
public FieldMask.Builder getReadMaskBuilder()Mask specifying which fields to read. The checksummed_data field and its children will always be present. If no mask is specified, will default to all fields except metadata.owner and metadata.acl.
- may be used to mean "all fields".
optional .google.protobuf.FieldMask read_mask = 12;
| Type | Description |
| Builder |
getReadMaskOrBuilder()
public FieldMaskOrBuilder getReadMaskOrBuilder()Mask specifying which fields to read. The checksummed_data field and its children will always be present. If no mask is specified, will default to all fields except metadata.owner and metadata.acl.
- may be used to mean "all fields".
optional .google.protobuf.FieldMask read_mask = 12;
| Type | Description |
| FieldMaskOrBuilder |
getReadOffset()
public long getReadOffset() The offset for the first byte to return in the read, relative to the start
of the object.
A negative read_offset value will be interpreted as the number of bytes
back from the end of the object to be returned. For example, if an object's
length is 15 bytes, a ReadObjectRequest with read_offset = -5 and
read_limit = 3 would return bytes 10 through 12 of the object. Requesting
a negative offset with magnitude larger than the size of the object will
return the entire object.
int64 read_offset = 4;
| Type | Description |
| long | The readOffset. |
hasCommonObjectRequestParams()
public boolean hasCommonObjectRequestParams()A set of parameters common to Storage API requests concerning an object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 10;
| 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 = 6;
| Type | Description |
| boolean | Whether the ifGenerationMatch field is set. |
hasIfGenerationNotMatch()
public boolean hasIfGenerationNotMatch()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 = 7;
| 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 = 8;
| 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 = 9;
| Type | Description |
| boolean | Whether the ifMetagenerationNotMatch field is set. |
hasReadMask()
public boolean hasReadMask()Mask specifying which fields to read. The checksummed_data field and its children will always be present. If no mask is specified, will default to all fields except metadata.owner and metadata.acl.
- may be used to mean "all fields".
optional .google.protobuf.FieldMask read_mask = 12;
| Type | Description |
| boolean | Whether the readMask field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeCommonObjectRequestParams(CommonObjectRequestParams value)
public ReadObjectRequest.Builder mergeCommonObjectRequestParams(CommonObjectRequestParams value)A set of parameters common to Storage API requests concerning an object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 10;
| Name | Description |
| value | CommonObjectRequestParams |
| Type | Description |
| ReadObjectRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ReadObjectRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ReadObjectRequest.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public ReadObjectRequest.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| ReadObjectRequest.Builder |
mergeFrom(ReadObjectRequest other)
public ReadObjectRequest.Builder mergeFrom(ReadObjectRequest other)| Name | Description |
| other | ReadObjectRequest |
| Type | Description |
| ReadObjectRequest.Builder |
mergeReadMask(FieldMask value)
public ReadObjectRequest.Builder mergeReadMask(FieldMask value)Mask specifying which fields to read. The checksummed_data field and its children will always be present. If no mask is specified, will default to all fields except metadata.owner and metadata.acl.
- may be used to mean "all fields".
optional .google.protobuf.FieldMask read_mask = 12;
| Name | Description |
| value | FieldMask |
| Type | Description |
| ReadObjectRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ReadObjectRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| ReadObjectRequest.Builder |
setBucket(String value)
public ReadObjectRequest.Builder setBucket(String value)The name of the bucket containing the object to read.
string bucket = 1;
| Name | Description |
| value | StringThe bucket to set. |
| Type | Description |
| ReadObjectRequest.Builder | This builder for chaining. |
setBucketBytes(ByteString value)
public ReadObjectRequest.Builder setBucketBytes(ByteString value)The name of the bucket containing the object to read.
string bucket = 1;
| Name | Description |
| value | ByteStringThe bytes for bucket to set. |
| Type | Description |
| ReadObjectRequest.Builder | This builder for chaining. |
setCommonObjectRequestParams(CommonObjectRequestParams value)
public ReadObjectRequest.Builder setCommonObjectRequestParams(CommonObjectRequestParams value)A set of parameters common to Storage API requests concerning an object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 10;
| Name | Description |
| value | CommonObjectRequestParams |
| Type | Description |
| ReadObjectRequest.Builder |
setCommonObjectRequestParams(CommonObjectRequestParams.Builder builderForValue)
public ReadObjectRequest.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 = 10;
| Name | Description |
| builderForValue | CommonObjectRequestParams.Builder |
| Type | Description |
| ReadObjectRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public ReadObjectRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| ReadObjectRequest.Builder |
setGeneration(long value)
public ReadObjectRequest.Builder setGeneration(long value)If present, selects a specific revision of this object (as opposed to the latest version, the default).
int64 generation = 3;
| Name | Description |
| value | longThe generation to set. |
| Type | Description |
| ReadObjectRequest.Builder | This builder for chaining. |
setIfGenerationMatch(long value)
public ReadObjectRequest.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 = 6;
| Name | Description |
| value | longThe ifGenerationMatch to set. |
| Type | Description |
| ReadObjectRequest.Builder | This builder for chaining. |
setIfGenerationNotMatch(long value)
public ReadObjectRequest.Builder setIfGenerationNotMatch(long value)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 = 7;
| Name | Description |
| value | longThe ifGenerationNotMatch to set. |
| Type | Description |
| ReadObjectRequest.Builder | This builder for chaining. |
setIfMetagenerationMatch(long value)
public ReadObjectRequest.Builder setIfMetagenerationMatch(long value)Makes the operation conditional on whether the object's current metageneration matches the given value.
optional int64 if_metageneration_match = 8;
| Name | Description |
| value | longThe ifMetagenerationMatch to set. |
| Type | Description |
| ReadObjectRequest.Builder | This builder for chaining. |
setIfMetagenerationNotMatch(long value)
public ReadObjectRequest.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 = 9;
| Name | Description |
| value | longThe ifMetagenerationNotMatch to set. |
| Type | Description |
| ReadObjectRequest.Builder | This builder for chaining. |
setObject(String value)
public ReadObjectRequest.Builder setObject(String value)The name of the object to read.
string object = 2;
| Name | Description |
| value | StringThe object to set. |
| Type | Description |
| ReadObjectRequest.Builder | This builder for chaining. |
setObjectBytes(ByteString value)
public ReadObjectRequest.Builder setObjectBytes(ByteString value)The name of the object to read.
string object = 2;
| Name | Description |
| value | ByteStringThe bytes for object to set. |
| Type | Description |
| ReadObjectRequest.Builder | This builder for chaining. |
setReadLimit(long value)
public ReadObjectRequest.Builder setReadLimit(long value) The maximum number of data bytes the server is allowed to return in the
sum of all Object messages. A read_limit of zero indicates that there
is no limit, and a negative read_limit will cause an error.
If the stream returns fewer bytes than allowed by the read_limit and no
error occurred, the stream includes all data from the read_offset to the
end of the resource.
int64 read_limit = 5;
| Name | Description |
| value | longThe readLimit to set. |
| Type | Description |
| ReadObjectRequest.Builder | This builder for chaining. |
setReadMask(FieldMask value)
public ReadObjectRequest.Builder setReadMask(FieldMask value)Mask specifying which fields to read. The checksummed_data field and its children will always be present. If no mask is specified, will default to all fields except metadata.owner and metadata.acl.
- may be used to mean "all fields".
optional .google.protobuf.FieldMask read_mask = 12;
| Name | Description |
| value | FieldMask |
| Type | Description |
| ReadObjectRequest.Builder |
setReadMask(FieldMask.Builder builderForValue)
public ReadObjectRequest.Builder setReadMask(FieldMask.Builder builderForValue)Mask specifying which fields to read. The checksummed_data field and its children will always be present. If no mask is specified, will default to all fields except metadata.owner and metadata.acl.
- may be used to mean "all fields".
optional .google.protobuf.FieldMask read_mask = 12;
| Name | Description |
| builderForValue | Builder |
| Type | Description |
| ReadObjectRequest.Builder |
setReadOffset(long value)
public ReadObjectRequest.Builder setReadOffset(long value) The offset for the first byte to return in the read, relative to the start
of the object.
A negative read_offset value will be interpreted as the number of bytes
back from the end of the object to be returned. For example, if an object's
length is 15 bytes, a ReadObjectRequest with read_offset = -5 and
read_limit = 3 would return bytes 10 through 12 of the object. Requesting
a negative offset with magnitude larger than the size of the object will
return the entire object.
int64 read_offset = 4;
| Name | Description |
| value | longThe readOffset to set. |
| Type | Description |
| ReadObjectRequest.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ReadObjectRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| ReadObjectRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final ReadObjectRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| ReadObjectRequest.Builder |