software.amazon.awssdk.services.sagemaker.model

Class QueryLineageRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sagemaker.model.SageMakerRequest

software.amazon.awssdk.services.sagemaker.model.QueryLineageRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<QueryLineageRequest.Builder,QueryLineageRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class QueryLineageRequest
extends SageMakerRequest
implements ToCopyableBuilder<QueryLineageRequest.Builder,QueryLineageRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	QueryLineageRequest.Builder

Method Summary

Modifier and Type	Method and Description
static QueryLineageRequest.Builder	builder()
Direction	direction() Associations between lineage entities have a direction.
String	directionAsString() Associations between lineage entities have a direction.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
QueryFilters	filters() A set of filtering parameters that allow you to specify which entities should be returned.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStartArns() For responses, this returns true if the service returned a value for the StartArns property.
Boolean	includeEdges() Setting this value to True retrieves not only the entities of interest but also the Associations and lineage entities on the path.
Integer	maxDepth() The maximum depth in lineage relationships from the StartArns that are traversed.
Integer	maxResults() Limits the number of vertices in the results.
String	nextToken() Limits the number of vertices in the request.
List<SdkField<?>>	sdkFields()
static Class<? extends QueryLineageRequest.Builder>	serializableBuilderClass()
List<String>	startArns() A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.
QueryLineageRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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 the isEmpty() 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

public final List<String> 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

public final Direction 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 return Direction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from directionAsString().

Returns:

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

See Also:

Direction

directionAsString

public final String 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 return Direction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from directionAsString().

Returns:

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

See Also:

Direction

includeEdges

public final 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.

Returns:

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.

filters

public final 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.

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, or Context.

• CreatedBefore - Filter entities created before this date.

• ModifiedBefore - Filter entities modified before this date.

• ModifiedAfter - Filter entities modified after this date.

maxDepth

public final 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.

Returns:

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.

maxResults

public final Integer 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

public final String 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

public QueryLineageRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<QueryLineageRequest.Builder,QueryLineageRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static QueryLineageRequest.Builder builder()

serializableBuilderClass

public static Class<? extends QueryLineageRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo