Struct google_storage1::api::ObjectInsertCall

source · 
pub struct ObjectInsertCall<'a, S>
where
    S: 'a,
{ /* private fields */ }
Expand description

Stores a new object and metadata.

A builder for the insert method supported by a object resource. It is not used directly, but through a ObjectMethods instance.

§Example

Instantiate a resource method builder

use storage1::api::Object;
use std::fs;
 
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = Object::default();
 
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `upload_resumable(...)`.
// Values shown here are possibly random and not representative !
let result = hub.objects().insert(req, "bucket")
             .user_project("nonumy")
             .projection("sea")
             .predefined_acl("ipsum")
             .name("kasd")
             .kms_key_name("justo")
             .if_metageneration_not_match(-17)
             .if_metageneration_match(-77)
             .if_generation_not_match(-81)
             .if_generation_match(-14)
             .content_encoding("vero")
             .upload_resumable(fs::File::open("file.ext").unwrap(), "application/octet-stream".parse().unwrap()).await;

Implementations§

source§

impl<'a, S> ObjectInsertCall<'a, S>
where S: Service<Uri> + Clone + Send + Sync + 'static, S::Response: Connection + AsyncRead + AsyncWrite + Send + Unpin + 'static, S::Future: Send + Unpin + 'static, S::Error: Into<Box<dyn StdError + Send + Sync>>,

source

pub async fn upload_resumable<RS>( self, resumeable_stream: RS, mime_type: Mime ) -> Result<(Response<Body>, Object)>
where RS: ReadSeek,

Upload media in a resumable fashion. Even if the upload fails or is interrupted, it can be resumed for a certain amount of time as the server maintains state temporarily.

The delegate will be asked for an upload_url(), and if not provided, will be asked to store an upload URL that was provided by the server, using store_upload_url(...). The upload will be done in chunks, the delegate may specify the chunk_size() and may cancel the operation before each chunk is uploaded, using cancel_chunk_upload(...).

  • multipart: yes
  • max size: 0kb
  • valid mime types: ‘/’
source

pub async fn upload<RS>( self, stream: RS, mime_type: Mime ) -> Result<(Response<Body>, Object)>
where RS: ReadSeek,

Upload media all at once. If the upload fails for whichever reason, all progress is lost.

  • multipart: yes
  • max size: 0kb
  • valid mime types: ‘/’
source

pub fn request(self, new_value: Object) -> ObjectInsertCall<'a, S>

Sets the request property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

source

pub fn bucket(self, new_value: &str) -> ObjectInsertCall<'a, S>

Name of the bucket in which to store the new object. Overrides the provided object metadata’s bucket value, if any.

Sets the bucket path property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

source

pub fn user_project(self, new_value: &str) -> ObjectInsertCall<'a, S>

The project to be billed for this request. Required for Requester Pays buckets.

Sets the user project query property to the given value.

source

pub fn projection(self, new_value: &str) -> ObjectInsertCall<'a, S>

Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.

Sets the projection query property to the given value.

source

pub fn predefined_acl(self, new_value: &str) -> ObjectInsertCall<'a, S>

Apply a predefined set of access controls to this object.

Sets the predefined acl query property to the given value.

source

pub fn name(self, new_value: &str) -> ObjectInsertCall<'a, S>

Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata’s name value, if any. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

Sets the name query property to the given value.

source

pub fn kms_key_name(self, new_value: &str) -> ObjectInsertCall<'a, S>

Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata’s kms_key_name value, if any.

Sets the kms key name query property to the given value.

source

pub fn if_metageneration_not_match( self, new_value: i64 ) -> ObjectInsertCall<'a, S>

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

Sets the if metageneration not match query property to the given value.

source

pub fn if_metageneration_match(self, new_value: i64) -> ObjectInsertCall<'a, S>

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

Sets the if metageneration match query property to the given value.

source

pub fn if_generation_not_match(self, new_value: i64) -> ObjectInsertCall<'a, S>

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.

Sets the if generation not match query property to the given value.

source

pub fn if_generation_match(self, new_value: i64) -> ObjectInsertCall<'a, S>

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.

Sets the if generation match query property to the given value.

source

pub fn content_encoding(self, new_value: &str) -> ObjectInsertCall<'a, S>

If set, sets the contentEncoding property of the final object to this value. Setting this parameter is equivalent to setting the contentEncoding metadata property. This can be useful when uploading an object with uploadType=media to indicate the encoding of the content being uploaded.

Sets the content encoding query property to the given value.

source

pub fn delegate( self, new_value: &'a mut dyn Delegate ) -> ObjectInsertCall<'a, S>

The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.

                  It should be used to handle progress information, and to implement a certain level of resilience.

Sets the delegate property to the given value.

source

pub fn param<T>(self, name: T, value: T) -> ObjectInsertCall<'a, S>
where T: AsRef<str>,

Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.

Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.

§Additional Parameters
  • alt (query-string) - Data format for the response.
  • fields (query-string) - Selector specifying which fields to include in a partial response.
  • key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token (query-string) - OAuth 2.0 token for the current user.
  • prettyPrint (query-boolean) - Returns response with indentations and line breaks.
  • quotaUser (query-string) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
  • uploadType (query-string) - Upload protocol for media (e.g. “media”, “multipart”, “resumable”).
  • userIp (query-string) - Deprecated. Please use quotaUser instead.
source

pub fn add_scope<St>(self, scope: St) -> ObjectInsertCall<'a, S>
where St: AsRef<str>,

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead of the default Scope variant Scope::CloudPlatform.

The scope will be added to a set of scopes. This is important as one can maintain access tokens for more than one scope.

Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.

source

pub fn add_scopes<I, St>(self, scopes: I) -> ObjectInsertCall<'a, S>
where I: IntoIterator<Item = St>, St: AsRef<str>,

Identifies the authorization scope(s) for the method you are building.

See Self::add_scope() for details.

source

pub fn clear_scopes(self) -> ObjectInsertCall<'a, S>

Removes all scopes, and no default scope will be used either. In this case, you have to specify your API-key using the key parameter (see Self::param() for details).

Trait Implementations§

source§

impl<'a, S> CallBuilder for ObjectInsertCall<'a, S>

Auto Trait Implementations§

§

impl<'a, S> !RefUnwindSafe for ObjectInsertCall<'a, S>

§

impl<'a, S> Send for ObjectInsertCall<'a, S>
where S: Sync,

§

impl<'a, S> !Sync for ObjectInsertCall<'a, S>

§

impl<'a, S> Unpin for ObjectInsertCall<'a, S>

§

impl<'a, S> !UnwindSafe for ObjectInsertCall<'a, S>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more