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>

  • Method Details

    • 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, groupScope will return GroupScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from groupScopeAsString().

      Returns:
      The scope of the AD group. For details, see Active Directory security groups.
      See Also:

    • 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, groupScope will return GroupScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from groupScopeAsString().

      Returns:
      The scope of the AD group. For details, see Active Directory security groups.
      See Also:

    • 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, groupType will return GroupType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from groupTypeAsString().

      Returns:
      The AD group type. For details, see Active Directory security group type.
      See Also:

    • 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, groupType will return GroupType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from groupTypeAsString().

      Returns:
      The AD group type. For details, see Active Directory security group type.
      See Also:

    • 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 the 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.

    • 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, use REPLACE to change an attribute value or REMOVE to clear the attribute value.

      If the service returns an enum value that is not available in the current SDK version, updateType will return UpdateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from updateTypeAsString().

      Returns:
      The type of update to be performed. If no value exists for the attribute, use ADD. Otherwise, use REPLACE to change an attribute value or REMOVE to clear the attribute value.
      See Also:

    • updateTypeAsString

      public final String updateTypeAsString()

      The type of update to be performed. If no value exists for the attribute, use ADD. Otherwise, use REPLACE to change an attribute value or REMOVE to clear the attribute value.

      If the service returns an enum value that is not available in the current SDK version, updateType will return UpdateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from updateTypeAsString().

      Returns:
      The type of update to be performed. If no value exists for the attribute, use ADD. Otherwise, use REPLACE to change an attribute value or REMOVE to clear the attribute value.
      See Also:

    • toBuilder

      public UpdateGroupRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateGroupRequest.Builder,UpdateGroupRequest>
      Specified by:
      toBuilder in class DirectoryServiceDataRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateGroupRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateGroupRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.