Class PartnershipSummary

java.lang.Object
software.amazon.awssdk.services.b2bi.model.PartnershipSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PartnershipSummary.Builder,PartnershipSummary>
@Generated("software.amazon.awssdk:codegen") public final class PartnershipSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PartnershipSummary.Builder,PartnershipSummary>

A structure that contains the details for a partnership. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

See Also:

  • Method Details

    • profileId

      public final String profileId()

      Returns the unique, system-generated identifier for the profile connected to this partnership.

      Returns:
      Returns the unique, system-generated identifier for the profile connected to this partnership.

    • partnershipId

      public final String partnershipId()

      Returns the unique, system-generated identifier for a partnership.

      Returns:
      Returns the unique, system-generated identifier for a partnership.

    • name

      public final String name()

      Returns the name of the partnership.

      Returns:
      Returns the name of the partnership.

    • hasCapabilities

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

    • capabilities

      public final List<String> capabilities()

      Returns one or more capabilities associated with this partnership.

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

      Returns:
      Returns one or more capabilities associated with this partnership.

    • capabilityOptions

      public final CapabilityOptions capabilityOptions()
      Returns the value of the CapabilityOptions property for this object.
      Returns:
      The value of the CapabilityOptions property for this object.

    • tradingPartnerId

      public final String tradingPartnerId()

      Returns the unique, system-generated identifier for a trading partner.

      Returns:
      Returns the unique, system-generated identifier for a trading partner.

    • createdAt

      public final Instant createdAt()

      Returns a timestamp for creation date and time of the partnership.

      Returns:
      Returns a timestamp for creation date and time of the partnership.

    • modifiedAt

      public final Instant modifiedAt()

      Returns a timestamp that identifies the most recent date and time that the partnership was modified.

      Returns:
      Returns a timestamp that identifies the most recent date and time that the partnership was modified.

    • toBuilder

      public PartnershipSummary.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<PartnershipSummary.Builder,PartnershipSummary>
      Returns:
      a builder for type T

    • builder

      public static PartnershipSummary.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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