Class ListCatalogsRequest (1.3.0)

public sealed class ListCatalogsRequest : IMessage<ListCatalogsRequest>, IEquatable<ListCatalogsRequest>, IDeepCloneable<ListCatalogsRequest>, IBufferMessage, IMessage, IPageRequest

Request for [CatalogService.ListCatalogs][google.cloud.retail.v2.CatalogService.ListCatalogs] method.

Inheritance

Object > ListCatalogsRequest

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

ListCatalogsRequest()

public ListCatalogsRequest()

ListCatalogsRequest(ListCatalogsRequest)

public ListCatalogsRequest(ListCatalogsRequest other)
Parameter
NameDescription
otherListCatalogsRequest

Properties

PageSize

public int PageSize { get; set; }

Maximum number of [Catalog][google.cloud.retail.v2.Catalog]s to return. If unspecified, defaults to 50. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.

If this field is negative, an INVALID_ARGUMENT is returned.

Property Value
TypeDescription
Int32

PageToken

public string PageToken { get; set; }

A page token [ListCatalogsResponse.next_page_token][google.cloud.retail.v2.ListCatalogsResponse.next_page_token], received from a previous [CatalogService.ListCatalogs][google.cloud.retail.v2.CatalogService.ListCatalogs] call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to [CatalogService.ListCatalogs][google.cloud.retail.v2.CatalogService.ListCatalogs] must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

Property Value
TypeDescription
String

Parent

public string Parent { get; set; }

Required. The account resource name with an associated location.

If the caller does not have permission to list [Catalog][google.cloud.retail.v2.Catalog]s under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.

Property Value
TypeDescription
String

ParentAsLocationName

public LocationName ParentAsLocationName { get; set; }

LocationName-typed view over the Parent resource name property.

Property Value
TypeDescription
LocationName