Struct gcp_client::google::storage::v1::GetObjectMediaRequest

pub struct GetObjectMediaRequest {
    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 common_request_params: Option<CommonRequestParams>,
}

Request message for GetObjectMedia.

Fields

bucket: String

The name of the bucket containing the object to read.

object: String

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 GetObjectMediaRequest with read_offset = -5 and read_limit = 3 would return bytes 10 through 12 of the 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 current 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.

common_request_params: Option<CommonRequestParams>

A set of parameters common to all Storage API requests.

Trait Implementations

impl Clone for GetObjectMediaRequest

fn clone(&self) -> GetObjectMediaRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetObjectMediaRequest

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

Formats the value using the given formatter.

impl Default for GetObjectMediaRequest

fn default() -> GetObjectMediaRequest

Returns the "default value" for a type.

impl Message for GetObjectMediaRequest

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

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

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

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

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

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

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

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

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

impl PartialEq<GetObjectMediaRequest> for GetObjectMediaRequest

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

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

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

This method tests for !=.

impl StructuralPartialEq for GetObjectMediaRequest