Package com.commercetools.api.models.subscription

Class SqsDestinationBuilder

java.lang.Object

com.commercetools.api.models.subscription.SqsDestinationBuilder

All Implemented Interfaces:

io.vrap.rmf.base.client.Builder<SqsDestination>

public class SqsDestinationBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<SqsDestination>

SqsDestinationBuilder Example to create an instance using the builder pattern

     SqsDestination sqsDestination = SqsDestination.builder()
             .queueUrl("{queueUrl}")
             .region("{region}")
             .build()
 

Constructor Summary

Constructors

Constructor	Description
SqsDestinationBuilder()

Method Summary

Modifier and Type	Method	Description
SqsDestinationBuilder	accessKey(String accessKey)	Only present if authenticationMode is set to Credentials.
SqsDestinationBuilder	accessSecret(String accessSecret)	Only present if authenticationMode is set to Credentials.
SqsDestinationBuilder	authenticationMode(AwsAuthenticationMode authenticationMode)	Defines the method of authentication for the SQS queue.
SqsDestination	build()	builds SqsDestination with checking for non-null required values
SqsDestination	buildUnchecked()	builds SqsDestination without checking for non-null required values
String	getAccessKey()	Only present if authenticationMode is set to Credentials.
String	getAccessSecret()	Only present if authenticationMode is set to Credentials.
AwsAuthenticationMode	getAuthenticationMode()	Defines the method of authentication for the SQS queue.
String	getQueueUrl()	URL of the Amazon SQS queue.
String	getRegion()	AWS Region the message queue is located in.
static SqsDestinationBuilder	of()	factory method for an instance of SqsDestinationBuilder
static SqsDestinationBuilder	of(SqsDestination template)	create builder for SqsDestination instance
SqsDestinationBuilder	queueUrl(String queueUrl)	URL of the Amazon SQS queue.
SqsDestinationBuilder	region(String region)	AWS Region the message queue is located in.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SqsDestinationBuilder

public SqsDestinationBuilder()

Method Details

accessKey

public SqsDestinationBuilder accessKey(@Nullable
 String accessKey)

Only present if authenticationMode is set to Credentials.

Parameters:

accessKey - value to be set

Returns:

Builder

accessSecret

public SqsDestinationBuilder accessSecret(@Nullable
 String accessSecret)

Only present if authenticationMode is set to Credentials.

Parameters:

accessSecret - value to be set

Returns:

Builder

queueUrl

public SqsDestinationBuilder queueUrl(String queueUrl)

URL of the Amazon SQS queue.

Parameters:

queueUrl - value to be set

Returns:

Builder

region

public SqsDestinationBuilder region(String region)

AWS Region the message queue is located in.

Parameters:

region - value to be set

Returns:

Builder

authenticationMode

public SqsDestinationBuilder authenticationMode(@Nullable
 AwsAuthenticationMode authenticationMode)

Defines the method of authentication for the SQS queue.

Parameters:

authenticationMode - value to be set

Returns:

Builder

getAccessKey

@Nullable
public String getAccessKey()

Only present if authenticationMode is set to Credentials.

Returns:

accessKey

getAccessSecret

@Nullable
public String getAccessSecret()

Only present if authenticationMode is set to Credentials.

Returns:

accessSecret

getQueueUrl

public String getQueueUrl()

URL of the Amazon SQS queue.

Returns:

queueUrl

getRegion

public String getRegion()

AWS Region the message queue is located in.

Returns:

region

getAuthenticationMode

@Nullable
public AwsAuthenticationMode getAuthenticationMode()

Defines the method of authentication for the SQS queue.

Returns:

authenticationMode

build

public SqsDestination build()

builds SqsDestination with checking for non-null required values

Specified by:

build in interface io.vrap.rmf.base.client.Builder<SqsDestination>

Returns:

SqsDestination

buildUnchecked

public SqsDestination buildUnchecked()

builds SqsDestination without checking for non-null required values

Returns:

SqsDestination

of

public static SqsDestinationBuilder of()

factory method for an instance of SqsDestinationBuilder

Returns:

builder

of

public static SqsDestinationBuilder of(SqsDestination template)

create builder for SqsDestination instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder