Compute Engine v1 API - Class RegionInstanceGroupsClientImpl (2.13.0)

Version 2.13.0

• 3.2.0 (latest)
• 3.1.0
• 3.0.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.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

Inherited Members

RegionInstanceGroupsClient.DefaultEndpoint

RegionInstanceGroupsClient.DefaultScopes

RegionInstanceGroupsClient.ServiceMetadata

RegionInstanceGroupsClient.CreateAsync(CancellationToken)

RegionInstanceGroupsClient.Create()

RegionInstanceGroupsClient.ShutdownDefaultChannelsAsync()

RegionInstanceGroupsClient.GetAsync(GetRegionInstanceGroupRequest, CancellationToken)

RegionInstanceGroupsClient.Get(string, string, string, CallSettings)

RegionInstanceGroupsClient.GetAsync(string, string, string, CallSettings)

RegionInstanceGroupsClient.GetAsync(string, string, string, CancellationToken)

RegionInstanceGroupsClient.List(string, string, string, int?, CallSettings)

RegionInstanceGroupsClient.ListAsync(string, string, string, int?, CallSettings)

RegionInstanceGroupsClient.ListInstances(string, string, string, RegionInstanceGroupsListInstancesRequest, string, int?, CallSettings)

RegionInstanceGroupsClient.ListInstancesAsync(string, string, string, RegionInstanceGroupsListInstancesRequest, string, int?, CallSettings)

RegionInstanceGroupsClient.SetNamedPortsAsync(SetNamedPortsRegionInstanceGroupRequest, CancellationToken)

RegionInstanceGroupsClient.PollOnceSetNamedPorts(string, CallSettings)

RegionInstanceGroupsClient.PollOnceSetNamedPortsAsync(string, CallSettings)

RegionInstanceGroupsClient.SetNamedPorts(string, string, string, RegionInstanceGroupsSetNamedPortsRequest, CallSettings)

RegionInstanceGroupsClient.SetNamedPortsAsync(string, string, string, RegionInstanceGroupsSetNamedPortsRequest, CallSettings)

RegionInstanceGroupsClient.SetNamedPortsAsync(string, string, string, RegionInstanceGroupsSetNamedPortsRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

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
Name	Description
grpcClient	RegionInstanceGroupsRegionInstanceGroupsClient The underlying gRPC client.
settings	RegionInstanceGroupsSettings The base RegionInstanceGroupsSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

GrpcClient

public override RegionInstanceGroups.RegionInstanceGroupsClient GrpcClient { get; }

The underlying gRPC RegionInstanceGroups client

Property Value
Type	Description
RegionInstanceGroupsRegionInstanceGroupsClient

Overrides

RegionInstanceGroupsClient.GrpcClient

SetNamedPortsOperationsClient

public override OperationsClient SetNamedPortsOperationsClient { get; }

The long-running operations client for SetNamedPorts.

Property Value
Type	Description
OperationsClient

Overrides

RegionInstanceGroupsClient.SetNamedPortsOperationsClient

Methods

Get(GetRegionInstanceGroupRequest, CallSettings)

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

Returns the specified instance group resource.

Parameters
Name	Description
request	GetRegionInstanceGroupRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
InstanceGroup	The RPC response.

Overrides

RegionInstanceGroupsClient.Get(GetRegionInstanceGroupRequest, CallSettings)

GetAsync(GetRegionInstanceGroupRequest, CallSettings)

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

Returns the specified instance group resource.

Parameters
Name	Description
request	GetRegionInstanceGroupRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskInstanceGroup	A Task containing the RPC response.

Overrides

RegionInstanceGroupsClient.GetAsync(GetRegionInstanceGroupRequest, CallSettings)

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
Name	Description
request	ListRegionInstanceGroupsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableRegionInstanceGroupListInstanceGroup	A pageable sequence of InstanceGroup resources.

Overrides

RegionInstanceGroupsClient.List(ListRegionInstanceGroupsRequest, CallSettings)

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
Name	Description
request	ListRegionInstanceGroupsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableRegionInstanceGroupListInstanceGroup	A pageable asynchronous sequence of InstanceGroup resources.

Overrides

RegionInstanceGroupsClient.ListAsync(ListRegionInstanceGroupsRequest, CallSettings)

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
Name	Description
request	ListInstancesRegionInstanceGroupsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableRegionInstanceGroupsListInstancesInstanceWithNamedPorts	A pageable sequence of InstanceWithNamedPorts resources.

Overrides

RegionInstanceGroupsClient.ListInstances(ListInstancesRegionInstanceGroupsRequest, CallSettings)

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
Name	Description
request	ListInstancesRegionInstanceGroupsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableRegionInstanceGroupsListInstancesInstanceWithNamedPorts	A pageable asynchronous sequence of InstanceWithNamedPorts resources.

Overrides

RegionInstanceGroupsClient.ListInstancesAsync(ListInstancesRegionInstanceGroupsRequest, CallSettings)

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
Name	Description
request	SetNamedPortsRegionInstanceGroupRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Overrides

RegionInstanceGroupsClient.SetNamedPorts(SetNamedPortsRegionInstanceGroupRequest, CallSettings)

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
Name	Description
request	SetNamedPortsRegionInstanceGroupRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Overrides

RegionInstanceGroupsClient.SetNamedPortsAsync(SetNamedPortsRegionInstanceGroupRequest, CallSettings)