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
System.Object > ListCatalogsRequestImplements
Google.Protobuf.IMessage<ListCatalogsRequest>, System.IEquatable<ListCatalogsRequest>, Google.Protobuf.IDeepCloneable<ListCatalogsRequest>, Google.Protobuf.IBufferMessage, Google.Protobuf.IMessage, Google.Api.Gax.Grpc.IPageRequestNamespace
Google.Cloud.Retail.V2Assembly
Google.Cloud.Retail.V2.dll
Constructors
ListCatalogsRequest()
public ListCatalogsRequest()
ListCatalogsRequest(ListCatalogsRequest)
public ListCatalogsRequest(ListCatalogsRequest other)
Parameter | |
---|---|
Name | Description |
other | ListCatalogsRequest |
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 | |
---|---|
Type | Description |
System.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 | |
---|---|
Type | Description |
System.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 | |
---|---|
Type | Description |
System.String |
ParentAsLocationName
public LocationName ParentAsLocationName { get; set; }
Google.Api.Gax.ResourceNames.LocationName-typed view over the Parent resource name property.
Property Value | |
---|---|
Type | Description |
Google.Api.Gax.ResourceNames.LocationName |