/AWS1/CL_QQBGETPLUGINRESPONSE¶
GetPluginResponse
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_applicationid TYPE /AWS1/QQBAPPLICATIONID /AWS1/QQBAPPLICATIONID¶
The identifier of the application which contains the plugin.
iv_pluginid TYPE /AWS1/QQBPLUGINID /AWS1/QQBPLUGINID¶
The identifier of the plugin.
iv_displayname TYPE /AWS1/QQBPLUGINNAME /AWS1/QQBPLUGINNAME¶
The name of the plugin.
iv_type TYPE /AWS1/QQBPLUGINTYPE /AWS1/QQBPLUGINTYPE¶
The type of the plugin.
iv_serverurl TYPE /AWS1/QQBURL /AWS1/QQBURL¶
The source URL used for plugin configuration.
io_authconfiguration TYPE REF TO /AWS1/CL_QQBPLUGINAUTHCONF /AWS1/CL_QQBPLUGINAUTHCONF¶
Authentication configuration information for an Amazon Q Business plugin.
io_custompluginconfiguration TYPE REF TO /AWS1/CL_QQBCUSTOMPLUGINCONF /AWS1/CL_QQBCUSTOMPLUGINCONF¶
Configuration information required to create a custom plugin.
iv_buildstatus TYPE /AWS1/QQBPLUGINBUILDSTATUS /AWS1/QQBPLUGINBUILDSTATUS¶
The current status of a plugin. A plugin is modified asynchronously.
iv_pluginarn TYPE /AWS1/QQBPLUGINARN /AWS1/QQBPLUGINARN¶
The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.
iv_state TYPE /AWS1/QQBPLUGINSTATE /AWS1/QQBPLUGINSTATE¶
The current state of the plugin.
iv_createdat TYPE /AWS1/QQBTIMESTAMP /AWS1/QQBTIMESTAMP¶
The timestamp for when the plugin was created.
iv_updatedat TYPE /AWS1/QQBTIMESTAMP /AWS1/QQBTIMESTAMP¶
The timestamp for when the plugin was last updated.
Queryable Attributes¶
applicationId¶
The identifier of the application which contains the plugin.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APPLICATIONID() |
Getter for APPLICATIONID, with configurable default |
ASK_APPLICATIONID() |
Getter for APPLICATIONID w/ exceptions if field has no value |
HAS_APPLICATIONID() |
Determine if APPLICATIONID has a value |
pluginId¶
The identifier of the plugin.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PLUGINID() |
Getter for PLUGINID, with configurable default |
ASK_PLUGINID() |
Getter for PLUGINID w/ exceptions if field has no value |
HAS_PLUGINID() |
Determine if PLUGINID has a value |
displayName¶
The name of the plugin.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DISPLAYNAME() |
Getter for DISPLAYNAME, with configurable default |
ASK_DISPLAYNAME() |
Getter for DISPLAYNAME w/ exceptions if field has no value |
HAS_DISPLAYNAME() |
Determine if DISPLAYNAME has a value |
type¶
The type of the plugin.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TYPE() |
Getter for TYPE, with configurable default |
ASK_TYPE() |
Getter for TYPE w/ exceptions if field has no value |
HAS_TYPE() |
Determine if TYPE has a value |
serverUrl¶
The source URL used for plugin configuration.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SERVERURL() |
Getter for SERVERURL, with configurable default |
ASK_SERVERURL() |
Getter for SERVERURL w/ exceptions if field has no value |
HAS_SERVERURL() |
Determine if SERVERURL has a value |
authConfiguration¶
Authentication configuration information for an Amazon Q Business plugin.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUTHCONFIGURATION() |
Getter for AUTHCONFIGURATION |
customPluginConfiguration¶
Configuration information required to create a custom plugin.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CUSTOMPLUGINCONF() |
Getter for CUSTOMPLUGINCONFIGURATION |
buildStatus¶
The current status of a plugin. A plugin is modified asynchronously.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BUILDSTATUS() |
Getter for BUILDSTATUS, with configurable default |
ASK_BUILDSTATUS() |
Getter for BUILDSTATUS w/ exceptions if field has no value |
HAS_BUILDSTATUS() |
Determine if BUILDSTATUS has a value |
pluginArn¶
The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PLUGINARN() |
Getter for PLUGINARN, with configurable default |
ASK_PLUGINARN() |
Getter for PLUGINARN w/ exceptions if field has no value |
HAS_PLUGINARN() |
Determine if PLUGINARN has a value |
state¶
The current state of the plugin.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATE() |
Getter for STATE, with configurable default |
ASK_STATE() |
Getter for STATE w/ exceptions if field has no value |
HAS_STATE() |
Determine if STATE has a value |
createdAt¶
The timestamp for when the plugin was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDAT() |
Getter for CREATEDAT, with configurable default |
ASK_CREATEDAT() |
Getter for CREATEDAT w/ exceptions if field has no value |
HAS_CREATEDAT() |
Determine if CREATEDAT has a value |
updatedAt¶
The timestamp for when the plugin was last updated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_UPDATEDAT() |
Getter for UPDATEDAT, with configurable default |
ASK_UPDATEDAT() |
Getter for UPDATEDAT w/ exceptions if field has no value |
HAS_UPDATEDAT() |
Determine if UPDATEDAT has a value |