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.
Inherited Members
Namespace
Google.Cloud.Compute.V1Assembly
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 |
SetNamedPortsOperationsClient
public override OperationsClient SetNamedPortsOperationsClient { get; }
The long-running operations client for SetNamedPorts
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |