Interface KnowledgeBaseRefreshFrequency.Builder

  • Method Details

    • interval

      The interval at which the schedule refreshes the knowledge base. Valid values include:

      • DAILY – The schedule refreshes the knowledge base once each day.

      • WEEKLY – The schedule refreshes the knowledge base once each week, on the day that you specify in RefreshOnDay.DayOfWeek.

      • MONTHLY – The schedule refreshes the knowledge base once each month, on the day that you specify in RefreshOnDay.DayOfMonth.

      • HOURLY – The schedule refreshes the knowledge base once each hour. Available only if your account is enabled for hourly refresh. Otherwise, the request fails with an InvalidParameterValueException.

      For DAILY, WEEKLY, and MONTHLY intervals, the service chooses the time of day at which the refresh runs. You can't specify the time of day.

      Parameters:
      interval - The interval at which the schedule refreshes the knowledge base. Valid values include:

      • DAILY – The schedule refreshes the knowledge base once each day.

      • WEEKLY – The schedule refreshes the knowledge base once each week, on the day that you specify in RefreshOnDay.DayOfWeek.

      • MONTHLY – The schedule refreshes the knowledge base once each month, on the day that you specify in RefreshOnDay.DayOfMonth.

      • HOURLY – The schedule refreshes the knowledge base once each hour. Available only if your account is enabled for hourly refresh. Otherwise, the request fails with an InvalidParameterValueException.

      For DAILY, WEEKLY, and MONTHLY intervals, the service chooses the time of day at which the refresh runs. You can't specify the time of day.

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

      The interval at which the schedule refreshes the knowledge base. Valid values include:

      • DAILY – The schedule refreshes the knowledge base once each day.

      • WEEKLY – The schedule refreshes the knowledge base once each week, on the day that you specify in RefreshOnDay.DayOfWeek.

      • MONTHLY – The schedule refreshes the knowledge base once each month, on the day that you specify in RefreshOnDay.DayOfMonth.

      • HOURLY – The schedule refreshes the knowledge base once each hour. Available only if your account is enabled for hourly refresh. Otherwise, the request fails with an InvalidParameterValueException.

      For DAILY, WEEKLY, and MONTHLY intervals, the service chooses the time of day at which the refresh runs. You can't specify the time of day.

      Parameters:
      interval - The interval at which the schedule refreshes the knowledge base. Valid values include:

      • DAILY – The schedule refreshes the knowledge base once each day.

      • WEEKLY – The schedule refreshes the knowledge base once each week, on the day that you specify in RefreshOnDay.DayOfWeek.

      • MONTHLY – The schedule refreshes the knowledge base once each month, on the day that you specify in RefreshOnDay.DayOfMonth.

      • HOURLY – The schedule refreshes the knowledge base once each hour. Available only if your account is enabled for hourly refresh. Otherwise, the request fails with an InvalidParameterValueException.

      For DAILY, WEEKLY, and MONTHLY intervals, the service chooses the time of day at which the refresh runs. You can't specify the time of day.

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

      The day on which the refresh runs. This parameter is required for a WEEKLY or MONTHLY interval: specify the day of the week for WEEKLY or the day of the month for MONTHLY. If you don't specify it for one of these intervals, the request fails. This parameter isn't used for a DAILY or HOURLY interval.

      Parameters:
      refreshOnDay - The day on which the refresh runs. This parameter is required for a WEEKLY or MONTHLY interval: specify the day of the week for WEEKLY or the day of the month for MONTHLY. If you don't specify it for one of these intervals, the request fails. This parameter isn't used for a DAILY or HOURLY interval.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • refreshOnDay

      The day on which the refresh runs. This parameter is required for a WEEKLY or MONTHLY interval: specify the day of the week for WEEKLY or the day of the month for MONTHLY. If you don't specify it for one of these intervals, the request fails. This parameter isn't used for a DAILY or HOURLY interval.

      This is a convenience method that creates an instance of the KnowledgeBaseScheduleRefreshOnEntity.Builder avoiding the need to create one manually via KnowledgeBaseScheduleRefreshOnEntity.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to refreshOnDay(KnowledgeBaseScheduleRefreshOnEntity).

      Parameters:
      refreshOnDay - a consumer that will call methods on KnowledgeBaseScheduleRefreshOnEntity.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: