software.amazon.awssdk.services.directoryservicedata.model.DescribeGroupResponse Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of directoryservicedata Show documentation
Show all versions of directoryservicedata Show documentation
The AWS Java SDK for Directory Service Data module holds the client classes that are used for
communicating with Directory Service Data.
/*
* 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.directoryservicedata.model;
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.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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeGroupResponse extends DirectoryServiceDataResponse implements
ToCopyableBuilder {
private static final SdkField DIRECTORY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DirectoryId").getter(getter(DescribeGroupResponse::directoryId)).setter(setter(Builder::directoryId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DirectoryId").build()).build();
private static final SdkField DISTINGUISHED_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DistinguishedName").getter(getter(DescribeGroupResponse::distinguishedName))
.setter(setter(Builder::distinguishedName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DistinguishedName").build()).build();
private static final SdkField GROUP_SCOPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("GroupScope").getter(getter(DescribeGroupResponse::groupScopeAsString))
.setter(setter(Builder::groupScope))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GroupScope").build()).build();
private static final SdkField GROUP_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("GroupType").getter(getter(DescribeGroupResponse::groupTypeAsString)).setter(setter(Builder::groupType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GroupType").build()).build();
private static final SdkField> OTHER_ATTRIBUTES_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("OtherAttributes")
.getter(getter(DescribeGroupResponse::otherAttributes))
.setter(setter(Builder::otherAttributes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OtherAttributes").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(AttributeValue::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField REALM_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Realm")
.getter(getter(DescribeGroupResponse::realm)).setter(setter(Builder::realm))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Realm").build()).build();
private static final SdkField SAM_ACCOUNT_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SAMAccountName").getter(getter(DescribeGroupResponse::samAccountName))
.setter(setter(Builder::samAccountName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SAMAccountName").build()).build();
private static final SdkField SID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("SID")
.getter(getter(DescribeGroupResponse::sid)).setter(setter(Builder::sid))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SID").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DIRECTORY_ID_FIELD,
DISTINGUISHED_NAME_FIELD, GROUP_SCOPE_FIELD, GROUP_TYPE_FIELD, OTHER_ATTRIBUTES_FIELD, REALM_FIELD,
SAM_ACCOUNT_NAME_FIELD, SID_FIELD));
private final String directoryId;
private final String distinguishedName;
private final String groupScope;
private final String groupType;
private final Map otherAttributes;
private final String realm;
private final String samAccountName;
private final String sid;
private DescribeGroupResponse(BuilderImpl builder) {
super(builder);
this.directoryId = builder.directoryId;
this.distinguishedName = builder.distinguishedName;
this.groupScope = builder.groupScope;
this.groupType = builder.groupType;
this.otherAttributes = builder.otherAttributes;
this.realm = builder.realm;
this.samAccountName = builder.samAccountName;
this.sid = builder.sid;
}
/**
*
* The identifier (ID) of the directory that's associated with the group.
*
*
* @return The identifier (ID) of the directory that's associated with the group.
*/
public final String directoryId() {
return directoryId;
}
/**
*
* The
* distinguished name of the object.
*
*
* @return The distinguished name of the object.
*/
public final String distinguishedName() {
return distinguishedName;
}
/**
*
* The scope of the AD group. For details, see Active Directory security groups.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #groupScope} will
* return {@link GroupScope#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #groupScopeAsString}.
*
*
* @return The scope of the AD group. For details, see Active Directory security groups.
* @see GroupScope
*/
public final GroupScope groupScope() {
return GroupScope.fromValue(groupScope);
}
/**
*
* The scope of the AD group. For details, see Active Directory security groups.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #groupScope} will
* return {@link GroupScope#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #groupScopeAsString}.
*
*
* @return The scope of the AD group. For details, see Active Directory security groups.
* @see GroupScope
*/
public final String groupScopeAsString() {
return groupScope;
}
/**
*
* The AD group type. For details, see Active Directory security group type.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #groupType} will
* return {@link GroupType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #groupTypeAsString}.
*
*
* @return The AD group type. For details, see Active Directory security group type.
* @see GroupType
*/
public final GroupType groupType() {
return GroupType.fromValue(groupType);
}
/**
*
* The AD group type. For details, see Active Directory security group type.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #groupType} will
* return {@link GroupType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #groupTypeAsString}.
*
*
* @return The AD group type. For details, see Active Directory security group type.
* @see GroupType
*/
public final String groupTypeAsString() {
return groupType;
}
/**
* For responses, this returns true if the service returned a value for the OtherAttributes 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 hasOtherAttributes() {
return otherAttributes != null && !(otherAttributes instanceof SdkAutoConstructMap);
}
/**
*
* The attribute values that are returned for the attribute names that are included in the request.
*
*
* 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 #hasOtherAttributes} method.
*
*
* @return The attribute values that are returned for the attribute names that are included in the request.
*/
public final Map otherAttributes() {
return otherAttributes;
}
/**
*
* The domain name that's associated with the group.
*
*
* @return The domain name that's associated with the group.
*/
public final String realm() {
return realm;
}
/**
*
* The name of the group.
*
*
* @return The name of the group.
*/
public final String samAccountName() {
return samAccountName;
}
/**
*
* The unique security identifier (SID) of the group.
*
*
* @return The unique security identifier (SID) of the group.
*/
public final String sid() {
return sid;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(directoryId());
hashCode = 31 * hashCode + Objects.hashCode(distinguishedName());
hashCode = 31 * hashCode + Objects.hashCode(groupScopeAsString());
hashCode = 31 * hashCode + Objects.hashCode(groupTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasOtherAttributes() ? otherAttributes() : null);
hashCode = 31 * hashCode + Objects.hashCode(realm());
hashCode = 31 * hashCode + Objects.hashCode(samAccountName());
hashCode = 31 * hashCode + Objects.hashCode(sid());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeGroupResponse)) {
return false;
}
DescribeGroupResponse other = (DescribeGroupResponse) obj;
return Objects.equals(directoryId(), other.directoryId())
&& Objects.equals(distinguishedName(), other.distinguishedName())
&& Objects.equals(groupScopeAsString(), other.groupScopeAsString())
&& Objects.equals(groupTypeAsString(), other.groupTypeAsString())
&& hasOtherAttributes() == other.hasOtherAttributes()
&& Objects.equals(otherAttributes(), other.otherAttributes()) && Objects.equals(realm(), other.realm())
&& Objects.equals(samAccountName(), other.samAccountName()) && Objects.equals(sid(), other.sid());
}
/**
* 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("DescribeGroupResponse").add("DirectoryId", directoryId())
.add("DistinguishedName", distinguishedName() == null ? null : "*** Sensitive Data Redacted ***")
.add("GroupScope", groupScopeAsString()).add("GroupType", groupTypeAsString())
.add("OtherAttributes", hasOtherAttributes() ? otherAttributes() : null).add("Realm", realm())
.add("SAMAccountName", samAccountName()).add("SID", sid()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DirectoryId":
return Optional.ofNullable(clazz.cast(directoryId()));
case "DistinguishedName":
return Optional.ofNullable(clazz.cast(distinguishedName()));
case "GroupScope":
return Optional.ofNullable(clazz.cast(groupScopeAsString()));
case "GroupType":
return Optional.ofNullable(clazz.cast(groupTypeAsString()));
case "OtherAttributes":
return Optional.ofNullable(clazz.cast(otherAttributes()));
case "Realm":
return Optional.ofNullable(clazz.cast(realm()));
case "SAMAccountName":
return Optional.ofNullable(clazz.cast(samAccountName()));
case "SID":
return Optional.ofNullable(clazz.cast(sid()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeGroupResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends DirectoryServiceDataResponse.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The identifier (ID) of the directory that's associated with the group.
*
*
* @param directoryId
* The identifier (ID) of the directory that's associated with the group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder directoryId(String directoryId);
/**
*
* The distinguished name of the object.
*
*
* @param distinguishedName
* The distinguished name of the object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder distinguishedName(String distinguishedName);
/**
*
* The scope of the AD group. For details, see Active Directory security groups.
*
*
* @param groupScope
* The scope of the AD group. For details, see Active Directory security groups.
* @see GroupScope
* @return Returns a reference to this object so that method calls can be chained together.
* @see GroupScope
*/
Builder groupScope(String groupScope);
/**
*
* The scope of the AD group. For details, see Active Directory security groups.
*
*
* @param groupScope
* The scope of the AD group. For details, see Active Directory security groups.
* @see GroupScope
* @return Returns a reference to this object so that method calls can be chained together.
* @see GroupScope
*/
Builder groupScope(GroupScope groupScope);
/**
*
* The AD group type. For details, see Active Directory security group type.
*
*
* @param groupType
* The AD group type. For details, see Active Directory security group type.
* @see GroupType
* @return Returns a reference to this object so that method calls can be chained together.
* @see GroupType
*/
Builder groupType(String groupType);
/**
*
* The AD group type. For details, see Active Directory security group type.
*
*
* @param groupType
* The AD group type. For details, see Active Directory security group type.
* @see GroupType
* @return Returns a reference to this object so that method calls can be chained together.
* @see GroupType
*/
Builder groupType(GroupType groupType);
/**
*
* The attribute values that are returned for the attribute names that are included in the request.
*
*
* @param otherAttributes
* The attribute values that are returned for the attribute names that are included in the request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder otherAttributes(Map otherAttributes);
/**
*
* The domain name that's associated with the group.
*
*
* @param realm
* The domain name that's associated with the group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder realm(String realm);
/**
*
* The name of the group.
*
*
* @param samAccountName
* The name of the group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder samAccountName(String samAccountName);
/**
*
* The unique security identifier (SID) of the group.
*
*
* @param sid
* The unique security identifier (SID) of the group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sid(String sid);
}
static final class BuilderImpl extends DirectoryServiceDataResponse.BuilderImpl implements Builder {
private String directoryId;
private String distinguishedName;
private String groupScope;
private String groupType;
private Map otherAttributes = DefaultSdkAutoConstructMap.getInstance();
private String realm;
private String samAccountName;
private String sid;
private BuilderImpl() {
}
private BuilderImpl(DescribeGroupResponse model) {
super(model);
directoryId(model.directoryId);
distinguishedName(model.distinguishedName);
groupScope(model.groupScope);
groupType(model.groupType);
otherAttributes(model.otherAttributes);
realm(model.realm);
samAccountName(model.samAccountName);
sid(model.sid);
}
public final String getDirectoryId() {
return directoryId;
}
public final void setDirectoryId(String directoryId) {
this.directoryId = directoryId;
}
@Override
public final Builder directoryId(String directoryId) {
this.directoryId = directoryId;
return this;
}
public final String getDistinguishedName() {
return distinguishedName;
}
public final void setDistinguishedName(String distinguishedName) {
this.distinguishedName = distinguishedName;
}
@Override
public final Builder distinguishedName(String distinguishedName) {
this.distinguishedName = distinguishedName;
return this;
}
public final String getGroupScope() {
return groupScope;
}
public final void setGroupScope(String groupScope) {
this.groupScope = groupScope;
}
@Override
public final Builder groupScope(String groupScope) {
this.groupScope = groupScope;
return this;
}
@Override
public final Builder groupScope(GroupScope groupScope) {
this.groupScope(groupScope == null ? null : groupScope.toString());
return this;
}
public final String getGroupType() {
return groupType;
}
public final void setGroupType(String groupType) {
this.groupType = groupType;
}
@Override
public final Builder groupType(String groupType) {
this.groupType = groupType;
return this;
}
@Override
public final Builder groupType(GroupType groupType) {
this.groupType(groupType == null ? null : groupType.toString());
return this;
}
public final Map getOtherAttributes() {
Map result = AttributesCopier.copyToBuilder(this.otherAttributes);
if (result instanceof SdkAutoConstructMap) {
return null;
}
return result;
}
public final void setOtherAttributes(Map otherAttributes) {
this.otherAttributes = AttributesCopier.copyFromBuilder(otherAttributes);
}
@Override
public final Builder otherAttributes(Map otherAttributes) {
this.otherAttributes = AttributesCopier.copy(otherAttributes);
return this;
}
public final String getRealm() {
return realm;
}
public final void setRealm(String realm) {
this.realm = realm;
}
@Override
public final Builder realm(String realm) {
this.realm = realm;
return this;
}
public final String getSamAccountName() {
return samAccountName;
}
public final void setSamAccountName(String samAccountName) {
this.samAccountName = samAccountName;
}
@Override
public final Builder samAccountName(String samAccountName) {
this.samAccountName = samAccountName;
return this;
}
public final String getSid() {
return sid;
}
public final void setSid(String sid) {
this.sid = sid;
}
@Override
public final Builder sid(String sid) {
this.sid = sid;
return this;
}
@Override
public DescribeGroupResponse build() {
return new DescribeGroupResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy