software.amazon.awssdk.services.sagemaker.model.QueryLineageResponse 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 java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
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 QueryLineageResponse extends SageMakerResponse implements
ToCopyableBuilder {
private static final SdkField> VERTICES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Vertices")
.getter(getter(QueryLineageResponse::vertices))
.setter(setter(Builder::vertices))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Vertices").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Vertex::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> EDGES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Edges")
.getter(getter(QueryLineageResponse::edges))
.setter(setter(Builder::edges))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Edges").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Edge::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(QueryLineageResponse::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(VERTICES_FIELD, EDGES_FIELD,
NEXT_TOKEN_FIELD));
private final List vertices;
private final List edges;
private final String nextToken;
private QueryLineageResponse(BuilderImpl builder) {
super(builder);
this.vertices = builder.vertices;
this.edges = builder.edges;
this.nextToken = builder.nextToken;
}
/**
* For responses, this returns true if the service returned a value for the Vertices 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 hasVertices() {
return vertices != null && !(vertices instanceof SdkAutoConstructList);
}
/**
*
* A list of vertices connected to the start entity(ies) in the lineage graph.
*
*
* 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 #hasVertices} method.
*
*
* @return A list of vertices connected to the start entity(ies) in the lineage graph.
*/
public final List vertices() {
return vertices;
}
/**
* For responses, this returns true if the service returned a value for the Edges 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 hasEdges() {
return edges != null && !(edges instanceof SdkAutoConstructList);
}
/**
*
* A list of edges that connect vertices in the response.
*
*
* 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 #hasEdges} method.
*
*
* @return A list of edges that connect vertices in the response.
*/
public final List edges() {
return edges;
}
/**
*
* Limits the number of vertices in the response. Use the NextToken in a response to to retrieve the
* next page of results.
*
*
* @return Limits the number of vertices in the response. 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(hasVertices() ? vertices() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasEdges() ? edges() : null);
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 QueryLineageResponse)) {
return false;
}
QueryLineageResponse other = (QueryLineageResponse) obj;
return hasVertices() == other.hasVertices() && Objects.equals(vertices(), other.vertices())
&& hasEdges() == other.hasEdges() && Objects.equals(edges(), other.edges())
&& 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("QueryLineageResponse").add("Vertices", hasVertices() ? vertices() : null)
.add("Edges", hasEdges() ? edges() : null).add("NextToken", nextToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Vertices":
return Optional.ofNullable(clazz.cast(vertices()));
case "Edges":
return Optional.ofNullable(clazz.cast(edges()));
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((QueryLineageResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SageMakerResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* A list of vertices connected to the start entity(ies) in the lineage graph.
*
*
* @param vertices
* A list of vertices connected to the start entity(ies) in the lineage graph.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder vertices(Collection vertices);
/**
*
* A list of vertices connected to the start entity(ies) in the lineage graph.
*
*
* @param vertices
* A list of vertices connected to the start entity(ies) in the lineage graph.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder vertices(Vertex... vertices);
/**
*
* A list of vertices connected to the start entity(ies) in the lineage graph.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.sagemaker.model.Vertex.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.sagemaker.model.Vertex#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.sagemaker.model.Vertex.Builder#build()} is called immediately and its
* result is passed to {@link #vertices(List)}.
*
* @param vertices
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.sagemaker.model.Vertex.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #vertices(java.util.Collection)
*/
Builder vertices(Consumer... vertices);
/**
*
* A list of edges that connect vertices in the response.
*
*
* @param edges
* A list of edges that connect vertices in the response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder edges(Collection edges);
/**
*
* A list of edges that connect vertices in the response.
*
*
* @param edges
* A list of edges that connect vertices in the response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder edges(Edge... edges);
/**
*
* A list of edges that connect vertices in the response.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.sagemaker.model.Edge.Builder} avoiding the need to create one manually
* via {@link software.amazon.awssdk.services.sagemaker.model.Edge#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.sagemaker.model.Edge.Builder#build()} is called immediately and its
* result is passed to {@link #edges(List)}.
*
* @param edges
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.sagemaker.model.Edge.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #edges(java.util.Collection)
*/
Builder edges(Consumer... edges);
/**
*
* Limits the number of vertices in the response. Use the NextToken in a response to to retrieve
* the next page of results.
*
*
* @param nextToken
* Limits the number of vertices in the response. 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);
}
static final class BuilderImpl extends SageMakerResponse.BuilderImpl implements Builder {
private List vertices = DefaultSdkAutoConstructList.getInstance();
private List edges = DefaultSdkAutoConstructList.getInstance();
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(QueryLineageResponse model) {
super(model);
vertices(model.vertices);
edges(model.edges);
nextToken(model.nextToken);
}
public final List getVertices() {
List result = VerticesCopier.copyToBuilder(this.vertices);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setVertices(Collection vertices) {
this.vertices = VerticesCopier.copyFromBuilder(vertices);
}
@Override
public final Builder vertices(Collection vertices) {
this.vertices = VerticesCopier.copy(vertices);
return this;
}
@Override
@SafeVarargs
public final Builder vertices(Vertex... vertices) {
vertices(Arrays.asList(vertices));
return this;
}
@Override
@SafeVarargs
public final Builder vertices(Consumer... vertices) {
vertices(Stream.of(vertices).map(c -> Vertex.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final List getEdges() {
List result = EdgesCopier.copyToBuilder(this.edges);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setEdges(Collection edges) {
this.edges = EdgesCopier.copyFromBuilder(edges);
}
@Override
public final Builder edges(Collection edges) {
this.edges = EdgesCopier.copy(edges);
return this;
}
@Override
@SafeVarargs
public final Builder edges(Edge... edges) {
edges(Arrays.asList(edges));
return this;
}
@Override
@SafeVarargs
public final Builder edges(Consumer... edges) {
edges(Stream.of(edges).map(c -> Edge.builder().applyMutation(c).build()).collect(Collectors.toList()));
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 QueryLineageResponse build() {
return new QueryLineageResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}