Interface GetClipRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<GetClipRequest.Builder,
,GetClipRequest> KinesisVideoArchivedMediaRequest.Builder
,SdkBuilder<GetClipRequest.Builder,
,GetClipRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GetClipRequest
public static interface GetClipRequest.Builder
extends KinesisVideoArchivedMediaRequest.Builder, SdkPojo, CopyableBuilder<GetClipRequest.Builder,GetClipRequest>
-
Method Summary
Modifier and TypeMethodDescriptiondefault GetClipRequest.Builder
clipFragmentSelector
(Consumer<ClipFragmentSelector.Builder> clipFragmentSelector) The time range of the requested clip and the source of the timestamps.clipFragmentSelector
(ClipFragmentSelector clipFragmentSelector) The time range of the requested clip and the source of the timestamps.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The Amazon Resource Name (ARN) of the stream for which to retrieve the media clip.streamName
(String streamName) The name of the stream for which to retrieve the media clip.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.KinesisVideoArchivedMediaRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
streamName
The name of the stream for which to retrieve the media clip.
You must specify either the StreamName or the StreamARN.
- Parameters:
streamName
- The name of the stream for which to retrieve the media clip.You must specify either the StreamName or the StreamARN.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
streamARN
The Amazon Resource Name (ARN) of the stream for which to retrieve the media clip.
You must specify either the StreamName or the StreamARN.
- Parameters:
streamARN
- The Amazon Resource Name (ARN) of the stream for which to retrieve the media clip.You must specify either the StreamName or the StreamARN.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clipFragmentSelector
The time range of the requested clip and the source of the timestamps.
- Parameters:
clipFragmentSelector
- The time range of the requested clip and the source of the timestamps.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clipFragmentSelector
default GetClipRequest.Builder clipFragmentSelector(Consumer<ClipFragmentSelector.Builder> clipFragmentSelector) The time range of the requested clip and the source of the timestamps.
This is a convenience method that creates an instance of theClipFragmentSelector.Builder
avoiding the need to create one manually viaClipFragmentSelector.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toclipFragmentSelector(ClipFragmentSelector)
.- Parameters:
clipFragmentSelector
- a consumer that will call methods onClipFragmentSelector.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
GetClipRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-