com.amazonaws.services.sagemaker.model

Class QueryLineageRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sagemaker.model.QueryLineageRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class QueryLineageRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
QueryLineageRequest()

Method Summary

Modifier and Type	Method and Description
QueryLineageRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDirection() Associations between lineage entities have a direction.
QueryFilters	getFilters() A set of filtering parameters that allow you to specify which entities should be returned.
Boolean	getIncludeEdges() Setting this value to True retrieves not only the entities of interest but also the Associations and lineage entities on the path.
Integer	getMaxDepth() The maximum depth in lineage relationships from the StartArns that are traversed.
Integer	getMaxResults() Limits the number of vertices in the results.
String	getNextToken() Limits the number of vertices in the request.
List<String>	getStartArns() A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.
int	hashCode()
Boolean	isIncludeEdges() Setting this value to True retrieves not only the entities of interest but also the Associations and lineage entities on the path.
void	setDirection(String direction) Associations between lineage entities have a direction.
void	setFilters(QueryFilters filters) A set of filtering parameters that allow you to specify which entities should be returned.
void	setIncludeEdges(Boolean includeEdges) Setting this value to True retrieves not only the entities of interest but also the Associations and lineage entities on the path.
void	setMaxDepth(Integer maxDepth) The maximum depth in lineage relationships from the StartArns that are traversed.
void	setMaxResults(Integer maxResults) Limits the number of vertices in the results.
void	setNextToken(String nextToken) Limits the number of vertices in the request.
void	setStartArns(Collection<String> startArns) A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.
String	toString() Returns a string representation of this object.
QueryLineageRequest	withDirection(Direction direction) Associations between lineage entities have a direction.
QueryLineageRequest	withDirection(String direction) Associations between lineage entities have a direction.
QueryLineageRequest	withFilters(QueryFilters filters) A set of filtering parameters that allow you to specify which entities should be returned.
QueryLineageRequest	withIncludeEdges(Boolean includeEdges) Setting this value to True retrieves not only the entities of interest but also the Associations and lineage entities on the path.
QueryLineageRequest	withMaxDepth(Integer maxDepth) The maximum depth in lineage relationships from the StartArns that are traversed.
QueryLineageRequest	withMaxResults(Integer maxResults) Limits the number of vertices in the results.
QueryLineageRequest	withNextToken(String nextToken) Limits the number of vertices in the request.
QueryLineageRequest	withStartArns(Collection<String> startArns) A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.
QueryLineageRequest	withStartArns(String... startArns) A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

QueryLineageRequest

public QueryLineageRequest()

Method Detail

getStartArns

public List<String> getStartArns()

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

Returns:

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

setStartArns

public void setStartArns(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.

withStartArns

public QueryLineageRequest withStartArns(String... startArns)

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

NOTE: This method appends the values to the existing list (if any). Use setStartArns(java.util.Collection) or withStartArns(java.util.Collection) if you want to override the existing values.

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.

withStartArns

public QueryLineageRequest withStartArns(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.

setDirection

public void setDirection(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.

See Also:

Direction

getDirection

public String getDirection()

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

Returns:

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

See Also:

Direction

withDirection

public QueryLineageRequest withDirection(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

withDirection

public QueryLineageRequest withDirection(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:

Direction

setIncludeEdges

public void setIncludeEdges(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.

getIncludeEdges

public Boolean getIncludeEdges()

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.

withIncludeEdges

public QueryLineageRequest withIncludeEdges(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.

isIncludeEdges

public Boolean isIncludeEdges()

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.

setFilters

public void setFilters(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.

getFilters

public QueryFilters getFilters()

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.

withFilters

public QueryLineageRequest withFilters(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.

setMaxDepth

public void setMaxDepth(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.

getMaxDepth

public Integer getMaxDepth()

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.

withMaxDepth

public QueryLineageRequest withMaxDepth(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.

setMaxResults

public void setMaxResults(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.

getMaxResults

public Integer getMaxResults()

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.

withMaxResults

public QueryLineageRequest withMaxResults(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.

setNextToken

public void setNextToken(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.

getNextToken

public String getNextToken()

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.

withNextToken

public QueryLineageRequest withNextToken(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public QueryLineageRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()