Struct google_compute1::api::TargetTcpProxyListCall

source ·

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

Expand description

Retrieves the list of TargetTcpProxy resources available to the specified project.

A builder for the list method supported by a targetTcpProxy resource. It is not used directly, but through a TargetTcpProxyMethods 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.target_tcp_proxies().list("project")
             .return_partial_success(true)
             .page_token("clita")
             .order_by("elitr")
             .max_results(35)
             .filter("voluptua.")
             .doit().await;

Implementations§

source §

impl<'a, S> TargetTcpProxyListCall<'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>, TargetTcpProxyList)>

Perform the operation you have build so far.

source

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

Project ID for this request.

Sets the project 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 return_partial_success( self, new_value: bool ) -> TargetTcpProxyListCall<'a, S>

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

Sets the return partial success query property to the given value.

source

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

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

Sets the page token query property to the given value.

source

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

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

Sets the order by query property to the given value.

source

pub fn max_results(self, new_value: u32) -> TargetTcpProxyListCall<'a, S>

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

Sets the max results query property to the given value.

source

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

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, !=, >, <, <=, >= or :. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

Sets the filter query property to the given value.

source

pub fn delegate( self, new_value: &'a mut dyn Delegate ) -> TargetTcpProxyListCall<'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) -> TargetTcpProxyListCall<'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”).
userIp (query-string) - Legacy name for parameter that has been superseded by quotaUser.

source

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

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) -> TargetTcpProxyListCall<'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) -> TargetTcpProxyListCall<'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).