software.amazon.awssdk.services.iam.model.Group Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of iam Show documentation
The AWS Java SDK for AWS IAM module holds the client classes that are used for communicating with AWS Identity and Access Management Service
There is a newer version: 2.30.1
Show newest version
/*
 * Copyright 2014-2019 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.iam.model;

import java.io.Serializable;
import java.time.Instant;
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;

/**
 * 
 * Contains information about an IAM group entity.
 * 
 * 
 * This data type is used as a response element in the following operations:
 * 
 * 
 * 
 * 
 * CreateGroup
 * 
 * 
 * 
 * 
 * GetGroup
 * 
 * 
 * 
 * 
 * ListGroups
 * 
 * 
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class Group implements SdkPojo, Serializable, ToCopyableBuilder {
    private static final SdkField PATH_FIELD = SdkField. builder(MarshallingType.STRING)
            .getter(getter(Group::path)).setter(setter(Builder::path))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Path").build()).build();

    private static final SdkField GROUP_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
            .getter(getter(Group::groupName)).setter(setter(Builder::groupName))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GroupName").build()).build();

    private static final SdkField GROUP_ID_FIELD = SdkField. builder(MarshallingType.STRING)
            .getter(getter(Group::groupId)).setter(setter(Builder::groupId))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GroupId").build()).build();

    private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING)
            .getter(getter(Group::arn)).setter(setter(Builder::arn))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Arn").build()).build();

    private static final SdkField CREATE_DATE_FIELD = SdkField. builder(MarshallingType.INSTANT)
            .getter(getter(Group::createDate)).setter(setter(Builder::createDate))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreateDate").build()).build();

    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PATH_FIELD, GROUP_NAME_FIELD,
            GROUP_ID_FIELD, ARN_FIELD, CREATE_DATE_FIELD));

    private static final long serialVersionUID = 1L;

    private final String path;

    private final String groupName;

    private final String groupId;

    private final String arn;

    private final Instant createDate;

    private Group(BuilderImpl builder) {
        this.path = builder.path;
        this.groupName = builder.groupName;
        this.groupId = builder.groupId;
        this.arn = builder.arn;
        this.createDate = builder.createDate;
    }

    /**
     * 
     * The path to the group. For more information about paths, see IAM Identifiers in the Using
     * IAM guide.
     * 
     * 
     * @return The path to the group. For more information about paths, see IAM Identifiers in the
     *         Using IAM guide.
     */
    public String path() {
        return path;
    }

    /**
     * 
     * The friendly name that identifies the group.
     * 
     * 
     * @return The friendly name that identifies the group.
     */
    public String groupName() {
        return groupName;
    }

    /**
     * 
     * The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the Using
     * IAM guide.
     * 
     * 
     * @return The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the
     *         Using IAM guide.
     */
    public String groupId() {
        return groupId;
    }

    /**
     * 
     * The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in
     * policies, see IAM
     * Identifiers in the Using IAM guide.
     * 
     * 
     * @return The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them
     *         in policies, see IAM
     *         Identifiers in the Using IAM guide.
     */
    public String arn() {
        return arn;
    }

    /**
     * 
     * The date and time, in ISO 8601 date-time format, when the group was
     * created.
     * 
     * 
     * @return The date and time, in ISO 8601 date-time format, when the
     *         group was created.
     */
    public Instant createDate() {
        return createDate;
    }

    @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 + Objects.hashCode(path());
        hashCode = 31 * hashCode + Objects.hashCode(groupName());
        hashCode = 31 * hashCode + Objects.hashCode(groupId());
        hashCode = 31 * hashCode + Objects.hashCode(arn());
        hashCode = 31 * hashCode + Objects.hashCode(createDate());
        return hashCode;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (!(obj instanceof Group)) {
            return false;
        }
        Group other = (Group) obj;
        return Objects.equals(path(), other.path()) && Objects.equals(groupName(), other.groupName())
                && Objects.equals(groupId(), other.groupId()) && Objects.equals(arn(), other.arn())
                && Objects.equals(createDate(), other.createDate());
    }

    /**
     * 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("Group").add("Path", path()).add("GroupName", groupName()).add("GroupId", groupId())
                .add("Arn", arn()).add("CreateDate", createDate()).build();
    }

    public  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "Path":
            return Optional.ofNullable(clazz.cast(path()));
        case "GroupName":
            return Optional.ofNullable(clazz.cast(groupName()));
        case "GroupId":
            return Optional.ofNullable(clazz.cast(groupId()));
        case "Arn":
            return Optional.ofNullable(clazz.cast(arn()));
        case "CreateDate":
            return Optional.ofNullable(clazz.cast(createDate()));
        default:
            return Optional.empty();
        }
    }

    @Override
    public List> sdkFields() {
        return SDK_FIELDS;
    }

    private static  Function getter(Function g) {
        return obj -> g.apply((Group) obj);
    }

    private static  BiConsumer setter(BiConsumer s) {
        return (obj, val) -> s.accept((Builder) obj, val);
    }

    public interface Builder extends SdkPojo, CopyableBuilder {
        /**
         * 
         * The path to the group. For more information about paths, see IAM Identifiers in the
         * Using IAM guide.
         * 
         * 
         * @param path
         *        The path to the group. For more information about paths, see IAM Identifiers in
         *        the Using IAM guide.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder path(String path);

        /**
         * 
         * The friendly name that identifies the group.
         * 
         * 
         * @param groupName
         *        The friendly name that identifies the group.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder groupName(String groupName);

        /**
         * 
         * The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the
         * Using IAM guide.
         * 
         * 
         * @param groupId
         *        The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in
         *        the Using IAM guide.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder groupId(String groupId);

        /**
         * 
         * The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in
         * policies, see IAM
         * Identifiers in the Using IAM guide.
         * 
         * 
         * @param arn
         *        The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use
         *        them in policies, see IAM Identifiers in
         *        the Using IAM guide.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder arn(String arn);

        /**
         * 
         * The date and time, in ISO 8601 date-time format, when the group
         * was created.
         * 
         * 
         * @param createDate
         *        The date and time, in ISO 8601 date-time format, when the
         *        group was created.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder createDate(Instant createDate);
    }

    static final class BuilderImpl implements Builder {
        private String path;

        private String groupName;

        private String groupId;

        private String arn;

        private Instant createDate;

        private BuilderImpl() {
        }

        private BuilderImpl(Group model) {
            path(model.path);
            groupName(model.groupName);
            groupId(model.groupId);
            arn(model.arn);
            createDate(model.createDate);
        }

        public final String getPath() {
            return path;
        }

        @Override
        public final Builder path(String path) {
            this.path = path;
            return this;
        }

        public final void setPath(String path) {
            this.path = path;
        }

        public final String getGroupName() {
            return groupName;
        }

        @Override
        public final Builder groupName(String groupName) {
            this.groupName = groupName;
            return this;
        }

        public final void setGroupName(String groupName) {
            this.groupName = groupName;
        }

        public final String getGroupId() {
            return groupId;
        }

        @Override
        public final Builder groupId(String groupId) {
            this.groupId = groupId;
            return this;
        }

        public final void setGroupId(String groupId) {
            this.groupId = groupId;
        }

        public final String getArn() {
            return arn;
        }

        @Override
        public final Builder arn(String arn) {
            this.arn = arn;
            return this;
        }

        public final void setArn(String arn) {
            this.arn = arn;
        }

        public final Instant getCreateDate() {
            return createDate;
        }

        @Override
        public final Builder createDate(Instant createDate) {
            this.createDate = createDate;
            return this;
        }

        public final void setCreateDate(Instant createDate) {
            this.createDate = createDate;
        }

        @Override
        public Group build() {
            return new Group(this);
        }

        @Override
        public List> sdkFields() {
            return SDK_FIELDS;
        }
    }
}