software.amazon.awssdk.services.migrationhubrefactorspaces.model

Class UriPathRouteInput

java.lang.Object

software.amazon.awssdk.services.migrationhubrefactorspaces.model.UriPathRouteInput

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<UriPathRouteInput.Builder,UriPathRouteInput>

@Generated(value="software.amazon.awssdk:codegen")
public final class UriPathRouteInput
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<UriPathRouteInput.Builder,UriPathRouteInput>

The configuration for the URI path route type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UriPathRouteInput.Builder

Method Summary

Modifier and Type	Method and Description
RouteActivationState	activationState() If set to ACTIVE, traffic is forwarded to this route’s service after the route is created.
String	activationStateAsString() If set to ACTIVE, traffic is forwarded to this route’s service after the route is created.
Boolean	appendSourcePath() If set to true, this option appends the source path to the service URL endpoint.
static UriPathRouteInput.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMethods() For responses, this returns true if the service returned a value for the Methods property.
Boolean	includeChildPaths() Indicates whether to match all subpaths of the given source path.
List<HttpMethod>	methods() A list of HTTP methods to match.
List<String>	methodsAsStrings() A list of HTTP methods to match.
List<SdkField<?>>	sdkFields()
static Class<? extends UriPathRouteInput.Builder>	serializableBuilderClass()
String	sourcePath() This is the path that Refactor Spaces uses to match traffic.
UriPathRouteInput.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

activationState

public final RouteActivationState activationState()

If set to ACTIVE, traffic is forwarded to this route’s service after the route is created.

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

Returns:

If set to ACTIVE, traffic is forwarded to this route’s service after the route is created.

See Also:

RouteActivationState

activationStateAsString

public final String activationStateAsString()

If set to ACTIVE, traffic is forwarded to this route’s service after the route is created.

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

Returns:

If set to ACTIVE, traffic is forwarded to this route’s service after the route is created.

See Also:

RouteActivationState

appendSourcePath

public final Boolean appendSourcePath()

If set to true, this option appends the source path to the service URL endpoint.

Returns:

If set to true, this option appends the source path to the service URL endpoint.

includeChildPaths

public final 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.

Returns:

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.

methods

public final List<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.

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 hasMethods() method.

Returns:

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.

hasMethods

public final boolean hasMethods()

For responses, this returns true if the service returned a value for the Methods 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.

methodsAsStrings

public final List<String> methodsAsStrings()

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.

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 hasMethods() method.

Returns:

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.

sourcePath

public final 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'.

Returns:

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

toBuilder

public UriPathRouteInput.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UriPathRouteInput.Builder,UriPathRouteInput>

builder

public static UriPathRouteInput.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo