1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="cloudprivatecatalog_v1beta1.html">Cloud Private Catalog API</a> . <a href="cloudprivatecatalog_v1beta1.folders.html">folders</a> . <a href="cloudprivatecatalog_v1beta1.folders.products.html">products</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#search">search(resource, pageSize=None, pageToken=None, query=None, x__xgafv=None)</a></code></p>
<p class="firstline">Search Product resources that consumers have access to, within the</p>
<p class="toc_element">
<code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="search">search(resource, pageSize=None, pageToken=None, query=None, x__xgafv=None)</code>
<pre>Search Product resources that consumers have access to, within the
scope of the consumer cloud resource hierarchy context.
Args:
resource: string, Required. The name of the resource context. See
SearchCatalogsRequest.resource for details. (required)
pageSize: integer, The maximum number of entries that are requested.
pageToken: string, A pagination token returned from a previous call to SearchProducts that
indicates where this listing should continue from.
This field is optional.
query: string, The query to filter the products.
The supported queries are:
* List products of all catalogs: empty
* List products under a catalog: `parent=catalogs/{catalog_id}`
* Get a product by name:
`name=catalogs/{catalog_id}/products/{product_id}`
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 PrivateCatalog.SearchProducts.
"nextPageToken": "A String", # A pagination token returned from a previous call to SearchProducts that
# indicates from where listing should continue.
# This field is optional.
"products": [ # The `Product` resources computed from the resource context.
{ # The readonly representation of a product computed with a given resource
# context.
"assetType": "A String", # Output only. The type of the product asset. It can be one of the
# following values:
#
# * `google.deploymentmanager.Template`
# * `google.cloudprivatecatalog.ListingOnly`
"updateTime": "A String", # Output only. The time when the product was last updated.
"name": "A String", # Output only. The resource name of the target product, in the format of
# `products/a-z*[a-z0-9]'.
#
# A unique identifier for the product under a catalog.
"displayMetadata": { # Output only. The display metadata to describe the product.
# The JSON schema of the metadata differs by Product.asset_type.
# When the type is `google.deploymentmanager.Template`, the schema is as
# follows:
#
# ```
# "$schema": http://json-schema.org/draft-04/schema#
# type: object
# properties:
# name:
# type: string
# minLength: 1
# maxLength: 64
# description:
# type: string
# minLength: 1
# maxLength: 2048
# tagline:
# type: string
# minLength: 1
# maxLength: 100
# support_info:
# type: string
# minLength: 1
# maxLength: 2048
# creator:
# type: string
# minLength: 1
# maxLength: 100
# documentation:
# type: array
# items:
# type: object
# properties:
# url:
# type: string
# pattern:
# "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
# title:
# type: string
# minLength: 1
# maxLength: 64
# description:
# type: string
# minLength: 1
# maxLength: 2048
# required:
# - name
# - description
# additionalProperties: false
#
# ```
#
# When the asset type is `google.cloudprivatecatalog.ListingOnly`, the schema
# is as follows:
#
# ```
# "$schema": http://json-schema.org/draft-04/schema#
# type: object
# properties:
# name:
# type: string
# minLength: 1
# maxLength: 64
# description:
# type: string
# minLength: 1
# maxLength: 2048
# tagline:
# type: string
# minLength: 1
# maxLength: 100
# support_info:
# type: string
# minLength: 1
# maxLength: 2048
# creator:
# type: string
# minLength: 1
# maxLength: 100
# documentation:
# type: array
# items:
# type: object
# properties:
# url:
# type: string
# pattern:
# "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
# title:
# type: string
# minLength: 1
# maxLength: 64
# description:
# type: string
# minLength: 1
# maxLength: 2048
# signup_url:
# type: string
# pattern:
# "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
# required:
# - name
# - description
# - signup_url
# additionalProperties: false
# ```
"a_key": "", # Properties of the object.
},
"iconUri": "A String", # Output only. The icon URI of the product.
"createTime": "A String", # Output only. The time when the product was created.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="search_next">search_next(previous_request, previous_response)</code>
<pre>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.
</pre>
</div>
</body></html>
|