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

A list of resource Amazon Resource Name (ARN) that represent the starting * point for your lineage query.

*/ inline const Aws::Vector& GetStartArns() const{ return m_startArns; } /** *

A list of resource Amazon Resource Name (ARN) that represent the starting * point for your lineage query.

*/ inline bool StartArnsHasBeenSet() const { return m_startArnsHasBeenSet; } /** *

A list of resource Amazon Resource Name (ARN) that represent the starting * point for your lineage query.

*/ inline void SetStartArns(const Aws::Vector& value) { m_startArnsHasBeenSet = true; m_startArns = value; } /** *

A list of resource Amazon Resource Name (ARN) that represent the starting * point for your lineage query.

*/ inline void SetStartArns(Aws::Vector&& value) { m_startArnsHasBeenSet = true; m_startArns = std::move(value); } /** *

A list of resource Amazon Resource Name (ARN) that represent the starting * point for your lineage query.

*/ inline QueryLineageRequest& WithStartArns(const Aws::Vector& value) { SetStartArns(value); return *this;} /** *

A list of resource Amazon Resource Name (ARN) that represent the starting * point for your lineage query.

*/ inline QueryLineageRequest& WithStartArns(Aws::Vector&& value) { SetStartArns(std::move(value)); return *this;} /** *

A list of resource Amazon Resource Name (ARN) that represent the starting * point for your lineage query.

*/ inline QueryLineageRequest& AddStartArns(const Aws::String& value) { m_startArnsHasBeenSet = true; m_startArns.push_back(value); return *this; } /** *

A list of resource Amazon Resource Name (ARN) that represent the starting * point for your lineage query.

*/ inline QueryLineageRequest& AddStartArns(Aws::String&& value) { m_startArnsHasBeenSet = true; m_startArns.push_back(std::move(value)); return *this; } /** *

A list of resource Amazon Resource Name (ARN) that represent the starting * point for your lineage query.

*/ inline QueryLineageRequest& AddStartArns(const char* value) { m_startArnsHasBeenSet = true; m_startArns.push_back(value); return *this; } /** *

Associations between lineage entities have a direction. This parameter * determines the direction from the StartArn(s) that the query traverses.

*/ inline const Direction& GetDirection() const{ return m_direction; } /** *

Associations between lineage entities have a direction. This parameter * determines the direction from the StartArn(s) that the query traverses.

*/ inline bool DirectionHasBeenSet() const { return m_directionHasBeenSet; } /** *

Associations between lineage entities have a direction. This parameter * determines the direction from the StartArn(s) that the query traverses.

*/ inline void SetDirection(const Direction& value) { m_directionHasBeenSet = true; m_direction = value; } /** *

Associations between lineage entities have a direction. This parameter * determines the direction from the StartArn(s) that the query traverses.

*/ inline void SetDirection(Direction&& value) { m_directionHasBeenSet = true; m_direction = std::move(value); } /** *

Associations between lineage entities have a direction. This parameter * determines the direction from the StartArn(s) that the query traverses.

*/ inline QueryLineageRequest& WithDirection(const Direction& value) { SetDirection(value); return *this;} /** *

Associations between lineage entities have a direction. This parameter * determines the direction from the StartArn(s) that the query traverses.

*/ inline QueryLineageRequest& WithDirection(Direction&& value) { SetDirection(std::move(value)); return *this;} /** *

Setting this value to True retrieves not only the entities of * interest but also the Associations * and lineage entities on the path. Set to False to only return * lineage entities that match your query.

*/ inline bool GetIncludeEdges() const{ return m_includeEdges; } /** *

Setting this value to True retrieves not only the entities of * interest but also the Associations * and lineage entities on the path. Set to False to only return * lineage entities that match your query.

*/ inline bool IncludeEdgesHasBeenSet() const { return m_includeEdgesHasBeenSet; } /** *

Setting this value to True retrieves not only the entities of * interest but also the Associations * and lineage entities on the path. Set to False to only return * lineage entities that match your query.

*/ inline void SetIncludeEdges(bool value) { m_includeEdgesHasBeenSet = true; m_includeEdges = value; } /** *

Setting this value to True retrieves not only the entities of * interest but also the Associations * and lineage entities on the path. Set to False to only return * lineage entities that match your query.

*/ inline QueryLineageRequest& WithIncludeEdges(bool value) { SetIncludeEdges(value); return *this;} /** *

A set of filtering parameters that allow you to specify which entities should * be returned.

  • Properties - Key-value pairs to match on the * lineage entities' properties.

  • LineageTypes - A set of lineage * entity types to match on. For example: TrialComponent, * Artifact, or Context.

  • CreatedBefore * - Filter entities created before this date.

  • ModifiedBefore - * Filter entities modified before this date.

  • ModifiedAfter - * Filter entities modified after this date.

*/ inline const QueryFilters& GetFilters() const{ return m_filters; } /** *

A set of filtering parameters that allow you to specify which entities should * be returned.

  • Properties - Key-value pairs to match on the * lineage entities' properties.

  • LineageTypes - A set of lineage * entity types to match on. For example: TrialComponent, * Artifact, or Context.

  • CreatedBefore * - Filter entities created before this date.

  • ModifiedBefore - * Filter entities modified before this date.

  • ModifiedAfter - * Filter entities modified after this date.

*/ inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; } /** *

A set of filtering parameters that allow you to specify which entities should * be returned.

  • Properties - Key-value pairs to match on the * lineage entities' properties.

  • LineageTypes - A set of lineage * entity types to match on. For example: TrialComponent, * Artifact, or Context.

  • CreatedBefore * - Filter entities created before this date.

  • ModifiedBefore - * Filter entities modified before this date.

  • ModifiedAfter - * Filter entities modified after this date.

*/ inline void SetFilters(const QueryFilters& value) { m_filtersHasBeenSet = true; m_filters = value; } /** *

A set of filtering parameters that allow you to specify which entities should * be returned.

  • Properties - Key-value pairs to match on the * lineage entities' properties.

  • LineageTypes - A set of lineage * entity types to match on. For example: TrialComponent, * Artifact, or Context.

  • CreatedBefore * - Filter entities created before this date.

  • ModifiedBefore - * Filter entities modified before this date.

  • ModifiedAfter - * Filter entities modified after this date.

*/ inline void SetFilters(QueryFilters&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); } /** *

A set of filtering parameters that allow you to specify which entities should * be returned.

  • Properties - Key-value pairs to match on the * lineage entities' properties.

  • LineageTypes - A set of lineage * entity types to match on. For example: TrialComponent, * Artifact, or Context.

  • CreatedBefore * - Filter entities created before this date.

  • ModifiedBefore - * Filter entities modified before this date.

  • ModifiedAfter - * Filter entities modified after this date.

*/ inline QueryLineageRequest& WithFilters(const QueryFilters& value) { SetFilters(value); return *this;} /** *

A set of filtering parameters that allow you to specify which entities should * be returned.

  • Properties - Key-value pairs to match on the * lineage entities' properties.

  • LineageTypes - A set of lineage * entity types to match on. For example: TrialComponent, * Artifact, or Context.

  • CreatedBefore * - Filter entities created before this date.

  • ModifiedBefore - * Filter entities modified before this date.

  • ModifiedAfter - * Filter entities modified after this date.

*/ inline QueryLineageRequest& WithFilters(QueryFilters&& value) { SetFilters(std::move(value)); return *this;} /** *

The maximum depth in lineage relationships from the StartArns * that are traversed. Depth is a measure of the number of * Associations from the StartArn entity to the matched * results.

*/ inline int GetMaxDepth() const{ return m_maxDepth; } /** *

The maximum depth in lineage relationships from the StartArns * that are traversed. Depth is a measure of the number of * Associations from the StartArn entity to the matched * results.

*/ inline bool MaxDepthHasBeenSet() const { return m_maxDepthHasBeenSet; } /** *

The maximum depth in lineage relationships from the StartArns * that are traversed. Depth is a measure of the number of * Associations from the StartArn entity to the matched * results.

*/ inline void SetMaxDepth(int value) { m_maxDepthHasBeenSet = true; m_maxDepth = value; } /** *

The maximum depth in lineage relationships from the StartArns * that are traversed. Depth is a measure of the number of * Associations from the StartArn entity to the matched * results.

*/ inline QueryLineageRequest& WithMaxDepth(int value) { SetMaxDepth(value); return *this;} /** *

Limits the number of vertices in the results. Use the NextToken * in a response to to retrieve the next page of results.

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

Limits the number of vertices in the results. Use the NextToken * in a response to to retrieve the next page of results.

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

Limits the number of vertices in the results. Use the NextToken * in a response to to retrieve the next page of results.

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

Limits the number of vertices in the results. Use the NextToken * in a response to to retrieve the next page of results.

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

Limits the number of vertices in the request. Use the NextToken * in a response to to retrieve the next page of results.

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

Limits the number of vertices in the request. Use the NextToken * in a response to to retrieve the next page of results.

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

Limits the number of vertices in the request. Use the NextToken * in a response to to retrieve the next page of results.

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

Limits the number of vertices in the request. Use the NextToken * in a response to to retrieve the next page of results.

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

Limits the number of vertices in the request. Use the NextToken * in a response to to retrieve the next page of results.

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

Limits the number of vertices in the request. Use the NextToken * in a response to to retrieve the next page of results.

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

Limits the number of vertices in the request. Use the NextToken * in a response to to retrieve the next page of results.

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

Limits the number of vertices in the request. Use the NextToken * in a response to to retrieve the next page of results.

*/ inline QueryLineageRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} private: Aws::Vector m_startArns; bool m_startArnsHasBeenSet = false; Direction m_direction; bool m_directionHasBeenSet = false; bool m_includeEdges; bool m_includeEdgesHasBeenSet = false; QueryFilters m_filters; bool m_filtersHasBeenSet = false; int m_maxDepth; bool m_maxDepthHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; }; } // namespace Model } // namespace SageMaker } // namespace Aws