software.amazon.awssdk.services.pi.model.DescribeDimensionKeysResponse Maven / Gradle / Ivy
/*
* 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.pi.model;
import java.time.Instant;
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 DescribeDimensionKeysResponse extends PiResponse implements
ToCopyableBuilder {
private static final SdkField ALIGNED_START_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.getter(getter(DescribeDimensionKeysResponse::alignedStartTime)).setter(setter(Builder::alignedStartTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AlignedStartTime").build()).build();
private static final SdkField ALIGNED_END_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.getter(getter(DescribeDimensionKeysResponse::alignedEndTime)).setter(setter(Builder::alignedEndTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AlignedEndTime").build()).build();
private static final SdkField> PARTITION_KEYS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(DescribeDimensionKeysResponse::partitionKeys))
.setter(setter(Builder::partitionKeys))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PartitionKeys").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ResponsePartitionKey::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> KEYS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(DescribeDimensionKeysResponse::keys))
.setter(setter(Builder::keys))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Keys").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(DimensionKeyDescription::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeDimensionKeysResponse::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(ALIGNED_START_TIME_FIELD,
ALIGNED_END_TIME_FIELD, PARTITION_KEYS_FIELD, KEYS_FIELD, NEXT_TOKEN_FIELD));
private final Instant alignedStartTime;
private final Instant alignedEndTime;
private final List partitionKeys;
private final List keys;
private final String nextToken;
private DescribeDimensionKeysResponse(BuilderImpl builder) {
super(builder);
this.alignedStartTime = builder.alignedStartTime;
this.alignedEndTime = builder.alignedEndTime;
this.partitionKeys = builder.partitionKeys;
this.keys = builder.keys;
this.nextToken = builder.nextToken;
}
/**
*
* The start time for the returned dimension keys, after alignment to a granular boundary (as specified by
* PeriodInSeconds). AlignedStartTime will be less than or equal to the value of the
* user-specified StartTime.
*
*
* @return The start time for the returned dimension keys, after alignment to a granular boundary (as specified by
* PeriodInSeconds). AlignedStartTime will be less than or equal to the value of
* the user-specified StartTime.
*/
public Instant alignedStartTime() {
return alignedStartTime;
}
/**
*
* The end time for the returned dimension keys, after alignment to a granular boundary (as specified by
* PeriodInSeconds). AlignedEndTime will be greater than or equal to the value of the
* user-specified Endtime.
*
*
* @return The end time for the returned dimension keys, after alignment to a granular boundary (as specified by
* PeriodInSeconds). AlignedEndTime will be greater than or equal to the value of
* the user-specified Endtime.
*/
public Instant alignedEndTime() {
return alignedEndTime;
}
/**
* Returns true if the PartitionKeys property was specified by the sender (it may be empty), or false if the sender
* did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public boolean hasPartitionKeys() {
return partitionKeys != null && !(partitionKeys instanceof SdkAutoConstructList);
}
/**
*
* If PartitionBy was present in the request, PartitionKeys contains the breakdown of
* dimension keys by the specified partitions.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasPartitionKeys()} to see if a value was sent in this field.
*
*
* @return If PartitionBy was present in the request, PartitionKeys contains the breakdown
* of dimension keys by the specified partitions.
*/
public List partitionKeys() {
return partitionKeys;
}
/**
* Returns true if the Keys property was specified by the sender (it may be empty), or false if the sender did not
* specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public boolean hasKeys() {
return keys != null && !(keys instanceof SdkAutoConstructList);
}
/**
*
* The dimension keys that were requested.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasKeys()} to see if a value was sent in this field.
*
*
* @return The dimension keys that were requested.
*/
public List keys() {
return keys;
}
/**
*
* An optional pagination token provided by a previous request. If this parameter is specified, the response
* includes only records beyond the token, up to the value specified by MaxRecords.
*
*
* @return An optional pagination token provided by a previous request. If this parameter is specified, the response
* includes only records beyond the token, up to the value specified by MaxRecords.
*/
public 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 int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(alignedStartTime());
hashCode = 31 * hashCode + Objects.hashCode(alignedEndTime());
hashCode = 31 * hashCode + Objects.hashCode(partitionKeys());
hashCode = 31 * hashCode + Objects.hashCode(keys());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeDimensionKeysResponse)) {
return false;
}
DescribeDimensionKeysResponse other = (DescribeDimensionKeysResponse) obj;
return Objects.equals(alignedStartTime(), other.alignedStartTime())
&& Objects.equals(alignedEndTime(), other.alignedEndTime())
&& Objects.equals(partitionKeys(), other.partitionKeys()) && Objects.equals(keys(), other.keys())
&& 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 String toString() {
return ToString.builder("DescribeDimensionKeysResponse").add("AlignedStartTime", alignedStartTime())
.add("AlignedEndTime", alignedEndTime()).add("PartitionKeys", partitionKeys()).add("Keys", keys())
.add("NextToken", nextToken()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AlignedStartTime":
return Optional.ofNullable(clazz.cast(alignedStartTime()));
case "AlignedEndTime":
return Optional.ofNullable(clazz.cast(alignedEndTime()));
case "PartitionKeys":
return Optional.ofNullable(clazz.cast(partitionKeys()));
case "Keys":
return Optional.ofNullable(clazz.cast(keys()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeDimensionKeysResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends PiResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* The start time for the returned dimension keys, after alignment to a granular boundary (as specified by
* PeriodInSeconds). AlignedStartTime will be less than or equal to the value of the
* user-specified StartTime.
*
*
* @param alignedStartTime
* The start time for the returned dimension keys, after alignment to a granular boundary (as specified
* by PeriodInSeconds). AlignedStartTime will be less than or equal to the
* value of the user-specified StartTime.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder alignedStartTime(Instant alignedStartTime);
/**
*
* The end time for the returned dimension keys, after alignment to a granular boundary (as specified by
* PeriodInSeconds). AlignedEndTime will be greater than or equal to the value of the
* user-specified Endtime.
*
*
* @param alignedEndTime
* The end time for the returned dimension keys, after alignment to a granular boundary (as specified by
* PeriodInSeconds). AlignedEndTime will be greater than or equal to the value
* of the user-specified Endtime.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder alignedEndTime(Instant alignedEndTime);
/**
*
* If PartitionBy was present in the request, PartitionKeys contains the breakdown of
* dimension keys by the specified partitions.
*
*
* @param partitionKeys
* If PartitionBy was present in the request, PartitionKeys contains the
* breakdown of dimension keys by the specified partitions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder partitionKeys(Collection partitionKeys);
/**
*
* If PartitionBy was present in the request, PartitionKeys contains the breakdown of
* dimension keys by the specified partitions.
*
*
* @param partitionKeys
* If PartitionBy was present in the request, PartitionKeys contains the
* breakdown of dimension keys by the specified partitions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder partitionKeys(ResponsePartitionKey... partitionKeys);
/**
*
* If PartitionBy was present in the request, PartitionKeys contains the breakdown of
* dimension keys by the specified partitions.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the
* need to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately
* and its result is passed to {@link #partitionKeys(List)}.
*
* @param partitionKeys
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #partitionKeys(List)
*/
Builder partitionKeys(Consumer... partitionKeys);
/**
*
* The dimension keys that were requested.
*
*
* @param keys
* The dimension keys that were requested.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder keys(Collection keys);
/**
*
* The dimension keys that were requested.
*
*
* @param keys
* The dimension keys that were requested.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder keys(DimensionKeyDescription... keys);
/**
*
* The dimension keys that were requested.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding
* the need to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called
* immediately and its result is passed to {@link #keys(List)}.
*
* @param keys
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #keys(List)
*/
Builder keys(Consumer... keys);
/**
*
* An optional pagination token provided by a previous request. If this parameter is specified, the response
* includes only records beyond the token, up to the value specified by MaxRecords.
*
*
* @param nextToken
* An optional pagination token provided by a previous request. If this parameter is specified, the
* response includes only records beyond the token, up to the value specified by MaxRecords.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
}
static final class BuilderImpl extends PiResponse.BuilderImpl implements Builder {
private Instant alignedStartTime;
private Instant alignedEndTime;
private List partitionKeys = DefaultSdkAutoConstructList.getInstance();
private List keys = DefaultSdkAutoConstructList.getInstance();
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(DescribeDimensionKeysResponse model) {
super(model);
alignedStartTime(model.alignedStartTime);
alignedEndTime(model.alignedEndTime);
partitionKeys(model.partitionKeys);
keys(model.keys);
nextToken(model.nextToken);
}
public final Instant getAlignedStartTime() {
return alignedStartTime;
}
@Override
public final Builder alignedStartTime(Instant alignedStartTime) {
this.alignedStartTime = alignedStartTime;
return this;
}
public final void setAlignedStartTime(Instant alignedStartTime) {
this.alignedStartTime = alignedStartTime;
}
public final Instant getAlignedEndTime() {
return alignedEndTime;
}
@Override
public final Builder alignedEndTime(Instant alignedEndTime) {
this.alignedEndTime = alignedEndTime;
return this;
}
public final void setAlignedEndTime(Instant alignedEndTime) {
this.alignedEndTime = alignedEndTime;
}
public final Collection getPartitionKeys() {
return partitionKeys != null ? partitionKeys.stream().map(ResponsePartitionKey::toBuilder)
.collect(Collectors.toList()) : null;
}
@Override
public final Builder partitionKeys(Collection partitionKeys) {
this.partitionKeys = ResponsePartitionKeyListCopier.copy(partitionKeys);
return this;
}
@Override
@SafeVarargs
public final Builder partitionKeys(ResponsePartitionKey... partitionKeys) {
partitionKeys(Arrays.asList(partitionKeys));
return this;
}
@Override
@SafeVarargs
public final Builder partitionKeys(Consumer... partitionKeys) {
partitionKeys(Stream.of(partitionKeys).map(c -> ResponsePartitionKey.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final void setPartitionKeys(Collection partitionKeys) {
this.partitionKeys = ResponsePartitionKeyListCopier.copyFromBuilder(partitionKeys);
}
public final Collection getKeys() {
return keys != null ? keys.stream().map(DimensionKeyDescription::toBuilder).collect(Collectors.toList()) : null;
}
@Override
public final Builder keys(Collection keys) {
this.keys = DimensionKeyDescriptionListCopier.copy(keys);
return this;
}
@Override
@SafeVarargs
public final Builder keys(DimensionKeyDescription... keys) {
keys(Arrays.asList(keys));
return this;
}
@Override
@SafeVarargs
public final Builder keys(Consumer... keys) {
keys(Stream.of(keys).map(c -> DimensionKeyDescription.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final void setKeys(Collection keys) {
this.keys = DimensionKeyDescriptionListCopier.copyFromBuilder(keys);
}
public final String getNextToken() {
return nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public DescribeDimensionKeysResponse build() {
return new DescribeDimensionKeysResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy