Service Consumer Management API . services

Instance Methods

tenancyUnits()

Returns the tenancyUnits Resource.

close()

Close httplib2 connections.

search(parent, pageSize=None, pageToken=None, query=None, x__xgafv=None)

Search tenancy units for a managed service.

search_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
search(parent, pageSize=None, pageToken=None, query=None, x__xgafv=None)
Search tenancy units for a managed service.

Args:
  parent: string, Required. Service for which search is performed. services/{service} {service} the name of a service, for example 'service.googleapis.com'. (required)
  pageSize: integer, Optional. The maximum number of results returned by this request. Currently, the default maximum is set to 1000. If `page_size` isn't provided or the size provided is a number larger than 1000, it's automatically set to 1000.
  pageToken: string, Optional. The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of `nextPageToken` from the previous response.
  query: string, Optional. Set a query `{expression}` for querying tenancy units. Your `{expression}` must be in the format: `field_name=literal_string`. The `field_name` is the name of the field you want to compare. Supported fields are `tenant_resources.tag` and `tenant_resources.resource`. For example, to search tenancy units that contain at least one tenant resource with a given tag 'xyz', use the query `tenant_resources.tag=xyz`. To search tenancy units that contain at least one tenant resource with a given resource name 'projects/123456', use the query `tenant_resources.resource=projects/123456`. Multiple expressions can be joined with `AND`s. Tenancy units must match all expressions to be included in the result set. For example, `tenant_resources.tag=xyz AND tenant_resources.resource=projects/123456`
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for the search query.
  "nextPageToken": "A String", # Pagination token for large results.
  "tenancyUnits": [ # Tenancy Units matching the request.
    { # Representation of a tenancy unit.
      "consumer": "A String", # Output only. @OutputOnly Cloud resource name of the consumer of this service. For example 'projects/123456'.
      "createTime": "A String", # Output only. @OutputOnly The time this tenancy unit was created.
      "name": "A String", # Globally unique identifier of this tenancy unit "services/{service}/{collection id}/{resource id}/tenancyUnits/{unit}"
      "service": "A String", # Output only. Google Cloud API name of the managed service owning this tenancy unit. For example 'serviceconsumermanagement.googleapis.com'.
      "tenantResources": [ # Resources constituting the tenancy unit. There can be at most 512 tenant resources in a tenancy unit.
        { # Resource constituting the TenancyUnit.
          "resource": "A String", # Output only. @OutputOnly Identifier of the tenant resource. For cloud projects, it is in the form 'projects/{number}'. For example 'projects/123456'.
          "status": "A String", # Status of tenant resource.
          "tag": "A String", # Unique per single tenancy unit.
        },
      ],
    },
  ],
}
search_next()
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.