Class ProcurementPortalPreference

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

Represents the full configuration of a procurement portal preference, including settings for e-invoice delivery and purchase order retrieval.

See Also:

  • Method Details

    • awsAccountId

      public final String awsAccountId()

      The Amazon Web Services account ID associated with this procurement portal preference.

      Returns:
      The Amazon Web Services account ID associated with this procurement portal preference.

    • procurementPortalPreferenceArn

      public final String procurementPortalPreferenceArn()

      The Amazon Resource Name (ARN) of the procurement portal preference.

      Returns:
      The Amazon Resource Name (ARN) of the procurement portal preference.

    • procurementPortalName

      public final ProcurementPortalName procurementPortalName()

      The name of the procurement portal.

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

      Returns:
      The name of the procurement portal.
      See Also:

    • procurementPortalNameAsString

      public final String procurementPortalNameAsString()

      The name of the procurement portal.

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

      Returns:
      The name of the procurement portal.
      See Also:

    • buyerDomain

      public final BuyerDomain buyerDomain()

      The domain identifier for the buyer in the procurement portal.

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

      Returns:
      The domain identifier for the buyer in the procurement portal.
      See Also:

    • buyerDomainAsString

      public final String buyerDomainAsString()

      The domain identifier for the buyer in the procurement portal.

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

      Returns:
      The domain identifier for the buyer in the procurement portal.
      See Also:

    • buyerIdentifier

      public final String buyerIdentifier()

      The unique identifier for the buyer in the procurement portal.

      Returns:
      The unique identifier for the buyer in the procurement portal.

    • supplierDomain

      public final SupplierDomain supplierDomain()

      The domain identifier for the supplier in the procurement portal.

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

      Returns:
      The domain identifier for the supplier in the procurement portal.
      See Also:

    • supplierDomainAsString

      public final String supplierDomainAsString()

      The domain identifier for the supplier in the procurement portal.

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

      Returns:
      The domain identifier for the supplier in the procurement portal.
      See Also:

    • supplierIdentifier

      public final String supplierIdentifier()

      The unique identifier for the supplier in the procurement portal.

      Returns:
      The unique identifier for the supplier in the procurement portal.

    • selector

      public final ProcurementPortalPreferenceSelector selector()
      Returns the value of the Selector property for this object.
      Returns:
      The value of the Selector property for this object.

    • procurementPortalSharedSecret

      public final String procurementPortalSharedSecret()

      The shared secret or authentication credential used for secure communication with the procurement portal.

      Returns:
      The shared secret or authentication credential used for secure communication with the procurement portal.

    • procurementPortalInstanceEndpoint

      public final String procurementPortalInstanceEndpoint()

      The endpoint URL where e-invoices are delivered to the procurement portal.

      Returns:
      The endpoint URL where e-invoices are delivered to the procurement portal.

    • purchaseOrderRetrievalEndpoint

      public final String purchaseOrderRetrievalEndpoint()

      The endpoint URL used for retrieving purchase orders from the procurement portal.

      Returns:
      The endpoint URL used for retrieving purchase orders from the procurement portal.

    • testEnvPreference

      public final TestEnvPreference testEnvPreference()

      Configuration on settings for the test environment of the procurement portal.

      Returns:
      Configuration on settings for the test environment of the procurement portal.

    • einvoiceDeliveryEnabled

      public final Boolean einvoiceDeliveryEnabled()

      Indicates whether e-invoice delivery is enabled for this procurement portal preference.

      Returns:
      Indicates whether e-invoice delivery is enabled for this procurement portal preference.

    • einvoiceDeliveryPreference

      public final EinvoiceDeliveryPreference einvoiceDeliveryPreference()

      The configuration settings that specify how e-invoices are delivered to the procurement portal.

      Returns:
      The configuration settings that specify how e-invoices are delivered to the procurement portal.

    • purchaseOrderRetrievalEnabled

      public final Boolean purchaseOrderRetrievalEnabled()

      Indicates whether purchase order retrieval is enabled for this procurement portal preference.

      Returns:
      Indicates whether purchase order retrieval is enabled for this procurement portal preference.

    • hasContacts

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

    • contacts

      public final List<Contact> contacts()

      List of contact information for portal administrators and technical contacts.

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

      Returns:
      List of contact information for portal administrators and technical contacts.

    • einvoiceDeliveryPreferenceStatus

      public final ProcurementPortalPreferenceStatus einvoiceDeliveryPreferenceStatus()

      The current status of the e-invoice delivery preference.

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

      Returns:
      The current status of the e-invoice delivery preference.
      See Also:

    • einvoiceDeliveryPreferenceStatusAsString

      public final String einvoiceDeliveryPreferenceStatusAsString()

      The current status of the e-invoice delivery preference.

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

      Returns:
      The current status of the e-invoice delivery preference.
      See Also:

    • einvoiceDeliveryPreferenceStatusReason

      public final String einvoiceDeliveryPreferenceStatusReason()

      The reason for the current e-invoice delivery preference status.

      Returns:
      The reason for the current e-invoice delivery preference status.

    • purchaseOrderRetrievalPreferenceStatus

      public final ProcurementPortalPreferenceStatus purchaseOrderRetrievalPreferenceStatus()

      The current status of the purchase order retrieval preference.

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

      Returns:
      The current status of the purchase order retrieval preference.
      See Also:

    • purchaseOrderRetrievalPreferenceStatusAsString

      public final String purchaseOrderRetrievalPreferenceStatusAsString()

      The current status of the purchase order retrieval preference.

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

      Returns:
      The current status of the purchase order retrieval preference.
      See Also:

    • purchaseOrderRetrievalPreferenceStatusReason

      public final String purchaseOrderRetrievalPreferenceStatusReason()

      The reason for the current purchase order retrieval preference status.

      Returns:
      The reason for the current purchase order retrieval preference status.

    • version

      public final Long version()

      The version number of the procurement portal preference configuration.

      Returns:
      The version number of the procurement portal preference configuration.

    • createDate

      public final Instant createDate()

      The date and time when the procurement portal preference was created.

      Returns:
      The date and time when the procurement portal preference was created.

    • lastUpdateDate

      public final Instant lastUpdateDate()

      The date and time when the procurement portal preference was last updated.

      Returns:
      The date and time when the procurement portal preference was last updated.

    • toBuilder

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

    • builder

      public static ProcurementPortalPreference.Builder builder()

    • serializableBuilderClass

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