software.amazon.awscdk.services.appmesh

Interface GrpcRouteSpecOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, RouteSpecOptionsBase

All Known Implementing Classes:

GrpcRouteSpecOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-11T19:24:24.364Z")
 @Stability(value=Experimental)
public interface GrpcRouteSpecOptions
extends software.amazon.jsii.JsiiSerializable, RouteSpecOptionsBase

(experimental) Properties specific for a GRPC Based Routes.

Example:

 VirtualRouter router;
 VirtualNode node;
 router.addRoute("route-http", RouteBaseProps.builder()
         .routeSpec(RouteSpec.grpc(GrpcRouteSpecOptions.builder()
                 .weightedTargets(List.of(WeightedTarget.builder()
                         .virtualNode(node)
                         .build()))
                 .match(GrpcRouteMatch.builder()
                         .serviceName("my-service.default.svc.cluster.local")
                         .build())
                 .timeout(GrpcTimeout.builder()
                         .idle(Duration.seconds(2))
                         .perRequest(Duration.seconds(1))
                         .build())
                 .build()))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GrpcRouteSpecOptions.Builder A builder for GrpcRouteSpecOptions
static class	GrpcRouteSpecOptions.Jsii$Proxy An implementation for GrpcRouteSpecOptions

Method Summary

Modifier and Type	Method and Description
static GrpcRouteSpecOptions.Builder	builder()
GrpcRouteMatch	getMatch() (experimental) The criterion for determining a request match for this Route.
default GrpcRetryPolicy	getRetryPolicy() (experimental) The retry policy.
default GrpcTimeout	getTimeout() (experimental) An object that represents a grpc timeout.
List<WeightedTarget>	getWeightedTargets() (experimental) List of targets that traffic is routed to when a request matches the route.

Methods inherited from interface software.amazon.awscdk.services.appmesh.RouteSpecOptionsBase

getPriority

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMatch

@Stability(value=Experimental)
 @NotNull
GrpcRouteMatch getMatch()

(experimental) The criterion for determining a request match for this Route.

getWeightedTargets

@Stability(value=Experimental)
 @NotNull
List<WeightedTarget> getWeightedTargets()

(experimental) List of targets that traffic is routed to when a request matches the route.

getRetryPolicy

@Stability(value=Experimental)
 @Nullable
default GrpcRetryPolicy getRetryPolicy()

(experimental) The retry policy.

Default: - no retry policy

getTimeout

@Stability(value=Experimental)
 @Nullable
default GrpcTimeout getTimeout()

(experimental) An object that represents a grpc timeout.

Default: - None

builder

@Stability(value=Experimental)
static GrpcRouteSpecOptions.Builder builder()

Specified by:

builder in interface RouteSpecOptionsBase

Returns:

a GrpcRouteSpecOptions.Builder of GrpcRouteSpecOptions