Class GetRouteResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetRouteResponse.Builder,
GetRouteResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
If set totrue
, this option appends the source path to the service URL endpoint.final String
The ID of the application that the route belongs to.final String
arn()
The Amazon Resource Name (ARN) of the route.static GetRouteResponse.Builder
builder()
final String
The Amazon Web Services account ID of the route creator.final Instant
The timestamp of when the route is created.final String
Unique identifier of the environment.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final ErrorResponse
error()
Any error associated with the route resource.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Methods property.final boolean
For responses, this returns true if the service returned a value for the PathResourceToId property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Boolean
Indicates whether to match all subpaths of the given source path.final Instant
A timestamp that indicates when the route was last updated.final List
<HttpMethod> methods()
A list of HTTP methods to match.A list of HTTP methods to match.final String
The Amazon Web Services account ID of the route owner.A mapping of Amazon API Gateway path resources to resource IDs.final String
routeId()
The unique identifier of the route.final RouteType
The type of route.final String
The type of route.static Class
<? extends GetRouteResponse.Builder> final String
The unique identifier of the service.final String
This is the path that Refactor Spaces uses to match traffic.final RouteState
state()
The current state of the route.final String
The current state of the route.tags()
The tags assigned to the route.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 class software.amazon.awssdk.services.migrationhubrefactorspaces.model.MigrationHubRefactorSpacesResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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.
-
applicationId
The ID of the application that the route belongs to.
- Returns:
- The ID of the application that the route belongs to.
-
arn
The Amazon Resource Name (ARN) of the route.
- Returns:
- The Amazon Resource Name (ARN) of the route.
-
createdByAccountId
The Amazon Web Services account ID of the route creator.
- Returns:
- The Amazon Web Services account ID of the route creator.
-
createdTime
The timestamp of when the route is created.
- Returns:
- The timestamp of when the route is created.
-
environmentId
Unique identifier of the environment.
- Returns:
- Unique identifier of the environment.
-
error
Any error associated with the route resource.
- Returns:
- Any error associated with the route resource.
-
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.
-
lastUpdatedTime
A timestamp that indicates when the route was last updated.
- Returns:
- A timestamp that indicates when the route was last updated.
-
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.
-
ownerAccountId
The Amazon Web Services account ID of the route owner.
- Returns:
- The Amazon Web Services account ID of the route owner.
-
hasPathResourceToId
public final boolean hasPathResourceToId()For responses, this returns true if the service returned a value for the PathResourceToId 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. -
pathResourceToId
A mapping of Amazon API Gateway path resources to resource IDs.
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
hasPathResourceToId()
method.- Returns:
- A mapping of Amazon API Gateway path resources to resource IDs.
-
routeId
The unique identifier of the route.
DEFAULT: 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: A route that is based on a URI path.
- Returns:
- The unique identifier of the route.
DEFAULT: 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: A route that is based on a URI path.
-
routeType
The type of route.
If the service returns an enum value that is not available in the current SDK version,
routeType
will returnRouteType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrouteTypeAsString()
.- Returns:
- The type of route.
- See Also:
-
routeTypeAsString
The type of route.
If the service returns an enum value that is not available in the current SDK version,
routeType
will returnRouteType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrouteTypeAsString()
.- Returns:
- The type of route.
- See Also:
-
serviceId
The unique identifier of the service.
- Returns:
- The unique identifier of the 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'.
-
state
The current state of the route.
If the service returns an enum value that is not available in the current SDK version,
state
will returnRouteState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the route.
- See Also:
-
stateAsString
The current state of the route.
If the service returns an enum value that is not available in the current SDK version,
state
will returnRouteState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the route.
- See Also:
-
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 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. -
tags
The tags assigned 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 assigned 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.
-
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<GetRouteResponse.Builder,
GetRouteResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-