| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -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="cloudasset_v1p1beta1.html">Cloud Asset API</a> . <a href="cloudasset_v1p1beta1.resources.html">resources</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 78 | <code><a href="#searchAll">searchAll(scope, orderBy=None, pageToken=None, assetTypes=None, query=None, pageSize=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Searches all the resources within a given accessible CRM scope</p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 80 | <p class="toc_element"> |
| 81 | <code><a href="#searchAll_next">searchAll_next(previous_request, previous_response)</a></code></p> |
| 82 | <p class="firstline">Retrieves the next page of results.</p> |
| 83 | <h3>Method Details</h3> |
| 84 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 85 | <code class="details" id="searchAll">searchAll(scope, orderBy=None, pageToken=None, assetTypes=None, query=None, pageSize=None, x__xgafv=None)</code> |
| 86 | <pre>Searches all the resources within a given accessible CRM scope |
| 87 | (project/folder/organization). This RPC gives callers especially |
| 88 | administrators the ability to search all the resources within a scope, even |
| 89 | if they don't have `.get` permission of all the resources. Callers should |
| 90 | have `cloud.assets.SearchAllResources` permission on the requested scope, |
| 91 | otherwise the request will be rejected. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 92 | |
| 93 | Args: |
| 94 | scope: string, Required. The relative name of an asset. The search is limited to the resources |
| 95 | within the `scope`. The allowed value must be: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 96 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 97 | * Organization number (such as "organizations/123") |
| 98 | * Folder number(such as "folders/1234") |
| 99 | * Project number (such as "projects/12345") |
| 100 | * Project id (such as "projects/abc") (required) |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 101 | orderBy: string, Optional. A comma separated list of fields specifying the sorting order of the |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 102 | results. The default order is ascending. Add ` DESC` after the field name |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 103 | to indicate descending order. Redundant space characters are ignored. For |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 104 | example, ` location DESC , name `. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 105 | pageToken: string, Optional. If present, then retrieve the next batch of results from the preceding call |
| 106 | to this method. `page_token` must be the value of `next_page_token` from |
| 107 | the previous response. The values of all other method parameters, must be |
| 108 | identical to those in the previous call. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 109 | assetTypes: string, Optional. A list of asset types that this request searches for. If empty, it will |
| 110 | search all the supported asset types. (repeated) |
| 111 | query: string, Optional. The query statement. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 112 | pageSize: integer, Optional. The page size for search result pagination. Page size is capped at 500 even |
| 113 | if a larger value is given. If set to zero, server will pick an appropriate |
| 114 | default. Returned results may be fewer than requested. When this happens, |
| 115 | there could be more results as long as `next_page_token` is returned. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 116 | x__xgafv: string, V1 error format. |
| 117 | Allowed values |
| 118 | 1 - v1 error format |
| 119 | 2 - v2 error format |
| 120 | |
| 121 | Returns: |
| 122 | An object of the form: |
| 123 | |
| 124 | { # Search all resources response. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 125 | "results": [ # A list of resource that match the search query. |
| 126 | { # The standard metadata of a cloud resource. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 127 | "networkTags": [ # Network tags associated with this resource. Like labels, network tags are a |
| 128 | # type of annotations used to group GCP resources. See [Labelling GCP |
| 129 | # resources](lhttps://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources) |
| 130 | # for more information. |
| 131 | "A String", |
| 132 | ], |
| 133 | "description": "A String", # One or more paragraphs of text description of this resource. Maximum length |
| 134 | # could be up to 1M bytes. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 135 | "additionalAttributes": [ # Additional searchable attributes of this resource. |
| 136 | # Informational only. The exact set of attributes is subject to change. |
| 137 | # For example: project id, DNS name etc. |
| 138 | "A String", |
| 139 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 140 | "project": "A String", # The project that this resource belongs to, in the form of |
| 141 | # `projects/{project_number}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 142 | "displayName": "A String", # The display name of this resource. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 143 | "labels": { # Labels associated with this resource. See [Labelling and grouping GCP |
| 144 | # resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources) |
| 145 | # for more information. |
| 146 | "a_key": "A String", |
| 147 | }, |
| 148 | "name": "A String", # The full resource name. For example: |
| 149 | # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. |
| 150 | # See [Resource |
| 151 | # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) |
| 152 | # for more information. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 153 | "location": "A String", # Location can be "global", regional like "us-east1", or zonal like |
| 154 | # "us-west1-b". |
| 155 | "assetType": "A String", # The type of this resource. |
| 156 | # For example: "compute.googleapis.com/Disk". |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 157 | }, |
| 158 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 159 | "nextPageToken": "A String", # If there are more results than those appearing in this response, then |
| 160 | # `next_page_token` is included. To get the next set of results, call this |
| 161 | # method again using the value of `next_page_token` as `page_token`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 162 | }</pre> |
| 163 | </div> |
| 164 | |
| 165 | <div class="method"> |
| 166 | <code class="details" id="searchAll_next">searchAll_next(previous_request, previous_response)</code> |
| 167 | <pre>Retrieves the next page of results. |
| 168 | |
| 169 | Args: |
| 170 | previous_request: The request for the previous page. (required) |
| 171 | previous_response: The response from the request for the previous page. (required) |
| 172 | |
| 173 | Returns: |
| 174 | A request object that you can call 'execute()' on to request the next |
| 175 | page. Returns None if there are no more items in the collection. |
| 176 | </pre> |
| 177 | </div> |
| 178 | |
| 179 | </body></html> |