Class GetMembershipResponse

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

  • Method Details

    • membershipId

      public final String membershipId()

      Response element for GetMembership that provides the queried membership ID.

      Returns:
      Response element for GetMembership that provides the queried membership ID.

    • accountId

      public final String accountId()

      Response element for GetMembership that provides the configured account for managing the membership.

      Returns:
      Response element for GetMembership that provides the configured account for managing the membership.

    • region

      public final AwsRegion region()

      Response element for GetMembership that provides the configured region for managing the membership.

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

      Returns:
      Response element for GetMembership that provides the configured region for managing the membership.
      See Also:

    • regionAsString

      public final String regionAsString()

      Response element for GetMembership that provides the configured region for managing the membership.

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

      Returns:
      Response element for GetMembership that provides the configured region for managing the membership.
      See Also:

    • membershipName

      public final String membershipName()

      Response element for GetMembership that provides the configured membership name.

      Returns:
      Response element for GetMembership that provides the configured membership name.

    • membershipArn

      public final String membershipArn()

      Response element for GetMembership that provides the membership ARN.

      Returns:
      Response element for GetMembership that provides the membership ARN.

    • membershipStatus

      public final MembershipStatus membershipStatus()

      Response element for GetMembership that provides the current membership status.

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

      Returns:
      Response element for GetMembership that provides the current membership status.
      See Also:

    • membershipStatusAsString

      public final String membershipStatusAsString()

      Response element for GetMembership that provides the current membership status.

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

      Returns:
      Response element for GetMembership that provides the current membership status.
      See Also:

    • membershipActivationTimestamp

      public final Instant membershipActivationTimestamp()

      Response element for GetMembership that provides the configured membership activation timestamp.

      Returns:
      Response element for GetMembership that provides the configured membership activation timestamp.

    • membershipDeactivationTimestamp

      public final Instant membershipDeactivationTimestamp()

      Response element for GetMembership that provides the configured membership name deactivation timestamp.

      Returns:
      Response element for GetMembership that provides the configured membership name deactivation timestamp.

    • customerType

      public final CustomerType customerType()

      Response element for GetMembership that provides the configured membership type. Options include Standalone | Organizations.

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

      Returns:
      Response element for GetMembership that provides the configured membership type. Options include Standalone | Organizations.
      See Also:

    • customerTypeAsString

      public final String customerTypeAsString()

      Response element for GetMembership that provides the configured membership type. Options include Standalone | Organizations.

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

      Returns:
      Response element for GetMembership that provides the configured membership type. Options include Standalone | Organizations.
      See Also:

    • numberOfAccountsCovered

      public final Long numberOfAccountsCovered()

      Response element for GetMembership that provides the number of accounts in the membership.

      Returns:
      Response element for GetMembership that provides the number of accounts in the membership.

    • 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()

      Response element for GetMembership that provides the configured membership incident response team members.

      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:
      Response element for GetMembership that provides the configured membership incident response team members.

    • 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()

      Response element for GetMembership that provides the if opt-in features have been enabled.

      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:
      Response element for GetMembership that provides the if opt-in features have been enabled.

    • toBuilder

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

    • builder

      public static GetMembershipResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.