Compute Engine v1 API - Class AggregatedListInstanceGroupsRequest (2.5.0)

public sealed class AggregatedListInstanceGroupsRequest : IMessage<AggregatedListInstanceGroupsRequest>, IEquatable<AggregatedListInstanceGroupsRequest>, IDeepCloneable<AggregatedListInstanceGroupsRequest>, IBufferMessage, IMessage, IPageRequest

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

A request message for InstanceGroups.AggregatedList. See the method description for details.

Inheritance

Object > AggregatedListInstanceGroupsRequest

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

AggregatedListInstanceGroupsRequest()

public AggregatedListInstanceGroupsRequest()

AggregatedListInstanceGroupsRequest(AggregatedListInstanceGroupsRequest)

public AggregatedListInstanceGroupsRequest(AggregatedListInstanceGroupsRequest other)
Parameter
NameDescription
otherAggregatedListInstanceGroupsRequest

Properties

Filter

public string Filter { get; set; }

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, !=, >, <, <=, >= or :. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. The : operator can be used with string fields to match substrings. For non-string fields it is equivalent to the = operator. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq &apos;single quoted literal&apos; fieldname eq &quot;double quoted literal&quot; (fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;) The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use name ne .*instance.

Property Value
TypeDescription
String

HasFilter

public bool HasFilter { get; }

Gets whether the "filter" field is set

Property Value
TypeDescription
Boolean

HasIncludeAllScopes

public bool HasIncludeAllScopes { get; }

Gets whether the "include_all_scopes" field is set

Property Value
TypeDescription
Boolean

HasMaxResults

public bool HasMaxResults { get; }

Gets whether the "max_results" field is set

Property Value
TypeDescription
Boolean

HasOrderBy

public bool HasOrderBy { get; }

Gets whether the "order_by" field is set

Property Value
TypeDescription
Boolean

HasPageToken

public bool HasPageToken { get; }

Gets whether the "page_token" field is set

Property Value
TypeDescription
Boolean

HasReturnPartialSuccess

public bool HasReturnPartialSuccess { get; }

Gets whether the "return_partial_success" field is set

Property Value
TypeDescription
Boolean

IncludeAllScopes

public bool IncludeAllScopes { get; set; }

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

Property Value
TypeDescription
Boolean

MaxResults

public uint MaxResults { get; set; }

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)

Property Value
TypeDescription
UInt32

OrderBy

public string OrderBy { get; set; }

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=&quot;creationTimestamp desc&quot;. 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.

Property Value
TypeDescription
String

PageSize

public int PageSize { get; set; }
Property Value
TypeDescription
Int32

PageToken

public string PageToken { get; set; }

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

Property Value
TypeDescription
String

Project

public string Project { get; set; }

Project ID for this request.

Property Value
TypeDescription
String

ReturnPartialSuccess

public bool ReturnPartialSuccess { get; set; }

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Property Value
TypeDescription
Boolean