software.amazon.awssdk.services.agcod.model

Class CreateGiftCardRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.agcod.model.AgcodRequest

software.amazon.awssdk.services.agcod.model.CreateGiftCardRequest

All Implemented Interfaces:

software.amazon.awssdk.core.SdkPojo, software.amazon.awssdk.utils.builder.ToCopyableBuilder<CreateGiftCardRequest.Builder,CreateGiftCardRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateGiftCardRequest
extends AgcodRequest
implements software.amazon.awssdk.utils.builder.ToCopyableBuilder<CreateGiftCardRequest.Builder,CreateGiftCardRequest>

Represents the input of a CreateGiftCardRequest operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateGiftCardRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateGiftCardRequest.Builder	builder()
String	creationRequestId() A unique identifier for every CreateGiftCard call that results in the creation of a GC.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
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).
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	partnerId() A unique identifier (CASE SENSITIVE, 1st letter is capitalized and the next four are lower case) provided by the Amazon GC team.
ProductType	productType() The ProductType field is required for the creation of an Amazon Product Voucher Claim Code.
String	productTypeAsString() The ProductType field is required for the creation of an Amazon Product Voucher Claim Code.
String	programId() The programID is an approved identifier provided by Amazon through a submission process.
List<software.amazon.awssdk.core.SdkField<?>>	sdkFields()
static Class<? extends CreateGiftCardRequest.Builder>	serializableBuilderClass()
CreateGiftCardRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
AgcodValue	value() Returns the value of the Value property for 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

creationRequestId

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

Returns:

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.

partnerId

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

Returns:

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.

value

public AgcodValue value()

Returns the value of the Value property for this object.

Returns:

The value of the Value property for this object.

programId

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

Returns:

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.

productType

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

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

Returns:

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.

See Also:

ProductType

productTypeAsString

public String productTypeAsString()

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.

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

Returns:

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.

See Also:

ProductType

externalReference

public 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).

Returns:

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

toBuilder

public CreateGiftCardRequest.Builder toBuilder()

Specified by:

toBuilder in interface software.amazon.awssdk.utils.builder.ToCopyableBuilder<CreateGiftCardRequest.Builder,CreateGiftCardRequest>

Specified by:

toBuilder in class AgcodRequest

builder

public static CreateGiftCardRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateGiftCardRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class software.amazon.awssdk.awscore.AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class software.amazon.awssdk.awscore.AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface software.amazon.awssdk.core.SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class software.amazon.awssdk.core.SdkRequest

sdkFields

public List<software.amazon.awssdk.core.SdkField<?>> sdkFields()

Specified by:

sdkFields in interface software.amazon.awssdk.core.SdkPojo