Class CreateProcurementPortalPreferenceRequest

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

  • Method Details

    • 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 to establish secure communication with the procurement portal. This value must be encrypted at rest.

      Returns:
      The shared secret or authentication credential used to establish secure communication with the procurement portal. This value must be encrypted at rest.

    • procurementPortalInstanceEndpoint

      public final String procurementPortalInstanceEndpoint()

      The endpoint URL where e-invoices will be delivered to the procurement portal. Must be a valid HTTPS URL.

      Returns:
      The endpoint URL where e-invoices will be delivered to the procurement portal. Must be a valid HTTPS URL.

    • testEnvPreference

      public final TestEnvPreferenceInput testEnvPreference()

      Configuration settings for the test environment of the procurement portal. Includes test credentials and endpoints that are used for validation before production deployment.

      Returns:
      Configuration settings for the test environment of the procurement portal. Includes test credentials and endpoints that are used for validation before production deployment.

    • einvoiceDeliveryEnabled

      public final Boolean einvoiceDeliveryEnabled()

      Indicates whether e-invoice delivery is enabled for this procurement portal preference. Set to true to enable e-invoice delivery, false to disable.

      Returns:
      Indicates whether e-invoice delivery is enabled for this procurement portal preference. Set to true to enable e-invoice delivery, false to disable.

    • einvoiceDeliveryPreference

      public final EinvoiceDeliveryPreference einvoiceDeliveryPreference()

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

      Returns:
      Specifies the e-invoice delivery configuration including document types, attachment types, and customization settings for the portal.

    • purchaseOrderRetrievalEnabled

      public final Boolean purchaseOrderRetrievalEnabled()

      Indicates whether purchase order retrieval is enabled for this procurement portal preference. Set to true to enable PO retrieval, false to disable.

      Returns:
      Indicates whether purchase order retrieval is enabled for this procurement portal preference. Set to true to enable PO retrieval, false to disable.

    • 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 responsible for the e-invoice integration.

      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 responsible for the e-invoice integration.

    • hasResourceTags

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

    • resourceTags

      public final List<ResourceTag> resourceTags()

      The tags to apply to this procurement portal preference resource. Each tag consists of a key and an optional value.

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

      Returns:
      The tags to apply to this procurement portal preference resource. Each tag consists of a key and an optional value.

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier that you provide to ensure idempotency of the request.

      Returns:
      A unique, case-sensitive identifier that you provide to ensure idempotency of the request.

    • toBuilder

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

    • builder

      public static CreateProcurementPortalPreferenceRequest.Builder builder()

    • serializableBuilderClass

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