Class StartSupportDataExportRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.marketplacecommerceanalytics.model.MarketplaceCommerceAnalyticsRequest
-
- software.amazon.awssdk.services.marketplacecommerceanalytics.model.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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceStartSupportDataExportRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static StartSupportDataExportRequest.Builderbuilder()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.SupportDataSetTypedataSetType()This target has been deprecated. Specifies the data set type to be written to the output csv file.StringdataSetTypeAsString()This target has been deprecated. Specifies the data set type to be written to the output csv file.StringdestinationS3BucketName()This target has been deprecated. The name (friendly name, not ARN) of the destination S3 bucket.StringdestinationS3Prefix()This target has been deprecated. (Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)InstantfromDate()This target has been deprecated. The start date from which to retrieve the data set in UTC.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasCustomerDefinedValues()For responses, this returns true if the service returned a value for the CustomerDefinedValues property.inthashCode()StringroleNameArn()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.List<SdkField<?>>sdkFields()static Class<? extends StartSupportDataExportRequest.Builder>serializableBuilderClass()StringsnsTopicArn()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.StartSupportDataExportRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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,
dataSetTypewill returnSupportDataSetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdataSetTypeAsString().- 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:
SupportDataSetType
-
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,
dataSetTypewill returnSupportDataSetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdataSetTypeAsString().- 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:
SupportDataSetType
-
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 theisEmpty()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
public StartSupportDataExportRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<StartSupportDataExportRequest.Builder,StartSupportDataExportRequest>- Specified by:
toBuilderin classMarketplaceCommerceAnalyticsRequest
-
builder
public static StartSupportDataExportRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends StartSupportDataExportRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-