Class StartSupportDataExportRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartSupportDataExportRequest.Builder,StartSupportDataExportRequest>

@Generated("software.amazon.awssdk:codegen") public final class StartSupportDataExportRequest extends MarketplaceCommerceAnalyticsRequest implements ToCopyableBuilder<StartSupportDataExportRequest.Builder,StartSupportDataExportRequest>
This target has been deprecated. Container for the parameters to the StartSupportDataExport operation.
  • Method Details

    • dataSetType

      public final SupportDataSetType dataSetType()

      This target has been deprecated. Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Product Code, Customer Guid, Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country Code, ZIP Code, Operation Type, and Operation Time.

      • customer_support_contacts_data Customer support contact data. The data set will contain all changes (Creates, Updates, and Deletes) to customer support contact data from the date specified in the from_date parameter.
      • test_customer_support_contacts_data An example data set containing static test data in the same format as customer_support_contacts_data

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

      Returns:
      This target has been deprecated. Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Product Code, Customer Guid, Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country Code, ZIP Code, Operation Type, and Operation Time.

      • customer_support_contacts_data Customer support contact data. The data set will contain all changes (Creates, Updates, and Deletes) to customer support contact data from the date specified in the from_date parameter.
      • test_customer_support_contacts_data An example data set containing static test data in the same format as customer_support_contacts_data
      See Also:
    • dataSetTypeAsString

      public final String dataSetTypeAsString()

      This target has been deprecated. Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Product Code, Customer Guid, Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country Code, ZIP Code, Operation Type, and Operation Time.

      • customer_support_contacts_data Customer support contact data. The data set will contain all changes (Creates, Updates, and Deletes) to customer support contact data from the date specified in the from_date parameter.
      • test_customer_support_contacts_data An example data set containing static test data in the same format as customer_support_contacts_data

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

      Returns:
      This target has been deprecated. Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Product Code, Customer Guid, Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country Code, ZIP Code, Operation Type, and Operation Time.

      • customer_support_contacts_data Customer support contact data. The data set will contain all changes (Creates, Updates, and Deletes) to customer support contact data from the date specified in the from_date parameter.
      • test_customer_support_contacts_data An example data set containing static test data in the same format as customer_support_contacts_data
      See Also:
    • fromDate

      public final Instant fromDate()
      This target has been deprecated. The start date from which to retrieve the data set in UTC. This parameter only affects the customer_support_contacts_data data set type.
      Returns:
      This target has been deprecated.
    • roleNameArn

      public final String roleNameArn()
      This target has been deprecated. The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.
      Returns:
      This target has been deprecated.
    • destinationS3BucketName

      public final String destinationS3BucketName()
      This target has been deprecated. The name (friendly name, not ARN) of the destination S3 bucket.
      Returns:
      This target has been deprecated.
    • destinationS3Prefix

      public final String destinationS3Prefix()
      This target has been deprecated. (Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems. For example, if given the bucket name "mybucket" and the prefix "myprefix/mydatasets", the output file "outputfile" would be published to "s3://mybucket/myprefix/mydatasets/outputfile". If the prefix directory structure does not exist, it will be created. If no prefix is provided, the data set will be published to the S3 bucket root.
      Returns:
      This target has been deprecated.
    • snsTopicArn

      public final String snsTopicArn()
      This target has been deprecated. Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an error has occurred.
      Returns:
      This target has been deprecated.
    • hasCustomerDefinedValues

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

      public final Map<String,String> customerDefinedValues()
      This target has been deprecated. (Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file.

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

      Returns:
      This target has been deprecated.
    • 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<StartSupportDataExportRequest.Builder,StartSupportDataExportRequest>
      Specified by:
      toBuilder in class MarketplaceCommerceAnalyticsRequest
      Returns:
      a builder for type T
    • builder

      public static StartSupportDataExportRequest.Builder builder()
    • serializableBuilderClass

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