Class RegionInstanceGroupsResource.ListInstancesRequest
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.
Inheritance
Implements
Inherited Members
Namespace: Google.Apis.Compute.v1
Assembly: Google.Apis.Compute.v1.dll
Syntax
public class ListInstancesRequest : ComputeBaseServiceRequest<RegionInstanceGroupsListInstances>, IClientServiceRequest<RegionInstanceGroupsListInstances>, IClientServiceRequest
Constructors
ListInstancesRequest(IClientService, RegionInstanceGroupsListInstancesRequest, String, String, String)
Constructs a new ListInstances request.
Declaration
public ListInstancesRequest(IClientService service, RegionInstanceGroupsListInstancesRequest body, string project, string region, string instanceGroup)
Parameters
| Type | Name | Description |
|---|---|---|
| Google.Apis.Services.IClientService | service | |
| RegionInstanceGroupsListInstancesRequest | body | |
| System.String | project | |
| System.String | region | |
| System.String | instanceGroup |
Properties
Filter
Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
InstanceGroup
Name of the regional instance group for which we want to list the instances.
Declaration
[RequestParameter("instanceGroup", RequestParameterType.Path)]
public virtual string InstanceGroup { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
MaxResults
The maximum number of results per page that should be returned. If the number of available
results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get
the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive.
(Default: 500)
Declaration
[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual long? MaxResults { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
OrderBy
Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
You can also sort results in descending order based on the creation timestamp using
orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse
chronological order (newest result first). Use this to sort resources like operations so that the newest
operation is returned first.
Currently, only sorting by name or creationTimestamp desc is supported.
Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual string OrderBy { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
PageToken
Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous
list request to get the next page of results.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Project
Project ID for this request.
Declaration
[RequestParameter("project", RequestParameterType.Path)]
public virtual string Project { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
Region
Name of the region scoping this request.
Declaration
[RequestParameter("region", RequestParameterType.Path)]
public virtual string Region { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
Methods
GetBody()
Returns the body of the request.
Declaration
protected override object GetBody()
Returns
| Type | Description |
|---|---|
| System.Object |
Overrides
InitParameters()
Initializes ListInstances parameter list.
Declaration
protected override void InitParameters()