Retail v2 API - Class ListControlsRequest (2.4.0)

Stay organized with collections Save and categorize content based on your preferences.
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.

Inheritance

Object > ListControlsRequest

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

ListControlsRequest()

public ListControlsRequest()

ListControlsRequest(ListControlsRequest)

public ListControlsRequest(ListControlsRequest other)
Parameter
NameDescription
otherListControlsRequest

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
TypeDescription
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
TypeDescription
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
TypeDescription
String

Parent

public string Parent { get; set; }

Required. The catalog resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}

Property Value
TypeDescription
String

ParentAsCatalogName

public CatalogName ParentAsCatalogName { get; set; }

CatalogName-typed view over the Parent resource name property.

Property Value
TypeDescription
CatalogName