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.



4388
4389
4390
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4388

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

Instance Attribute Details

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

Identifier of an App. Corresponds to the JSON property appId

Returns:



4337
4338
4339
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4337

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) 


4343
4344
4345
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4343

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) 


4349
4350
4351
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4349

def bot_name
  @bot_name
end

#description ⇒ String

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

Returns:

  • (String) 


4354
4355
4356
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4354

def description
  @description
end

#developer_name ⇒ String

Name of bot developer. Corresponds to the JSON property developerName

Returns:

  • (String) 


4359
4360
4361
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4359

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) 


4364
4365
4366
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4364

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) 


4369
4370
4371
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4369

def status
  @status
end

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

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

Returns:



4374
4375
4376
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4374

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


4381
4382
4383
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4381

def supported_uses
  @supported_uses
end

#whitelist_status ⇒ String

Corresponds to the JSON property whitelistStatus

Returns:

  • (String) 


4386
4387
4388
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4386

def whitelist_status
  @whitelist_status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4393

def update!(**args)
  @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_urls = args[:support_urls] if args.key?(:support_urls)
  @supported_uses = args[:supported_uses] if args.key?(:supported_uses)
  @whitelist_status = args[:whitelist_status] if args.key?(:whitelist_status)
end