Struct ProjectLocationGlobalHubListSpokeCall

pub struct ProjectLocationGlobalHubListSpokeCall<'a, C>
where
    C: 'a,
{ /* private fields */ }

Lists the Network Connectivity Center spokes associated with a specified hub and location. The list includes both spokes that are attached to the hub and spokes that have been proposed but not yet accepted.

A builder for the locations.global.hubs.listSpokes 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_global_hubs_list_spokes("name")
             .view("sed")
             .add_spoke_locations("et")
             .page_token("et")
             .page_size(-76)
             .order_by("erat")
             .filter("sed")
             .doit().await;

Implementations

impl<'a, C> ProjectLocationGlobalHubListSpokeCall<'a, C>

where C: Connector,

pub async fn doit(self) -> Result<(Response, ListHubSpokesResponse)>

Perform the operation you have build so far.

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

Required. The name of the hub.

Sets the name 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.

pub fn view( self, new_value: &str, ) -> ProjectLocationGlobalHubListSpokeCall<'a, C>

The view of the spoke to return. The view that you use determines which spoke fields are included in the response.

Sets the view query property to the given value.

pub fn add_spoke_locations( self, new_value: &str, ) -> ProjectLocationGlobalHubListSpokeCall<'a, C>

A list of locations. Specify one of the following: [global], a single region (for example, [us-central1]), or a combination of values (for example, [global, us-central1, us-west1]). If the spoke_locations field is populated, the list of results includes only spokes in the specified location. If the spoke_locations field is not populated, the list of results includes spokes in all locations.

Append the given value to the spoke locations query property. Each appended value will retain its original ordering and be ‘/’-separated in the URL’s parameters.

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

The page token.

Sets the page token query property to the given value.

pub fn page_size( self, new_value: i32, ) -> ProjectLocationGlobalHubListSpokeCall<'a, C>

The maximum number of results to return per page.

Sets the page size query property to the given value.

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

Sort the results by name or create_time.

Sets the order by query property to the given value.

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

An expression that filters the list of results.

Sets the filter query property to the given value.

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

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.

pub fn param<T>( self, name: T, value: T, ) -> ProjectLocationGlobalHubListSpokeCall<'a, C>

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”).

pub fn add_scope<St>( self, scope: St, ) -> ProjectLocationGlobalHubListSpokeCall<'a, C>

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.

pub fn add_scopes<I, St>( self, scopes: I, ) -> ProjectLocationGlobalHubListSpokeCall<'a, C>

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.

pub fn clear_scopes(self) -> ProjectLocationGlobalHubListSpokeCall<'a, C>

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

impl<'a, C> CallBuilder for ProjectLocationGlobalHubListSpokeCall<'a, C>