Class: Google::Apis::PartnersV2::ListCompaniesResponse

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

Overview

Response message for ListCompanies.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ListCompaniesResponse

Returns a new instance of ListCompaniesResponse



1246
1247
1248
# File 'generated/google/apis/partners_v2/classes.rb', line 1246

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

Instance Attribute Details

#companiesArray<Google::Apis::PartnersV2::Company>

The list of companies. Corresponds to the JSON property companies



1230
1231
1232
# File 'generated/google/apis/partners_v2/classes.rb', line 1230

def companies
  @companies
end

#next_page_tokenString

A token to retrieve next page of results. Pass this value in the ListCompaniesRequest.page_token field in the subsequent call to ListCompanies to retrieve the next page of results. Corresponds to the JSON property nextPageToken

Returns:

  • (String)


1239
1240
1241
# File 'generated/google/apis/partners_v2/classes.rb', line 1239

def next_page_token
  @next_page_token
end

#response_metadataGoogle::Apis::PartnersV2::ResponseMetadata

Common data that is in each API response. Corresponds to the JSON property responseMetadata



1244
1245
1246
# File 'generated/google/apis/partners_v2/classes.rb', line 1244

def 
  @response_metadata
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1251
1252
1253
1254
1255
# File 'generated/google/apis/partners_v2/classes.rb', line 1251

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