Reference documentation and code samples for the Google Cloud Retail V2 Client class ListCatalogsRequest.
Request for CatalogService.ListCatalogs method.
Generated from protobuf message google.cloud.retail.v2.ListCatalogsRequest
Namespace
Google \ Cloud \ Retail \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The account resource name with an associated location. If the caller does not have permission to list Catalog s under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.
↳ page_size
int
Maximum number of 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.
↳ page_token
string
A page token ListCatalogsResponse.next_page_token , received from a previous CatalogService.ListCatalogs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CatalogService.ListCatalogs must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
getParent
Required. The account resource name with an associated location.
If the caller does not have permission to list Catalog s under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.
string
setParent
Required. The account resource name with an associated location.
If the caller does not have permission to list Catalog s under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.
var
string
$this
getPageSize
Maximum number of 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.
int
setPageSize
Maximum number of 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.
var
int
$this
getPageToken
A page token ListCatalogsResponse.next_page_token , received from a previous CatalogService.ListCatalogs call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to CatalogService.ListCatalogs must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
string
setPageToken
A page token ListCatalogsResponse.next_page_token , received from a previous CatalogService.ListCatalogs call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to CatalogService.ListCatalogs must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
var
string
$this
static::build
parent
string
Required. The account resource name with an associated location.
If the caller does not have permission to list Catalog s under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned. Please see Google\Cloud\Retail\V2\CatalogServiceClient::locationName() for help formatting this field.
