software.amazon.awssdk.services.migrationhubrefactorspaces.model

Class CreateRouteRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.migrationhubrefactorspaces.model.MigrationHubRefactorSpacesRequest

software.amazon.awssdk.services.migrationhubrefactorspaces.model.CreateRouteRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateRouteRequest.Builder,CreateRouteRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateRouteRequest
extends MigrationHubRefactorSpacesRequest
implements ToCopyableBuilder<CreateRouteRequest.Builder,CreateRouteRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateRouteRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	applicationIdentifier() The ID of the application within which the route is being created.
static CreateRouteRequest.Builder	builder()
String	clientToken() A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
DefaultRouteInput	defaultRoute() Configuration for the default route type.
String	environmentIdentifier() The ID of the environment in which the route is created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
RouteType	routeType() The route type of the route.
String	routeTypeAsString() The route type of the route.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateRouteRequest.Builder>	serializableBuilderClass()
String	serviceIdentifier() The ID of the service in which the route is created.
Map<String,String>	tags() The tags to assign to the route.
CreateRouteRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
UriPathRouteInput	uriPathRoute() The configuration for the URI path route type.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

applicationIdentifier

public final String applicationIdentifier()

The ID of the application within which the route is being created.

Returns:

The ID of the application within which the route is being created.

clientToken

public final String clientToken()

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

defaultRoute

public final DefaultRouteInput defaultRoute()

Configuration for the default route type.

Returns:

Configuration for the default route type.

environmentIdentifier

public final String environmentIdentifier()

The ID of the environment in which the route is created.

Returns:

The ID of the environment in which the route is created.

routeType

public final RouteType routeType()

The route type of the route. DEFAULT indicates that 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 indicates a route that is based on a URI path.

If the service returns an enum value that is not available in the current SDK version, routeType will return RouteType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from routeTypeAsString().

Returns:

The route type of the route. DEFAULT indicates that 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 indicates a route that is based on a URI path.

See Also:

RouteType

routeTypeAsString

public final String routeTypeAsString()

The route type of the route. DEFAULT indicates that 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 indicates a route that is based on a URI path.

If the service returns an enum value that is not available in the current SDK version, routeType will return RouteType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from routeTypeAsString().

Returns:

The route type of the route. DEFAULT indicates that 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 indicates a route that is based on a URI path.

See Also:

RouteType

serviceIdentifier

public final String serviceIdentifier()

The ID of the service in which the route is created. Traffic that matches this route is forwarded to this service.

Returns:

The ID of the service in which the route is created. Traffic that matches this route is forwarded to this service.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final Map<String,String> tags()

The tags to assign 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..

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

The tags to assign 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..

uriPathRoute

public final UriPathRouteInput uriPathRoute()

The configuration for the URI path route type.

Returns:

The configuration for the URI path route type.

toBuilder

public CreateRouteRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateRouteRequest.Builder,CreateRouteRequest>

Specified by:

toBuilder in class MigrationHubRefactorSpacesRequest

builder

public static CreateRouteRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateRouteRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo