Compute Engine v1 API - Class InstanceGroupManagers.InstanceGroupManagersClient (2.7.0)

public class InstanceGroupManagers.InstanceGroupManagersClient : ClientBase<InstanceGroupManagers.InstanceGroupManagersClient>

Reference documentation and code samples for the Compute Engine v1 API class InstanceGroupManagers.InstanceGroupManagersClient.

Client for InstanceGroupManagers

Inheritance

object > ClientBase > ClientBaseInstanceGroupManagersInstanceGroupManagersClient > InstanceGroupManagers.InstanceGroupManagersClient

Namespace

GoogleCloudGoogle.Cloud.ComputeV1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

InstanceGroupManagersClient()

protected InstanceGroupManagersClient()

Protected parameterless constructor to allow creation of test doubles.

InstanceGroupManagersClient(CallInvoker)

public InstanceGroupManagersClient(CallInvoker callInvoker)

Creates a new client for InstanceGroupManagers that uses a custom CallInvoker.

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

InstanceGroupManagersClient(ChannelBase)

public InstanceGroupManagersClient(ChannelBase channel)

Creates a new client for InstanceGroupManagers

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

InstanceGroupManagersClient(ClientBaseConfiguration)

protected InstanceGroupManagersClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

AbandonInstances(AbandonInstancesInstanceGroupManagerRequest, CallOptions)

public virtual Operation AbandonInstances(AbandonInstancesInstanceGroupManagerRequest request, CallOptions options)

Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

Parameters
NameDescription
requestAbandonInstancesInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

