Struct ReadObjectRequest 

#[non_exhaustive]
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>,
    /* private fields */
}

Request message for [ReadObject][google.storage.v2.Storage.ReadObject].

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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

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

read_offset: i64

Optional. The offset for the first byte to return in the read, relative to the start of the object.

A negative read_offset value is 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 returns the entire object.

read_limit: i64

Optional. 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 causes 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>

Optional. 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 are always present. If no mask is specified, it defaults to all fields except metadata. owner and metadata.acl. * might be used to mean “all fields”.

Implementations

impl ReadObjectRequest

pub fn new() -> Self

pub fn set_bucket<T: Into<String>>(self, v: T) -> Self

Sets the value of bucket.

Example

let x = ReadObjectRequest::new().set_bucket("example");

pub fn set_object<T: Into<String>>(self, v: T) -> Self

Sets the value of object.

Example

let x = ReadObjectRequest::new().set_object("example");

pub fn set_generation<T: Into<i64>>(self, v: T) -> Self

Sets the value of generation.

Example

let x = ReadObjectRequest::new().set_generation(42);

pub fn set_read_offset<T: Into<i64>>(self, v: T) -> Self

Sets the value of read_offset.

Example

let x = ReadObjectRequest::new().set_read_offset(42);

pub fn set_read_limit<T: Into<i64>>(self, v: T) -> Self

Sets the value of read_limit.

Example

let x = ReadObjectRequest::new().set_read_limit(42);

pub fn set_if_generation_match<T>(self, v: T) -> Self

where T: Into<i64>,

Sets the value of if_generation_match.

Example

let x = ReadObjectRequest::new().set_if_generation_match(42);

pub fn set_or_clear_if_generation_match<T>(self, v: Option<T>) -> Self

where T: Into<i64>,

Sets or clears the value of if_generation_match.

Example

let x = ReadObjectRequest::new().set_or_clear_if_generation_match(Some(42));
let x = ReadObjectRequest::new().set_or_clear_if_generation_match(None::<i32>);

pub fn set_if_generation_not_match<T>(self, v: T) -> Self

where T: Into<i64>,

Sets the value of if_generation_not_match.

Example

let x = ReadObjectRequest::new().set_if_generation_not_match(42);

pub fn set_or_clear_if_generation_not_match<T>(self, v: Option<T>) -> Self

where T: Into<i64>,

Sets or clears the value of if_generation_not_match.

Example

let x = ReadObjectRequest::new().set_or_clear_if_generation_not_match(Some(42));
let x = ReadObjectRequest::new().set_or_clear_if_generation_not_match(None::<i32>);

pub fn set_if_metageneration_match<T>(self, v: T) -> Self

where T: Into<i64>,

Sets the value of if_metageneration_match.

Example

let x = ReadObjectRequest::new().set_if_metageneration_match(42);

pub fn set_or_clear_if_metageneration_match<T>(self, v: Option<T>) -> Self

where T: Into<i64>,

Sets or clears the value of if_metageneration_match.

Example

let x = ReadObjectRequest::new().set_or_clear_if_metageneration_match(Some(42));
let x = ReadObjectRequest::new().set_or_clear_if_metageneration_match(None::<i32>);

pub fn set_if_metageneration_not_match<T>(self, v: T) -> Self

where T: Into<i64>,

Sets the value of if_metageneration_not_match.

Example

let x = ReadObjectRequest::new().set_if_metageneration_not_match(42);

pub fn set_or_clear_if_metageneration_not_match<T>(self, v: Option<T>) -> Self

where T: Into<i64>,

Sets or clears the value of if_metageneration_not_match.

Example

let x = ReadObjectRequest::new().set_or_clear_if_metageneration_not_match(Some(42));
let x = ReadObjectRequest::new().set_or_clear_if_metageneration_not_match(None::<i32>);

pub fn set_common_object_request_params<T>(self, v: T) -> Self

where T: Into<CommonObjectRequestParams>,

Sets the value of common_object_request_params.

Example

use google_cloud_storage::model::CommonObjectRequestParams;
let x = ReadObjectRequest::new().set_common_object_request_params(CommonObjectRequestParams::default()/* use setters */);

pub fn set_or_clear_common_object_request_params<T>(self, v: Option<T>) -> Self

where T: Into<CommonObjectRequestParams>,

Sets or clears the value of common_object_request_params.

Example

use google_cloud_storage::model::CommonObjectRequestParams;
let x = ReadObjectRequest::new().set_or_clear_common_object_request_params(Some(CommonObjectRequestParams::default()/* use setters */));
let x = ReadObjectRequest::new().set_or_clear_common_object_request_params(None::<CommonObjectRequestParams>);

pub fn set_read_mask<T>(self, v: T) -> Self

where T: Into<FieldMask>,

Sets the value of read_mask.

Example

use wkt::FieldMask;
let x = ReadObjectRequest::new().set_read_mask(FieldMask::default()/* use setters */);

pub fn set_or_clear_read_mask<T>(self, v: Option<T>) -> Self

where T: Into<FieldMask>,

Sets or clears the value of read_mask.

Example

use wkt::FieldMask;
let x = ReadObjectRequest::new().set_or_clear_read_mask(Some(FieldMask::default()/* use setters */));
let x = ReadObjectRequest::new().set_or_clear_read_mask(None::<FieldMask>);

Trait Implementations

impl Clone for ReadObjectRequest

fn clone(&self) -> ReadObjectRequest

Returns a duplicate 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() -> ReadObjectRequest

Returns the “default value” for a type.

impl Message for ReadObjectRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ReadObjectRequest

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ReadObjectRequest