Class ProjectsResource.LocationsResource.CapacityAllocationsResource.ListRequest
Lists CapacityAllocation resources in a given project and location.
Inheritance
Inherited Members
Namespace: Google.Apis.VMwareEngine.v1
Assembly: Google.Apis.VMwareEngine.v1.dll
Syntax
public class ProjectsResource.LocationsResource.CapacityAllocationsResource.ListRequest : VMwareEngineBaseServiceRequest<ListCapacityAllocationsResponse>, IClientServiceRequest<ListCapacityAllocationsResponse>, IClientServiceRequest
Constructors
ListRequest(IClientService, string)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, string parent)
Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service | |
| string | parent |
Properties
Filter
Optional. A filter expression that matches resources returned 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 or a number. The comparison operator must be =, !=,
>, >=, <, or <=. The has operator : is also supported.
Supported fields include name, display_name (or placement_group), machine_family,
allocated_capacity_count, consumed_capacity_count, and connected_placement_group (using
=). For example, if you are filtering a list of capacity allocations, you can exclude the ones
named example-capacity-allocation by specifying name != "example-capacity-allocation". You
can also filter on other fields, such as machine family ("ve1", "ve2", or "ve3") or
connected placement group:
machine_family = "ve1" connected_placement_group =
"example-placement-group"
To filter on multiple expressions, provide each separate expression within parentheses. For example:
(machine_family = "ve1")
(allocated_capacity_count > 10)
By default, each expression is an AND expression.
However, you can include AND, OR, and NOT expressions explicitly. For example:
((machine_family = "ve1") AND (allocated_capacity_count > 10)) OR
(consumed_capacity_count > 0)
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
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
| Type | Description |
|---|---|
| string |
Overrides
OrderBy
Optional. Sorts list results by a certain order. By default, returned results are ordered by
name in ascending order. You can also sort results in descending order based on the name
value using orderBy="name desc". Currently, only ordering by name is supported.
Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual string OrderBy { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
PageSize
Optional. The maximum number of capacity allocations to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
| Type | Description |
|---|---|
| int? |
PageToken
Optional. A page token, received from a previous ListCapacityAllocations call. Provide this to
retrieve the subsequent page. When paginating, all other parameters provided to
ListCapacityAllocations must match the call that provided the page token.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Parent
Required. The resource name of the location to query for capacity allocations. Resource names
are schemeless URIs that follow the conventions in
https://cloud.google.com/apis/design/resource_names. For example:
projects/my-project/locations/us-central1-a
Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
| Type | Description |
|---|---|
| string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
| Type | Description |
|---|---|
| string |
Overrides
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()