Class CreateMembershipRequest

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

Request structure for adding a single member to an agent space.

  • Method Details

    • applicationId

      public final String applicationId()

      The unique identifier of the application that contains the agent space.

      Returns:
      The unique identifier of the application that contains the agent space.

    • agentSpaceId

      public final String agentSpaceId()

      The unique identifier of the agent space to grant access to.

      Returns:
      The unique identifier of the agent space to grant access to.

    • membershipId

      public final String membershipId()

      The unique identifier for the membership.

      Returns:
      The unique identifier for the membership.

    • memberType

      public final MembershipType memberType()

      The type of member. Currently, only USER is supported.

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

      Returns:
      The type of member. Currently, only USER is supported.
      See Also:

    • memberTypeAsString

      public final String memberTypeAsString()

      The type of member. Currently, only USER is supported.

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

      Returns:
      The type of member. Currently, only USER is supported.
      See Also:

    • config

      public final MembershipConfig config()

      The configuration for the membership, such as the user role.

      Returns:
      The configuration for the membership, such as the user role.

    • toBuilder

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

    • builder

      public static CreateMembershipRequest.Builder builder()

    • serializableBuilderClass

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