Retail V2 API - Class Google::Cloud::Retail::V2::ListCatalogsRequest (v0.12.0)

Stay organized with collections Save and categorize content based on your preferences.

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::ListCatalogsRequest.

Request for CatalogService.ListCatalogs method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — Maximum number of Catalogs 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_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — Maximum number of Catalogs 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.

Returns
  • (::Integer) — Maximum number of Catalogs 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

def page_token() -> ::String
Returns

#page_token=

def page_token=(value) -> ::String
Parameter
Returns

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The account resource name with an associated location.

    If the caller does not have permission to list {::Google::Cloud::Retail::V2::Catalog Catalog}s under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The account resource name with an associated location.

    If the caller does not have permission to list {::Google::Cloud::Retail::V2::Catalog Catalog}s under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.

Returns
  • (::String) — Required. The account resource name with an associated location.

    If the caller does not have permission to list {::Google::Cloud::Retail::V2::Catalog Catalog}s under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.