Class UpdateGroupRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.directoryservicedata.model.DirectoryServiceDataRequest
-
- software.amazon.awssdk.services.directoryservicedata.model.UpdateGroupRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<UpdateGroupRequest.Builder,UpdateGroupRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateGroupRequest extends DirectoryServiceDataRequest implements ToCopyableBuilder<UpdateGroupRequest.Builder,UpdateGroupRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceUpdateGroupRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static UpdateGroupRequest.Builderbuilder()StringclientToken()A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call.StringdirectoryId()The identifier (ID) of the directory that's associated with the group.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)GroupScopegroupScope()The scope of the AD group.StringgroupScopeAsString()The scope of the AD group.GroupTypegroupType()The AD group type.StringgroupTypeAsString()The AD group type.inthashCode()booleanhasOtherAttributes()For responses, this returns true if the service returned a value for the OtherAttributes property.Map<String,AttributeValue>otherAttributes()An expression that defines one or more attributes with the data type and the value of each attribute.StringsamAccountName()The name of the group.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends UpdateGroupRequest.Builder>serializableBuilderClass()UpdateGroupRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.UpdateTypeupdateType()The type of update to be performed.StringupdateTypeAsString()The type of update to be performed.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
clientToken
public final String clientToken()
A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call.
A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours.
If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an
ConflictException.This parameter is optional when using the CLI or SDK.
- Returns:
- A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so
multiple identical calls have the same effect as one single call.
A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours.
If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an
ConflictException.This parameter is optional when using the CLI or SDK.
-
directoryId
public final String directoryId()
The identifier (ID) of the directory that's associated with the group.
- Returns:
- The identifier (ID) of the directory that's associated with the group.
-
groupScope
public final GroupScope 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,
groupScopewill returnGroupScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromgroupScopeAsString().- Returns:
- The scope of the AD group. For details, see Active Directory security groups.
- See Also:
GroupScope
-
groupScopeAsString
public final String groupScopeAsString()
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,
groupScopewill returnGroupScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromgroupScopeAsString().- Returns:
- The scope of the AD group. For details, see Active Directory security groups.
- See Also:
GroupScope
-
groupType
public final GroupType 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,
groupTypewill returnGroupType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromgroupTypeAsString().- Returns:
- The AD group type. For details, see Active Directory security group type.
- See Also:
GroupType
-
groupTypeAsString
public final String groupTypeAsString()
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,
groupTypewill returnGroupType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromgroupTypeAsString().- Returns:
- The AD group type. For details, see Active Directory security group type.
- See Also:
GroupType
-
hasOtherAttributes
public final boolean hasOtherAttributes()
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 theisEmpty()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.
-
otherAttributes
public final Map<String,AttributeValue> otherAttributes()
An expression that defines one or more attributes with the data type and the value of each attribute.
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
hasOtherAttributes()method.- Returns:
- An expression that defines one or more attributes with the data type and the value of each attribute.
-
samAccountName
public final String samAccountName()
The name of the group.
- Returns:
- The name of the group.
-
updateType
public final UpdateType updateType()
The type of update to be performed. If no value exists for the attribute, use
ADD. Otherwise, useREPLACEto change an attribute value orREMOVEto clear the attribute value.If the service returns an enum value that is not available in the current SDK version,
updateTypewill returnUpdateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromupdateTypeAsString().- Returns:
- The type of update to be performed. If no value exists for the attribute, use
ADD. Otherwise, useREPLACEto change an attribute value orREMOVEto clear the attribute value. - See Also:
UpdateType
-
updateTypeAsString
public final String updateTypeAsString()
The type of update to be performed. If no value exists for the attribute, use
ADD. Otherwise, useREPLACEto change an attribute value orREMOVEto clear the attribute value.If the service returns an enum value that is not available in the current SDK version,
updateTypewill returnUpdateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromupdateTypeAsString().- Returns:
- The type of update to be performed. If no value exists for the attribute, use
ADD. Otherwise, useREPLACEto change an attribute value orREMOVEto clear the attribute value. - See Also:
UpdateType
-
toBuilder
public UpdateGroupRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<UpdateGroupRequest.Builder,UpdateGroupRequest>- Specified by:
toBuilderin classDirectoryServiceDataRequest
-
builder
public static UpdateGroupRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdateGroupRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-