Class EinvoiceDeliveryPreference

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

Specifies the preferences for e-invoice delivery, including document types, attachment types, and customization settings.

See Also:

  • Method Details

    • einvoiceDeliveryDocumentTypes

      public final List<EinvoiceDeliveryDocumentType> einvoiceDeliveryDocumentTypes()

      The types of e-invoice documents to be delivered.

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

      Returns:
      The types of e-invoice documents to be delivered.

    • hasEinvoiceDeliveryDocumentTypes

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

    • einvoiceDeliveryDocumentTypesAsStrings

      public final List<String> einvoiceDeliveryDocumentTypesAsStrings()

      The types of e-invoice documents to be delivered.

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

      Returns:
      The types of e-invoice documents to be delivered.

    • einvoiceDeliveryAttachmentTypes

      public final List<EinvoiceDeliveryAttachmentType> einvoiceDeliveryAttachmentTypes()

      The types of attachments to include with the e-invoice delivery.

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

      Returns:
      The types of attachments to include with the e-invoice delivery.

    • hasEinvoiceDeliveryAttachmentTypes

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

    • einvoiceDeliveryAttachmentTypesAsStrings

      public final List<String> einvoiceDeliveryAttachmentTypesAsStrings()

      The types of attachments to include with the e-invoice delivery.

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

      Returns:
      The types of attachments to include with the e-invoice delivery.

    • protocol

      public final Protocol protocol()

      The communication protocol to use for e-invoice delivery.

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

      Returns:
      The communication protocol to use for e-invoice delivery.
      See Also:

    • protocolAsString

      public final String protocolAsString()

      The communication protocol to use for e-invoice delivery.

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

      Returns:
      The communication protocol to use for e-invoice delivery.
      See Also:

    • hasPurchaseOrderDataSources

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

    • purchaseOrderDataSources

      public final List<PurchaseOrderDataSource> purchaseOrderDataSources()

      The sources of purchase order data to use for e-invoice generation and delivery.

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

      Returns:
      The sources of purchase order data to use for e-invoice generation and delivery.

    • connectionTestingMethod

      public final ConnectionTestingMethod connectionTestingMethod()

      The method to use for testing the connection to the procurement portal.

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

      Returns:
      The method to use for testing the connection to the procurement portal.
      See Also:

    • connectionTestingMethodAsString

      public final String connectionTestingMethodAsString()

      The method to use for testing the connection to the procurement portal.

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

      Returns:
      The method to use for testing the connection to the procurement portal.
      See Also:

    • einvoiceDeliveryActivationDate

      public final Instant einvoiceDeliveryActivationDate()

      The date when e-invoice delivery should be activated for this preference.

      Returns:
      The date when e-invoice delivery should be activated for this preference.

    • toBuilder

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

    • builder

      public static EinvoiceDeliveryPreference.Builder builder()

    • serializableBuilderClass

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