Class AggregatedListInstancesRequest (1.0.0)

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

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

Inheritance

Object > AggregatedListInstancesRequest

Implements

IMessage<AggregatedListInstancesRequest>, IEquatable<AggregatedListInstancesRequest>, IDeepCloneable<AggregatedListInstancesRequest>, IBufferMessage, IMessage, IPageRequest

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

AggregatedListInstancesRequest()

public AggregatedListInstancesRequest()

AggregatedListInstancesRequest(AggregatedListInstancesRequest)

public AggregatedListInstancesRequest(AggregatedListInstancesRequest other)

Parameter
Name	Description
`other`	`AggregatedListInstancesRequest`

Properties

Filter

public string Filter { get; set; }

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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. 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 = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)

Property Value
Type	Description
`String`

HasFilter

public bool HasFilter { get; }

Gets whether the "filter" field is set

Property Value
Type	Description
`Boolean`

HasIncludeAllScopes

public bool HasIncludeAllScopes { get; }

Gets whether the "include_all_scopes" field is set

Property Value
Type	Description
`Boolean`

HasMaxResults

public bool HasMaxResults { get; }

Gets whether the "max_results" field is set

Property Value
Type	Description
`Boolean`

HasOrderBy

public bool HasOrderBy { get; }

Gets whether the "order_by" field is set

Property Value
Type	Description
`Boolean`

HasPageToken

public bool HasPageToken { get; }

Gets whether the "page_token" field is set

Property Value
Type	Description
`Boolean`

HasReturnPartialSuccess

public bool HasReturnPartialSuccess { get; }

Gets whether the "return_partial_success" field is set

Property Value
Type	Description
`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
Type	Description
`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
Type	Description
`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="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.

Property Value
Type	Description
`String`

PageSize

public int PageSize { get; set; }

Property Value
Type	Description
`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
Type	Description
`String`

Project

public string Project { get; set; }

Project ID for this request.

Property Value
Type	Description
`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
Type	Description
`Boolean`