Class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListProductsResponse

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/retail_v2alpha/classes.rb,
lib/google/apis/retail_v2alpha/representations.rb,
lib/google/apis/retail_v2alpha/representations.rb

Overview

Response message for ProductService.ListProducts method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2alphaListProductsResponse

Returns a new instance of GoogleCloudRetailV2alphaListProductsResponse.



3323
3324
3325
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3323

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#next_page_tokenString

A token that can be sent as ListProductsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. Corresponds to the JSON property nextPageToken

Returns:

  • (String)


3308
3309
3310
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3308

def next_page_token
  @next_page_token
end

#productsArray<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct>

The Products. Corresponds to the JSON property products



3313
3314
3315
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3313

def products
  @products
end

#total_sizeFixnum

The total count of matched Products irrespective of pagination. The total number of Products returned by pagination may be less than the total_size that matches. This field is ignored if ListProductsRequest.require_total_size is not set or ListProductsRequest.page_token is not empty. Corresponds to the JSON property totalSize

Returns:

  • (Fixnum)


3321
3322
3323
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3321

def total_size
  @total_size
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3328
3329
3330
3331
3332
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3328

def update!(**args)
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
  @products = args[:products] if args.key?(:products)
  @total_size = args[:total_size] if args.key?(:total_size)
end