AbandonInstances(AbandonInstancesInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation AbandonInstances(AbandonInstancesInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

Parameters
NameDescription
requestAbandonInstancesInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

AbandonInstancesAsync(AbandonInstancesInstanceGroupManagerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> AbandonInstancesAsync(AbandonInstancesInstanceGroupManagerRequest request, CallOptions options)

Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

Parameters
NameDescription
requestAbandonInstancesInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

AbandonInstancesAsync(AbandonInstancesInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> AbandonInstancesAsync(AbandonInstancesInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

Parameters
NameDescription
requestAbandonInstancesInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

AggregatedList(AggregatedListInstanceGroupManagersRequest, CallOptions)

public virtual InstanceGroupManagerAggregatedList AggregatedList(AggregatedListInstanceGroupManagersRequest request, CallOptions options)

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

Parameters
NameDescription
requestAggregatedListInstanceGroupManagersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
InstanceGroupManagerAggregatedList

The response received from the server.

AggregatedList(AggregatedListInstanceGroupManagersRequest, Metadata, DateTime?, CancellationToken)

public virtual InstanceGroupManagerAggregatedList AggregatedList(AggregatedListInstanceGroupManagersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestAggregatedListInstanceGroupManagersRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
InstanceGroupManagerAggregatedList

The response received from the server.

AggregatedListAsync(AggregatedListInstanceGroupManagersRequest, CallOptions)

public virtual AsyncUnaryCall<InstanceGroupManagerAggregatedList> AggregatedListAsync(AggregatedListInstanceGroupManagersRequest request, CallOptions options)

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

Parameters
NameDescription
requestAggregatedListInstanceGroupManagersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallInstanceGroupManagerAggregatedList

The call object.

AggregatedListAsync(AggregatedListInstanceGroupManagersRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<InstanceGroupManagerAggregatedList> AggregatedListAsync(AggregatedListInstanceGroupManagersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestAggregatedListInstanceGroupManagersRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallInstanceGroupManagerAggregatedList

The call object.

ApplyUpdatesToInstances(ApplyUpdatesToInstancesInstanceGroupManagerRequest, CallOptions)

public virtual Operation ApplyUpdatesToInstances(ApplyUpdatesToInstancesInstanceGroupManagerRequest request, CallOptions options)

Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions.

Parameters
NameDescription
requestApplyUpdatesToInstancesInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

ApplyUpdatesToInstances(ApplyUpdatesToInstancesInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ApplyUpdatesToInstances(ApplyUpdatesToInstancesInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions.

Parameters
NameDescription
requestApplyUpdatesToInstancesInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

ApplyUpdatesToInstancesAsync(ApplyUpdatesToInstancesInstanceGroupManagerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ApplyUpdatesToInstancesAsync(ApplyUpdatesToInstancesInstanceGroupManagerRequest request, CallOptions options)

Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions.

Parameters
NameDescription
requestApplyUpdatesToInstancesInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

ApplyUpdatesToInstancesAsync(ApplyUpdatesToInstancesInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ApplyUpdatesToInstancesAsync(ApplyUpdatesToInstancesInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions.

Parameters
NameDescription
requestApplyUpdatesToInstancesInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateInstances(CreateInstancesInstanceGroupManagerRequest, CallOptions)

public virtual Operation CreateInstances(CreateInstancesInstanceGroupManagerRequest request, CallOptions options)

Creates instances with per-instance configurations in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.

Parameters
NameDescription
requestCreateInstancesInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateInstances(CreateInstancesInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateInstances(CreateInstancesInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates instances with per-instance configurations in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.

Parameters
NameDescription
requestCreateInstancesInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateInstancesAsync(CreateInstancesInstanceGroupManagerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateInstancesAsync(CreateInstancesInstanceGroupManagerRequest request, CallOptions options)

Creates instances with per-instance configurations in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.

Parameters
NameDescription
requestCreateInstancesInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateInstancesAsync(CreateInstancesInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateInstancesAsync(CreateInstancesInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates instances with per-instance configurations in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.

Parameters
NameDescription
requestCreateInstancesInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateOperationsClientForZoneOperations()

public virtual Operations.OperationsClient CreateOperationsClientForZoneOperations()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client, delegating to ZoneOperations.

Returns
TypeDescription
OperationsOperationsClient

A new Operations client for the same target as this client.

Delete(DeleteInstanceGroupManagerRequest, CallOptions)

public virtual Operation Delete(DeleteInstanceGroupManagerRequest request, CallOptions options)

Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.

Parameters
NameDescription
requestDeleteInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Delete(DeleteInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Delete(DeleteInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.

Parameters
NameDescription
requestDeleteInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteAsync(DeleteInstanceGroupManagerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteInstanceGroupManagerRequest request, CallOptions options)

Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.

Parameters
NameDescription
requestDeleteInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteAsync(DeleteInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.

Parameters
NameDescription
requestDeleteInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteInstances(DeleteInstancesInstanceGroupManagerRequest, CallOptions)

public virtual Operation DeleteInstances(DeleteInstancesInstanceGroupManagerRequest request, CallOptions options)

Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

Parameters
NameDescription
requestDeleteInstancesInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteInstances(DeleteInstancesInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteInstances(DeleteInstancesInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

Parameters
NameDescription
requestDeleteInstancesInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteInstancesAsync(DeleteInstancesInstanceGroupManagerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteInstancesAsync(DeleteInstancesInstanceGroupManagerRequest request, CallOptions options)

Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

Parameters
NameDescription
requestDeleteInstancesInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteInstancesAsync(DeleteInstancesInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteInstancesAsync(DeleteInstancesInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

Parameters
NameDescription
requestDeleteInstancesInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeletePerInstanceConfigs(DeletePerInstanceConfigsInstanceGroupManagerRequest, CallOptions)

public virtual Operation DeletePerInstanceConfigs(DeletePerInstanceConfigsInstanceGroupManagerRequest request, CallOptions options)

Deletes selected per-instance configurations for the managed instance group.

Parameters
NameDescription
requestDeletePerInstanceConfigsInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeletePerInstanceConfigs(DeletePerInstanceConfigsInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeletePerInstanceConfigs(DeletePerInstanceConfigsInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes selected per-instance configurations for the managed instance group.

Parameters
NameDescription
requestDeletePerInstanceConfigsInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeletePerInstanceConfigsAsync(DeletePerInstanceConfigsInstanceGroupManagerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeletePerInstanceConfigsAsync(DeletePerInstanceConfigsInstanceGroupManagerRequest request, CallOptions options)

Deletes selected per-instance configurations for the managed instance group.

Parameters
NameDescription
requestDeletePerInstanceConfigsInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeletePerInstanceConfigsAsync(DeletePerInstanceConfigsInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeletePerInstanceConfigsAsync(DeletePerInstanceConfigsInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes selected per-instance configurations for the managed instance group.

Parameters
NameDescription
requestDeletePerInstanceConfigsInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

Get(GetInstanceGroupManagerRequest, CallOptions)

public virtual InstanceGroupManager Get(GetInstanceGroupManagerRequest request, CallOptions options)

Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request.

Parameters
NameDescription
requestGetInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
InstanceGroupManager

The response received from the server.

Get(GetInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual InstanceGroupManager Get(GetInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request.

Parameters
NameDescription
requestGetInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
InstanceGroupManager

The response received from the server.

GetAsync(GetInstanceGroupManagerRequest, CallOptions)

public virtual AsyncUnaryCall<InstanceGroupManager> GetAsync(GetInstanceGroupManagerRequest request, CallOptions options)

Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request.

Parameters
NameDescription
requestGetInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallInstanceGroupManager

The call object.

GetAsync(GetInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<InstanceGroupManager> GetAsync(GetInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request.

Parameters
NameDescription
requestGetInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallInstanceGroupManager

The call object.

Insert(InsertInstanceGroupManagerRequest, CallOptions)

public virtual Operation Insert(InsertInstanceGroupManagerRequest request, CallOptions options)

Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.

Parameters
NameDescription
requestInsertInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Insert(InsertInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Insert(InsertInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.

Parameters
NameDescription
requestInsertInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

InsertAsync(InsertInstanceGroupManagerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertInstanceGroupManagerRequest request, CallOptions options)

Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.

Parameters
NameDescription
requestInsertInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

InsertAsync(InsertInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.

Parameters
NameDescription
requestInsertInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

List(ListInstanceGroupManagersRequest, CallOptions)

public virtual InstanceGroupManagerList List(ListInstanceGroupManagersRequest request, CallOptions options)

Retrieves a list of managed instance groups that are contained within the specified project and zone.

Parameters
NameDescription
requestListInstanceGroupManagersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
InstanceGroupManagerList

The response received from the server.

List(ListInstanceGroupManagersRequest, Metadata, DateTime?, CancellationToken)

public virtual InstanceGroupManagerList List(ListInstanceGroupManagersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a list of managed instance groups that are contained within the specified project and zone.

Parameters
NameDescription
requestListInstanceGroupManagersRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
InstanceGroupManagerList

The response received from the server.

ListAsync(ListInstanceGroupManagersRequest, CallOptions)

public virtual AsyncUnaryCall<InstanceGroupManagerList> ListAsync(ListInstanceGroupManagersRequest request, CallOptions options)

Retrieves a list of managed instance groups that are contained within the specified project and zone.

Parameters
NameDescription
requestListInstanceGroupManagersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallInstanceGroupManagerList

The call object.

ListAsync(ListInstanceGroupManagersRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<InstanceGroupManagerList> ListAsync(ListInstanceGroupManagersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a list of managed instance groups that are contained within the specified project and zone.

Parameters
NameDescription
requestListInstanceGroupManagersRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallInstanceGroupManagerList

The call object.

ListErrors(ListErrorsInstanceGroupManagersRequest, CallOptions)

public virtual InstanceGroupManagersListErrorsResponse ListErrors(ListErrorsInstanceGroupManagersRequest request, CallOptions options)

Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported.

Parameters
NameDescription
requestListErrorsInstanceGroupManagersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
InstanceGroupManagersListErrorsResponse

The response received from the server.

ListErrors(ListErrorsInstanceGroupManagersRequest, Metadata, DateTime?, CancellationToken)

public virtual InstanceGroupManagersListErrorsResponse ListErrors(ListErrorsInstanceGroupManagersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported.

Parameters
NameDescription
requestListErrorsInstanceGroupManagersRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
InstanceGroupManagersListErrorsResponse

The response received from the server.

ListErrorsAsync(ListErrorsInstanceGroupManagersRequest, CallOptions)

public virtual AsyncUnaryCall<InstanceGroupManagersListErrorsResponse> ListErrorsAsync(ListErrorsInstanceGroupManagersRequest request, CallOptions options)

Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported.

Parameters
NameDescription
requestListErrorsInstanceGroupManagersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallInstanceGroupManagersListErrorsResponse

The call object.

ListErrorsAsync(ListErrorsInstanceGroupManagersRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<InstanceGroupManagersListErrorsResponse> ListErrorsAsync(ListErrorsInstanceGroupManagersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported.

Parameters
NameDescription
requestListErrorsInstanceGroupManagersRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallInstanceGroupManagersListErrorsResponse

The call object.

ListManagedInstances(ListManagedInstancesInstanceGroupManagersRequest, CallOptions)

public virtual InstanceGroupManagersListManagedInstancesResponse ListManagedInstances(ListManagedInstancesInstanceGroupManagersRequest request, CallOptions options)

Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. The orderBy query parameter is not supported. The pageToken query parameter is supported only in the alpha and beta API and only if the group's listManagedInstancesResults field is set to PAGINATED.

Parameters
NameDescription
requestListManagedInstancesInstanceGroupManagersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
InstanceGroupManagersListManagedInstancesResponse

The response received from the server.

ListManagedInstances(ListManagedInstancesInstanceGroupManagersRequest, Metadata, DateTime?, CancellationToken)

public virtual InstanceGroupManagersListManagedInstancesResponse ListManagedInstances(ListManagedInstancesInstanceGroupManagersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. The orderBy query parameter is not supported. The pageToken query parameter is supported only in the alpha and beta API and only if the group's listManagedInstancesResults field is set to PAGINATED.

Parameters
NameDescription
requestListManagedInstancesInstanceGroupManagersRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
InstanceGroupManagersListManagedInstancesResponse

The response received from the server.

ListManagedInstancesAsync(ListManagedInstancesInstanceGroupManagersRequest, CallOptions)

public virtual AsyncUnaryCall<InstanceGroupManagersListManagedInstancesResponse> ListManagedInstancesAsync(ListManagedInstancesInstanceGroupManagersRequest request, CallOptions options)

Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. The orderBy query parameter is not supported. The pageToken query parameter is supported only in the alpha and beta API and only if the group's listManagedInstancesResults field is set to PAGINATED.

Parameters
NameDescription
requestListManagedInstancesInstanceGroupManagersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallInstanceGroupManagersListManagedInstancesResponse

The call object.

ListManagedInstancesAsync(ListManagedInstancesInstanceGroupManagersRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<InstanceGroupManagersListManagedInstancesResponse> ListManagedInstancesAsync(ListManagedInstancesInstanceGroupManagersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. The orderBy query parameter is not supported. The pageToken query parameter is supported only in the alpha and beta API and only if the group's listManagedInstancesResults field is set to PAGINATED.

Parameters
NameDescription
requestListManagedInstancesInstanceGroupManagersRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallInstanceGroupManagersListManagedInstancesResponse

The call object.

ListPerInstanceConfigs(ListPerInstanceConfigsInstanceGroupManagersRequest, CallOptions)

public virtual InstanceGroupManagersListPerInstanceConfigsResp ListPerInstanceConfigs(ListPerInstanceConfigsInstanceGroupManagersRequest request, CallOptions options)

Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported.

Parameters
NameDescription
requestListPerInstanceConfigsInstanceGroupManagersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
InstanceGroupManagersListPerInstanceConfigsResp

The response received from the server.

ListPerInstanceConfigs(ListPerInstanceConfigsInstanceGroupManagersRequest, Metadata, DateTime?, CancellationToken)

public virtual InstanceGroupManagersListPerInstanceConfigsResp ListPerInstanceConfigs(ListPerInstanceConfigsInstanceGroupManagersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported.

Parameters
NameDescription
requestListPerInstanceConfigsInstanceGroupManagersRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
InstanceGroupManagersListPerInstanceConfigsResp

The response received from the server.

ListPerInstanceConfigsAsync(ListPerInstanceConfigsInstanceGroupManagersRequest, CallOptions)

public virtual AsyncUnaryCall<InstanceGroupManagersListPerInstanceConfigsResp> ListPerInstanceConfigsAsync(ListPerInstanceConfigsInstanceGroupManagersRequest request, CallOptions options)

Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported.

Parameters
NameDescription
requestListPerInstanceConfigsInstanceGroupManagersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallInstanceGroupManagersListPerInstanceConfigsResp

The call object.

ListPerInstanceConfigsAsync(ListPerInstanceConfigsInstanceGroupManagersRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<InstanceGroupManagersListPerInstanceConfigsResp> ListPerInstanceConfigsAsync(ListPerInstanceConfigsInstanceGroupManagersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported.

Parameters
NameDescription
requestListPerInstanceConfigsInstanceGroupManagersRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallInstanceGroupManagersListPerInstanceConfigsResp

The call object.

NewInstance(ClientBaseConfiguration)

protected override InstanceGroupManagers.InstanceGroupManagersClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
InstanceGroupManagersInstanceGroupManagersClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Compute.V1.InstanceGroupManagers.InstanceGroupManagersClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

Patch(PatchInstanceGroupManagerRequest, CallOptions)

public virtual Operation Patch(PatchInstanceGroupManagerRequest request, CallOptions options)

Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.

Parameters
NameDescription
requestPatchInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Patch(PatchInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Patch(PatchInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.

Parameters
NameDescription
requestPatchInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

PatchAsync(PatchInstanceGroupManagerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> PatchAsync(PatchInstanceGroupManagerRequest request, CallOptions options)

Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.

Parameters
NameDescription
requestPatchInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

PatchAsync(PatchInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> PatchAsync(PatchInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.

Parameters
NameDescription
requestPatchInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

PatchPerInstanceConfigs(PatchPerInstanceConfigsInstanceGroupManagerRequest, CallOptions)

public virtual Operation PatchPerInstanceConfigs(PatchPerInstanceConfigsInstanceGroupManagerRequest request, CallOptions options)

Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

Parameters
NameDescription
requestPatchPerInstanceConfigsInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

PatchPerInstanceConfigs(PatchPerInstanceConfigsInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation PatchPerInstanceConfigs(PatchPerInstanceConfigsInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

Parameters
NameDescription
requestPatchPerInstanceConfigsInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

PatchPerInstanceConfigsAsync(PatchPerInstanceConfigsInstanceGroupManagerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> PatchPerInstanceConfigsAsync(PatchPerInstanceConfigsInstanceGroupManagerRequest request, CallOptions options)

Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

Parameters
NameDescription
requestPatchPerInstanceConfigsInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

PatchPerInstanceConfigsAsync(PatchPerInstanceConfigsInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> PatchPerInstanceConfigsAsync(PatchPerInstanceConfigsInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

Parameters
NameDescription
requestPatchPerInstanceConfigsInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

RecreateInstances(RecreateInstancesInstanceGroupManagerRequest, CallOptions)

public virtual Operation RecreateInstances(RecreateInstancesInstanceGroupManagerRequest request, CallOptions options)

Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

Parameters
NameDescription
requestRecreateInstancesInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

RecreateInstances(RecreateInstancesInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation RecreateInstances(RecreateInstancesInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

Parameters
NameDescription
requestRecreateInstancesInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

RecreateInstancesAsync(RecreateInstancesInstanceGroupManagerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RecreateInstancesAsync(RecreateInstancesInstanceGroupManagerRequest request, CallOptions options)

Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

Parameters
NameDescription
requestRecreateInstancesInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

RecreateInstancesAsync(RecreateInstancesInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> RecreateInstancesAsync(RecreateInstancesInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed 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 has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.

Parameters
NameDescription
requestRecreateInstancesInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

Resize(ResizeInstanceGroupManagerRequest, CallOptions)

public virtual Operation Resize(ResizeInstanceGroupManagerRequest request, CallOptions options)

Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. 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 has elapsed before the VM instance is removed or deleted.

Parameters
NameDescription
requestResizeInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Resize(ResizeInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Resize(ResizeInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. 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 has elapsed before the VM instance is removed or deleted.

Parameters
NameDescription
requestResizeInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

ResizeAsync(ResizeInstanceGroupManagerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ResizeAsync(ResizeInstanceGroupManagerRequest request, CallOptions options)

Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. 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 has elapsed before the VM instance is removed or deleted.

Parameters
NameDescription
requestResizeInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

ResizeAsync(ResizeInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ResizeAsync(ResizeInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. 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 has elapsed before the VM instance is removed or deleted.

Parameters
NameDescription
requestResizeInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

SetInstanceTemplate(SetInstanceTemplateInstanceGroupManagerRequest, CallOptions)

public virtual Operation SetInstanceTemplate(SetInstanceTemplateInstanceGroupManagerRequest request, CallOptions options)

Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.

Parameters
NameDescription
requestSetInstanceTemplateInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetInstanceTemplate(SetInstanceTemplateInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation SetInstanceTemplate(SetInstanceTemplateInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.

Parameters
NameDescription
requestSetInstanceTemplateInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

SetInstanceTemplateAsync(SetInstanceTemplateInstanceGroupManagerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetInstanceTemplateAsync(SetInstanceTemplateInstanceGroupManagerRequest request, CallOptions options)

Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.

Parameters
NameDescription
requestSetInstanceTemplateInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

SetInstanceTemplateAsync(SetInstanceTemplateInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> SetInstanceTemplateAsync(SetInstanceTemplateInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.

Parameters
NameDescription
requestSetInstanceTemplateInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

SetTargetPools(SetTargetPoolsInstanceGroupManagerRequest, CallOptions)

public virtual Operation SetTargetPools(SetTargetPoolsInstanceGroupManagerRequest request, CallOptions options)

Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.

Parameters
NameDescription
requestSetTargetPoolsInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetTargetPools(SetTargetPoolsInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation SetTargetPools(SetTargetPoolsInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.

Parameters
NameDescription
requestSetTargetPoolsInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

SetTargetPoolsAsync(SetTargetPoolsInstanceGroupManagerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetTargetPoolsAsync(SetTargetPoolsInstanceGroupManagerRequest request, CallOptions options)

Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.

Parameters
NameDescription
requestSetTargetPoolsInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

SetTargetPoolsAsync(SetTargetPoolsInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> SetTargetPoolsAsync(SetTargetPoolsInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.

Parameters
NameDescription
requestSetTargetPoolsInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdatePerInstanceConfigs(UpdatePerInstanceConfigsInstanceGroupManagerRequest, CallOptions)

public virtual Operation UpdatePerInstanceConfigs(UpdatePerInstanceConfigsInstanceGroupManagerRequest request, CallOptions options)

Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

Parameters
NameDescription
requestUpdatePerInstanceConfigsInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdatePerInstanceConfigs(UpdatePerInstanceConfigsInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdatePerInstanceConfigs(UpdatePerInstanceConfigsInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

Parameters
NameDescription
requestUpdatePerInstanceConfigsInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdatePerInstanceConfigsAsync(UpdatePerInstanceConfigsInstanceGroupManagerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdatePerInstanceConfigsAsync(UpdatePerInstanceConfigsInstanceGroupManagerRequest request, CallOptions options)

Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

Parameters
NameDescription
requestUpdatePerInstanceConfigsInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdatePerInstanceConfigsAsync(UpdatePerInstanceConfigsInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdatePerInstanceConfigsAsync(UpdatePerInstanceConfigsInstanceGroupManagerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.

Parameters
NameDescription
requestUpdatePerInstanceConfigsInstanceGroupManagerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.