Struct google_api_proto::google::storage::v2::ReadObjectRequest

pub struct ReadObjectRequest {
    pub bucket: String,
    pub object: String,
    pub generation: i64,
    pub read_offset: i64,
    pub read_limit: i64,
    pub if_generation_match: Option<i64>,
    pub if_generation_not_match: Option<i64>,
    pub if_metageneration_match: Option<i64>,
    pub if_metageneration_not_match: Option<i64>,
    pub common_object_request_params: Option<CommonObjectRequestParams>,
    pub read_mask: Option<FieldMask>,
}

Request message for ReadObject.

Fields

bucket: String

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

object: String

Required. The name of the object to read.

generation: i64

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

read_offset: i64

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.

read_limit: i64

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.

if_generation_match: Option<i64>

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.

if_generation_not_match: Option<i64>

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.

if_metageneration_match: Option<i64>

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

if_metageneration_not_match: Option<i64>

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

common_object_request_params: Option<CommonObjectRequestParams>

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

read_mask: Option<FieldMask>

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

Implementations

impl ReadObjectRequest

pub fn if_generation_match(&self) -> i64

Returns the value of if_generation_match, or the default value if if_generation_match is unset.

pub fn if_generation_not_match(&self) -> i64

Returns the value of if_generation_not_match, or the default value if if_generation_not_match is unset.

pub fn if_metageneration_match(&self) -> i64

Returns the value of if_metageneration_match, or the default value if if_metageneration_match is unset.

pub fn if_metageneration_not_match(&self) -> i64

Returns the value of if_metageneration_not_match, or the default value if if_metageneration_not_match is unset.

Trait Implementations

impl Clone for ReadObjectRequest

fn clone(&self) -> ReadObjectRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReadObjectRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ReadObjectRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ReadObjectRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ReadObjectRequest

fn eq(&self, other: &ReadObjectRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ReadObjectRequest