Interface ListPrefetchSchedulesRequest.Builder

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

  • Method Details

    • maxResults

      ListPrefetchSchedulesRequest.Builder maxResults(Integer maxResults)

      The maximum number of prefetch schedules that you want MediaTailor to return in response to the current request. If there are more than MaxResults prefetch schedules, use the value of NextToken in the response to get the next page of results.

      The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.

      Parameters:
      maxResults - The maximum number of prefetch schedules that you want MediaTailor to return in response to the current request. If there are more than MaxResults prefetch schedules, use the value of NextToken in the response to get the next page of results.

      The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.

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

    • nextToken

      ListPrefetchSchedulesRequest.Builder nextToken(String nextToken)

      Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

      For the first ListPrefetchSchedules request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.

      Parameters:
      nextToken - Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

      For the first ListPrefetchSchedules request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.

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

    • playbackConfigurationName

      ListPrefetchSchedulesRequest.Builder playbackConfigurationName(String playbackConfigurationName)

      Retrieves the prefetch schedule(s) for a specific playback configuration.

      Parameters:
      playbackConfigurationName - Retrieves the prefetch schedule(s) for a specific playback configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduleType

      ListPrefetchSchedulesRequest.Builder scheduleType(String scheduleType)

      The type of prefetch schedules that you want to list. SINGLE indicates that you want to list the configured single prefetch schedules. RECURRING indicates that you want to list the configured recurring prefetch schedules. ALL indicates that you want to list all configured prefetch schedules.

      Parameters:
      scheduleType - The type of prefetch schedules that you want to list. SINGLE indicates that you want to list the configured single prefetch schedules. RECURRING indicates that you want to list the configured recurring prefetch schedules. ALL indicates that you want to list all configured prefetch schedules.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scheduleType

      ListPrefetchSchedulesRequest.Builder scheduleType(ListPrefetchScheduleType scheduleType)

      The type of prefetch schedules that you want to list. SINGLE indicates that you want to list the configured single prefetch schedules. RECURRING indicates that you want to list the configured recurring prefetch schedules. ALL indicates that you want to list all configured prefetch schedules.

      Parameters:
      scheduleType - The type of prefetch schedules that you want to list. SINGLE indicates that you want to list the configured single prefetch schedules. RECURRING indicates that you want to list the configured recurring prefetch schedules. ALL indicates that you want to list all configured prefetch schedules.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • streamId

      ListPrefetchSchedulesRequest.Builder streamId(String streamId)

      An optional filtering parameter whereby MediaTailor filters the prefetch schedules to include only specific streams.

      Parameters:
      streamId - An optional filtering parameter whereby MediaTailor filters the prefetch schedules to include only specific streams.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      ListPrefetchSchedulesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListPrefetchSchedulesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.