Interface RouteSummary.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<RouteSummary.Builder,RouteSummary>,SdkBuilder<RouteSummary.Builder,RouteSummary>,SdkPojo
- Enclosing class:
- RouteSummary
public static interface RouteSummary.Builder extends SdkPojo, CopyableBuilder<RouteSummary.Builder,RouteSummary>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description RouteSummary.BuilderappendSourcePath(Boolean appendSourcePath)If set totrue, this option appends the source path to the service URL endpoint.RouteSummary.BuilderapplicationId(String applicationId)The unique identifier of the application.RouteSummary.Builderarn(String arn)The Amazon Resource Name (ARN) of the route.RouteSummary.BuildercreatedByAccountId(String createdByAccountId)The Amazon Web Services account ID of the route creator.RouteSummary.BuildercreatedTime(Instant createdTime)A timestamp that indicates when the route is created.RouteSummary.BuilderenvironmentId(String environmentId)The unique identifier of the environment.default RouteSummary.Buildererror(Consumer<ErrorResponse.Builder> error)Any error associated with the route resource.RouteSummary.Buildererror(ErrorResponse error)Any error associated with the route resource.RouteSummary.BuilderincludeChildPaths(Boolean includeChildPaths)Indicates whether to match all subpaths of the given source path.RouteSummary.BuilderlastUpdatedTime(Instant lastUpdatedTime)A timestamp that indicates when the route was last updated.RouteSummary.Buildermethods(Collection<HttpMethod> methods)A list of HTTP methods to match.RouteSummary.Buildermethods(HttpMethod... methods)A list of HTTP methods to match.RouteSummary.BuildermethodsWithStrings(String... methods)A list of HTTP methods to match.RouteSummary.BuildermethodsWithStrings(Collection<String> methods)A list of HTTP methods to match.RouteSummary.BuilderownerAccountId(String ownerAccountId)The Amazon Web Services account ID of the route owner.RouteSummary.BuilderpathResourceToId(Map<String,String> pathResourceToId)A mapping of Amazon API Gateway path resources to resource IDs.RouteSummary.BuilderrouteId(String routeId)The unique identifier of the route.RouteSummary.BuilderrouteType(String routeType)The route type of the route.RouteSummary.BuilderrouteType(RouteType routeType)The route type of the route.RouteSummary.BuilderserviceId(String serviceId)The unique identifier of the service.RouteSummary.BuildersourcePath(String sourcePath)This is the path that Refactor Spaces uses to match traffic.RouteSummary.Builderstate(String state)The current state of the route.RouteSummary.Builderstate(RouteState state)The current state of the route.RouteSummary.Buildertags(Map<String,String> tags)The tags assigned to the route.-
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 Detail
-
appendSourcePath
RouteSummary.Builder appendSourcePath(Boolean appendSourcePath)
If set to
true, this option appends the source path to the service URL endpoint.- Parameters:
appendSourcePath- If set totrue, this option appends the source path to the service URL endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
applicationId
RouteSummary.Builder applicationId(String applicationId)
The unique identifier of the application.
- Parameters:
applicationId- The unique identifier of the application.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
arn
RouteSummary.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
RouteSummary.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
RouteSummary.Builder createdTime(Instant createdTime)
A timestamp that indicates when the route is created.
- Parameters:
createdTime- A timestamp that indicates when the route is created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
environmentId
RouteSummary.Builder environmentId(String environmentId)
The unique identifier of the environment.
- Parameters:
environmentId- The unique identifier of the environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
error
RouteSummary.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 RouteSummary.Builder error(Consumer<ErrorResponse.Builder> error)
Any error associated with the route resource.
This is a convenience method that creates an instance of theErrorResponse.Builderavoiding the need to create one manually viaErrorResponse.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toerror(ErrorResponse).- Parameters:
error- a consumer that will call methods onErrorResponse.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
error(ErrorResponse)
-
includeChildPaths
RouteSummary.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 isfalse, 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
RouteSummary.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
RouteSummary.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
RouteSummary.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
RouteSummary.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
RouteSummary.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
RouteSummary.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
RouteSummary.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
RouteSummary.Builder routeId(String routeId)
The unique identifier of the route.
- Parameters:
routeId- The unique identifier of the route.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
routeType
RouteSummary.Builder routeType(String routeType)
The route type of the route.
-
routeType
RouteSummary.Builder routeType(RouteType routeType)
The route type of the route.
-
serviceId
RouteSummary.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
RouteSummary.Builder sourcePath(String sourcePath)
This is the path that Refactor Spaces uses to match traffic. Paths must start with
/and are relative to the base of the application. To use path parameters in the source path, add a variable in curly braces. For example, the resource path {user} represents a path parameter called 'user'.- Parameters:
sourcePath- This is the path that Refactor Spaces uses to match traffic. Paths must start with/and are relative to the base of the application. To use path parameters in the source path, add a variable in curly braces. For example, the resource path {user} represents a path parameter called 'user'.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
state
RouteSummary.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
RouteSummary.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
RouteSummary.Builder tags(Map<String,String> tags)
The tags assigned to the route.
- Parameters:
tags- The tags assigned to the route.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-