Interface QueryLineageRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<QueryLineageRequest.Builder,
,QueryLineageRequest> SageMakerRequest.Builder
,SdkBuilder<QueryLineageRequest.Builder,
,QueryLineageRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
QueryLineageRequest
-
Method Summary
Modifier and TypeMethodDescriptionAssociations between lineage entities have a 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.filters
(QueryFilters filters) A set of filtering parameters that allow you to specify which entities should be returned.includeEdges
(Boolean includeEdges) Setting this value toTrue
retrieves not only the entities of interest but also the Associations and lineage entities on the path.The maximum depth in lineage relationships from theStartArns
that are traversed.maxResults
(Integer maxResults) Limits the number of vertices in the results.Limits the number of vertices in the request.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.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 Details
-
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
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
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
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
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
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
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:
-
-
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
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
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) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-