software.amazon.awssdk.services.athena.model.Tag 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.athena.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;
/**
*
* A label that you assign to a resource. In Athena, a resource can be a workgroup or data catalog. Each tag consists of
* a key and an optional value, both of which you define. For example, you can use tags to categorize Athena workgroups
* or data catalogs by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and
* filter workgroups or data catalogs in your account. For best practices, see Tagging Best Practices. Tag keys
* can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can
* use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values
* are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Tag implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField KEY_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Key")
.getter(getter(Tag::key)).setter(setter(Builder::key))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Key").build()).build();
private static final SdkField VALUE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Value")
.getter(getter(Tag::value)).setter(setter(Builder::value))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Value").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(KEY_FIELD, VALUE_FIELD));
private static final long serialVersionUID = 1L;
private final String key;
private final String value;
private Tag(BuilderImpl builder) {
this.key = builder.key;
this.value = builder.value;
}
/**
*
* A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8. You can use letters and numbers
* representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys are case-sensitive and must be
* unique per resource.
*
*
* @return A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8. You can use letters and
* numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys are
* case-sensitive and must be unique per resource.
*/
public final String key() {
return key;
}
/**
*
* A tag value. The tag value length is from 0 to 256 Unicode characters in UTF-8. You can use letters and numbers
* representable in UTF-8, and the following characters: + - = . _ : / @. Tag values are case-sensitive.
*
*
* @return A tag value. The tag value length is from 0 to 256 Unicode characters in UTF-8. You can use letters and
* numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag values are
* case-sensitive.
*/
public final String value() {
return value;
}
@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(key());
hashCode = 31 * hashCode + Objects.hashCode(value());
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 Tag)) {
return false;
}
Tag other = (Tag) obj;
return Objects.equals(key(), other.key()) && Objects.equals(value(), other.value());
}
/**
* 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("Tag").add("Key", key()).add("Value", value()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Key":
return Optional.ofNullable(clazz.cast(key()));
case "Value":
return Optional.ofNullable(clazz.cast(value()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Tag) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8. You can use letters and numbers
* representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys are case-sensitive and must
* be unique per resource.
*
*
* @param key
* A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8. You can use letters and
* numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys are
* case-sensitive and must be unique per resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder key(String key);
/**
*
* A tag value. The tag value length is from 0 to 256 Unicode characters in UTF-8. You can use letters and
* numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag values are case-sensitive.
*
*
* @param value
* A tag value. The tag value length is from 0 to 256 Unicode characters in UTF-8. You can use letters
* and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag values are
* case-sensitive.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder value(String value);
}
static final class BuilderImpl implements Builder {
private String key;
private String value;
private BuilderImpl() {
}
private BuilderImpl(Tag model) {
key(model.key);
value(model.value);
}
public final String getKey() {
return key;
}
@Override
public final Builder key(String key) {
this.key = key;
return this;
}
public final void setKey(String key) {
this.key = key;
}
public final String getValue() {
return value;
}
@Override
public final Builder value(String value) {
this.value = value;
return this;
}
public final void setValue(String value) {
this.value = value;
}
@Override
public Tag build() {
return new Tag(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}