software.amazon.awssdk.services.agcod.model

Interface CreateGiftCardRequest.Builder

All Superinterfaces:

AgcodRequest.Builder, software.amazon.awssdk.awscore.AwsRequest.Builder, software.amazon.awssdk.utils.builder.Buildable, software.amazon.awssdk.utils.builder.CopyableBuilder<CreateGiftCardRequest.Builder,CreateGiftCardRequest>, software.amazon.awssdk.utils.builder.SdkBuilder<CreateGiftCardRequest.Builder,CreateGiftCardRequest>, software.amazon.awssdk.core.SdkPojo, software.amazon.awssdk.core.SdkRequest.Builder

Enclosing class:

CreateGiftCardRequest

public static interface CreateGiftCardRequest.Builder
extends AgcodRequest.Builder, software.amazon.awssdk.core.SdkPojo, software.amazon.awssdk.utils.builder.CopyableBuilder<CreateGiftCardRequest.Builder,CreateGiftCardRequest>

Method Summary

Modifier and Type	Method and Description
CreateGiftCardRequest.Builder	creationRequestId(String creationRequestId) A unique identifier for every CreateGiftCard call that results in the creation of a GC.
CreateGiftCardRequest.Builder	externalReference(String externalReference) You can use the externalReference field to pass your own reference identifier as a string when making gift code requests (up to 100 Unicode characters).
CreateGiftCardRequest.Builder	overrideConfiguration(software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration overrideConfiguration)
CreateGiftCardRequest.Builder	overrideConfiguration(Consumer<software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateGiftCardRequest.Builder	partnerId(String partnerId) A unique identifier (CASE SENSITIVE, 1st letter is capitalized and the next four are lower case) provided by the Amazon GC team.
CreateGiftCardRequest.Builder	productType(ProductType productType) The ProductType field is required for the creation of an Amazon Product Voucher Claim Code.
CreateGiftCardRequest.Builder	productType(String productType) The ProductType field is required for the creation of an Amazon Product Voucher Claim Code.
CreateGiftCardRequest.Builder	programId(String programId) The programID is an approved identifier provided by Amazon through a submission process.
CreateGiftCardRequest.Builder	value(AgcodValue value) Sets the value of the Value property for this object.
default CreateGiftCardRequest.Builder	value(Consumer<AgcodValue.Builder> value) Sets the value of the Value property for this object.

Methods inherited from interface software.amazon.awssdk.services.agcod.model.AgcodRequest.Builder

build

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

overrideConfiguration

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

equalsBySdkFields, 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

creationRequestId

CreateGiftCardRequest.Builder creationRequestId(String creationRequestId)

A unique identifier for every CreateGiftCard call that results in the creation of a GC. The partner must generate a new value for every Create request (except for retries) To keep this as the globally unique transaction identifier, the partner needs to:

• Generate an alphanumeric value that is unique within your system. This ID can have up to 40 alphanumeric characters.
• Begin the creationRequestId value with your partnerID.

Parameters:

creationRequestId - A unique identifier for every CreateGiftCard call that results in the creation of a GC. The partner must generate a new value for every Create request (except for retries) To keep this as the globally unique transaction identifier, the partner needs to:

• Generate an alphanumeric value that is unique within your system. This ID can have up to 40 alphanumeric characters.
• Begin the creationRequestId value with your partnerID.

Returns:

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

partnerId

CreateGiftCardRequest.Builder partnerId(String partnerId)

A unique identifier (CASE SENSITIVE, 1st letter is capitalized and the next four are lower case) provided by the Amazon GC team. This value is part of the Payload of every AGCOD Gateway request.

Parameters:

partnerId - A unique identifier (CASE SENSITIVE, 1st letter is capitalized and the next four are lower case) provided by the Amazon GC team. This value is part of the Payload of every AGCOD Gateway request.

Returns:

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

value

CreateGiftCardRequest.Builder value(AgcodValue value)

Sets the value of the Value property for this object.

Parameters:

value - The new value for the Value property for this object.

Returns:

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

value

default CreateGiftCardRequest.Builder value(Consumer<AgcodValue.Builder> value)

Sets the value of the Value property for this object. This is a convenience that creates an instance of the AgcodValue.Builder avoiding the need to create one manually via AgcodValue.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to value(AgcodValue).

Parameters:

value - a consumer that will call methods on AgcodValue.Builder

Returns:

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

See Also:

value(AgcodValue)

programId

CreateGiftCardRequest.Builder programId(String programId)

The programID is an approved identifier provided by Amazon through a submission process. The programID is alphanumeric and can be up to 100 characters in length.

Parameters:

programId - The programID is an approved identifier provided by Amazon through a submission process. The programID is alphanumeric and can be up to 100 characters in length.

Returns:

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

productType

CreateGiftCardRequest.Builder productType(String productType)

The ProductType field is required for the creation of an Amazon Product Voucher Claim Code. Only authorized partners can create Product Vouchers. This attribute is alpha-numeric with a max length of 50 characters.

Parameters:

productType - The ProductType field is required for the creation of an Amazon Product Voucher Claim Code. Only authorized partners can create Product Vouchers. This attribute is alpha-numeric with a max length of 50 characters.

Returns:

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

See Also:

ProductType, ProductType

productType

CreateGiftCardRequest.Builder productType(ProductType productType)

The ProductType field is required for the creation of an Amazon Product Voucher Claim Code. Only authorized partners can create Product Vouchers. This attribute is alpha-numeric with a max length of 50 characters.

Parameters:

productType - The ProductType field is required for the creation of an Amazon Product Voucher Claim Code. Only authorized partners can create Product Vouchers. This attribute is alpha-numeric with a max length of 50 characters.

Returns:

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

See Also:

ProductType, ProductType

externalReference

CreateGiftCardRequest.Builder externalReference(String externalReference)

You can use the externalReference field to pass your own reference identifier as a string when making gift code requests (up to 100 Unicode characters).

Parameters:

externalReference - You can use the externalReference field to pass your own reference identifier as a string when making gift code requests (up to 100 Unicode characters).

Returns:

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

overrideConfiguration

CreateGiftCardRequest.Builder overrideConfiguration(software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

CreateGiftCardRequest.Builder overrideConfiguration(Consumer<software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface software.amazon.awssdk.awscore.AwsRequest.Builder