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.



4459
4460
4461
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4459

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

Instance Attribute Details

#app_allowlist_status ⇒ String

Corresponds to the JSON property appAllowlistStatus

Returns:

  • (String) 


4402
4403
4404
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4402

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:



4407
4408
4409
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4407

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) 


4413
4414
4415
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4413

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) 


4419
4420
4421
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4419

def bot_name
  @bot_name
end

#description ⇒ String

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

Returns:

  • (String) 


4424
4425
4426
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4424

def description
  @description
end

#developer_name ⇒ String

Name of bot developer. Corresponds to the JSON property developerName

Returns:

  • (String) 


4429
4430
4431
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4429

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) 


4434
4435
4436
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4434

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) 


4439
4440
4441
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4439

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) 


4444
4445
4446
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4444

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:



4450
4451
4452
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4450

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


4457
4458
4459
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4457

def supported_uses
  @supported_uses
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4464

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