Class UriPathRouteInput
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<UriPathRouteInput.Builder,
UriPathRouteInput>
The configuration for the URI path route type.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal RouteActivationState
If set toACTIVE
, traffic is forwarded to this route’s service after the route is created.final String
If set toACTIVE
, traffic is forwarded to this route’s service after the route is created.final Boolean
If set totrue
, this option appends the source path to the service URL endpoint.static UriPathRouteInput.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Methods property.final Boolean
Indicates whether to match all subpaths of the given source path.final List
<HttpMethod> methods()
A list of HTTP methods to match.A list of HTTP methods to match.static Class
<? extends UriPathRouteInput.Builder> final String
This is the path that Refactor Spaces uses to match traffic.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnRouteActivationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactivationStateAsString()
.- Returns:
- If set to
ACTIVE
, traffic is forwarded to this route’s service after the route is created. - See Also:
-
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 returnRouteActivationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactivationStateAsString()
.- Returns:
- If set to
ACTIVE
, traffic is forwarded to this route’s service after the route is created. - See Also:
-
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
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
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 theisEmpty()
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
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<UriPathRouteInput.Builder,
UriPathRouteInput> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-