software.amazon.awssdk.services.migrationhubrefactorspaces.model

Interface GetRouteResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetRouteResponse.Builder,GetRouteResponse>, MigrationHubRefactorSpacesResponse.Builder, SdkBuilder<GetRouteResponse.Builder,GetRouteResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetRouteResponse

public static interface GetRouteResponse.Builder
extends MigrationHubRefactorSpacesResponse.Builder, SdkPojo, CopyableBuilder<GetRouteResponse.Builder,GetRouteResponse>

Method Summary

Modifier and Type	Method and Description
GetRouteResponse.Builder	applicationId(String applicationId) The ID of the application that the route belongs to.
GetRouteResponse.Builder	arn(String arn) The Amazon Resource Name (ARN) of the route.
GetRouteResponse.Builder	createdByAccountId(String createdByAccountId) The Amazon Web Services account ID of the route creator.
GetRouteResponse.Builder	createdTime(Instant createdTime) The timestamp of when the route is created.
GetRouteResponse.Builder	environmentId(String environmentId) Unique identifier of the environment.
default GetRouteResponse.Builder	error(Consumer<ErrorResponse.Builder> error) Any error associated with the route resource.
GetRouteResponse.Builder	error(ErrorResponse error) Any error associated with the route resource.
GetRouteResponse.Builder	includeChildPaths(Boolean includeChildPaths) Indicates whether to match all subpaths of the given source path.
GetRouteResponse.Builder	lastUpdatedTime(Instant lastUpdatedTime) A timestamp that indicates when the route was last updated.
GetRouteResponse.Builder	methods(Collection<HttpMethod> methods) A list of HTTP methods to match.
GetRouteResponse.Builder	methods(HttpMethod... methods) A list of HTTP methods to match.
GetRouteResponse.Builder	methodsWithStrings(Collection<String> methods) A list of HTTP methods to match.
GetRouteResponse.Builder	methodsWithStrings(String... methods) A list of HTTP methods to match.
GetRouteResponse.Builder	ownerAccountId(String ownerAccountId) The Amazon Web Services account ID of the route owner.
GetRouteResponse.Builder	pathResourceToId(Map<String,String> pathResourceToId) A mapping of Amazon API Gateway path resources to resource IDs.
GetRouteResponse.Builder	routeId(String routeId) The unique identifier of the route.
GetRouteResponse.Builder	routeType(RouteType routeType) The type of route.
GetRouteResponse.Builder	routeType(String routeType) The type of route.
GetRouteResponse.Builder	serviceId(String serviceId) The unique identifier of the service.
GetRouteResponse.Builder	sourcePath(String sourcePath) The path to use to match traffic.
GetRouteResponse.Builder	state(RouteState state) The current state of the route.
GetRouteResponse.Builder	state(String state) The current state of the route.
GetRouteResponse.Builder	tags(Map<String,String> tags) The tags assigned to the route.

Methods inherited from interface software.amazon.awssdk.services.migrationhubrefactorspaces.model.MigrationHubRefactorSpacesResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

applicationId

GetRouteResponse.Builder applicationId(String applicationId)

The ID of the application that the route belongs to.

Parameters:

applicationId - The ID of the application that the route belongs to.

Returns:

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

arn

GetRouteResponse.Builder arn(String arn)

The Amazon Resource Name (ARN) of the route.

Parameters:

arn - The Amazon Resource Name (ARN) of the route.

Returns:

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

createdByAccountId

GetRouteResponse.Builder createdByAccountId(String createdByAccountId)

The Amazon Web Services account ID of the route creator.

Parameters:

createdByAccountId - The Amazon Web Services account ID of the route creator.

Returns:

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

createdTime

GetRouteResponse.Builder createdTime(Instant createdTime)

The timestamp of when the route is created.

Parameters:

createdTime - The timestamp of when the route is created.

Returns:

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

environmentId

GetRouteResponse.Builder environmentId(String environmentId)

Unique identifier of the environment.

Parameters:

environmentId - Unique identifier of the environment.

Returns:

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

