Struct google_dataproc1::api::ProjectLocationBatchListCall

source ·

pub struct ProjectLocationBatchListCall<'a, S>where
    S: 'a,
{ /* private fields */ }

Expand description

Lists batch workloads.

A builder for the locations.batches.list method supported by a project resource. It is not used directly, but through a ProjectMethods instance.

§Example

Instantiate a resource method builder

 
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.projects().locations_batches_list("parent")
             .page_token("est")
             .page_size(-62)
             .order_by("ea")
             .filter("dolor")
             .doit().await;

Implementations§

source §

impl<'a, S> ProjectLocationBatchListCall<'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 doit(self) -> Result<(Response<Body>, ListBatchesResponse)>

Perform the operation you have build so far.

source

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

Required. The parent, which owns this collection of batches.

Sets the parent 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 page_token(self, new_value: &str) -> ProjectLocationBatchListCall<'a, S>

Optional. A page token received from a previous ListBatches call. Provide this token to retrieve the subsequent page.

Sets the page token query property to the given value.

source

pub fn page_size(self, new_value: i32) -> ProjectLocationBatchListCall<'a, S>

Optional. The maximum number of batches to return in each response. The service may return fewer than this value. The default page size is 20; the maximum page size is 1000.

Sets the page size query property to the given value.

source

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

Optional. Field(s) on which to sort the list of batches.Currently the only supported sort orders are unspecified (empty) and create_time desc to sort by most recently created batches first.See https://google.aip.dev/132#ordering for more details.

Sets the order by query property to the given value.

source

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

Optional. A filter for the batches to return in the response.A filter is a logical expression constraining the values of various fields in each batch resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND/OR). Supported fields are batch_id, batch_uuid, state, create_time, and labels.e.g. state = RUNNING and create_time < “2023-01-01T00:00:00Z” filters for batches in state RUNNING that were created before 2023-01-01. state = RUNNING and labels.environment=production filters for batches in state in a RUNNING state that have a production environment label.See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed description of the filter syntax and a list of supported comparisons.

Sets the filter query property to the given value.

source

pub fn delegate( self, new_value: &'a mut dyn Delegate ) -> ProjectLocationBatchListCall<'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) -> ProjectLocationBatchListCall<'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

$.xgafv (query-string) - V1 error format.
access_token (query-string) - OAuth access token.
alt (query-string) - Data format for response.
callback (query-string) - JSONP
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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
uploadType (query-string) - Legacy upload protocol for media (e.g. “media”, “multipart”).
upload_protocol (query-string) - Upload protocol for media (e.g. “raw”, “multipart”).

source

pub fn add_scope<St>(self, scope: St) -> ProjectLocationBatchListCall<'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) -> ProjectLocationBatchListCall<'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) -> ProjectLocationBatchListCall<'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).