Struct InstanceGroups 

pub struct InstanceGroups { /* private fields */ }

Available on crate feature instance-groups only.

Implements a client for the Google Compute Engine API.

Example

let client = InstanceGroups::builder().build().await?;
// use `client` to make requests to the Google Compute Engine API.

Service Description

Service for the instanceGroups resource.

Configuration

To configure InstanceGroups use the with_* methods in the type returned by builder(). The default configuration should work for most applications. Common configuration changes include

• with_endpoint(): by default this client uses the global default endpoint (https://compute.googleapis.com). Applications using regional endpoints or running in restricted networks (e.g. a network configured override this default.
• with_credentials(): by default this client uses Application Default Credentials. Applications using custom authentication may need to override this default.

Pooling and Cloning

InstanceGroups holds a connection pool internally, it is advised to create one and the reuse it. You do not need to wrap InstanceGroups in an Rc or Arc to reuse it, because it already uses an Arc internally.

Implementations

impl InstanceGroups

pub fn builder() -> ClientBuilder

Returns a builder for InstanceGroups.

let client = InstanceGroups::builder().build().await?;

pub fn from_stub<T>(stub: T) -> Self

where T: InstanceGroups + 'static,

Creates a new client from the provided stub.

The most common case for calling this function is in tests mocking the client’s behavior.

pub fn add_instances(&self) -> AddInstances

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.

pub fn aggregated_list(&self) -> AggregatedList

Retrieves the list of instance groups and sorts them by zone.

To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

pub fn delete(&self) -> Delete

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.

pub fn get(&self) -> Get

Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request.

For managed instance groups, use theinstanceGroupManagers or regionInstanceGroupManagers methods instead.

pub fn insert(&self) -> Insert

Creates an instance group in the specified project using the parameters that are included in the request.

pub fn list(&self) -> List

Retrieves the list of zonal instance group resources contained within the specified zone.

For managed instance groups, use theinstanceGroupManagers or regionInstanceGroupManagers methods instead.

pub fn list_instances(&self) -> ListInstances

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.

pub fn remove_instances(&self) -> RemoveInstances

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.

pub fn set_named_ports(&self) -> SetNamedPorts

Sets the named ports for the specified instance group.

pub fn test_iam_permissions(&self) -> TestIamPermissions

Returns permissions that a caller has on the specified resource.

pub fn get_operation(&self) -> GetOperation

Retrieves the specified zone-specific Operations resource.

Trait Implementations

impl Clone for InstanceGroups

fn clone(&self) -> InstanceGroups

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InstanceGroups

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.