Interface GetBackendApiRequest.Builder

All Superinterfaces:

AmplifyBackendRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<GetBackendApiRequest.Builder,GetBackendApiRequest>, SdkBuilder<GetBackendApiRequest.Builder,GetBackendApiRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetBackendApiRequest

@Mutable
@NotThreadSafe
public static interface GetBackendApiRequest.Builder
extends AmplifyBackendRequest.Builder, SdkPojo, CopyableBuilder<GetBackendApiRequest.Builder,GetBackendApiRequest>

Method Summary

Modifier and Type	Method	Description
GetBackendApiRequest.Builder	appId(String appId)	The app ID.
GetBackendApiRequest.Builder	backendEnvironmentName(String backendEnvironmentName)	The name of the backend environment.
GetBackendApiRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
GetBackendApiRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default GetBackendApiRequest.Builder	resourceConfig(Consumer<BackendAPIResourceConfig.Builder> resourceConfig)	Defines the resource configuration for the data model in your Amplify project.
GetBackendApiRequest.Builder	resourceConfig(BackendAPIResourceConfig resourceConfig)	Defines the resource configuration for the data model in your Amplify project.
GetBackendApiRequest.Builder	resourceName(String resourceName)	The name of this resource.

Methods inherited from interface software.amazon.awssdk.services.amplifybackend.model.AmplifyBackendRequest.Builder

build

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

overrideConfiguration

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

appId

GetBackendApiRequest.Builder appId(String appId)

The app ID.

Parameters:

appId - The app ID.

Returns:

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

backendEnvironmentName

GetBackendApiRequest.Builder backendEnvironmentName(String backendEnvironmentName)

The name of the backend environment.

Parameters:

backendEnvironmentName - The name of the backend environment.

Returns:

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

resourceConfig

GetBackendApiRequest.Builder resourceConfig(BackendAPIResourceConfig resourceConfig)

Defines the resource configuration for the data model in your Amplify project.

Parameters:

resourceConfig - Defines the resource configuration for the data model in your Amplify project.

Returns:

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

resourceConfig

default GetBackendApiRequest.Builder resourceConfig(Consumer<BackendAPIResourceConfig.Builder> resourceConfig)

Defines the resource configuration for the data model in your Amplify project.

This is a convenience method that creates an instance of the BackendAPIResourceConfig.Builder avoiding the need to create one manually via BackendAPIResourceConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resourceConfig(BackendAPIResourceConfig).

Parameters:

resourceConfig - a consumer that will call methods on BackendAPIResourceConfig.Builder

Returns:

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

See Also:

• resourceConfig(BackendAPIResourceConfig)

resourceName

GetBackendApiRequest.Builder resourceName(String resourceName)

The name of this resource.

Parameters:

resourceName - The name of this resource.

Returns:

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

overrideConfiguration

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

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