Class AssociateMemberToQueueRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.deadline.model.DeadlineRequest
software.amazon.awssdk.services.deadline.model.AssociateMemberToQueueRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<AssociateMemberToQueueRequest.Builder,AssociateMemberToQueueRequest>
@Generated("software.amazon.awssdk:codegen") public final class AssociateMemberToQueueRequest extends DeadlineRequest implements ToCopyableBuilder<AssociateMemberToQueueRequest.Builder,AssociateMemberToQueueRequest>

  • Method Details

    • farmId

      public final String farmId()

      The farm ID of the queue to associate with the member.

      Returns:
      The farm ID of the queue to associate with the member.

    • queueId

      public final String queueId()

      The ID of the queue to associate to the member.

      Returns:
      The ID of the queue to associate to the member.

    • principalId

      public final String principalId()

      The member's principal ID to associate with the queue.

      Returns:
      The member's principal ID to associate with the queue.

    • principalType

      public final PrincipalType principalType()

      The member's principal type to associate with the queue.

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

      Returns:
      The member's principal type to associate with the queue.
      See Also:

    • principalTypeAsString

      public final String principalTypeAsString()

      The member's principal type to associate with the queue.

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

      Returns:
      The member's principal type to associate with the queue.
      See Also:

    • identityStoreId

      public final String identityStoreId()

      The member's identity store ID to associate with the queue.

      Returns:
      The member's identity store ID to associate with the queue.

    • membershipLevel

      public final MembershipLevel membershipLevel()

      The principal's membership level for the associated queue.

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

      Returns:
      The principal's membership level for the associated queue.
      See Also:

    • membershipLevelAsString

      public final String membershipLevelAsString()

      The principal's membership level for the associated queue.

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

      Returns:
      The principal's membership level for the associated queue.
      See Also:

    • toBuilder

      public AssociateMemberToQueueRequest.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<AssociateMemberToQueueRequest.Builder,AssociateMemberToQueueRequest>
      Specified by:
      toBuilder in class DeadlineRequest
      Returns:
      a builder for type T

    • builder

      public static AssociateMemberToQueueRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AssociateMemberToQueueRequest.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.