Struct google_compute1::api::InstanceGroupMethods
source · pub struct InstanceGroupMethods<'a, S>where
S: 'a,{ /* private fields */ }
Expand description
A builder providing access to all methods supported on instanceGroup resources.
It is not used directly, but through the Compute
hub.
§Example
Instantiate a resource builder
extern crate hyper;
extern crate hyper_rustls;
extern crate google_compute1 as compute1;
use std::default::Default;
use compute1::{Compute, oauth2, hyper, hyper_rustls, chrono, FieldMask};
let secret: oauth2::ApplicationSecret = Default::default();
let auth = oauth2::InstalledFlowAuthenticator::builder(
secret,
oauth2::InstalledFlowReturnMethod::HTTPRedirect,
).build().await.unwrap();
let mut hub = Compute::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
// Usually you wouldn't bind this to a variable, but keep calling *CallBuilders*
// like `add_instances(...)`, `aggregated_list(...)`, `delete(...)`, `get(...)`, `insert(...)`, `list(...)`, `list_instances(...)`, `remove_instances(...)` and `set_named_ports(...)`
// to build up your call.
let rb = hub.instance_groups();
Implementations§
source§impl<'a, S> InstanceGroupMethods<'a, S>
impl<'a, S> InstanceGroupMethods<'a, S>
sourcepub fn add_instances(
&self,
request: InstanceGroupsAddInstancesRequest,
project: &str,
zone: &str,
instance_group: &str
) -> InstanceGroupAddInstanceCall<'a, S>
pub fn add_instances( &self, request: InstanceGroupsAddInstancesRequest, project: &str, zone: &str, instance_group: &str ) -> InstanceGroupAddInstanceCall<'a, S>
Create a builder to help you perform the following task:
Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.
§Arguments
request
- No description provided.project
- Project ID for this request.zone
- The name of the zone where the instance group is located.instanceGroup
- The name of the instance group where you are adding instances.
sourcepub fn aggregated_list(
&self,
project: &str
) -> InstanceGroupAggregatedListCall<'a, S>
pub fn aggregated_list( &self, project: &str ) -> InstanceGroupAggregatedListCall<'a, S>
Create a builder to help you perform the following task:
Retrieves the list of instance groups and sorts them by zone. To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
.
§Arguments
project
- Project ID for this request.
sourcepub fn delete(
&self,
project: &str,
zone: &str,
instance_group: &str
) -> InstanceGroupDeleteCall<'a, S>
pub fn delete( &self, project: &str, zone: &str, instance_group: &str ) -> InstanceGroupDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.
§Arguments
project
- Project ID for this request.zone
- The name of the zone where the instance group is located.instanceGroup
- The name of the instance group to delete.
sourcepub fn get(
&self,
project: &str,
zone: &str,
instance_group: &str
) -> InstanceGroupGetCall<'a, S>
pub fn get( &self, project: &str, zone: &str, instance_group: &str ) -> InstanceGroupGetCall<'a, S>
Create a builder to help you perform the following task:
Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
§Arguments
project
- Project ID for this request.zone
- The name of the zone where the instance group is located.instanceGroup
- The name of the instance group.
sourcepub fn insert(
&self,
request: InstanceGroup,
project: &str,
zone: &str
) -> InstanceGroupInsertCall<'a, S>
pub fn insert( &self, request: InstanceGroup, project: &str, zone: &str ) -> InstanceGroupInsertCall<'a, S>
Create a builder to help you perform the following task:
Creates an instance group in the specified project using the parameters that are included in the request.
§Arguments
request
- No description provided.project
- Project ID for this request.zone
- The name of the zone where you want to create the instance group.
sourcepub fn list(&self, project: &str, zone: &str) -> InstanceGroupListCall<'a, S>
pub fn list(&self, project: &str, zone: &str) -> InstanceGroupListCall<'a, S>
Create a builder to help you perform the following task:
Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
§Arguments
project
- Project ID for this request.zone
- The name of the zone where the instance group is located.
sourcepub fn list_instances(
&self,
request: InstanceGroupsListInstancesRequest,
project: &str,
zone: &str,
instance_group: &str
) -> InstanceGroupListInstanceCall<'a, S>
pub fn list_instances( &self, request: InstanceGroupsListInstancesRequest, project: &str, zone: &str, instance_group: &str ) -> InstanceGroupListInstanceCall<'a, S>
Create a builder to help you perform the following task:
Lists the instances in the specified instance group. The orderBy query parameter is not supported. The filter query parameter is supported, but only for expressions that use eq
(equal) or ne
(not equal) operators.
§Arguments
request
- No description provided.project
- Project ID for this request.zone
- The name of the zone where the instance group is located.instanceGroup
- The name of the instance group from which you want to generate a list of included instances.
sourcepub fn remove_instances(
&self,
request: InstanceGroupsRemoveInstancesRequest,
project: &str,
zone: &str,
instance_group: &str
) -> InstanceGroupRemoveInstanceCall<'a, S>
pub fn remove_instances( &self, request: InstanceGroupsRemoveInstancesRequest, project: &str, zone: &str, instance_group: &str ) -> InstanceGroupRemoveInstanceCall<'a, S>
Create a builder to help you perform the following task:
Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.
§Arguments
request
- No description provided.project
- Project ID for this request.zone
- The name of the zone where the instance group is located.instanceGroup
- The name of the instance group where the specified instances will be removed.
sourcepub fn set_named_ports(
&self,
request: InstanceGroupsSetNamedPortsRequest,
project: &str,
zone: &str,
instance_group: &str
) -> InstanceGroupSetNamedPortCall<'a, S>
pub fn set_named_ports( &self, request: InstanceGroupsSetNamedPortsRequest, project: &str, zone: &str, instance_group: &str ) -> InstanceGroupSetNamedPortCall<'a, S>
Create a builder to help you perform the following task:
Sets the named ports for the specified instance group.
§Arguments
request
- No description provided.project
- Project ID for this request.zone
- The name of the zone where the instance group is located.instanceGroup
- The name of the instance group where the named ports are updated.