Compute Engine v1 API - Class RegionInstanceGroupManagers.RegionInstanceGroupManagersClient (2.11.0)

public class RegionInstanceGroupManagers.RegionInstanceGroupManagersClient : ClientBase<RegionInstanceGroupManagers.RegionInstanceGroupManagersClient>

Reference documentation and code samples for the Compute Engine v1 API class RegionInstanceGroupManagers.RegionInstanceGroupManagersClient.

Client for RegionInstanceGroupManagers

Inheritance

object > ClientBase > ClientBaseRegionInstanceGroupManagersRegionInstanceGroupManagersClient > RegionInstanceGroupManagers.RegionInstanceGroupManagersClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

RegionInstanceGroupManagersClient()

protected RegionInstanceGroupManagersClient()

Protected parameterless constructor to allow creation of test doubles.

RegionInstanceGroupManagersClient(CallInvoker)

public RegionInstanceGroupManagersClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

RegionInstanceGroupManagersClient(ChannelBase)

public RegionInstanceGroupManagersClient(ChannelBase channel)

Creates a new client for RegionInstanceGroupManagers

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

RegionInstanceGroupManagersClient(ClientBaseConfiguration)

protected RegionInstanceGroupManagersClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

AbandonInstances(AbandonInstancesRegionInstanceGroupManagerRequest, CallOptions)

public virtual Operation AbandonInstances(AbandonInstancesRegionInstanceGroupManagerRequest request, CallOptions options)

Flags the specified instances to be immediately 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
requestAbandonInstancesRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

