Class Capabilities

java.lang.Object
software.amazon.awssdk.services.quicksight.model.Capabilities
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Capabilities.Builder,Capabilities>
@Generated("software.amazon.awssdk:codegen") public final class Capabilities extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Capabilities.Builder,Capabilities>

A set of actions that correspond to Amazon Quick Sight permissions.

See Also:

  • Method Details

    • exportToCsv

      public final CapabilityState exportToCsv()

      The ability to export to CSV files from the UI.

      If the service returns an enum value that is not available in the current SDK version, exportToCsv will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from exportToCsvAsString().

      Returns:
      The ability to export to CSV files from the UI.
      See Also:

    • exportToCsvAsString

      public final String exportToCsvAsString()

      The ability to export to CSV files from the UI.

      If the service returns an enum value that is not available in the current SDK version, exportToCsv will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from exportToCsvAsString().

      Returns:
      The ability to export to CSV files from the UI.
      See Also:

    • exportToExcel

      public final CapabilityState exportToExcel()

      The ability to export to Excel files from the UI.

      If the service returns an enum value that is not available in the current SDK version, exportToExcel will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from exportToExcelAsString().

      Returns:
      The ability to export to Excel files from the UI.
      See Also:

    • exportToExcelAsString

      public final String exportToExcelAsString()

      The ability to export to Excel files from the UI.

      If the service returns an enum value that is not available in the current SDK version, exportToExcel will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from exportToExcelAsString().

      Returns:
      The ability to export to Excel files from the UI.
      See Also:

    • exportToPdf

      public final CapabilityState exportToPdf()

      The ability to export to PDF files from the UI.

      If the service returns an enum value that is not available in the current SDK version, exportToPdf will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from exportToPdfAsString().

      Returns:
      The ability to export to PDF files from the UI.
      See Also:

    • exportToPdfAsString

      public final String exportToPdfAsString()

      The ability to export to PDF files from the UI.

      If the service returns an enum value that is not available in the current SDK version, exportToPdf will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from exportToPdfAsString().

      Returns:
      The ability to export to PDF files from the UI.
      See Also:

    • printReports

      public final CapabilityState printReports()

      The ability to print reports.

      If the service returns an enum value that is not available in the current SDK version, printReports will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from printReportsAsString().

      Returns:
      The ability to print reports.
      See Also:

    • printReportsAsString

      public final String printReportsAsString()

      The ability to print reports.

      If the service returns an enum value that is not available in the current SDK version, printReports will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from printReportsAsString().

      Returns:
      The ability to print reports.
      See Also:

    • createAndUpdateThemes

      public final CapabilityState createAndUpdateThemes()

      The ability to export to Create and Update themes.

      If the service returns an enum value that is not available in the current SDK version, createAndUpdateThemes will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from createAndUpdateThemesAsString().

      Returns:
      The ability to export to Create and Update themes.
      See Also:

    • createAndUpdateThemesAsString

      public final String createAndUpdateThemesAsString()

      The ability to export to Create and Update themes.

      If the service returns an enum value that is not available in the current SDK version, createAndUpdateThemes will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from createAndUpdateThemesAsString().

      Returns:
      The ability to export to Create and Update themes.
      See Also:

    • addOrRunAnomalyDetectionForAnalyses

      public final CapabilityState addOrRunAnomalyDetectionForAnalyses()

      The ability to add or run anomaly detection.

      If the service returns an enum value that is not available in the current SDK version, addOrRunAnomalyDetectionForAnalyses will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from addOrRunAnomalyDetectionForAnalysesAsString().

      Returns:
      The ability to add or run anomaly detection.
      See Also:

    • addOrRunAnomalyDetectionForAnalysesAsString

      public final String addOrRunAnomalyDetectionForAnalysesAsString()

      The ability to add or run anomaly detection.

      If the service returns an enum value that is not available in the current SDK version, addOrRunAnomalyDetectionForAnalyses will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from addOrRunAnomalyDetectionForAnalysesAsString().

      Returns:
      The ability to add or run anomaly detection.
      See Also:

    • shareAnalyses

      public final CapabilityState shareAnalyses()

      The ability to share analyses.

      If the service returns an enum value that is not available in the current SDK version, shareAnalyses will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shareAnalysesAsString().

      Returns:
      The ability to share analyses.
      See Also:

    • shareAnalysesAsString

      public final String shareAnalysesAsString()

      The ability to share analyses.

      If the service returns an enum value that is not available in the current SDK version, shareAnalyses will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shareAnalysesAsString().

      Returns:
      The ability to share analyses.
      See Also:

    • createAndUpdateDatasets

      public final CapabilityState createAndUpdateDatasets()

      The ability to create and update datasets.

      If the service returns an enum value that is not available in the current SDK version, createAndUpdateDatasets will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from createAndUpdateDatasetsAsString().

      Returns:
      The ability to create and update datasets.
      See Also:

    • createAndUpdateDatasetsAsString

      public final String createAndUpdateDatasetsAsString()

      The ability to create and update datasets.

      If the service returns an enum value that is not available in the current SDK version, createAndUpdateDatasets will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from createAndUpdateDatasetsAsString().

      Returns:
      The ability to create and update datasets.
      See Also:

    • shareDatasets

      public final CapabilityState shareDatasets()

      The ability to share datasets.

      If the service returns an enum value that is not available in the current SDK version, shareDatasets will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shareDatasetsAsString().

      Returns:
      The ability to share datasets.
      See Also:

    • shareDatasetsAsString

      public final String shareDatasetsAsString()

      The ability to share datasets.

      If the service returns an enum value that is not available in the current SDK version, shareDatasets will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shareDatasetsAsString().

      Returns:
      The ability to share datasets.
      See Also:

    • subscribeDashboardEmailReports

      public final CapabilityState subscribeDashboardEmailReports()

      The ability to subscribe to email reports.

      If the service returns an enum value that is not available in the current SDK version, subscribeDashboardEmailReports will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from subscribeDashboardEmailReportsAsString().

      Returns:
      The ability to subscribe to email reports.
      See Also:

    • subscribeDashboardEmailReportsAsString

      public final String subscribeDashboardEmailReportsAsString()

      The ability to subscribe to email reports.

      If the service returns an enum value that is not available in the current SDK version, subscribeDashboardEmailReports will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from subscribeDashboardEmailReportsAsString().

      Returns:
      The ability to subscribe to email reports.
      See Also:

    • createAndUpdateDashboardEmailReports

      public final CapabilityState createAndUpdateDashboardEmailReports()

      The ability to create and update email reports.

      If the service returns an enum value that is not available in the current SDK version, createAndUpdateDashboardEmailReports will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from createAndUpdateDashboardEmailReportsAsString().

      Returns:
      The ability to create and update email reports.
      See Also:

    • createAndUpdateDashboardEmailReportsAsString

      public final String createAndUpdateDashboardEmailReportsAsString()

      The ability to create and update email reports.

      If the service returns an enum value that is not available in the current SDK version, createAndUpdateDashboardEmailReports will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from createAndUpdateDashboardEmailReportsAsString().

      Returns:
      The ability to create and update email reports.
      See Also:

    • shareDashboards

      public final CapabilityState shareDashboards()

      The ability to share dashboards.

      If the service returns an enum value that is not available in the current SDK version, shareDashboards will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shareDashboardsAsString().

      Returns:
      The ability to share dashboards.
      See Also:

    • shareDashboardsAsString

      public final String shareDashboardsAsString()

      The ability to share dashboards.

      If the service returns an enum value that is not available in the current SDK version, shareDashboards will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shareDashboardsAsString().

      Returns:
      The ability to share dashboards.
      See Also:

    • createAndUpdateThresholdAlerts

      public final CapabilityState createAndUpdateThresholdAlerts()

      The ability to create and update threshold alerts.

      If the service returns an enum value that is not available in the current SDK version, createAndUpdateThresholdAlerts will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from createAndUpdateThresholdAlertsAsString().

      Returns:
      The ability to create and update threshold alerts.
      See Also:

    • createAndUpdateThresholdAlertsAsString

      public final String createAndUpdateThresholdAlertsAsString()

      The ability to create and update threshold alerts.

      If the service returns an enum value that is not available in the current SDK version, createAndUpdateThresholdAlerts will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from createAndUpdateThresholdAlertsAsString().

      Returns:
      The ability to create and update threshold alerts.
      See Also:

    • renameSharedFolders

      public final CapabilityState renameSharedFolders()

      The ability to rename shared folders.

      If the service returns an enum value that is not available in the current SDK version, renameSharedFolders will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from renameSharedFoldersAsString().

      Returns:
      The ability to rename shared folders.
      See Also:

    • renameSharedFoldersAsString

      public final String renameSharedFoldersAsString()

      The ability to rename shared folders.

      If the service returns an enum value that is not available in the current SDK version, renameSharedFolders will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from renameSharedFoldersAsString().

      Returns:
      The ability to rename shared folders.
      See Also:

    • createSharedFolders

      public final CapabilityState createSharedFolders()

      The ability to create shared folders.

      If the service returns an enum value that is not available in the current SDK version, createSharedFolders will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from createSharedFoldersAsString().

      Returns:
      The ability to create shared folders.
      See Also:

    • createSharedFoldersAsString

      public final String createSharedFoldersAsString()

      The ability to create shared folders.

      If the service returns an enum value that is not available in the current SDK version, createSharedFolders will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from createSharedFoldersAsString().

      Returns:
      The ability to create shared folders.
      See Also:

    • createAndUpdateDataSources

      public final CapabilityState createAndUpdateDataSources()

      The ability to create and update data sources.

      If the service returns an enum value that is not available in the current SDK version, createAndUpdateDataSources will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from createAndUpdateDataSourcesAsString().

      Returns:
      The ability to create and update data sources.
      See Also:

    • createAndUpdateDataSourcesAsString

      public final String createAndUpdateDataSourcesAsString()

      The ability to create and update data sources.

      If the service returns an enum value that is not available in the current SDK version, createAndUpdateDataSources will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from createAndUpdateDataSourcesAsString().

      Returns:
      The ability to create and update data sources.
      See Also:

    • shareDataSources

      public final CapabilityState shareDataSources()

      The ability to share data sources.

      If the service returns an enum value that is not available in the current SDK version, shareDataSources will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shareDataSourcesAsString().

      Returns:
      The ability to share data sources.
      See Also:

    • shareDataSourcesAsString

      public final String shareDataSourcesAsString()

      The ability to share data sources.

      If the service returns an enum value that is not available in the current SDK version, shareDataSources will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shareDataSourcesAsString().

      Returns:
      The ability to share data sources.
      See Also:

    • viewAccountSPICECapacity

      public final CapabilityState viewAccountSPICECapacity()

      The ability to view account SPICE capacity.

      If the service returns an enum value that is not available in the current SDK version, viewAccountSPICECapacity will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from viewAccountSPICECapacityAsString().

      Returns:
      The ability to view account SPICE capacity.
      See Also:

    • viewAccountSPICECapacityAsString

      public final String viewAccountSPICECapacityAsString()

      The ability to view account SPICE capacity.

      If the service returns an enum value that is not available in the current SDK version, viewAccountSPICECapacity will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from viewAccountSPICECapacityAsString().

      Returns:
      The ability to view account SPICE capacity.
      See Also:

    • createSPICEDataset

      public final CapabilityState createSPICEDataset()

      The ability to create a SPICE dataset.

      If the service returns an enum value that is not available in the current SDK version, createSPICEDataset will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from createSPICEDatasetAsString().

      Returns:
      The ability to create a SPICE dataset.
      See Also:

    • createSPICEDatasetAsString

      public final String createSPICEDatasetAsString()

      The ability to create a SPICE dataset.

      If the service returns an enum value that is not available in the current SDK version, createSPICEDataset will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from createSPICEDatasetAsString().

      Returns:
      The ability to create a SPICE dataset.
      See Also:

    • exportToPdfInScheduledReports

      public final CapabilityState exportToPdfInScheduledReports()

      The ability to export to PDF files in scheduled email reports.

      If the service returns an enum value that is not available in the current SDK version, exportToPdfInScheduledReports will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from exportToPdfInScheduledReportsAsString().

      Returns:
      The ability to export to PDF files in scheduled email reports.
      See Also:

    • exportToPdfInScheduledReportsAsString

      public final String exportToPdfInScheduledReportsAsString()

      The ability to export to PDF files in scheduled email reports.

      If the service returns an enum value that is not available in the current SDK version, exportToPdfInScheduledReports will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from exportToPdfInScheduledReportsAsString().

      Returns:
      The ability to export to PDF files in scheduled email reports.
      See Also:

    • exportToCsvInScheduledReports

      public final CapabilityState exportToCsvInScheduledReports()

      The ability to export to CSV files in scheduled email reports.

      If the service returns an enum value that is not available in the current SDK version, exportToCsvInScheduledReports will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from exportToCsvInScheduledReportsAsString().

      Returns:
      The ability to export to CSV files in scheduled email reports.
      See Also:

    • exportToCsvInScheduledReportsAsString

      public final String exportToCsvInScheduledReportsAsString()

      The ability to export to CSV files in scheduled email reports.

      If the service returns an enum value that is not available in the current SDK version, exportToCsvInScheduledReports will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from exportToCsvInScheduledReportsAsString().

      Returns:
      The ability to export to CSV files in scheduled email reports.
      See Also:

    • exportToExcelInScheduledReports

      public final CapabilityState exportToExcelInScheduledReports()

      The ability to export to Excel files in scheduled email reports.

      If the service returns an enum value that is not available in the current SDK version, exportToExcelInScheduledReports will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from exportToExcelInScheduledReportsAsString().

      Returns:
      The ability to export to Excel files in scheduled email reports.
      See Also:

    • exportToExcelInScheduledReportsAsString

      public final String exportToExcelInScheduledReportsAsString()

      The ability to export to Excel files in scheduled email reports.

      If the service returns an enum value that is not available in the current SDK version, exportToExcelInScheduledReports will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from exportToExcelInScheduledReportsAsString().

      Returns:
      The ability to export to Excel files in scheduled email reports.
      See Also:

    • includeContentInScheduledReportsEmail

      public final CapabilityState includeContentInScheduledReportsEmail()

      The ability to include content in scheduled email reports.

      If the service returns an enum value that is not available in the current SDK version, includeContentInScheduledReportsEmail will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from includeContentInScheduledReportsEmailAsString().

      Returns:
      The ability to include content in scheduled email reports.
      See Also:

    • includeContentInScheduledReportsEmailAsString

      public final String includeContentInScheduledReportsEmailAsString()

      The ability to include content in scheduled email reports.

      If the service returns an enum value that is not available in the current SDK version, includeContentInScheduledReportsEmail will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from includeContentInScheduledReportsEmailAsString().

      Returns:
      The ability to include content in scheduled email reports.
      See Also:

    • dashboard

      public final CapabilityState dashboard()

      The ability to perform dashboard-related actions.

      If the service returns an enum value that is not available in the current SDK version, dashboard will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dashboardAsString().

      Returns:
      The ability to perform dashboard-related actions.
      See Also:

    • dashboardAsString

      public final String dashboardAsString()

      The ability to perform dashboard-related actions.

      If the service returns an enum value that is not available in the current SDK version, dashboard will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dashboardAsString().

      Returns:
      The ability to perform dashboard-related actions.
      See Also:

    • analysis

      public final CapabilityState analysis()

      The ability to perform analysis-related actions.

      If the service returns an enum value that is not available in the current SDK version, analysis will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from analysisAsString().

      Returns:
      The ability to perform analysis-related actions.
      See Also:

    • analysisAsString

      public final String analysisAsString()

      The ability to perform analysis-related actions.

      If the service returns an enum value that is not available in the current SDK version, analysis will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from analysisAsString().

      Returns:
      The ability to perform analysis-related actions.
      See Also:

    • automate

      public final CapabilityState automate()

      The ability to perform automate-related actions.

      If the service returns an enum value that is not available in the current SDK version, automate will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from automateAsString().

      Returns:
      The ability to perform automate-related actions.
      See Also:

    • automateAsString

      public final String automateAsString()

      The ability to perform automate-related actions.

      If the service returns an enum value that is not available in the current SDK version, automate will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from automateAsString().

      Returns:
      The ability to perform automate-related actions.
      See Also:

    • flow

      public final CapabilityState flow()

      The ability to perform flow-related actions.

      If the service returns an enum value that is not available in the current SDK version, flow will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from flowAsString().

      Returns:
      The ability to perform flow-related actions.
      See Also:

    • flowAsString

      public final String flowAsString()

      The ability to perform flow-related actions.

      If the service returns an enum value that is not available in the current SDK version, flow will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from flowAsString().

      Returns:
      The ability to perform flow-related actions.
      See Also:

    • publishWithoutApproval

      public final CapabilityState publishWithoutApproval()

      The ability to enable approvals for flow share.

      If the service returns an enum value that is not available in the current SDK version, publishWithoutApproval will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from publishWithoutApprovalAsString().

      Returns:
      The ability to enable approvals for flow share.
      See Also:

    • publishWithoutApprovalAsString

      public final String publishWithoutApprovalAsString()

      The ability to enable approvals for flow share.

      If the service returns an enum value that is not available in the current SDK version, publishWithoutApproval will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from publishWithoutApprovalAsString().

      Returns:
      The ability to enable approvals for flow share.
      See Also:

    • useBedrockModels

      public final CapabilityState useBedrockModels()

      The ability to use Bedrock models for general knowledge step in flows.

      If the service returns an enum value that is not available in the current SDK version, useBedrockModels will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from useBedrockModelsAsString().

      Returns:
      The ability to use Bedrock models for general knowledge step in flows.
      See Also:

    • useBedrockModelsAsString

      public final String useBedrockModelsAsString()

      The ability to use Bedrock models for general knowledge step in flows.

      If the service returns an enum value that is not available in the current SDK version, useBedrockModels will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from useBedrockModelsAsString().

      Returns:
      The ability to use Bedrock models for general knowledge step in flows.
      See Also:

    • performFlowUiTask

      public final CapabilityState performFlowUiTask()

      The ability to use UI Agent step to perform tasks on public websites.

      If the service returns an enum value that is not available in the current SDK version, performFlowUiTask will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from performFlowUiTaskAsString().

      Returns:
      The ability to use UI Agent step to perform tasks on public websites.
      See Also:

    • performFlowUiTaskAsString

      public final String performFlowUiTaskAsString()

      The ability to use UI Agent step to perform tasks on public websites.

      If the service returns an enum value that is not available in the current SDK version, performFlowUiTask will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from performFlowUiTaskAsString().

      Returns:
      The ability to use UI Agent step to perform tasks on public websites.
      See Also:

    • useAgentWebSearch

      public final CapabilityState useAgentWebSearch()

      The ability to use internet to enhance results in Chat Agents, Flows, and Quick Research. Web search queries will be processed securely in an Amazon Web Services region us-east-1.

      If the service returns an enum value that is not available in the current SDK version, useAgentWebSearch will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from useAgentWebSearchAsString().

      Returns:
      The ability to use internet to enhance results in Chat Agents, Flows, and Quick Research. Web search queries will be processed securely in an Amazon Web Services region us-east-1.
      See Also:

    • useAgentWebSearchAsString

      public final String useAgentWebSearchAsString()

      The ability to use internet to enhance results in Chat Agents, Flows, and Quick Research. Web search queries will be processed securely in an Amazon Web Services region us-east-1.

      If the service returns an enum value that is not available in the current SDK version, useAgentWebSearch will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from useAgentWebSearchAsString().

      Returns:
      The ability to use internet to enhance results in Chat Agents, Flows, and Quick Research. Web search queries will be processed securely in an Amazon Web Services region us-east-1.
      See Also:

    • knowledgeBase

      public final CapabilityState knowledgeBase()

      The ability to use knowledge bases to specify content from external applications.

      If the service returns an enum value that is not available in the current SDK version, knowledgeBase will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from knowledgeBaseAsString().

      Returns:
      The ability to use knowledge bases to specify content from external applications.
      See Also:

    • knowledgeBaseAsString

      public final String knowledgeBaseAsString()

      The ability to use knowledge bases to specify content from external applications.

      If the service returns an enum value that is not available in the current SDK version, knowledgeBase will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from knowledgeBaseAsString().

      Returns:
      The ability to use knowledge bases to specify content from external applications.
      See Also:

    • action

      public final CapabilityState action()

      The ability to perform actions in external services through Action connectors. Actions allow users to interact with third-party systems.

      If the service returns an enum value that is not available in the current SDK version, action will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

      Returns:
      The ability to perform actions in external services through Action connectors. Actions allow users to interact with third-party systems.
      See Also:

    • actionAsString

      public final String actionAsString()

      The ability to perform actions in external services through Action connectors. Actions allow users to interact with third-party systems.

      If the service returns an enum value that is not available in the current SDK version, action will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

      Returns:
      The ability to perform actions in external services through Action connectors. Actions allow users to interact with third-party systems.
      See Also:

    • space

      public final CapabilityState space()

      The ability to perform space-related actions.

      If the service returns an enum value that is not available in the current SDK version, space will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from spaceAsString().

      Returns:
      The ability to perform space-related actions.
      See Also:

    • spaceAsString

      public final String spaceAsString()

      The ability to perform space-related actions.

      If the service returns an enum value that is not available in the current SDK version, space will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from spaceAsString().

      Returns:
      The ability to perform space-related actions.
      See Also:

    • chatAgent

      public final CapabilityState chatAgent()

      The ability to perform chat-related actions.

      If the service returns an enum value that is not available in the current SDK version, chatAgent will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from chatAgentAsString().

      Returns:
      The ability to perform chat-related actions.
      See Also:

    • chatAgentAsString

      public final String chatAgentAsString()

      The ability to perform chat-related actions.

      If the service returns an enum value that is not available in the current SDK version, chatAgent will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from chatAgentAsString().

      Returns:
      The ability to perform chat-related actions.
      See Also:

    • createChatAgents

      public final CapabilityState createChatAgents()

      The ability to create chat agents.

      If the service returns an enum value that is not available in the current SDK version, createChatAgents will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from createChatAgentsAsString().

      Returns:
      The ability to create chat agents.
      See Also:

    • createChatAgentsAsString

      public final String createChatAgentsAsString()

      The ability to create chat agents.

      If the service returns an enum value that is not available in the current SDK version, createChatAgents will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from createChatAgentsAsString().

      Returns:
      The ability to create chat agents.
      See Also:

    • research

      public final CapabilityState research()

      The ability to perform research-related actions.

      If the service returns an enum value that is not available in the current SDK version, research will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from researchAsString().

      Returns:
      The ability to perform research-related actions.
      See Also:

    • researchAsString

      public final String researchAsString()

      The ability to perform research-related actions.

      If the service returns an enum value that is not available in the current SDK version, research will return CapabilityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from researchAsString().

      Returns:
      The ability to perform research-related actions.
      See Also:

    • toBuilder

      public Capabilities.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Capabilities.Builder,Capabilities>
      Returns:
      a builder for type T

    • builder

      public static Capabilities.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Capabilities.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.