software.amazon.awssdk.services.timestreamwrite.model.Dimension Maven / Gradle / Ivy
Show all versions of timestreamwrite 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.timestreamwrite.model;
import java.io.Serializable;
import java.util.Arrays;
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.Function;
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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Represents the metadata attributes of the time series. For example, the name and Availability Zone of an EC2 instance
* or the name of the manufacturer of a wind turbine are dimensions.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Dimension implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(Dimension::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField VALUE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Value")
.getter(getter(Dimension::value)).setter(setter(Builder::value))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Value").build()).build();
private static final SdkField DIMENSION_VALUE_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DimensionValueType").getter(getter(Dimension::dimensionValueTypeAsString))
.setter(setter(Builder::dimensionValueType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DimensionValueType").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, VALUE_FIELD,
DIMENSION_VALUE_TYPE_FIELD));
private static final long serialVersionUID = 1L;
private final String name;
private final String value;
private final String dimensionValueType;
private Dimension(BuilderImpl builder) {
this.name = builder.name;
this.value = builder.value;
this.dimensionValueType = builder.dimensionValueType;
}
/**
*
* Dimension represents the metadata attributes of the time series. For example, the name and Availability Zone of
* an EC2 instance or the name of the manufacturer of a wind turbine are dimensions.
*
*
* For constraints on dimension names, see Naming
* Constraints.
*
*
* @return Dimension represents the metadata attributes of the time series. For example, the name and Availability
* Zone of an EC2 instance or the name of the manufacturer of a wind turbine are dimensions.
*
* For constraints on dimension names, see Naming
* Constraints.
*/
public final String name() {
return name;
}
/**
*
* The value of the dimension.
*
*
* @return The value of the dimension.
*/
public final String value() {
return value;
}
/**
*
* The data type of the dimension for the time-series data point.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #dimensionValueType} will return {@link DimensionValueType#UNKNOWN_TO_SDK_VERSION}. The raw value returned
* by the service is available from {@link #dimensionValueTypeAsString}.
*
*
* @return The data type of the dimension for the time-series data point.
* @see DimensionValueType
*/
public final DimensionValueType dimensionValueType() {
return DimensionValueType.fromValue(dimensionValueType);
}
/**
*
* The data type of the dimension for the time-series data point.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #dimensionValueType} will return {@link DimensionValueType#UNKNOWN_TO_SDK_VERSION}. The raw value returned
* by the service is available from {@link #dimensionValueTypeAsString}.
*
*
* @return The data type of the dimension for the time-series data point.
* @see DimensionValueType
*/
public final String dimensionValueTypeAsString() {
return dimensionValueType;
}
@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(name());
hashCode = 31 * hashCode + Objects.hashCode(value());
hashCode = 31 * hashCode + Objects.hashCode(dimensionValueTypeAsString());
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 Dimension)) {
return false;
}
Dimension other = (Dimension) obj;
return Objects.equals(name(), other.name()) && Objects.equals(value(), other.value())
&& Objects.equals(dimensionValueTypeAsString(), other.dimensionValueTypeAsString());
}
/**
* 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("Dimension").add("Name", name()).add("Value", value())
.add("DimensionValueType", dimensionValueTypeAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Value":
return Optional.ofNullable(clazz.cast(value()));
case "DimensionValueType":
return Optional.ofNullable(clazz.cast(dimensionValueTypeAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Dimension) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Dimension represents the metadata attributes of the time series. For example, the name and Availability Zone
* of an EC2 instance or the name of the manufacturer of a wind turbine are dimensions.
*
*
* For constraints on dimension names, see Naming
* Constraints.
*
*
* @param name
* Dimension represents the metadata attributes of the time series. For example, the name and
* Availability Zone of an EC2 instance or the name of the manufacturer of a wind turbine are dimensions.
*
*
* For constraints on dimension names, see Naming Constraints.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The value of the dimension.
*
*
* @param value
* The value of the dimension.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder value(String value);
/**
*
* The data type of the dimension for the time-series data point.
*
*
* @param dimensionValueType
* The data type of the dimension for the time-series data point.
* @see DimensionValueType
* @return Returns a reference to this object so that method calls can be chained together.
* @see DimensionValueType
*/
Builder dimensionValueType(String dimensionValueType);
/**
*
* The data type of the dimension for the time-series data point.
*
*
* @param dimensionValueType
* The data type of the dimension for the time-series data point.
* @see DimensionValueType
* @return Returns a reference to this object so that method calls can be chained together.
* @see DimensionValueType
*/
Builder dimensionValueType(DimensionValueType dimensionValueType);
}
static final class BuilderImpl implements Builder {
private String name;
private String value;
private String dimensionValueType;
private BuilderImpl() {
}
private BuilderImpl(Dimension model) {
name(model.name);
value(model.value);
dimensionValueType(model.dimensionValueType);
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getValue() {
return value;
}
public final void setValue(String value) {
this.value = value;
}
@Override
public final Builder value(String value) {
this.value = value;
return this;
}
public final String getDimensionValueType() {
return dimensionValueType;
}
public final void setDimensionValueType(String dimensionValueType) {
this.dimensionValueType = dimensionValueType;
}
@Override
public final Builder dimensionValueType(String dimensionValueType) {
this.dimensionValueType = dimensionValueType;
return this;
}
@Override
public final Builder dimensionValueType(DimensionValueType dimensionValueType) {
this.dimensionValueType(dimensionValueType == null ? null : dimensionValueType.toString());
return this;
}
@Override
public Dimension build() {
return new Dimension(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}