Compute Engine v1 API - Class RegionInstanceGroupsClientImpl (2.11.0)

public sealed class RegionInstanceGroupsClientImpl : RegionInstanceGroupsClient

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

RegionInstanceGroups client wrapper implementation, for convenient use.

Inheritance

object > RegionInstanceGroupsClient > RegionInstanceGroupsClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The RegionInstanceGroups API.

Constructors

RegionInstanceGroupsClientImpl(RegionInstanceGroupsClient, RegionInstanceGroupsSettings, ILogger)

public RegionInstanceGroupsClientImpl(RegionInstanceGroups.RegionInstanceGroupsClient grpcClient, RegionInstanceGroupsSettings settings, ILogger logger)

Constructs a client wrapper for the RegionInstanceGroups service, with the specified gRPC client and settings.

Parameters
NameDescription
grpcClientRegionInstanceGroupsRegionInstanceGroupsClient

The underlying gRPC client.

settingsRegionInstanceGroupsSettings

The base RegionInstanceGroupsSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override RegionInstanceGroups.RegionInstanceGroupsClient GrpcClient { get; }

The underlying gRPC RegionInstanceGroups client

Property Value
TypeDescription
RegionInstanceGroupsRegionInstanceGroupsClient
Overrides

SetNamedPortsOperationsClient

public override OperationsClient SetNamedPortsOperationsClient { get; }

The long-running operations client for SetNamedPorts.

Property Value
TypeDescription
OperationsClient
Overrides

Methods

Get(GetRegionInstanceGroupRequest, CallSettings)

public override InstanceGroup Get(GetRegionInstanceGroupRequest request, CallSettings callSettings = null)

Returns the specified instance group resource.

Parameters
NameDescription
requestGetRegionInstanceGroupRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
InstanceGroup

The RPC response.

Overrides

GetAsync(GetRegionInstanceGroupRequest, CallSettings)

public override Task<InstanceGroup> GetAsync(GetRegionInstanceGroupRequest request, CallSettings callSettings = null)

Returns the specified instance group resource.

Parameters
NameDescription
requestGetRegionInstanceGroupRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskInstanceGroup

A Task containing the RPC response.

Overrides

List(ListRegionInstanceGroupsRequest, CallSettings)

public override PagedEnumerable<RegionInstanceGroupList, InstanceGroup> List(ListRegionInstanceGroupsRequest request, CallSettings callSettings = null)

Retrieves the list of instance group resources contained within the specified region.

Parameters
NameDescription
requestListRegionInstanceGroupsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableRegionInstanceGroupListInstanceGroup

A pageable sequence of InstanceGroup resources.

Overrides

ListAsync(ListRegionInstanceGroupsRequest, CallSettings)

public override PagedAsyncEnumerable<RegionInstanceGroupList, InstanceGroup> ListAsync(ListRegionInstanceGroupsRequest request, CallSettings callSettings = null)

Retrieves the list of instance group resources contained within the specified region.

Parameters
NameDescription
requestListRegionInstanceGroupsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableRegionInstanceGroupListInstanceGroup

A pageable asynchronous sequence of InstanceGroup resources.

Overrides

ListInstances(ListInstancesRegionInstanceGroupsRequest, CallSettings)

public override PagedEnumerable<RegionInstanceGroupsListInstances, InstanceWithNamedPorts> ListInstances(ListInstancesRegionInstanceGroupsRequest request, CallSettings callSettings = null)

Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. The orderBy query parameter is not supported.

Parameters
NameDescription
requestListInstancesRegionInstanceGroupsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableRegionInstanceGroupsListInstancesInstanceWithNamedPorts

A pageable sequence of InstanceWithNamedPorts resources.

Overrides

ListInstancesAsync(ListInstancesRegionInstanceGroupsRequest, CallSettings)

public override PagedAsyncEnumerable<RegionInstanceGroupsListInstances, InstanceWithNamedPorts> ListInstancesAsync(ListInstancesRegionInstanceGroupsRequest request, CallSettings callSettings = null)

Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. The orderBy query parameter is not supported.

Parameters
NameDescription
requestListInstancesRegionInstanceGroupsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableRegionInstanceGroupsListInstancesInstanceWithNamedPorts

A pageable asynchronous sequence of InstanceWithNamedPorts resources.

Overrides

SetNamedPorts(SetNamedPortsRegionInstanceGroupRequest, CallSettings)

public override Operation<Operation, Operation> SetNamedPorts(SetNamedPortsRegionInstanceGroupRequest request, CallSettings callSettings = null)

Sets the named ports for the specified regional instance group.

Parameters
NameDescription
requestSetNamedPortsRegionInstanceGroupRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationOperationOperation

The RPC response.

Overrides

SetNamedPortsAsync(SetNamedPortsRegionInstanceGroupRequest, CallSettings)

public override Task<Operation<Operation, Operation>> SetNamedPortsAsync(SetNamedPortsRegionInstanceGroupRequest request, CallSettings callSettings = null)

Sets the named ports for the specified regional instance group.

Parameters
NameDescription
requestSetNamedPortsRegionInstanceGroupRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides