Class CreatePartnershipRequest

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

  • Method Details

    • profileId

      public final String profileId()

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

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

    • name

      public final String name()

      Specifies a descriptive name for the partnership.

      Returns:
      Specifies a descriptive name for the partnership.

    • email

      public final String email()

      Specifies the email address associated with this trading partner.

      Returns:
      Specifies the email address associated with this trading partner.

    • phone

      public final String phone()

      Specifies the phone number associated with the partnership.

      Returns:
      Specifies the phone number associated with 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()

      Specifies a list of the 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:
      Specifies a list of the capabilities associated with this partnership.

    • capabilityOptions

      public final CapabilityOptions capabilityOptions()

      Specify the structure that contains the details for the associated capabilities.

      Returns:
      Specify the structure that contains the details for the associated capabilities.

    • clientToken

      public final String clientToken()

      Reserved for future use.

      Returns:
      Reserved for future use.

    • hasTags

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

    • tags

      public final List<Tag> tags()

      Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

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

      Returns:
      Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

    • toBuilder

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

    • builder

      public static CreatePartnershipRequest.Builder builder()

    • serializableBuilderClass

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