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.



5263
5264
5265
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5263

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

Instance Attribute Details

#app_allowlist_status ⇒ String

Corresponds to the JSON property appAllowlistStatus

Returns:

  • (String) 


5201
5202
5203
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5201

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:



5206
5207
5208
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5206

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) 


5212
5213
5214
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5212

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) 


5218
5219
5220
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5218

def bot_name
  @bot_name
end

#description ⇒ String

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

Returns:

  • (String) 


5223
5224
5225
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5223

def description
  @description
end

#developer_name ⇒ String

Name of bot developer. Corresponds to the JSON property developerName

Returns:

  • (String) 


5228
5229
5230
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5228

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) 


5233
5234
5235
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5233

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) 


5238
5239
5240
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5238

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) 


5243
5244
5245
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5243

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:



5249
5250
5251
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5249

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>) 


5256
5257
5258
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5256

def supported_uses
  @supported_uses
end

#uninstall_capability ⇒ String

Determine how uninstall is permitted for this app. Corresponds to the JSON property uninstallCapability

Returns:

  • (String) 


5261
5262
5263
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5261

def uninstall_capability
  @uninstall_capability
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5268

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)
  @uninstall_capability = args[:uninstall_capability] if args.key?(:uninstall_capability)
end