Package com.commercetools.api.models.extension

Interface GoogleCloudFunctionDestination

All Superinterfaces:

ExtensionDestination

public interface GoogleCloudFunctionDestination
extends ExtensionDestination

For GoogleCloudFunction destinations, you need to grant permissions to the extensions@commercetools-platform.iam.gserviceaccount.com service account to invoke your function. If your function's version is 1st gen, grant the service account the IAM role Cloud Functions Invoker. For version 2nd gen, assign the IAM role Cloud Run Invoker using the Cloud Run console.

Example to create an instance using the builder pattern

     GoogleCloudFunctionDestination googleCloudFunctionDestination = GoogleCloudFunctionDestination.builder()
             .url("{url}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GOOGLE_CLOUD_FUNCTION	discriminator value for GoogleCloudFunctionDestination

Method Summary

Modifier and Type	Method	Description
static GoogleCloudFunctionDestinationBuilder	builder()	builder factory method for GoogleCloudFunctionDestination
static GoogleCloudFunctionDestinationBuilder	builder(GoogleCloudFunctionDestination template)	create builder for GoogleCloudFunctionDestination instance
GoogleCloudFunctionDestination	copyDeep()
static GoogleCloudFunctionDestination	deepCopy(GoogleCloudFunctionDestination template)	factory method to create a deep copy of GoogleCloudFunctionDestination
@NotNull String	getUrl()	URL to the target function.
static GoogleCloudFunctionDestination	of()	factory method
static GoogleCloudFunctionDestination	of(GoogleCloudFunctionDestination template)	factory method to create a shallow copy GoogleCloudFunctionDestination
void	setUrl(String url)	URL to the target function.
static com.fasterxml.jackson.core.type.TypeReference<GoogleCloudFunctionDestination>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withGoogleCloudFunctionDestination(Function<GoogleCloudFunctionDestination,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.extension.ExtensionDestination

getType, withExtensionDestination

Field Details

GOOGLE_CLOUD_FUNCTION

static final String GOOGLE_CLOUD_FUNCTION

discriminator value for GoogleCloudFunctionDestination

See Also:

• Constant Field Values

Method Details

getUrl

@NotNull
@NotNull String getUrl()

URL to the target function.

Returns:

url

setUrl

void setUrl(String url)

URL to the target function.

Parameters:

url - value to be set

of

static GoogleCloudFunctionDestination of()

factory method

Returns:

instance of GoogleCloudFunctionDestination

of

static GoogleCloudFunctionDestination of(GoogleCloudFunctionDestination template)

factory method to create a shallow copy GoogleCloudFunctionDestination

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

GoogleCloudFunctionDestination copyDeep()

Specified by:

copyDeep in interface ExtensionDestination

deepCopy

@Nullable
static GoogleCloudFunctionDestination deepCopy(@Nullable
 GoogleCloudFunctionDestination template)

factory method to create a deep copy of GoogleCloudFunctionDestination

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static GoogleCloudFunctionDestinationBuilder builder()

builder factory method for GoogleCloudFunctionDestination

Returns:

builder

builder

static GoogleCloudFunctionDestinationBuilder builder(GoogleCloudFunctionDestination template)

create builder for GoogleCloudFunctionDestination instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withGoogleCloudFunctionDestination

default <T> T withGoogleCloudFunctionDestination(Function<GoogleCloudFunctionDestination,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<GoogleCloudFunctionDestination> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference