software.amazon.awssdk.services.marketplacecommerceanalytics.model

Interface StartSupportDataExportRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartSupportDataExportRequest.Builder,StartSupportDataExportRequest>, MarketplaceCommerceAnalyticsRequest.Builder, SdkBuilder<StartSupportDataExportRequest.Builder,StartSupportDataExportRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartSupportDataExportRequest

public static interface StartSupportDataExportRequest.Builder
extends MarketplaceCommerceAnalyticsRequest.Builder, SdkPojo, CopyableBuilder<StartSupportDataExportRequest.Builder,StartSupportDataExportRequest>

Method Summary

Modifier and Type	Method and Description
StartSupportDataExportRequest.Builder	customerDefinedValues(Map<String,String> customerDefinedValues) (Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file.
StartSupportDataExportRequest.Builder	dataSetType(String dataSetType) Specifies the data set type to be written to the output csv file.
StartSupportDataExportRequest.Builder	dataSetType(SupportDataSetType dataSetType) Specifies the data set type to be written to the output csv file.
StartSupportDataExportRequest.Builder	destinationS3BucketName(String destinationS3BucketName) The name (friendly name, not ARN) of the destination S3 bucket.
StartSupportDataExportRequest.Builder	destinationS3Prefix(String destinationS3Prefix) (Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems.
StartSupportDataExportRequest.Builder	fromDate(Instant fromDate) The start date from which to retrieve the data set in UTC.
StartSupportDataExportRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
StartSupportDataExportRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
StartSupportDataExportRequest.Builder	roleNameArn(String roleNameArn) The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.
StartSupportDataExportRequest.Builder	snsTopicArn(String snsTopicArn) 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.

Methods inherited from interface software.amazon.awssdk.services.marketplacecommerceanalytics.model.MarketplaceCommerceAnalyticsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

dataSetType

StartSupportDataExportRequest.Builder dataSetType(String dataSetType)

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

Parameters:

dataSetType - 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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SupportDataSetType, SupportDataSetType

dataSetType

StartSupportDataExportRequest.Builder dataSetType(SupportDataSetType dataSetType)

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

Parameters:

dataSetType - 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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SupportDataSetType, SupportDataSetType

fromDate

StartSupportDataExportRequest.Builder fromDate(Instant fromDate)

The start date from which to retrieve the data set in UTC. This parameter only affects the customer_support_contacts_data data set type.

Parameters:

fromDate - 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:

Returns a reference to this object so that method calls can be chained together.

roleNameArn

StartSupportDataExportRequest.Builder roleNameArn(String roleNameArn)

The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.

Parameters:

roleNameArn - The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.

Returns:

Returns a reference to this object so that method calls can be chained together.

destinationS3BucketName

StartSupportDataExportRequest.Builder destinationS3BucketName(String destinationS3BucketName)

The name (friendly name, not ARN) of the destination S3 bucket.

Parameters:

destinationS3BucketName - The name (friendly name, not ARN) of the destination S3 bucket.

Returns:

Returns a reference to this object so that method calls can be chained together.

destinationS3Prefix

StartSupportDataExportRequest.Builder destinationS3Prefix(String destinationS3Prefix)

(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.

Parameters:

destinationS3Prefix - (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:

Returns a reference to this object so that method calls can be chained together.

snsTopicArn

StartSupportDataExportRequest.Builder snsTopicArn(String snsTopicArn)

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.

Parameters:

snsTopicArn - 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:

Returns a reference to this object so that method calls can be chained together.

customerDefinedValues

StartSupportDataExportRequest.Builder customerDefinedValues(Map<String,String> customerDefinedValues)

(Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file.

Parameters:

customerDefinedValues - (Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

StartSupportDataExportRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

StartSupportDataExportRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.