public sealed class ListControlsRequest : IMessage<ListControlsRequest>, IEquatable<ListControlsRequest>, IDeepCloneable<ListControlsRequest>, IBufferMessage, IMessage, IPageRequest
Reference documentation and code samples for the Retail v2 API class ListControlsRequest.
Request for ListControls method.
Implements
IMessage<ListControlsRequest>, IEquatable<ListControlsRequest>, IDeepCloneable<ListControlsRequest>, IBufferMessage, IMessage, IPageRequestNamespace
Google.Cloud.Retail.V2Assembly
Google.Cloud.Retail.V2.dll
Constructors
ListControlsRequest()
public ListControlsRequest()
ListControlsRequest(ListControlsRequest)
public ListControlsRequest(ListControlsRequest other)
Parameter | |
---|---|
Name | Description |
other | ListControlsRequest |
Properties
Filter
public string Filter { get; set; }
Optional. A filter to apply on the list results. Supported features:
- List all the products under the parent branch if [filter][google.cloud.retail.v2.ListControlsRequest.filter] is unset.
- List controls that are used in a single ServingConfig: 'serving_config = "boosted_home_page_cvr"'
Property Value | |
---|---|
Type | Description |
String |
PageSize
public int PageSize { get; set; }
Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
Property Value | |
---|---|
Type | Description |
Int32 |
PageToken
public string PageToken { get; set; }
Optional. A page token, received from a previous ListControls
call.
Provide this to retrieve the subsequent page.
Property Value | |
---|---|
Type | Description |
String |
Parent
public string Parent { get; set; }
Required. The catalog resource name. Format:
projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
Property Value | |
---|---|
Type | Description |
String |
ParentAsCatalogName
public CatalogName ParentAsCatalogName { get; set; }
CatalogName-typed view over the Parent resource name property.
Property Value | |
---|---|
Type | Description |
CatalogName |