/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace Rekognition { namespace Model { /** */ class GetPersonTrackingRequest : public RekognitionRequest { public: AWS_REKOGNITION_API GetPersonTrackingRequest(); // 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 "GetPersonTracking"; } AWS_REKOGNITION_API Aws::String SerializePayload() const override; AWS_REKOGNITION_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The identifier for a job that tracks persons in a video. You get the * JobId from a call to StartPersonTracking.

*/ inline const Aws::String& GetJobId() const{ return m_jobId; } /** *

The identifier for a job that tracks persons in a video. You get the * JobId from a call to StartPersonTracking.

*/ inline bool JobIdHasBeenSet() const { return m_jobIdHasBeenSet; } /** *

The identifier for a job that tracks persons in a video. You get the * JobId from a call to StartPersonTracking.

*/ inline void SetJobId(const Aws::String& value) { m_jobIdHasBeenSet = true; m_jobId = value; } /** *

The identifier for a job that tracks persons in a video. You get the * JobId from a call to StartPersonTracking.

*/ inline void SetJobId(Aws::String&& value) { m_jobIdHasBeenSet = true; m_jobId = std::move(value); } /** *

The identifier for a job that tracks persons in a video. You get the * JobId from a call to StartPersonTracking.

*/ inline void SetJobId(const char* value) { m_jobIdHasBeenSet = true; m_jobId.assign(value); } /** *

The identifier for a job that tracks persons in a video. You get the * JobId from a call to StartPersonTracking.

*/ inline GetPersonTrackingRequest& WithJobId(const Aws::String& value) { SetJobId(value); return *this;} /** *

The identifier for a job that tracks persons in a video. You get the * JobId from a call to StartPersonTracking.

*/ inline GetPersonTrackingRequest& WithJobId(Aws::String&& value) { SetJobId(std::move(value)); return *this;} /** *

The identifier for a job that tracks persons in a video. You get the * JobId from a call to StartPersonTracking.

*/ inline GetPersonTrackingRequest& WithJobId(const char* value) { SetJobId(value); return *this;} /** *

Maximum number of results to return per paginated call. The largest value you * can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 * results is returned. The default value is 1000.

*/ inline int GetMaxResults() const{ return m_maxResults; } /** *

Maximum number of results to return per paginated call. The largest value you * can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 * results is returned. The default value is 1000.

*/ inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } /** *

Maximum number of results to return per paginated call. The largest value you * can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 * results is returned. The default value is 1000.

*/ inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } /** *

Maximum number of results to return per paginated call. The largest value you * can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 * results is returned. The default value is 1000.

*/ inline GetPersonTrackingRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} /** *

If the previous response was incomplete (because there are more persons to * retrieve), Amazon Rekognition Video returns a pagination token in the response. * You can use this pagination token to retrieve the next set of persons.

*/ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

If the previous response was incomplete (because there are more persons to * retrieve), Amazon Rekognition Video returns a pagination token in the response. * You can use this pagination token to retrieve the next set of persons.

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

If the previous response was incomplete (because there are more persons to * retrieve), Amazon Rekognition Video returns a pagination token in the response. * You can use this pagination token to retrieve the next set of persons.

*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

If the previous response was incomplete (because there are more persons to * retrieve), Amazon Rekognition Video returns a pagination token in the response. * You can use this pagination token to retrieve the next set of persons.

*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

If the previous response was incomplete (because there are more persons to * retrieve), Amazon Rekognition Video returns a pagination token in the response. * You can use this pagination token to retrieve the next set of persons.

*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

If the previous response was incomplete (because there are more persons to * retrieve), Amazon Rekognition Video returns a pagination token in the response. * You can use this pagination token to retrieve the next set of persons.

*/ inline GetPersonTrackingRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

If the previous response was incomplete (because there are more persons to * retrieve), Amazon Rekognition Video returns a pagination token in the response. * You can use this pagination token to retrieve the next set of persons.

*/ inline GetPersonTrackingRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

If the previous response was incomplete (because there are more persons to * retrieve), Amazon Rekognition Video returns a pagination token in the response. * You can use this pagination token to retrieve the next set of persons.

*/ inline GetPersonTrackingRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

Sort to use for elements in the Persons array. Use * TIMESTAMP to sort array elements by the time persons are detected. * Use INDEX to sort by the tracked persons. If you sort by * INDEX, the array elements for each person are sorted by detection * confidence. The default sort is by TIMESTAMP.

*/ inline const PersonTrackingSortBy& GetSortBy() const{ return m_sortBy; } /** *

Sort to use for elements in the Persons array. Use * TIMESTAMP to sort array elements by the time persons are detected. * Use INDEX to sort by the tracked persons. If you sort by * INDEX, the array elements for each person are sorted by detection * confidence. The default sort is by TIMESTAMP.

*/ inline bool SortByHasBeenSet() const { return m_sortByHasBeenSet; } /** *

Sort to use for elements in the Persons array. Use * TIMESTAMP to sort array elements by the time persons are detected. * Use INDEX to sort by the tracked persons. If you sort by * INDEX, the array elements for each person are sorted by detection * confidence. The default sort is by TIMESTAMP.

*/ inline void SetSortBy(const PersonTrackingSortBy& value) { m_sortByHasBeenSet = true; m_sortBy = value; } /** *

Sort to use for elements in the Persons array. Use * TIMESTAMP to sort array elements by the time persons are detected. * Use INDEX to sort by the tracked persons. If you sort by * INDEX, the array elements for each person are sorted by detection * confidence. The default sort is by TIMESTAMP.

*/ inline void SetSortBy(PersonTrackingSortBy&& value) { m_sortByHasBeenSet = true; m_sortBy = std::move(value); } /** *

Sort to use for elements in the Persons array. Use * TIMESTAMP to sort array elements by the time persons are detected. * Use INDEX to sort by the tracked persons. If you sort by * INDEX, the array elements for each person are sorted by detection * confidence. The default sort is by TIMESTAMP.

*/ inline GetPersonTrackingRequest& WithSortBy(const PersonTrackingSortBy& value) { SetSortBy(value); return *this;} /** *

Sort to use for elements in the Persons array. Use * TIMESTAMP to sort array elements by the time persons are detected. * Use INDEX to sort by the tracked persons. If you sort by * INDEX, the array elements for each person are sorted by detection * confidence. The default sort is by TIMESTAMP.

*/ inline GetPersonTrackingRequest& WithSortBy(PersonTrackingSortBy&& value) { SetSortBy(std::move(value)); return *this;} private: Aws::String m_jobId; bool m_jobIdHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; PersonTrackingSortBy m_sortBy; bool m_sortByHasBeenSet = false; }; } // namespace Model } // namespace Rekognition } // namespace Aws