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.



4442
4443
4444
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4442

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:



4391
4392
4393
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4391

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) 


4397
4398
4399
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4397

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) 


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

def bot_name
  @bot_name
end

#description ⇒ String

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

Returns:

  • (String) 


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

def description
  @description
end

#developer_name ⇒ String

Name of bot developer. Corresponds to the JSON property developerName

Returns:

  • (String) 


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

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) 


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

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) 


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

def status
  @status
end

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

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

Returns:



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

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


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

def supported_uses
  @supported_uses
end

#whitelist_status ⇒ String

Corresponds to the JSON property whitelistStatus

Returns:

  • (String) 


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

def whitelist_status
  @whitelist_status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4447

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