Compute Engine v1 API - Class RegionInstanceGroups.RegionInstanceGroupsClient (2.17.0) 

public class RegionInstanceGroups.RegionInstanceGroupsClient : ClientBase<RegionInstanceGroups.RegionInstanceGroupsClient>

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

Client for RegionInstanceGroups

Inheritance

object > ClientBase > ClientBaseRegionInstanceGroupsRegionInstanceGroupsClient > RegionInstanceGroups.RegionInstanceGroupsClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

RegionInstanceGroupsClient()

protected RegionInstanceGroupsClient()

Protected parameterless constructor to allow creation of test doubles.

RegionInstanceGroupsClient(CallInvoker)

public RegionInstanceGroupsClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

RegionInstanceGroupsClient(ChannelBase)

public RegionInstanceGroupsClient(ChannelBase channel)

Creates a new client for RegionInstanceGroups

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

RegionInstanceGroupsClient(ClientBaseConfiguration)

protected RegionInstanceGroupsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

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
Type Description
OperationsOperationsClient

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

Get(GetRegionInstanceGroupRequest, CallOptions)

public virtual InstanceGroup Get(GetRegionInstanceGroupRequest request, CallOptions options)

Returns the specified instance group resource.

Parameters
Name Description
request GetRegionInstanceGroupRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
InstanceGroup

The response received from the server.

Get(GetRegionInstanceGroupRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified instance group resource.

Parameters
Name Description
request GetRegionInstanceGroupRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
InstanceGroup

The response received from the server.

GetAsync(GetRegionInstanceGroupRequest, CallOptions)

public virtual AsyncUnaryCall<InstanceGroup> GetAsync(GetRegionInstanceGroupRequest request, CallOptions options)

Returns the specified instance group resource.

Parameters
Name Description
request GetRegionInstanceGroupRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallInstanceGroup

The call object.

GetAsync(GetRegionInstanceGroupRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified instance group resource.

Parameters
Name Description
request GetRegionInstanceGroupRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallInstanceGroup

The call object.

List(ListRegionInstanceGroupsRequest, CallOptions)

public virtual RegionInstanceGroupList List(ListRegionInstanceGroupsRequest request, CallOptions options)

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

Parameters
Name Description
request ListRegionInstanceGroupsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
RegionInstanceGroupList

The response received from the server.

List(ListRegionInstanceGroupsRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request ListRegionInstanceGroupsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
RegionInstanceGroupList

The response received from the server.

ListAsync(ListRegionInstanceGroupsRequest, CallOptions)

public virtual AsyncUnaryCall<RegionInstanceGroupList> ListAsync(ListRegionInstanceGroupsRequest request, CallOptions options)

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

Parameters
Name Description
request ListRegionInstanceGroupsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallRegionInstanceGroupList

The call object.

ListAsync(ListRegionInstanceGroupsRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request ListRegionInstanceGroupsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallRegionInstanceGroupList

The call object.

ListInstances(ListInstancesRegionInstanceGroupsRequest, CallOptions)

public virtual RegionInstanceGroupsListInstances ListInstances(ListInstancesRegionInstanceGroupsRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
RegionInstanceGroupsListInstances

The response received from the server.

ListInstances(ListInstancesRegionInstanceGroupsRequest, Metadata, DateTime?, CancellationToken)

public virtual RegionInstanceGroupsListInstances ListInstances(ListInstancesRegionInstanceGroupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
RegionInstanceGroupsListInstances

The response received from the server.

ListInstancesAsync(ListInstancesRegionInstanceGroupsRequest, CallOptions)

public virtual AsyncUnaryCall<RegionInstanceGroupsListInstances> ListInstancesAsync(ListInstancesRegionInstanceGroupsRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallRegionInstanceGroupsListInstances

The call object.

ListInstancesAsync(ListInstancesRegionInstanceGroupsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RegionInstanceGroupsListInstances> ListInstancesAsync(ListInstancesRegionInstanceGroupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallRegionInstanceGroupsListInstances

The call object.

NewInstance(ClientBaseConfiguration)

protected override RegionInstanceGroups.RegionInstanceGroupsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
RegionInstanceGroupsRegionInstanceGroupsClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Compute.V1.RegionInstanceGroups.RegionInstanceGroupsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

SetNamedPorts(SetNamedPortsRegionInstanceGroupRequest, CallOptions)

public virtual Operation SetNamedPorts(SetNamedPortsRegionInstanceGroupRequest request, CallOptions options)

Sets the named ports for the specified regional instance group.

Parameters
Name Description
request SetNamedPortsRegionInstanceGroupRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

SetNamedPorts(SetNamedPortsRegionInstanceGroupRequest, Metadata, DateTime?, CancellationToken)

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

Sets the named ports for the specified regional instance group.

Parameters
Name Description
request SetNamedPortsRegionInstanceGroupRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

SetNamedPortsAsync(SetNamedPortsRegionInstanceGroupRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetNamedPortsAsync(SetNamedPortsRegionInstanceGroupRequest request, CallOptions options)

Sets the named ports for the specified regional instance group.

Parameters
Name Description
request SetNamedPortsRegionInstanceGroupRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

SetNamedPortsAsync(SetNamedPortsRegionInstanceGroupRequest, Metadata, DateTime?, CancellationToken)

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

Sets the named ports for the specified regional instance group.

Parameters
Name Description
request SetNamedPortsRegionInstanceGroupRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.