Class: Google::Apis::CloudsearchV1::BotInfo

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

Overview

Bot-specific profile information.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BotInfo

Returns a new instance of BotInfo.



4919
4920
4921
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4919

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

Instance Attribute Details

#app_allowlist_status ⇒ String

Corresponds to the JSON property appAllowlistStatus

Returns:

  • (String) 


4862
4863
4864
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4862

def app_allowlist_status
  @app_allowlist_status
end

#app_id ⇒ Google::Apis::CloudsearchV1::AppId

Identifier of an App. Corresponds to the JSON property appId

Returns:



4867
4868
4869
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4867

def app_id
  @app_id
end

#bot_avatar_url ⇒ String

URL for the avatar picture of the User in dynamite. This field should be populated if the request is FetchBotCategories/ListBotCatalogEntries Corresponds to the JSON property botAvatarUrl

Returns:

  • (String) 


4873
4874
4875
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4873

def bot_avatar_url
  @bot_avatar_url
end

#bot_name ⇒ String

Non-unique, user-defined display name of the Bot. This field should be populated if the request is FetchBotCategories/ListBotCatalogEntries. Corresponds to the JSON property botName

Returns:

  • (String) 


4879
4880
4881
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4879

def bot_name
  @bot_name
end

#description ⇒ String

Short description for the bot. Corresponds to the JSON property description

Returns:

  • (String) 


4884
4885
4886
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4884

def description
  @description
end

#developer_name ⇒ String

Name of bot developer. Corresponds to the JSON property developerName

Returns:

  • (String) 


4889
4890
4891
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4889

def developer_name
  @developer_name
end

#market_place_banner_url ⇒ String

URL for the banner image in GSuite Market Place. The banner will be 220x140. Corresponds to the JSON property marketPlaceBannerUrl

Returns:

  • (String) 


4894
4895
4896
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4894

def market_place_banner_url
  @market_place_banner_url
end

#status ⇒ String

Indicates whether bot is enabled/disabled. Corresponds to the JSON property status

Returns:

  • (String) 


4899
4900
4901
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4899

def status
  @status
end

#support_home_screen ⇒ Boolean Also known as: support_home_screen?

If the app supports a home screen. Corresponds to the JSON property supportHomeScreen

Returns:

  • (Boolean) 


4904
4905
4906
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4904

def support_home_screen
  @support_home_screen
end

#support_urls ⇒ Google::Apis::CloudsearchV1::SupportUrls

Urls with additional bot related information. Corresponds to the JSON property supportUrls

Returns:



4910
4911
4912
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4910

def support_urls
  @support_urls
end

#supported_uses ⇒ Array<String>

The supported uses are limited according to the user that made the request. If the user does not have permission to use the bot, the list will be empty. This could occur for non whitelisted bots in the catalog. Corresponds to the JSON property supportedUses

Returns:

  • (Array<String>) 


4917
4918
4919
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4917

def supported_uses
  @supported_uses
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4924

def update!(**args)
  @app_allowlist_status = args[:app_allowlist_status] if args.key?(:app_allowlist_status)
  @app_id = args[:app_id] if args.key?(:app_id)
  @bot_avatar_url = args[:bot_avatar_url] if args.key?(:bot_avatar_url)
  @bot_name = args[:bot_name] if args.key?(:bot_name)
  @description = args[:description] if args.key?(:description)
  @developer_name = args[:developer_name] if args.key?(:developer_name)
  @market_place_banner_url = args[:market_place_banner_url] if args.key?(:market_place_banner_url)
  @status = args[:status] if args.key?(:status)
  @support_home_screen = args[:support_home_screen] if args.key?(:support_home_screen)
  @support_urls = args[:support_urls] if args.key?(:support_urls)
  @supported_uses = args[:supported_uses] if args.key?(:supported_uses)
end