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.



840
841
842
 
# File 'generated/google/apis/partners_v2/classes.rb', line 840

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

Instance Attribute Details

#companies ⇒ Array<Google::Apis::PartnersV2::Company>

The list of companies. Corresponds to the JSON property companies

Returns:



831
832
833
 
# File 'generated/google/apis/partners_v2/classes.rb', line 831

def companies
  @companies
end

#next_page_token ⇒ String

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) 


838
839
840
 
# File 'generated/google/apis/partners_v2/classes.rb', line 838

def next_page_token
  @next_page_token
end

#response_metadata ⇒ Google::Apis::PartnersV2::ResponseMetadata

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

Returns:



826
827
828
 
# File 'generated/google/apis/partners_v2/classes.rb', line 826

def response_metadata
  @response_metadata
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



845
846
847
848
849
 
# File 'generated/google/apis/partners_v2/classes.rb', line 845

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