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 Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description QueryLineageRequest.Builder
direction(String direction)
Associations between lineage entities have a direction.QueryLineageRequest.Builder
direction(Direction direction)
Associations between lineage entities have a direction.default QueryLineageRequest.Builder
filters(Consumer<QueryFilters.Builder> filters)
A set of filtering parameters that allow you to specify which entities should be returned.QueryLineageRequest.Builder
filters(QueryFilters filters)
A set of filtering parameters that allow you to specify which entities should be returned.QueryLineageRequest.Builder
includeEdges(Boolean includeEdges)
Setting this value toTrue
retrieves not only the entities of interest but also the Associations and lineage entities on the path.QueryLineageRequest.Builder
maxDepth(Integer maxDepth)
The maximum depth in lineage relationships from theStartArns
that are traversed.QueryLineageRequest.Builder
maxResults(Integer maxResults)
Limits the number of vertices in the results.QueryLineageRequest.Builder
nextToken(String nextToken)
Limits the number of vertices in the request.QueryLineageRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
QueryLineageRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
QueryLineageRequest.Builder
startArns(String... startArns)
A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.QueryLineageRequest.Builder
startArns(Collection<String> startArns)
A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.-
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.sagemaker.model.SageMakerRequest.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 Detail
-
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.
-
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.
-
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 toFalse
to only return lineage entities that match your query.- Parameters:
includeEdges
- Setting this value toTrue
retrieves not only the entities of interest but also the Associations and lineage entities on the path. Set toFalse
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
, orContext
. -
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
, orContext
. -
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
, orContext
. -
CreatedBefore - Filter entities created before this date.
-
ModifiedBefore - Filter entities modified before this date.
-
ModifiedAfter - Filter entities modified after this date.
QueryFilters.Builder
avoiding the need to create one manually viaQueryFilters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilters(QueryFilters)
.- Parameters:
filters
- a consumer that will call methods onQueryFilters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
filters(QueryFilters)
-
-
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 ofAssociations
from theStartArn
entity to the matched results.- Parameters:
maxDepth
- The maximum depth in lineage relationships from theStartArns
that are traversed. Depth is a measure of the number ofAssociations
from theStartArn
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 theNextToken
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 theNextToken
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)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
QueryLineageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-