AbandonInstances(AbandonInstancesRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

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

Flags the specified instances to be immediately 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
requestAbandonInstancesRegionInstanceGroupManagerRequest

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(AbandonInstancesRegionInstanceGroupManagerRequest, CallOptions)

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

Flags the specified instances to be immediately 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
requestAbandonInstancesRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

AbandonInstancesAsync(AbandonInstancesRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

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

Flags the specified instances to be immediately 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
requestAbandonInstancesRegionInstanceGroupManagerRequest

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.

ApplyUpdatesToInstances(ApplyUpdatesToInstancesRegionInstanceGroupManagerRequest, CallOptions)

public virtual Operation ApplyUpdatesToInstances(ApplyUpdatesToInstancesRegionInstanceGroupManagerRequest request, CallOptions options)

Apply updates to selected instances the managed instance group.

Parameters
NameDescription
requestApplyUpdatesToInstancesRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

ApplyUpdatesToInstances(ApplyUpdatesToInstancesRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

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

Apply updates to selected instances the managed instance group.

Parameters
NameDescription
requestApplyUpdatesToInstancesRegionInstanceGroupManagerRequest

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(ApplyUpdatesToInstancesRegionInstanceGroupManagerRequest, CallOptions)

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

Apply updates to selected instances the managed instance group.

Parameters
NameDescription
requestApplyUpdatesToInstancesRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

ApplyUpdatesToInstancesAsync(ApplyUpdatesToInstancesRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

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

Apply updates to selected instances the managed instance group.

Parameters
NameDescription
requestApplyUpdatesToInstancesRegionInstanceGroupManagerRequest

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(CreateInstancesRegionInstanceGroupManagerRequest, CallOptions)

public virtual Operation CreateInstances(CreateInstancesRegionInstanceGroupManagerRequest request, CallOptions options)

Creates instances with per-instance configurations in this regional 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
requestCreateInstancesRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateInstances(CreateInstancesRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

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

Creates instances with per-instance configurations in this regional 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
requestCreateInstancesRegionInstanceGroupManagerRequest

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(CreateInstancesRegionInstanceGroupManagerRequest, CallOptions)

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

Creates instances with per-instance configurations in this regional 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
requestCreateInstancesRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateInstancesAsync(CreateInstancesRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

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

Creates instances with per-instance configurations in this regional 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
requestCreateInstancesRegionInstanceGroupManagerRequest

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.

CreateOperationsClientForRegionOperations()

public virtual Operations.OperationsClient CreateOperationsClientForRegionOperations()

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

Returns
TypeDescription
OperationsOperationsClient

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

Delete(DeleteRegionInstanceGroupManagerRequest, CallOptions)

public virtual Operation Delete(DeleteRegionInstanceGroupManagerRequest request, CallOptions options)

Deletes the specified managed instance group and all of the instances in that group.

Parameters
NameDescription
requestDeleteRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Delete(DeleteRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified managed instance group and all of the instances in that group.

Parameters
NameDescription
requestDeleteRegionInstanceGroupManagerRequest

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(DeleteRegionInstanceGroupManagerRequest, CallOptions)

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

Deletes the specified managed instance group and all of the instances in that group.

Parameters
NameDescription
requestDeleteRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteAsync(DeleteRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified managed instance group and all of the instances in that group.

Parameters
NameDescription
requestDeleteRegionInstanceGroupManagerRequest

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(DeleteInstancesRegionInstanceGroupManagerRequest, CallOptions)

public virtual Operation DeleteInstances(DeleteInstancesRegionInstanceGroupManagerRequest request, CallOptions options)

Flags the specified instances in the managed instance group to be immediately deleted. 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. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. 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
requestDeleteInstancesRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteInstances(DeleteInstancesRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

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

Flags the specified instances in the managed instance group to be immediately deleted. 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. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. 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
requestDeleteInstancesRegionInstanceGroupManagerRequest

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(DeleteInstancesRegionInstanceGroupManagerRequest, CallOptions)

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

Flags the specified instances in the managed instance group to be immediately deleted. 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. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. 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
requestDeleteInstancesRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteInstancesAsync(DeleteInstancesRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

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

Flags the specified instances in the managed instance group to be immediately deleted. 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. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. 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
requestDeleteInstancesRegionInstanceGroupManagerRequest

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(DeletePerInstanceConfigsRegionInstanceGroupManagerRequest, CallOptions)

public virtual Operation DeletePerInstanceConfigs(DeletePerInstanceConfigsRegionInstanceGroupManagerRequest request, CallOptions options)

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

Parameters
NameDescription
requestDeletePerInstanceConfigsRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeletePerInstanceConfigs(DeletePerInstanceConfigsRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
NameDescription
requestDeletePerInstanceConfigsRegionInstanceGroupManagerRequest

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(DeletePerInstanceConfigsRegionInstanceGroupManagerRequest, CallOptions)

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

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

Parameters
NameDescription
requestDeletePerInstanceConfigsRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeletePerInstanceConfigsAsync(DeletePerInstanceConfigsRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
NameDescription
requestDeletePerInstanceConfigsRegionInstanceGroupManagerRequest

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(GetRegionInstanceGroupManagerRequest, CallOptions)

public virtual InstanceGroupManager Get(GetRegionInstanceGroupManagerRequest request, CallOptions options)

Returns all of the details about the specified managed instance group.

Parameters
NameDescription
requestGetRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
InstanceGroupManager

The response received from the server.

Get(GetRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

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

Returns all of the details about the specified managed instance group.

Parameters
NameDescription
requestGetRegionInstanceGroupManagerRequest

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(GetRegionInstanceGroupManagerRequest, CallOptions)

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

Returns all of the details about the specified managed instance group.

Parameters
NameDescription
requestGetRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallInstanceGroupManager

The call object.

GetAsync(GetRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

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

Returns all of the details about the specified managed instance group.

Parameters
NameDescription
requestGetRegionInstanceGroupManagerRequest

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(InsertRegionInstanceGroupManagerRequest, CallOptions)

public virtual Operation Insert(InsertRegionInstanceGroupManagerRequest 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 regional managed instance group can contain up to 2000 instances.

Parameters
NameDescription
requestInsertRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Insert(InsertRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Insert(InsertRegionInstanceGroupManagerRequest 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 regional managed instance group can contain up to 2000 instances.

Parameters
NameDescription
requestInsertRegionInstanceGroupManagerRequest

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(InsertRegionInstanceGroupManagerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertRegionInstanceGroupManagerRequest 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 regional managed instance group can contain up to 2000 instances.

Parameters
NameDescription
requestInsertRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

InsertAsync(InsertRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertRegionInstanceGroupManagerRequest 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 regional managed instance group can contain up to 2000 instances.

Parameters
NameDescription
requestInsertRegionInstanceGroupManagerRequest

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(ListRegionInstanceGroupManagersRequest, CallOptions)

public virtual RegionInstanceGroupManagerList List(ListRegionInstanceGroupManagersRequest request, CallOptions options)

Retrieves the list of managed instance groups that are contained within the specified region.

Parameters
NameDescription
requestListRegionInstanceGroupManagersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
RegionInstanceGroupManagerList

The response received from the server.

List(ListRegionInstanceGroupManagersRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves the list of managed instance groups that are contained within the specified region.

Parameters
NameDescription
requestListRegionInstanceGroupManagersRequest

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
RegionInstanceGroupManagerList

The response received from the server.

ListAsync(ListRegionInstanceGroupManagersRequest, CallOptions)

public virtual AsyncUnaryCall<RegionInstanceGroupManagerList> ListAsync(ListRegionInstanceGroupManagersRequest request, CallOptions options)

Retrieves the list of managed instance groups that are contained within the specified region.

Parameters
NameDescription
requestListRegionInstanceGroupManagersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallRegionInstanceGroupManagerList

The call object.

ListAsync(ListRegionInstanceGroupManagersRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves the list of managed instance groups that are contained within the specified region.

Parameters
NameDescription
requestListRegionInstanceGroupManagersRequest

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
AsyncUnaryCallRegionInstanceGroupManagerList

The call object.

ListErrors(ListErrorsRegionInstanceGroupManagersRequest, CallOptions)

public virtual RegionInstanceGroupManagersListErrorsResponse ListErrors(ListErrorsRegionInstanceGroupManagersRequest request, CallOptions options)

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

Parameters
NameDescription
requestListErrorsRegionInstanceGroupManagersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
RegionInstanceGroupManagersListErrorsResponse

The response received from the server.

ListErrors(ListErrorsRegionInstanceGroupManagersRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
NameDescription
requestListErrorsRegionInstanceGroupManagersRequest

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
RegionInstanceGroupManagersListErrorsResponse

The response received from the server.

ListErrorsAsync(ListErrorsRegionInstanceGroupManagersRequest, CallOptions)

public virtual AsyncUnaryCall<RegionInstanceGroupManagersListErrorsResponse> ListErrorsAsync(ListErrorsRegionInstanceGroupManagersRequest request, CallOptions options)

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

Parameters
NameDescription
requestListErrorsRegionInstanceGroupManagersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallRegionInstanceGroupManagersListErrorsResponse

The call object.

ListErrorsAsync(ListErrorsRegionInstanceGroupManagersRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
NameDescription
requestListErrorsRegionInstanceGroupManagersRequest

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
AsyncUnaryCallRegionInstanceGroupManagersListErrorsResponse

The call object.

ListManagedInstances(ListManagedInstancesRegionInstanceGroupManagersRequest, CallOptions)

public virtual RegionInstanceGroupManagersListInstancesResponse ListManagedInstances(ListManagedInstancesRegionInstanceGroupManagersRequest request, CallOptions options)

Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. 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
requestListManagedInstancesRegionInstanceGroupManagersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
RegionInstanceGroupManagersListInstancesResponse

The response received from the server.

ListManagedInstances(ListManagedInstancesRegionInstanceGroupManagersRequest, Metadata, DateTime?, CancellationToken)

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

Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. 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
requestListManagedInstancesRegionInstanceGroupManagersRequest

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
RegionInstanceGroupManagersListInstancesResponse

The response received from the server.

ListManagedInstancesAsync(ListManagedInstancesRegionInstanceGroupManagersRequest, CallOptions)

public virtual AsyncUnaryCall<RegionInstanceGroupManagersListInstancesResponse> ListManagedInstancesAsync(ListManagedInstancesRegionInstanceGroupManagersRequest request, CallOptions options)

Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. 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
requestListManagedInstancesRegionInstanceGroupManagersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallRegionInstanceGroupManagersListInstancesResponse

The call object.

ListManagedInstancesAsync(ListManagedInstancesRegionInstanceGroupManagersRequest, Metadata, DateTime?, CancellationToken)

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

Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. 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
requestListManagedInstancesRegionInstanceGroupManagersRequest

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
AsyncUnaryCallRegionInstanceGroupManagersListInstancesResponse

The call object.

ListPerInstanceConfigs(ListPerInstanceConfigsRegionInstanceGroupManagersRequest, CallOptions)

public virtual RegionInstanceGroupManagersListInstanceConfigsResp ListPerInstanceConfigs(ListPerInstanceConfigsRegionInstanceGroupManagersRequest 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
requestListPerInstanceConfigsRegionInstanceGroupManagersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
RegionInstanceGroupManagersListInstanceConfigsResp

The response received from the server.

ListPerInstanceConfigs(ListPerInstanceConfigsRegionInstanceGroupManagersRequest, Metadata, DateTime?, CancellationToken)

public virtual RegionInstanceGroupManagersListInstanceConfigsResp ListPerInstanceConfigs(ListPerInstanceConfigsRegionInstanceGroupManagersRequest 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
requestListPerInstanceConfigsRegionInstanceGroupManagersRequest

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
RegionInstanceGroupManagersListInstanceConfigsResp

The response received from the server.

ListPerInstanceConfigsAsync(ListPerInstanceConfigsRegionInstanceGroupManagersRequest, CallOptions)

public virtual AsyncUnaryCall<RegionInstanceGroupManagersListInstanceConfigsResp> ListPerInstanceConfigsAsync(ListPerInstanceConfigsRegionInstanceGroupManagersRequest 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
requestListPerInstanceConfigsRegionInstanceGroupManagersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallRegionInstanceGroupManagersListInstanceConfigsResp

The call object.

ListPerInstanceConfigsAsync(ListPerInstanceConfigsRegionInstanceGroupManagersRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RegionInstanceGroupManagersListInstanceConfigsResp> ListPerInstanceConfigsAsync(ListPerInstanceConfigsRegionInstanceGroupManagersRequest 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
requestListPerInstanceConfigsRegionInstanceGroupManagersRequest

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
AsyncUnaryCallRegionInstanceGroupManagersListInstanceConfigsResp

The call object.

NewInstance(ClientBaseConfiguration)

protected override RegionInstanceGroupManagers.RegionInstanceGroupManagersClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
RegionInstanceGroupManagersRegionInstanceGroupManagersClient
Overrides

Patch(PatchRegionInstanceGroupManagerRequest, CallOptions)

public virtual Operation Patch(PatchRegionInstanceGroupManagerRequest 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
requestPatchRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Patch(PatchRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Patch(PatchRegionInstanceGroupManagerRequest 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
requestPatchRegionInstanceGroupManagerRequest

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(PatchRegionInstanceGroupManagerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> PatchAsync(PatchRegionInstanceGroupManagerRequest 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
requestPatchRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

PatchAsync(PatchRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> PatchAsync(PatchRegionInstanceGroupManagerRequest 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
requestPatchRegionInstanceGroupManagerRequest

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(PatchPerInstanceConfigsRegionInstanceGroupManagerRequest, CallOptions)

public virtual Operation PatchPerInstanceConfigs(PatchPerInstanceConfigsRegionInstanceGroupManagerRequest 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
requestPatchPerInstanceConfigsRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

PatchPerInstanceConfigs(PatchPerInstanceConfigsRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation PatchPerInstanceConfigs(PatchPerInstanceConfigsRegionInstanceGroupManagerRequest 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
requestPatchPerInstanceConfigsRegionInstanceGroupManagerRequest

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(PatchPerInstanceConfigsRegionInstanceGroupManagerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> PatchPerInstanceConfigsAsync(PatchPerInstanceConfigsRegionInstanceGroupManagerRequest 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
requestPatchPerInstanceConfigsRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

PatchPerInstanceConfigsAsync(PatchPerInstanceConfigsRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> PatchPerInstanceConfigsAsync(PatchPerInstanceConfigsRegionInstanceGroupManagerRequest 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
requestPatchPerInstanceConfigsRegionInstanceGroupManagerRequest

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(RecreateInstancesRegionInstanceGroupManagerRequest, CallOptions)

public virtual Operation RecreateInstances(RecreateInstancesRegionInstanceGroupManagerRequest 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
requestRecreateInstancesRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

RecreateInstances(RecreateInstancesRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation RecreateInstances(RecreateInstancesRegionInstanceGroupManagerRequest 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
requestRecreateInstancesRegionInstanceGroupManagerRequest

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(RecreateInstancesRegionInstanceGroupManagerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RecreateInstancesAsync(RecreateInstancesRegionInstanceGroupManagerRequest 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
requestRecreateInstancesRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

RecreateInstancesAsync(RecreateInstancesRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> RecreateInstancesAsync(RecreateInstancesRegionInstanceGroupManagerRequest 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
requestRecreateInstancesRegionInstanceGroupManagerRequest

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(ResizeRegionInstanceGroupManagerRequest, CallOptions)

public virtual Operation Resize(ResizeRegionInstanceGroupManagerRequest request, CallOptions options)

Changes the intended size of 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 one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions 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.

Parameters
NameDescription
requestResizeRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Resize(ResizeRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

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

Changes the intended size of 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 one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions 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.

Parameters
NameDescription
requestResizeRegionInstanceGroupManagerRequest

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(ResizeRegionInstanceGroupManagerRequest, CallOptions)

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

Changes the intended size of 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 one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions 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.

Parameters
NameDescription
requestResizeRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

ResizeAsync(ResizeRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

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

Changes the intended size of 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 one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions 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.

Parameters
NameDescription
requestResizeRegionInstanceGroupManagerRequest

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(SetInstanceTemplateRegionInstanceGroupManagerRequest, CallOptions)

public virtual Operation SetInstanceTemplate(SetInstanceTemplateRegionInstanceGroupManagerRequest request, CallOptions options)

Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.

Parameters
NameDescription
requestSetInstanceTemplateRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetInstanceTemplate(SetInstanceTemplateRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

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

Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.

Parameters
NameDescription
requestSetInstanceTemplateRegionInstanceGroupManagerRequest

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(SetInstanceTemplateRegionInstanceGroupManagerRequest, CallOptions)

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

Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.

Parameters
NameDescription
requestSetInstanceTemplateRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

SetInstanceTemplateAsync(SetInstanceTemplateRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

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

Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.

Parameters
NameDescription
requestSetInstanceTemplateRegionInstanceGroupManagerRequest

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(SetTargetPoolsRegionInstanceGroupManagerRequest, CallOptions)

public virtual Operation SetTargetPools(SetTargetPoolsRegionInstanceGroupManagerRequest request, CallOptions options)

Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.

Parameters
NameDescription
requestSetTargetPoolsRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetTargetPools(SetTargetPoolsRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

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

Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.

Parameters
NameDescription
requestSetTargetPoolsRegionInstanceGroupManagerRequest

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(SetTargetPoolsRegionInstanceGroupManagerRequest, CallOptions)

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

Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.

Parameters
NameDescription
requestSetTargetPoolsRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

SetTargetPoolsAsync(SetTargetPoolsRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

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

Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.

Parameters
NameDescription
requestSetTargetPoolsRegionInstanceGroupManagerRequest

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(UpdatePerInstanceConfigsRegionInstanceGroupManagerRequest, CallOptions)

public virtual Operation UpdatePerInstanceConfigs(UpdatePerInstanceConfigsRegionInstanceGroupManagerRequest 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
requestUpdatePerInstanceConfigsRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdatePerInstanceConfigs(UpdatePerInstanceConfigsRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdatePerInstanceConfigs(UpdatePerInstanceConfigsRegionInstanceGroupManagerRequest 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
requestUpdatePerInstanceConfigsRegionInstanceGroupManagerRequest

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(UpdatePerInstanceConfigsRegionInstanceGroupManagerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdatePerInstanceConfigsAsync(UpdatePerInstanceConfigsRegionInstanceGroupManagerRequest 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
requestUpdatePerInstanceConfigsRegionInstanceGroupManagerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdatePerInstanceConfigsAsync(UpdatePerInstanceConfigsRegionInstanceGroupManagerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdatePerInstanceConfigsAsync(UpdatePerInstanceConfigsRegionInstanceGroupManagerRequest 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
requestUpdatePerInstanceConfigsRegionInstanceGroupManagerRequest

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.