error

GetRouteResponse.Builder error(ErrorResponse error)

Any error associated with the route resource.

Parameters:

error - Any error associated with the route resource.

Returns:

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

error

default GetRouteResponse.Builder error(Consumer<ErrorResponse.Builder> error)

Any error associated with the route resource.

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

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

Parameters:

error - a consumer that will call methods on ErrorResponse.Builder

Returns:

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

See Also:

error(ErrorResponse)

includeChildPaths

GetRouteResponse.Builder includeChildPaths(Boolean includeChildPaths)

Indicates whether to match all subpaths of the given source path. If this value is false, requests must match the source path exactly before they are forwarded to this route's service.

Parameters:

includeChildPaths - Indicates whether to match all subpaths of the given source path. If this value is false, requests must match the source path exactly before they are forwarded to this route's service.

Returns:

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

lastUpdatedTime

GetRouteResponse.Builder lastUpdatedTime(Instant lastUpdatedTime)

A timestamp that indicates when the route was last updated.

Parameters:

lastUpdatedTime - A timestamp that indicates when the route was last updated.

Returns:

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

methodsWithStrings

GetRouteResponse.Builder methodsWithStrings(Collection<String> methods)

A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.

Parameters:

methods - A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.

Returns:

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

methodsWithStrings

GetRouteResponse.Builder methodsWithStrings(String... methods)

A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.

Parameters:

methods - A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.

Returns:

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

methods

GetRouteResponse.Builder methods(Collection<HttpMethod> methods)

A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.

Parameters:

methods - A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.

Returns:

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

methods

GetRouteResponse.Builder methods(HttpMethod... methods)

A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.

Parameters:

methods - A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.

Returns:

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

ownerAccountId

GetRouteResponse.Builder ownerAccountId(String ownerAccountId)

The Amazon Web Services account ID of the route owner.

Parameters:

ownerAccountId - The Amazon Web Services account ID of the route owner.

Returns:

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

pathResourceToId

GetRouteResponse.Builder pathResourceToId(Map<String,String> pathResourceToId)

A mapping of Amazon API Gateway path resources to resource IDs.

Parameters:

pathResourceToId - A mapping of Amazon API Gateway path resources to resource IDs.

Returns:

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

routeId

GetRouteResponse.Builder routeId(String routeId)

The unique identifier of the route.

DEFAULT: All traffic that does not match another route is forwarded to the default route. Applications must have a default route before any other routes can be created.

URI_PATH: A route that is based on a URI path.

Parameters:

routeId - The unique identifier of the route.

DEFAULT: All traffic that does not match another route is forwarded to the default route. Applications must have a default route before any other routes can be created.

URI_PATH: A route that is based on a URI path.

Returns:

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

routeType

GetRouteResponse.Builder routeType(String routeType)

The type of route.

Parameters:

routeType - The type of route.

Returns:

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

See Also:

RouteType, RouteType

routeType

GetRouteResponse.Builder routeType(RouteType routeType)

The type of route.

Parameters:

routeType - The type of route.

Returns:

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

See Also:

RouteType, RouteType

serviceId

GetRouteResponse.Builder serviceId(String serviceId)

The unique identifier of the service.

Parameters:

serviceId - The unique identifier of the service.

Returns:

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

sourcePath

GetRouteResponse.Builder sourcePath(String sourcePath)

The path to use to match traffic. Paths must start with / and are relative to the base of the application.

Parameters:

sourcePath - The path to use to match traffic. Paths must start with / and are relative to the base of the application.

Returns:

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

state

GetRouteResponse.Builder state(String state)

The current state of the route.

Parameters:

state - The current state of the route.

Returns:

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

See Also:

RouteState, RouteState

state

GetRouteResponse.Builder state(RouteState state)

The current state of the route.

Parameters:

state - The current state of the route.

Returns:

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

See Also:

RouteState, RouteState

tags

GetRouteResponse.Builder tags(Map<String,String> tags)

The tags assigned to the route. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.

Parameters:

tags - The tags assigned to the route. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.

Returns:

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