Class UpdateMembershipRequest

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

  • Method Details

    • membershipId

      public final String membershipId()

      Required element for UpdateMembership to identify the membership to update.

      Returns:
      Required element for UpdateMembership to identify the membership to update.

    • membershipName

      public final String membershipName()

      Optional element for UpdateMembership to update the membership name.

      Returns:
      Optional element for UpdateMembership to update the membership name.

    • hasIncidentResponseTeam

      public final boolean hasIncidentResponseTeam()
      For responses, this returns true if the service returned a value for the IncidentResponseTeam 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.

    • incidentResponseTeam

      public final List<IncidentResponder> incidentResponseTeam()

      Optional element for UpdateMembership to update the membership name.

      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 hasIncidentResponseTeam() method.

      Returns:
      Optional element for UpdateMembership to update the membership name.

    • hasOptInFeatures

      public final boolean hasOptInFeatures()
      For responses, this returns true if the service returned a value for the OptInFeatures 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.

    • optInFeatures

      public final List<OptInFeature> optInFeatures()

      Optional element for UpdateMembership to enable or disable opt-in features for the service.

      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 hasOptInFeatures() method.

      Returns:
      Optional element for UpdateMembership to enable or disable opt-in features for the service.

    • membershipAccountsConfigurationsUpdate

      public final MembershipAccountsConfigurationsUpdate membershipAccountsConfigurationsUpdate()

      The membershipAccountsConfigurationsUpdate field in the UpdateMembershipRequest structure allows you to update the configuration settings for accounts within a membership.

      This field is optional and contains a structure of type MembershipAccountsConfigurationsUpdate that specifies the updated account configurations for the membership.

      Returns:
      The membershipAccountsConfigurationsUpdate field in the UpdateMembershipRequest structure allows you to update the configuration settings for accounts within a membership.

      This field is optional and contains a structure of type MembershipAccountsConfigurationsUpdate that specifies the updated account configurations for the membership.

    • undoMembershipCancellation

      public final Boolean undoMembershipCancellation()

      The undoMembershipCancellation parameter is a boolean flag that indicates whether to reverse a previously requested membership cancellation. When set to true, this will revoke the cancellation request and maintain the membership status.

      This parameter is optional and can be used in scenarios where you need to restore a membership that was marked for cancellation but hasn't been fully terminated yet.

      • If set to true, the cancellation request will be revoked

      • If set to false the service will throw a ValidationException.

      Returns:
      The undoMembershipCancellation parameter is a boolean flag that indicates whether to reverse a previously requested membership cancellation. When set to true, this will revoke the cancellation request and maintain the membership status.

      This parameter is optional and can be used in scenarios where you need to restore a membership that was marked for cancellation but hasn't been fully terminated yet.

      • If set to true, the cancellation request will be revoked

      • If set to false the service will throw a ValidationException.

    • toBuilder

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

    • builder

      public static UpdateMembershipRequest.Builder builder()

    • serializableBuilderClass

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