software.amazon.awssdk.services.connect.model.HierarchyGroup Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of connect Show documentation
Show all versions of connect Show documentation
The AWS Java SDK for Connect module holds the client classes that are used for
communicating with Connect.
/*
* 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.connect.model;
import java.beans.Transient;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
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.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains information about a hierarchy group.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class HierarchyGroup implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Id")
.getter(getter(HierarchyGroup::id)).setter(setter(Builder::id))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Id").build()).build();
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Arn")
.getter(getter(HierarchyGroup::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Arn").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(HierarchyGroup::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField LEVEL_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("LevelId").getter(getter(HierarchyGroup::levelId)).setter(setter(Builder::levelId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LevelId").build()).build();
private static final SdkField HIERARCHY_PATH_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("HierarchyPath")
.getter(getter(HierarchyGroup::hierarchyPath)).setter(setter(Builder::hierarchyPath))
.constructor(HierarchyPath::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("HierarchyPath").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Tags")
.getter(getter(HierarchyGroup::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ID_FIELD, ARN_FIELD,
NAME_FIELD, LEVEL_ID_FIELD, HIERARCHY_PATH_FIELD, TAGS_FIELD));
private static final long serialVersionUID = 1L;
private final String id;
private final String arn;
private final String name;
private final String levelId;
private final HierarchyPath hierarchyPath;
private final Map tags;
private HierarchyGroup(BuilderImpl builder) {
this.id = builder.id;
this.arn = builder.arn;
this.name = builder.name;
this.levelId = builder.levelId;
this.hierarchyPath = builder.hierarchyPath;
this.tags = builder.tags;
}
/**
*
* The identifier of the hierarchy group.
*
*
* @return The identifier of the hierarchy group.
*/
public final String id() {
return id;
}
/**
*
* The Amazon Resource Name (ARN) of the hierarchy group.
*
*
* @return The Amazon Resource Name (ARN) of the hierarchy group.
*/
public final String arn() {
return arn;
}
/**
*
* The name of the hierarchy group.
*
*
* @return The name of the hierarchy group.
*/
public final String name() {
return name;
}
/**
*
* The identifier of the level in the hierarchy group.
*
*
* @return The identifier of the level in the hierarchy group.
*/
public final String levelId() {
return levelId;
}
/**
*
* Information about the levels in the hierarchy group.
*
*
* @return Information about the levels in the hierarchy group.
*/
public final HierarchyPath hierarchyPath() {
return hierarchyPath;
}
/**
* For responses, this returns true if the service returned a value for the Tags 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 hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructMap);
}
/**
*
* The tags used to organize, track, or control access for this resource.
*
*
* 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 #hasTags} method.
*
*
* @return The tags used to organize, track, or control access for this resource.
*/
public final Map tags() {
return tags;
}
@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(id());
hashCode = 31 * hashCode + Objects.hashCode(arn());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(levelId());
hashCode = 31 * hashCode + Objects.hashCode(hierarchyPath());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
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 HierarchyGroup)) {
return false;
}
HierarchyGroup other = (HierarchyGroup) obj;
return Objects.equals(id(), other.id()) && Objects.equals(arn(), other.arn()) && Objects.equals(name(), other.name())
&& Objects.equals(levelId(), other.levelId()) && Objects.equals(hierarchyPath(), other.hierarchyPath())
&& hasTags() == other.hasTags() && Objects.equals(tags(), other.tags());
}
/**
* 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("HierarchyGroup").add("Id", id()).add("Arn", arn()).add("Name", name()).add("LevelId", levelId())
.add("HierarchyPath", hierarchyPath()).add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Id":
return Optional.ofNullable(clazz.cast(id()));
case "Arn":
return Optional.ofNullable(clazz.cast(arn()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "LevelId":
return Optional.ofNullable(clazz.cast(levelId()));
case "HierarchyPath":
return Optional.ofNullable(clazz.cast(hierarchyPath()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((HierarchyGroup) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The identifier of the hierarchy group.
*
*
* @param id
* The identifier of the hierarchy group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder id(String id);
/**
*
* The Amazon Resource Name (ARN) of the hierarchy group.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the hierarchy group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arn(String arn);
/**
*
* The name of the hierarchy group.
*
*
* @param name
* The name of the hierarchy group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The identifier of the level in the hierarchy group.
*
*
* @param levelId
* The identifier of the level in the hierarchy group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder levelId(String levelId);
/**
*
* Information about the levels in the hierarchy group.
*
*
* @param hierarchyPath
* Information about the levels in the hierarchy group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder hierarchyPath(HierarchyPath hierarchyPath);
/**
*
* Information about the levels in the hierarchy group.
*
* This is a convenience that creates an instance of the {@link HierarchyPath.Builder} avoiding the need to
* create one manually via {@link HierarchyPath#builder()}.
*
* When the {@link Consumer} completes, {@link HierarchyPath.Builder#build()} is called immediately and its
* result is passed to {@link #hierarchyPath(HierarchyPath)}.
*
* @param hierarchyPath
* a consumer that will call methods on {@link HierarchyPath.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #hierarchyPath(HierarchyPath)
*/
default Builder hierarchyPath(Consumer hierarchyPath) {
return hierarchyPath(HierarchyPath.builder().applyMutation(hierarchyPath).build());
}
/**
*
* The tags used to organize, track, or control access for this resource.
*
*
* @param tags
* The tags used to organize, track, or control access for this resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
}
static final class BuilderImpl implements Builder {
private String id;
private String arn;
private String name;
private String levelId;
private HierarchyPath hierarchyPath;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(HierarchyGroup model) {
id(model.id);
arn(model.arn);
name(model.name);
levelId(model.levelId);
hierarchyPath(model.hierarchyPath);
tags(model.tags);
}
public final String getId() {
return id;
}
public final void setId(String id) {
this.id = id;
}
@Override
@Transient
public final Builder id(String id) {
this.id = id;
return this;
}
public final String getArn() {
return arn;
}
public final void setArn(String arn) {
this.arn = arn;
}
@Override
@Transient
public final Builder arn(String arn) {
this.arn = arn;
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
@Transient
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getLevelId() {
return levelId;
}
public final void setLevelId(String levelId) {
this.levelId = levelId;
}
@Override
@Transient
public final Builder levelId(String levelId) {
this.levelId = levelId;
return this;
}
public final HierarchyPath.Builder getHierarchyPath() {
return hierarchyPath != null ? hierarchyPath.toBuilder() : null;
}
public final void setHierarchyPath(HierarchyPath.BuilderImpl hierarchyPath) {
this.hierarchyPath = hierarchyPath != null ? hierarchyPath.build() : null;
}
@Override
@Transient
public final Builder hierarchyPath(HierarchyPath hierarchyPath) {
this.hierarchyPath = hierarchyPath;
return this;
}
public final Map getTags() {
if (tags instanceof SdkAutoConstructMap) {
return null;
}
return tags;
}
public final void setTags(Map tags) {
this.tags = TagMapCopier.copy(tags);
}
@Override
@Transient
public final Builder tags(Map tags) {
this.tags = TagMapCopier.copy(tags);
return this;
}
@Override
public HierarchyGroup build() {
return new HierarchyGroup(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy