Class RegionMultiMigsResource.ListRequest
Retrieves a list of MultiMIGs in a project and region.
Inheritance
Inherited Members
Namespace: Google.Apis.Compute.alpha
Assembly: Google.Apis.Compute.alpha.dll
Syntax
public class RegionMultiMigsResource.ListRequest : ComputeBaseServiceRequest<MultiMigsList>, IClientServiceRequest<MultiMigsList>, IClientServiceRequest
Constructors
ListRequest(IClientService, string, string)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, string project, string region)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
string | project | |
string | region |
Properties
Filter
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. These two types of filter expressions cannot be mixed in one request.
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 :*
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 = "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)
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 'single quoted literal'
fieldname eq "double quoted literal"
(fieldname1 eq literal) (fieldname2 ne "literal")
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
. You cannot combine constraints on multiple fields
using regular expressions.
Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type | Description |
---|---|
string |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
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 |
---|---|
long? |
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
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 |
---|---|
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 |
---|---|
string |
Project
Project ID for this request.
Declaration
[RequestParameter("project", RequestParameterType.Path)]
public virtual string Project { get; }
Property Value
Type | Description |
---|---|
string |
Region
Name of the region for this request.
Declaration
[RequestParameter("region", RequestParameterType.Path)]
public virtual string Region { get; }
Property Value
Type | Description |
---|---|
string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
ReturnPartialSuccess
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
Declaration
[RequestParameter("returnPartialSuccess", RequestParameterType.Query)]
public virtual bool? ReturnPartialSuccess { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()