Class QueryLineageRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<QueryLineageRequest.Builder,
QueryLineageRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic QueryLineageRequest.Builder
builder()
final Direction
Associations between lineage entities have a direction.final String
Associations between lineage entities have a direction.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final QueryFilters
filters()
A set of filtering parameters that allow you to specify which entities should be returned.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the StartArns property.final Boolean
Setting this value toTrue
retrieves not only the entities of interest but also the Associations and lineage entities on the path.final Integer
maxDepth()
The maximum depth in lineage relationships from theStartArns
that are traversed.final Integer
Limits the number of vertices in the results.final String
Limits the number of vertices in the request.static Class
<? extends QueryLineageRequest.Builder> A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasStartArns
public final boolean hasStartArns()For responses, this returns true if the service returned a value for the StartArns property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
startArns
A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasStartArns()
method.- Returns:
- A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.
-
direction
Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.
If the service returns an enum value that is not available in the current SDK version,
direction
will returnDirection.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdirectionAsString()
.- Returns:
- Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.
- See Also:
-
directionAsString
Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.
If the service returns an enum value that is not available in the current SDK version,
direction
will returnDirection.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdirectionAsString()
.- Returns:
- Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.
- 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.- Returns:
- 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.
-
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:
- 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.
-
-
-
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.- Returns:
- 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.
-
maxResults
Limits the number of vertices in the results. Use the
NextToken
in a response to to retrieve the next page of results.- Returns:
- Limits the number of vertices in the results. Use the
NextToken
in a response to to retrieve the next page of results.
-
nextToken
Limits the number of vertices in the request. Use the
NextToken
in a response to to retrieve the next page of results.- Returns:
- Limits the number of vertices in the request. Use the
NextToken
in a response to to retrieve the next page of results.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<QueryLineageRequest.Builder,
QueryLineageRequest> - Specified by:
toBuilder
in classSageMakerRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-