software.amazon.awssdk.services.pinpoint.model.JourneyRunsResponse Maven / Gradle / Ivy
Show all versions of pinpoint 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.pinpoint.model;
import java.io.Serializable;
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;
/**
*
* Provides information from all runs of a journey.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class JourneyRunsResponse implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> ITEM_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Item")
.getter(getter(JourneyRunsResponse::item))
.setter(setter(Builder::item))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Item").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(JourneyRunResponse::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(JourneyRunsResponse::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(ITEM_FIELD, NEXT_TOKEN_FIELD));
private static final long serialVersionUID = 1L;
private final List item;
private final String nextToken;
private JourneyRunsResponse(BuilderImpl builder) {
this.item = builder.item;
this.nextToken = builder.nextToken;
}
/**
* For responses, this returns true if the service returned a value for the Item 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 hasItem() {
return item != null && !(item instanceof SdkAutoConstructList);
}
/**
*
* An array of responses, one for each run of the journey
*
*
* 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 #hasItem} method.
*
*
* @return An array of responses, one for each run of the journey
*/
public final List item() {
return item;
}
/**
*
* The string to use in a subsequent request to get the next page of results in a paginated response. This value is
* null if there are no additional pages.
*
*
* @return The string to use in a subsequent request to get the next page of results in a paginated response. This
* value is null if there are no additional pages.
*/
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 + Objects.hashCode(hasItem() ? item() : null);
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof JourneyRunsResponse)) {
return false;
}
JourneyRunsResponse other = (JourneyRunsResponse) obj;
return hasItem() == other.hasItem() && Objects.equals(item(), other.item())
&& 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("JourneyRunsResponse").add("Item", hasItem() ? item() : null).add("NextToken", nextToken())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Item":
return Optional.ofNullable(clazz.cast(item()));
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((JourneyRunsResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* An array of responses, one for each run of the journey
*
*
* @param item
* An array of responses, one for each run of the journey
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder item(Collection item);
/**
*
* An array of responses, one for each run of the journey
*
*
* @param item
* An array of responses, one for each run of the journey
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder item(JourneyRunResponse... item);
/**
*
* An array of responses, one for each run of the journey
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.pinpoint.model.JourneyRunResponse.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.pinpoint.model.JourneyRunResponse#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.pinpoint.model.JourneyRunResponse.Builder#build()} is called
* immediately and its result is passed to {@link #item(List)}.
*
* @param item
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.pinpoint.model.JourneyRunResponse.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #item(java.util.Collection)
*/
Builder item(Consumer... item);
/**
*
* The string to use in a subsequent request to get the next page of results in a paginated response. This value
* is null if there are no additional pages.
*
*
* @param nextToken
* The string to use in a subsequent request to get the next page of results in a paginated response.
* This value is null if there are no additional pages.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
}
static final class BuilderImpl implements Builder {
private List item = DefaultSdkAutoConstructList.getInstance();
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(JourneyRunsResponse model) {
item(model.item);
nextToken(model.nextToken);
}
public final List getItem() {
List result = ListOfJourneyRunResponseCopier.copyToBuilder(this.item);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setItem(Collection item) {
this.item = ListOfJourneyRunResponseCopier.copyFromBuilder(item);
}
@Override
public final Builder item(Collection item) {
this.item = ListOfJourneyRunResponseCopier.copy(item);
return this;
}
@Override
@SafeVarargs
public final Builder item(JourneyRunResponse... item) {
item(Arrays.asList(item));
return this;
}
@Override
@SafeVarargs
public final Builder item(Consumer... item) {
item(Stream.of(item).map(c -> JourneyRunResponse.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 JourneyRunsResponse build() {
return new JourneyRunsResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}