Retail V2 API - Class Google::Cloud::Retail::V2::ListProductsRequest (v0.14.0)

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

Request message for ProductService.ListProducts method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns

#filter=

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

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — Maximum number of Products to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.

    If this field is negative, an INVALID_ARGUMENT error is returned.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — Maximum number of Products to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.

    If this field is negative, an INVALID_ARGUMENT error is returned.

Returns
  • (::Integer) — Maximum number of Products to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.

    If this field is negative, an INVALID_ARGUMENT error 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 parent branch resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/0. Use default_branch as the branch ID, to list products under the default branch.

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

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The parent branch resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/0. Use default_branch as the branch ID, to list products under the default branch.

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

Returns
  • (::String) — Required. The parent branch resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/0. Use default_branch as the branch ID, to list products under the default branch.

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

#read_mask

def read_mask() -> ::Google::Protobuf::FieldMask
Returns

#read_mask=

def read_mask=(value) -> ::Google::Protobuf::FieldMask
Parameter
Returns