Interface InsightSelector.Builder

All Superinterfaces:
Buildable, CopyableBuilder<InsightSelector.Builder,InsightSelector>, SdkBuilder<InsightSelector.Builder,InsightSelector>, SdkPojo
Enclosing class:
InsightSelector
@Mutable @NotThreadSafe public static interface InsightSelector.Builder extends SdkPojo, CopyableBuilder<InsightSelector.Builder,InsightSelector>

  • Method Details

    • insightType

      InsightSelector.Builder insightType(String insightType)

      The type of Insights events to log on a trail or event data store. ApiCallRateInsight and ApiErrorRateInsight are valid Insight types.

      The ApiCallRateInsight Insights type analyzes write-only management API calls or read and write data API calls that are aggregated per minute against a baseline API call volume.

      The ApiErrorRateInsight Insights type analyzes management and data API calls that result in error codes. The error is shown if the API call is unsuccessful.

      Parameters:
      insightType - The type of Insights events to log on a trail or event data store. ApiCallRateInsight and ApiErrorRateInsight are valid Insight types.

      The ApiCallRateInsight Insights type analyzes write-only management API calls or read and write data API calls that are aggregated per minute against a baseline API call volume.

      The ApiErrorRateInsight Insights type analyzes management and data API calls that result in error codes. The error is shown if the API call is unsuccessful.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • insightType

      InsightSelector.Builder insightType(InsightType insightType)

      The type of Insights events to log on a trail or event data store. ApiCallRateInsight and ApiErrorRateInsight are valid Insight types.

      The ApiCallRateInsight Insights type analyzes write-only management API calls or read and write data API calls that are aggregated per minute against a baseline API call volume.

      The ApiErrorRateInsight Insights type analyzes management and data API calls that result in error codes. The error is shown if the API call is unsuccessful.

      Parameters:
      insightType - The type of Insights events to log on a trail or event data store. ApiCallRateInsight and ApiErrorRateInsight are valid Insight types.

      The ApiCallRateInsight Insights type analyzes write-only management API calls or read and write data API calls that are aggregated per minute against a baseline API call volume.

      The ApiErrorRateInsight Insights type analyzes management and data API calls that result in error codes. The error is shown if the API call is unsuccessful.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • eventCategoriesWithStrings

      InsightSelector.Builder eventCategoriesWithStrings(Collection<String> eventCategories)

      Select the event category on which Insights should be enabled.

      • If EventCategories is not provided, the specified Insights types are enabled on management API calls by default.

      • If EventCategories is provided, the given event categories will overwrite the existing ones. For example, if a trail already has Insights enabled on management events, and then a PutInsightSelectors request is made with only data events specified in EventCategories, Insights on management events will be disabled.

      Parameters:
      eventCategories - Select the event category on which Insights should be enabled.

      • If EventCategories is not provided, the specified Insights types are enabled on management API calls by default.

      • If EventCategories is provided, the given event categories will overwrite the existing ones. For example, if a trail already has Insights enabled on management events, and then a PutInsightSelectors request is made with only data events specified in EventCategories, Insights on management events will be disabled.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventCategoriesWithStrings

      InsightSelector.Builder eventCategoriesWithStrings(String... eventCategories)

      Select the event category on which Insights should be enabled.

      • If EventCategories is not provided, the specified Insights types are enabled on management API calls by default.

      • If EventCategories is provided, the given event categories will overwrite the existing ones. For example, if a trail already has Insights enabled on management events, and then a PutInsightSelectors request is made with only data events specified in EventCategories, Insights on management events will be disabled.

      Parameters:
      eventCategories - Select the event category on which Insights should be enabled.

      • If EventCategories is not provided, the specified Insights types are enabled on management API calls by default.

      • If EventCategories is provided, the given event categories will overwrite the existing ones. For example, if a trail already has Insights enabled on management events, and then a PutInsightSelectors request is made with only data events specified in EventCategories, Insights on management events will be disabled.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventCategories

      InsightSelector.Builder eventCategories(Collection<SourceEventCategory> eventCategories)

      Select the event category on which Insights should be enabled.

      • If EventCategories is not provided, the specified Insights types are enabled on management API calls by default.

      • If EventCategories is provided, the given event categories will overwrite the existing ones. For example, if a trail already has Insights enabled on management events, and then a PutInsightSelectors request is made with only data events specified in EventCategories, Insights on management events will be disabled.

      Parameters:
      eventCategories - Select the event category on which Insights should be enabled.

      • If EventCategories is not provided, the specified Insights types are enabled on management API calls by default.

      • If EventCategories is provided, the given event categories will overwrite the existing ones. For example, if a trail already has Insights enabled on management events, and then a PutInsightSelectors request is made with only data events specified in EventCategories, Insights on management events will be disabled.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventCategories

      InsightSelector.Builder eventCategories(SourceEventCategory... eventCategories)

      Select the event category on which Insights should be enabled.

      • If EventCategories is not provided, the specified Insights types are enabled on management API calls by default.

      • If EventCategories is provided, the given event categories will overwrite the existing ones. For example, if a trail already has Insights enabled on management events, and then a PutInsightSelectors request is made with only data events specified in EventCategories, Insights on management events will be disabled.

      Parameters:
      eventCategories - Select the event category on which Insights should be enabled.

      • If EventCategories is not provided, the specified Insights types are enabled on management API calls by default.

      • If EventCategories is provided, the given event categories will overwrite the existing ones. For example, if a trail already has Insights enabled on management events, and then a PutInsightSelectors request is made with only data events specified in EventCategories, Insights on management events will be disabled.

      Returns:
      Returns a reference to this object so that method calls can be chained together.