AgentLaunch

  • Agent launch details include the launch identifier and type of agent being launched, such as a Business Messages agent.

  • Business Messages agent launch details specify launch information for each supported entry point.

  • Launch information for each entry point includes the entry point type, its launch state, and optionally, a list of region codes for non-local launches.

Details about an agent launch.

JSON representation 
{
  "name": string,

  // Union field launch_detail can be only one of the following:
  "businessMessages": {
    object (BusinessMessagesLaunch)
  }
  // End of list of possible types for union field launch_detail.
}
Fields
name

string

Required. The identifier for launch.
Union field launch_detail. Allows launch based on agent type. launch_detail can be only one of the following:
businessMessages

object (BusinessMessagesLaunch)

Launch details for a Business Messages agent.

BusinessMessagesLaunch

Details about a Business Messages agent launch.

JSON representation 
{
  "launchDetails": {
    string: {
      object (BusinessMessagesEntryPointLaunch)
    },
    ...
  }
}
Fields
launchDetails

map (key: string, value: object (BusinessMessagesEntryPointLaunch))

Required. Launch details for each supported entry point. Key represented by BusinessMessagesEntryPointConfig.EntryPoint

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

BusinessMessagesEntryPointLaunch

Details about Business Messages agent launch for each entry point.

JSON representation 
{
  "entryPoint": enum (EntryPoint),
  "launchState": enum (LaunchState),
  "regionCodes": [
    string
  ]
}
Fields
entryPoint

enum (EntryPoint)

Entry point for which launch information is provided.
launchState

enum (LaunchState)

The launch state for entry point.
regionCodes[]

string

List of CLDR region codes for countries where the agent should launch NON_LOCAL entry points. Required for NON_LOCAL entry points. This must be a subset of the region codes specified in the agent's nonLocalConfig.