software.amazon.awssdk.services.sagemaker.model.QueryLineageRequest Maven / Gradle / Ivy
Show all versions of sagemaker Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.sagemaker.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class QueryLineageRequest extends SageMakerRequest implements
ToCopyableBuilder {
private static final SdkField> START_ARNS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("StartArns")
.getter(getter(QueryLineageRequest::startArns))
.setter(setter(Builder::startArns))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StartArns").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField DIRECTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Direction").getter(getter(QueryLineageRequest::directionAsString)).setter(setter(Builder::direction))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Direction").build()).build();
private static final SdkField INCLUDE_EDGES_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("IncludeEdges").getter(getter(QueryLineageRequest::includeEdges)).setter(setter(Builder::includeEdges))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IncludeEdges").build()).build();
private static final SdkField FILTERS_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("Filters").getter(getter(QueryLineageRequest::filters)).setter(setter(Builder::filters))
.constructor(QueryFilters::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Filters").build()).build();
private static final SdkField MAX_DEPTH_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxDepth").getter(getter(QueryLineageRequest::maxDepth)).setter(setter(Builder::maxDepth))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxDepth").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(QueryLineageRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(QueryLineageRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(START_ARNS_FIELD,
DIRECTION_FIELD, INCLUDE_EDGES_FIELD, FILTERS_FIELD, MAX_DEPTH_FIELD, MAX_RESULTS_FIELD, NEXT_TOKEN_FIELD));
private final List startArns;
private final String direction;
private final Boolean includeEdges;
private final QueryFilters filters;
private final Integer maxDepth;
private final Integer maxResults;
private final String nextToken;
private QueryLineageRequest(BuilderImpl builder) {
super(builder);
this.startArns = builder.startArns;
this.direction = builder.direction;
this.includeEdges = builder.includeEdges;
this.filters = builder.filters;
this.maxDepth = builder.maxDepth;
this.maxResults = builder.maxResults;
this.nextToken = builder.nextToken;
}
/**
* 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 {@code 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.
*/
public final boolean hasStartArns() {
return startArns != null && !(startArns instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasStartArns} method.
*
*
* @return A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.
*/
public final List startArns() {
return startArns;
}
/**
*
* 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, {@link #direction} will
* return {@link Direction#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #directionAsString}.
*
*
* @return Associations between lineage entities have a direction. This parameter determines the direction from the
* StartArn(s) that the query traverses.
* @see Direction
*/
public final Direction direction() {
return Direction.fromValue(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, {@link #direction} will
* return {@link Direction#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #directionAsString}.
*
*
* @return Associations between lineage entities have a direction. This parameter determines the direction from the
* StartArn(s) that the query traverses.
* @see Direction
*/
public final String directionAsString() {
return direction;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final Boolean includeEdges() {
return includeEdges;
}
/**
*
* 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.
*
*
*
*
* @return 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.
*
*
*/
public final QueryFilters filters() {
return filters;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final Integer maxDepth() {
return maxDepth;
}
/**
*
* Limits the number of vertices in the results. Use the NextToken in a response to to retrieve the
* next page of results.
*
*
* @return Limits the number of vertices in the results. Use the NextToken in a response to to retrieve
* the next page of results.
*/
public final Integer maxResults() {
return maxResults;
}
/**
*
* Limits the number of vertices in the request. Use the NextToken in a response to to retrieve the
* next page of results.
*
*
* @return Limits the number of vertices in the request. Use the NextToken in a response to to retrieve
* the next page of results.
*/
public final String nextToken() {
return nextToken;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(hasStartArns() ? startArns() : null);
hashCode = 31 * hashCode + Objects.hashCode(directionAsString());
hashCode = 31 * hashCode + Objects.hashCode(includeEdges());
hashCode = 31 * hashCode + Objects.hashCode(filters());
hashCode = 31 * hashCode + Objects.hashCode(maxDepth());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof QueryLineageRequest)) {
return false;
}
QueryLineageRequest other = (QueryLineageRequest) obj;
return hasStartArns() == other.hasStartArns() && Objects.equals(startArns(), other.startArns())
&& Objects.equals(directionAsString(), other.directionAsString())
&& Objects.equals(includeEdges(), other.includeEdges()) && Objects.equals(filters(), other.filters())
&& Objects.equals(maxDepth(), other.maxDepth()) && Objects.equals(maxResults(), other.maxResults())
&& Objects.equals(nextToken(), other.nextToken());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("QueryLineageRequest").add("StartArns", hasStartArns() ? startArns() : null)
.add("Direction", directionAsString()).add("IncludeEdges", includeEdges()).add("Filters", filters())
.add("MaxDepth", maxDepth()).add("MaxResults", maxResults()).add("NextToken", nextToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "StartArns":
return Optional.ofNullable(clazz.cast(startArns()));
case "Direction":
return Optional.ofNullable(clazz.cast(directionAsString()));
case "IncludeEdges":
return Optional.ofNullable(clazz.cast(includeEdges()));
case "Filters":
return Optional.ofNullable(clazz.cast(filters()));
case "MaxDepth":
return Optional.ofNullable(clazz.cast(maxDepth()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((QueryLineageRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.
*
*
* @param startArns
* A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage
* query.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder startArns(Collection startArns);
/**
*
* A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.
*
*
* @param startArns
* A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage
* query.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder startArns(String... startArns);
/**
*
* Associations between lineage entities have a direction. This parameter determines the direction from the
* StartArn(s) that the query traverses.
*
*
* @param direction
* Associations between lineage entities have a direction. This parameter determines the direction from
* the StartArn(s) that the query traverses.
* @see Direction
* @return Returns a reference to this object so that method calls can be chained together.
* @see Direction
*/
Builder direction(String direction);
/**
*
* Associations between lineage entities have a direction. This parameter determines the direction from the
* StartArn(s) that the query traverses.
*
*
* @param direction
* Associations between lineage entities have a direction. This parameter determines the direction from
* the StartArn(s) that the query traverses.
* @see Direction
* @return Returns a reference to this object so that method calls can be chained together.
* @see Direction
*/
Builder direction(Direction direction);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder includeEdges(Boolean includeEdges);
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
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, or Context.
*
*
* -
*
* CreatedBefore - Filter entities created before this date.
*
*
* -
*
* ModifiedBefore - Filter entities modified before this date.
*
*
* -
*
* ModifiedAfter - Filter entities modified after this date.
*
*
*
* This is a convenience method that creates an instance of the {@link QueryFilters.Builder} avoiding the need
* to create one manually via {@link QueryFilters#builder()}.
*
*
* When the {@link Consumer} completes, {@link QueryFilters.Builder#build()} is called immediately and its
* result is passed to {@link #filters(QueryFilters)}.
*
* @param filters
* a consumer that will call methods on {@link QueryFilters.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #filters(QueryFilters)
*/
default Builder filters(Consumer filters) {
return filters(QueryFilters.builder().applyMutation(filters).build());
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxDepth(Integer maxDepth);
/**
*
* Limits the number of vertices in the results. Use the NextToken in a response to to retrieve the
* next page of results.
*
*
* @param maxResults
* Limits the number of vertices in the results. Use the NextToken in a response to to
* retrieve the next page of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* Limits the number of vertices in the request. Use the NextToken in a response to to retrieve the
* next page of results.
*
*
* @param nextToken
* Limits the number of vertices in the request. Use the NextToken in a response to to
* retrieve the next page of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends SageMakerRequest.BuilderImpl implements Builder {
private List startArns = DefaultSdkAutoConstructList.getInstance();
private String direction;
private Boolean includeEdges;
private QueryFilters filters;
private Integer maxDepth;
private Integer maxResults;
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(QueryLineageRequest model) {
super(model);
startArns(model.startArns);
direction(model.direction);
includeEdges(model.includeEdges);
filters(model.filters);
maxDepth(model.maxDepth);
maxResults(model.maxResults);
nextToken(model.nextToken);
}
public final Collection getStartArns() {
if (startArns instanceof SdkAutoConstructList) {
return null;
}
return startArns;
}
public final void setStartArns(Collection startArns) {
this.startArns = QueryLineageStartArnsCopier.copy(startArns);
}
@Override
public final Builder startArns(Collection startArns) {
this.startArns = QueryLineageStartArnsCopier.copy(startArns);
return this;
}
@Override
@SafeVarargs
public final Builder startArns(String... startArns) {
startArns(Arrays.asList(startArns));
return this;
}
public final String getDirection() {
return direction;
}
public final void setDirection(String direction) {
this.direction = direction;
}
@Override
public final Builder direction(String direction) {
this.direction = direction;
return this;
}
@Override
public final Builder direction(Direction direction) {
this.direction(direction == null ? null : direction.toString());
return this;
}
public final Boolean getIncludeEdges() {
return includeEdges;
}
public final void setIncludeEdges(Boolean includeEdges) {
this.includeEdges = includeEdges;
}
@Override
public final Builder includeEdges(Boolean includeEdges) {
this.includeEdges = includeEdges;
return this;
}
public final QueryFilters.Builder getFilters() {
return filters != null ? filters.toBuilder() : null;
}
public final void setFilters(QueryFilters.BuilderImpl filters) {
this.filters = filters != null ? filters.build() : null;
}
@Override
public final Builder filters(QueryFilters filters) {
this.filters = filters;
return this;
}
public final Integer getMaxDepth() {
return maxDepth;
}
public final void setMaxDepth(Integer maxDepth) {
this.maxDepth = maxDepth;
}
@Override
public final Builder maxDepth(Integer maxDepth) {
this.maxDepth = maxDepth;
return this;
}
public final Integer getMaxResults() {
return maxResults;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public QueryLineageRequest build() {
return new QueryLineageRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}