public sealed class InstanceGroupsClientImpl : InstanceGroupsClientInstanceGroups client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Compute.V1Assembly
Google.Cloud.Compute.V1.dll
Remarks
The InstanceGroups API.
Constructors
InstanceGroupsClientImpl(InstanceGroups.InstanceGroupsClient, InstanceGroupsSettings, ILogger)
public InstanceGroupsClientImpl(InstanceGroups.InstanceGroupsClient grpcClient, InstanceGroupsSettings settings, ILogger logger)Constructs a client wrapper for the InstanceGroups service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient | InstanceGroups.InstanceGroupsClientThe underlying gRPC client. |
settings | InstanceGroupsSettingsThe base InstanceGroupsSettings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Properties
AddInstancesOperationsClient
public override OperationsClient AddInstancesOperationsClient { get; }The long-running operations client for AddInstances.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
DeleteOperationsClient
public override OperationsClient DeleteOperationsClient { get; }The long-running operations client for Delete.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
GrpcClient
public override InstanceGroups.InstanceGroupsClient GrpcClient { get; }The underlying gRPC InstanceGroups client
| Property Value | |
|---|---|
| Type | Description |
InstanceGroups.InstanceGroupsClient | |
InsertOperationsClient
public override OperationsClient InsertOperationsClient { get; }The long-running operations client for Insert.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
RemoveInstancesOperationsClient
public override OperationsClient RemoveInstancesOperationsClient { get; }The long-running operations client for RemoveInstances.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
SetNamedPortsOperationsClient
public override OperationsClient SetNamedPortsOperationsClient { get; }The long-running operations client for SetNamedPorts.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
Methods
AddInstances(AddInstancesInstanceGroupRequest, CallSettings)
public override Operation<Operation, Operation> AddInstances(AddInstancesInstanceGroupRequest request, CallSettings callSettings = null)Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.
| Parameters | |
|---|---|
| Name | Description |
request | AddInstancesInstanceGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<Operation, Operation> | The RPC response. |
AddInstancesAsync(AddInstancesInstanceGroupRequest, CallSettings)
public override async Task<Operation<Operation, Operation>> AddInstancesAsync(AddInstancesInstanceGroupRequest request, CallSettings callSettings = null)Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.
| Parameters | |
|---|---|
| Name | Description |
request | AddInstancesInstanceGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<Operation, Operation>> | A Task containing the RPC response. |
AggregatedList(AggregatedListInstanceGroupsRequest, CallSettings)
public override PagedEnumerable<InstanceGroupAggregatedList, KeyValuePair<string, InstanceGroupsScopedList>> AggregatedList(AggregatedListInstanceGroupsRequest request, CallSettings callSettings = null)Retrieves the list of instance groups and sorts them by zone.
| Parameters | |
|---|---|
| Name | Description |
request | AggregatedListInstanceGroupsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<InstanceGroupAggregatedList, KeyValuePair<String, InstanceGroupsScopedList>> | A pageable sequence of KeyValuePair<TKey,TValue> resources. |
AggregatedListAsync(AggregatedListInstanceGroupsRequest, CallSettings)
public override PagedAsyncEnumerable<InstanceGroupAggregatedList, KeyValuePair<string, InstanceGroupsScopedList>> AggregatedListAsync(AggregatedListInstanceGroupsRequest request, CallSettings callSettings = null)Retrieves the list of instance groups and sorts them by zone.
| Parameters | |
|---|---|
| Name | Description |
request | AggregatedListInstanceGroupsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<InstanceGroupAggregatedList, KeyValuePair<String, InstanceGroupsScopedList>> | A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources. |
Delete(DeleteInstanceGroupRequest, CallSettings)
public override Operation<Operation, Operation> Delete(DeleteInstanceGroupRequest request, CallSettings callSettings = null)Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteInstanceGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<Operation, Operation> | The RPC response. |
DeleteAsync(DeleteInstanceGroupRequest, CallSettings)
public override async Task<Operation<Operation, Operation>> DeleteAsync(DeleteInstanceGroupRequest request, CallSettings callSettings = null)Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteInstanceGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<Operation, Operation>> | A Task containing the RPC response. |
Get(GetInstanceGroupRequest, CallSettings)
public override InstanceGroup Get(GetInstanceGroupRequest request, CallSettings callSettings = null)Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
| Parameters | |
|---|---|
| Name | Description |
request | GetInstanceGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
InstanceGroup | The RPC response. |
GetAsync(GetInstanceGroupRequest, CallSettings)
public override Task<InstanceGroup> GetAsync(GetInstanceGroupRequest request, CallSettings callSettings = null)Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
| Parameters | |
|---|---|
| Name | Description |
request | GetInstanceGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<InstanceGroup> | A Task containing the RPC response. |
Insert(InsertInstanceGroupRequest, CallSettings)
public override Operation<Operation, Operation> Insert(InsertInstanceGroupRequest request, CallSettings callSettings = null)Creates an instance group in the specified project using the parameters that are included in the request.
| Parameters | |
|---|---|
| Name | Description |
request | InsertInstanceGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<Operation, Operation> | The RPC response. |
InsertAsync(InsertInstanceGroupRequest, CallSettings)
public override async Task<Operation<Operation, Operation>> InsertAsync(InsertInstanceGroupRequest request, CallSettings callSettings = null)Creates an instance group in the specified project using the parameters that are included in the request.
| Parameters | |
|---|---|
| Name | Description |
request | InsertInstanceGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<Operation, Operation>> | A Task containing the RPC response. |
List(ListInstanceGroupsRequest, CallSettings)
public override PagedEnumerable<InstanceGroupList, InstanceGroup> List(ListInstanceGroupsRequest request, CallSettings callSettings = null)Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
| Parameters | |
|---|---|
| Name | Description |
request | ListInstanceGroupsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<InstanceGroupList, InstanceGroup> | A pageable sequence of InstanceGroup resources. |
ListAsync(ListInstanceGroupsRequest, CallSettings)
public override PagedAsyncEnumerable<InstanceGroupList, InstanceGroup> ListAsync(ListInstanceGroupsRequest request, CallSettings callSettings = null)Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
| Parameters | |
|---|---|
| Name | Description |
request | ListInstanceGroupsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<InstanceGroupList, InstanceGroup> | A pageable asynchronous sequence of InstanceGroup resources. |
ListInstances(ListInstancesInstanceGroupsRequest, CallSettings)
public override PagedEnumerable<InstanceGroupsListInstances, InstanceWithNamedPorts> ListInstances(ListInstancesInstanceGroupsRequest request, CallSettings callSettings = null)Lists the instances in the specified instance group. The orderBy query parameter is not supported. The filter query parameter is supported, but only for expressions that use eq (equal) or ne (not equal) operators.
| Parameters | |
|---|---|
| Name | Description |
request | ListInstancesInstanceGroupsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<InstanceGroupsListInstances, InstanceWithNamedPorts> | A pageable sequence of InstanceWithNamedPorts resources. |
ListInstancesAsync(ListInstancesInstanceGroupsRequest, CallSettings)
public override PagedAsyncEnumerable<InstanceGroupsListInstances, InstanceWithNamedPorts> ListInstancesAsync(ListInstancesInstanceGroupsRequest request, CallSettings callSettings = null)Lists the instances in the specified instance group. The orderBy query parameter is not supported. The filter query parameter is supported, but only for expressions that use eq (equal) or ne (not equal) operators.
| Parameters | |
|---|---|
| Name | Description |
request | ListInstancesInstanceGroupsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<InstanceGroupsListInstances, InstanceWithNamedPorts> | A pageable asynchronous sequence of InstanceWithNamedPorts resources. |
RemoveInstances(RemoveInstancesInstanceGroupRequest, CallSettings)
public override Operation<Operation, Operation> RemoveInstances(RemoveInstancesInstanceGroupRequest request, CallSettings callSettings = null)Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.
| Parameters | |
|---|---|
| Name | Description |
request | RemoveInstancesInstanceGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<Operation, Operation> | The RPC response. |
RemoveInstancesAsync(RemoveInstancesInstanceGroupRequest, CallSettings)
public override async Task<Operation<Operation, Operation>> RemoveInstancesAsync(RemoveInstancesInstanceGroupRequest request, CallSettings callSettings = null)Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.
| Parameters | |
|---|---|
| Name | Description |
request | RemoveInstancesInstanceGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<Operation, Operation>> | A Task containing the RPC response. |
SetNamedPorts(SetNamedPortsInstanceGroupRequest, CallSettings)
public override Operation<Operation, Operation> SetNamedPorts(SetNamedPortsInstanceGroupRequest request, CallSettings callSettings = null)Sets the named ports for the specified instance group.
| Parameters | |
|---|---|
| Name | Description |
request | SetNamedPortsInstanceGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<Operation, Operation> | The RPC response. |
SetNamedPortsAsync(SetNamedPortsInstanceGroupRequest, CallSettings)
public override async Task<Operation<Operation, Operation>> SetNamedPortsAsync(SetNamedPortsInstanceGroupRequest request, CallSettings callSettings = null)Sets the named ports for the specified instance group.
| Parameters | |
|---|---|
| Name | Description |
request | SetNamedPortsInstanceGroupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<Operation, Operation>> | A Task containing the RPC response. |