This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files

179 lines
7.1 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/kinesis-video-archived-media/KinesisVideoArchivedMedia_EXPORTS.h>
#include <aws/kinesis-video-archived-media/KinesisVideoArchivedMediaRequest.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/kinesis-video-archived-media/model/ClipFragmentSelector.h>
#include <utility>
namespace Aws
{
namespace KinesisVideoArchivedMedia
{
namespace Model
{
/**
*/
class AWS_KINESISVIDEOARCHIVEDMEDIA_API GetClipRequest : public KinesisVideoArchivedMediaRequest
{
public:
GetClipRequest();
// Service request name is the Operation name which will send this request out,
// each operation should has unique request name, so that we can get operation's name from this request.
// Note: this is not true for response, multiple operations may have the same response name,
// so we can not get operation's name from response.
inline virtual const char* GetServiceRequestName() const override { return "GetClip"; }
Aws::String SerializePayload() const override;
/**
* <p>The name of the stream for which to retrieve the media clip. </p> <p>You must
* specify either the StreamName or the StreamARN. </p>
*/
inline const Aws::String& GetStreamName() const{ return m_streamName; }
/**
* <p>The name of the stream for which to retrieve the media clip. </p> <p>You must
* specify either the StreamName or the StreamARN. </p>
*/
inline bool StreamNameHasBeenSet() const { return m_streamNameHasBeenSet; }
/**
* <p>The name of the stream for which to retrieve the media clip. </p> <p>You must
* specify either the StreamName or the StreamARN. </p>
*/
inline void SetStreamName(const Aws::String& value) { m_streamNameHasBeenSet = true; m_streamName = value; }
/**
* <p>The name of the stream for which to retrieve the media clip. </p> <p>You must
* specify either the StreamName or the StreamARN. </p>
*/
inline void SetStreamName(Aws::String&& value) { m_streamNameHasBeenSet = true; m_streamName = std::move(value); }
/**
* <p>The name of the stream for which to retrieve the media clip. </p> <p>You must
* specify either the StreamName or the StreamARN. </p>
*/
inline void SetStreamName(const char* value) { m_streamNameHasBeenSet = true; m_streamName.assign(value); }
/**
* <p>The name of the stream for which to retrieve the media clip. </p> <p>You must
* specify either the StreamName or the StreamARN. </p>
*/
inline GetClipRequest& WithStreamName(const Aws::String& value) { SetStreamName(value); return *this;}
/**
* <p>The name of the stream for which to retrieve the media clip. </p> <p>You must
* specify either the StreamName or the StreamARN. </p>
*/
inline GetClipRequest& WithStreamName(Aws::String&& value) { SetStreamName(std::move(value)); return *this;}
/**
* <p>The name of the stream for which to retrieve the media clip. </p> <p>You must
* specify either the StreamName or the StreamARN. </p>
*/
inline GetClipRequest& WithStreamName(const char* value) { SetStreamName(value); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of the stream for which to retrieve the media
* clip. </p> <p>You must specify either the StreamName or the StreamARN. </p>
*/
inline const Aws::String& GetStreamARN() const{ return m_streamARN; }
/**
* <p>The Amazon Resource Name (ARN) of the stream for which to retrieve the media
* clip. </p> <p>You must specify either the StreamName or the StreamARN. </p>
*/
inline bool StreamARNHasBeenSet() const { return m_streamARNHasBeenSet; }
/**
* <p>The Amazon Resource Name (ARN) of the stream for which to retrieve the media
* clip. </p> <p>You must specify either the StreamName or the StreamARN. </p>
*/
inline void SetStreamARN(const Aws::String& value) { m_streamARNHasBeenSet = true; m_streamARN = value; }
/**
* <p>The Amazon Resource Name (ARN) of the stream for which to retrieve the media
* clip. </p> <p>You must specify either the StreamName or the StreamARN. </p>
*/
inline void SetStreamARN(Aws::String&& value) { m_streamARNHasBeenSet = true; m_streamARN = std::move(value); }
/**
* <p>The Amazon Resource Name (ARN) of the stream for which to retrieve the media
* clip. </p> <p>You must specify either the StreamName or the StreamARN. </p>
*/
inline void SetStreamARN(const char* value) { m_streamARNHasBeenSet = true; m_streamARN.assign(value); }
/**
* <p>The Amazon Resource Name (ARN) of the stream for which to retrieve the media
* clip. </p> <p>You must specify either the StreamName or the StreamARN. </p>
*/
inline GetClipRequest& WithStreamARN(const Aws::String& value) { SetStreamARN(value); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of the stream for which to retrieve the media
* clip. </p> <p>You must specify either the StreamName or the StreamARN. </p>
*/
inline GetClipRequest& WithStreamARN(Aws::String&& value) { SetStreamARN(std::move(value)); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of the stream for which to retrieve the media
* clip. </p> <p>You must specify either the StreamName or the StreamARN. </p>
*/
inline GetClipRequest& WithStreamARN(const char* value) { SetStreamARN(value); return *this;}
/**
* <p>The time range of the requested clip and the source of the timestamps.</p>
*/
inline const ClipFragmentSelector& GetClipFragmentSelector() const{ return m_clipFragmentSelector; }
/**
* <p>The time range of the requested clip and the source of the timestamps.</p>
*/
inline bool ClipFragmentSelectorHasBeenSet() const { return m_clipFragmentSelectorHasBeenSet; }
/**
* <p>The time range of the requested clip and the source of the timestamps.</p>
*/
inline void SetClipFragmentSelector(const ClipFragmentSelector& value) { m_clipFragmentSelectorHasBeenSet = true; m_clipFragmentSelector = value; }
/**
* <p>The time range of the requested clip and the source of the timestamps.</p>
*/
inline void SetClipFragmentSelector(ClipFragmentSelector&& value) { m_clipFragmentSelectorHasBeenSet = true; m_clipFragmentSelector = std::move(value); }
/**
* <p>The time range of the requested clip and the source of the timestamps.</p>
*/
inline GetClipRequest& WithClipFragmentSelector(const ClipFragmentSelector& value) { SetClipFragmentSelector(value); return *this;}
/**
* <p>The time range of the requested clip and the source of the timestamps.</p>
*/
inline GetClipRequest& WithClipFragmentSelector(ClipFragmentSelector&& value) { SetClipFragmentSelector(std::move(value)); return *this;}
private:
Aws::String m_streamName;
bool m_streamNameHasBeenSet;
Aws::String m_streamARN;
bool m_streamARNHasBeenSet;
ClipFragmentSelector m_clipFragmentSelector;
bool m_clipFragmentSelectorHasBeenSet;
};
} // namespace Model
} // namespace KinesisVideoArchivedMedia
} // namespace Aws