VMware Engine API . projects . locations . capacityAllocations

close()

Close httplib2 connections.

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists `CapacityAllocation` resources in a given project and location.

Args:
  parent: string, 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` (required)
  filter: string, 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) ```
  orderBy: string, 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.
  pageSize: integer, 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.
  pageToken: string, 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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for VmwareEngine.ListCapacityAllocations
  "capacityAllocations": [ # A list of capacity allocations.
    { # Represents a capacity allocation. Capacity allocation is zonal.
      "allocatedCapacityCount": 42, # Output only. The allocated capacity for the capacity allocation.
      "consumedCapacityCount": 42, # Output only. The consumed capacity for the capacity allocation.
      "machineFamily": "A String", # Output only. The machine family of the capacity allocation.
      "name": "A String", # Output only. Identifier. The resource name of the capacity allocation. The last segment of the name is the placement group name. For example: `projects/my-project/locations/us-central1-a/capacityAllocations/pg-123`
      "privateClouds": [ # Output only. The private cloud names using the capacity allocation.
        "A String",
      ],
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "unreachable": [ # Unordered list. Locations that could not be reached when making an aggregated query using wildcards.
    "A String",
  ],
}

list_next(previous_request, previous_response)

Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.