| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame^] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="serviceconsumermanagement_v1.html">Service Consumer Management API</a> . <a href="serviceconsumermanagement_v1.services.html">services</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="serviceconsumermanagement_v1.services.tenancyUnits.html">tenancyUnits()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the tenancyUnits Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| 83 | <code><a href="#search">search(parent, pageToken=None, x__xgafv=None, query=None, pageSize=None)</a></code></p> |
| 84 | <p class="firstline">Search tenancy units for a managed service.</p> |
| 85 | <p class="toc_element"> |
| 86 | <code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p> |
| 87 | <p class="firstline">Retrieves the next page of results.</p> |
| 88 | <h3>Method Details</h3> |
| 89 | <div class="method"> |
| 90 | <code class="details" id="search">search(parent, pageToken=None, x__xgafv=None, query=None, pageSize=None)</code> |
| 91 | <pre>Search tenancy units for a managed service. |
| 92 | |
| 93 | Args: |
| 94 | parent: string, Service for which search is performed. |
| 95 | services/{service} |
| 96 | {service} the name of a service, for example 'service.googleapis.com'. (required) |
| 97 | pageToken: string, The continuation token, which is used to page through large result sets. |
| 98 | To get the next page of results, set this parameter to the value of |
| 99 | `nextPageToken` from the previous response. |
| 100 | |
| 101 | Optional. |
| 102 | x__xgafv: string, V1 error format. |
| 103 | Allowed values |
| 104 | 1 - v1 error format |
| 105 | 2 - v2 error format |
| 106 | query: string, Set a query `{expression}` for querying tenancy units. Your `{expression}` |
| 107 | must be in the format: `field_name=literal_string`. The `field_name` is the |
| 108 | name of the field you want to compare. Supported fields are |
| 109 | `tenant_resources.tag` and `tenant_resources.resource`. |
| 110 | |
| 111 | For example, to search tenancy units that contain at least one tenant |
| 112 | resource with a given tag 'xyz', use the query `tenant_resources.tag=xyz`. |
| 113 | To search tenancy units that contain at least one tenant resource with |
| 114 | a given resource name 'projects/123456', use the query |
| 115 | `tenant_resources.resource=projects/123456`. |
| 116 | |
| 117 | Multiple expressions can be joined with `AND`s. Tenancy units must match |
| 118 | all expressions to be included in the result set. For example, |
| 119 | `tenant_resources.tag=xyz AND tenant_resources.resource=projects/123456` |
| 120 | |
| 121 | Optional. |
| 122 | pageSize: integer, The maximum number of results returned by this request. Currently, the |
| 123 | default maximum is set to 1000. If `page_size` isn't provided or the size |
| 124 | provided is a number larger than 1000, it's automatically set to 1000. |
| 125 | |
| 126 | Optional. |
| 127 | |
| 128 | Returns: |
| 129 | An object of the form: |
| 130 | |
| 131 | { # Response for the search query. |
| 132 | "nextPageToken": "A String", # Pagination token for large results. |
| 133 | "tenancyUnits": [ # Tenancy Units matching the request. |
| 134 | { # Representation of a tenancy unit. |
| 135 | "tenantResources": [ # Resources constituting the tenancy unit. |
| 136 | # There can be at most 512 tenant resources in a tenancy unit. |
| 137 | { # Resource constituting the TenancyUnit. |
| 138 | "status": "A String", # Status of tenant resource. |
| 139 | "tag": "A String", # Unique per single tenancy unit. |
| 140 | "resource": "A String", # @OutputOnly Identifier of the tenant resource. |
| 141 | # For cloud projects, it is in the form 'projects/{number}'. |
| 142 | # For example 'projects/123456'. |
| 143 | }, |
| 144 | ], |
| 145 | "consumer": "A String", # @OutputOnly Cloud resource name of the consumer of this service. |
| 146 | # For example 'projects/123456'. |
| 147 | "createTime": "A String", # @OutputOnly The time this tenancy unit was created. |
| 148 | "service": "A String", # Output only. Google Cloud API name of the managed service owning this |
| 149 | # tenancy unit. |
| 150 | # For example 'serviceconsumermanagement.googleapis.com'. |
| 151 | "name": "A String", # Globally unique identifier of this tenancy unit |
| 152 | # "services/{service}/{collection id}/{resource id}/tenancyUnits/{unit}" |
| 153 | }, |
| 154 | ], |
| 155 | }</pre> |
| 156 | </div> |
| 157 | |
| 158 | <div class="method"> |
| 159 | <code class="details" id="search_next">search_next(previous_request, previous_response)</code> |
| 160 | <pre>Retrieves the next page of results. |
| 161 | |
| 162 | Args: |
| 163 | previous_request: The request for the previous page. (required) |
| 164 | previous_response: The response from the request for the previous page. (required) |
| 165 | |
| 166 | Returns: |
| 167 | A request object that you can call 'execute()' on to request the next |
| 168 | page. Returns None if there are no more items in the collection. |
| 169 | </pre> |
| 170 | </div> |
| 171 | |
| 172 | </body></html> |