Interface QueryLineageRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<QueryLineageRequest.Builder,QueryLineageRequest>, SageMakerRequest.Builder, SdkBuilder<QueryLineageRequest.Builder,QueryLineageRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
QueryLineageRequest
public static interface QueryLineageRequest.Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<QueryLineageRequest.Builder,QueryLineageRequest>

  • Method Details

    • startArns

      QueryLineageRequest.Builder startArns(Collection<String> startArns)

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

      Parameters:
      startArns - A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startArns

      QueryLineageRequest.Builder startArns(String... startArns)

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

      Parameters:
      startArns - A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • direction

      QueryLineageRequest.Builder direction(String direction)

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

      Parameters:
      direction - Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • direction

      QueryLineageRequest.Builder direction(Direction direction)

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

      Parameters:
      direction - Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • includeEdges

      QueryLineageRequest.Builder includeEdges(Boolean 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      QueryLineageRequest.Builder filters(QueryFilters 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.

      Parameters:
      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.

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

    • filters

      default QueryLineageRequest.Builder filters(Consumer<QueryFilters.Builder> 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.

      This is a convenience method that creates an instance of the QueryFilters.Builder avoiding the need to create one manually via QueryFilters.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(QueryFilters).

      Parameters:
      filters - a consumer that will call methods on QueryFilters.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxDepth

      QueryLineageRequest.Builder maxDepth(Integer 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      QueryLineageRequest.Builder maxResults(Integer maxResults)

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

      Parameters:
      maxResults - Limits the number of vertices in the results. Use the NextToken in a response to to retrieve the next page of results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      QueryLineageRequest.Builder nextToken(String nextToken)

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

      Parameters:
      nextToken - Limits the number of vertices in the request. Use the NextToken in a response to to retrieve the next page of results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      QueryLineageRequest.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

      QueryLineageRequest.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.