@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class GetRouteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
GetRouteResult() |
Modifier and Type | Method and Description |
---|---|
GetRouteResult |
addPathResourceToIdEntry(String key,
String value)
Add a single PathResourceToId entry
|
GetRouteResult |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
GetRouteResult |
clearPathResourceToIdEntries()
Removes all the entries added into PathResourceToId.
|
GetRouteResult |
clearTagsEntries()
Removes all the entries added into Tags.
|
GetRouteResult |
clone() |
boolean |
equals(Object obj) |
Boolean |
getAppendSourcePath()
If set to
true , this option appends the source path to the service URL endpoint. |
String |
getApplicationId()
The ID of the application that the route belongs to.
|
String |
getArn()
The Amazon Resource Name (ARN) of the route.
|
String |
getCreatedByAccountId()
The Amazon Web Services account ID of the route creator.
|
Date |
getCreatedTime()
The timestamp of when the route is created.
|
String |
getEnvironmentId()
Unique identifier of the environment.
|
ErrorResponse |
getError()
Any error associated with the route resource.
|
Boolean |
getIncludeChildPaths()
Indicates whether to match all subpaths of the given source path.
|
Date |
getLastUpdatedTime()
A timestamp that indicates when the route was last updated.
|
List<String> |
getMethods()
A list of HTTP methods to match.
|
String |
getOwnerAccountId()
The Amazon Web Services account ID of the route owner.
|
Map<String,String> |
getPathResourceToId()
A mapping of Amazon API Gateway path resources to resource IDs.
|
String |
getRouteId()
The unique identifier of the route.
|
String |
getRouteType()
The type of route.
|
String |
getServiceId()
The unique identifier of the service.
|
String |
getSourcePath()
This is the path that Refactor Spaces uses to match traffic.
|
String |
getState()
The current state of the route.
|
Map<String,String> |
getTags()
The tags assigned to the route.
|
int |
hashCode() |
Boolean |
isAppendSourcePath()
If set to
true , this option appends the source path to the service URL endpoint. |
Boolean |
isIncludeChildPaths()
Indicates whether to match all subpaths of the given source path.
|
void |
setAppendSourcePath(Boolean appendSourcePath)
If set to
true , this option appends the source path to the service URL endpoint. |
void |
setApplicationId(String applicationId)
The ID of the application that the route belongs to.
|
void |
setArn(String arn)
The Amazon Resource Name (ARN) of the route.
|
void |
setCreatedByAccountId(String createdByAccountId)
The Amazon Web Services account ID of the route creator.
|
void |
setCreatedTime(Date createdTime)
The timestamp of when the route is created.
|
void |
setEnvironmentId(String environmentId)
Unique identifier of the environment.
|
void |
setError(ErrorResponse error)
Any error associated with the route resource.
|
void |
setIncludeChildPaths(Boolean includeChildPaths)
Indicates whether to match all subpaths of the given source path.
|
void |
setLastUpdatedTime(Date lastUpdatedTime)
A timestamp that indicates when the route was last updated.
|
void |
setMethods(Collection<String> methods)
A list of HTTP methods to match.
|
void |
setOwnerAccountId(String ownerAccountId)
The Amazon Web Services account ID of the route owner.
|
void |
setPathResourceToId(Map<String,String> pathResourceToId)
A mapping of Amazon API Gateway path resources to resource IDs.
|
void |
setRouteId(String routeId)
The unique identifier of the route.
|
void |
setRouteType(String routeType)
The type of route.
|
void |
setServiceId(String serviceId)
The unique identifier of the service.
|
void |
setSourcePath(String sourcePath)
This is the path that Refactor Spaces uses to match traffic.
|
void |
setState(String state)
The current state of the route.
|
void |
setTags(Map<String,String> tags)
The tags assigned to the route.
|
String |
toString()
Returns a string representation of this object.
|
GetRouteResult |
withAppendSourcePath(Boolean appendSourcePath)
If set to
true , this option appends the source path to the service URL endpoint. |
GetRouteResult |
withApplicationId(String applicationId)
The ID of the application that the route belongs to.
|
GetRouteResult |
withArn(String arn)
The Amazon Resource Name (ARN) of the route.
|
GetRouteResult |
withCreatedByAccountId(String createdByAccountId)
The Amazon Web Services account ID of the route creator.
|
GetRouteResult |
withCreatedTime(Date createdTime)
The timestamp of when the route is created.
|
GetRouteResult |
withEnvironmentId(String environmentId)
Unique identifier of the environment.
|
GetRouteResult |
withError(ErrorResponse error)
Any error associated with the route resource.
|
GetRouteResult |
withIncludeChildPaths(Boolean includeChildPaths)
Indicates whether to match all subpaths of the given source path.
|
GetRouteResult |
withLastUpdatedTime(Date lastUpdatedTime)
A timestamp that indicates when the route was last updated.
|
GetRouteResult |
withMethods(Collection<String> methods)
A list of HTTP methods to match.
|
GetRouteResult |
withMethods(HttpMethod... methods)
A list of HTTP methods to match.
|
GetRouteResult |
withMethods(String... methods)
A list of HTTP methods to match.
|
GetRouteResult |
withOwnerAccountId(String ownerAccountId)
The Amazon Web Services account ID of the route owner.
|
GetRouteResult |
withPathResourceToId(Map<String,String> pathResourceToId)
A mapping of Amazon API Gateway path resources to resource IDs.
|
GetRouteResult |
withRouteId(String routeId)
The unique identifier of the route.
|
GetRouteResult |
withRouteType(RouteType routeType)
The type of route.
|
GetRouteResult |
withRouteType(String routeType)
The type of route.
|
GetRouteResult |
withServiceId(String serviceId)
The unique identifier of the service.
|
GetRouteResult |
withSourcePath(String sourcePath)
This is the path that Refactor Spaces uses to match traffic.
|
GetRouteResult |
withState(RouteState state)
The current state of the route.
|
GetRouteResult |
withState(String state)
The current state of the route.
|
GetRouteResult |
withTags(Map<String,String> tags)
The tags assigned to the route.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setAppendSourcePath(Boolean appendSourcePath)
If set to true
, this option appends the source path to the service URL endpoint.
appendSourcePath
- If set to true
, this option appends the source path to the service URL endpoint.public Boolean getAppendSourcePath()
If set to true
, this option appends the source path to the service URL endpoint.
true
, this option appends the source path to the service URL endpoint.public GetRouteResult withAppendSourcePath(Boolean appendSourcePath)
If set to true
, this option appends the source path to the service URL endpoint.
appendSourcePath
- If set to true
, this option appends the source path to the service URL endpoint.public Boolean isAppendSourcePath()
If set to true
, this option appends the source path to the service URL endpoint.
true
, this option appends the source path to the service URL endpoint.public void setApplicationId(String applicationId)
The ID of the application that the route belongs to.
applicationId
- The ID of the application that the route belongs to.public String getApplicationId()
The ID of the application that the route belongs to.
public GetRouteResult withApplicationId(String applicationId)
The ID of the application that the route belongs to.
applicationId
- The ID of the application that the route belongs to.public void setArn(String arn)
The Amazon Resource Name (ARN) of the route.
arn
- The Amazon Resource Name (ARN) of the route.public String getArn()
The Amazon Resource Name (ARN) of the route.
public GetRouteResult withArn(String arn)
The Amazon Resource Name (ARN) of the route.
arn
- The Amazon Resource Name (ARN) of the route.public void setCreatedByAccountId(String createdByAccountId)
The Amazon Web Services account ID of the route creator.
createdByAccountId
- The Amazon Web Services account ID of the route creator.public String getCreatedByAccountId()
The Amazon Web Services account ID of the route creator.
public GetRouteResult withCreatedByAccountId(String createdByAccountId)
The Amazon Web Services account ID of the route creator.
createdByAccountId
- The Amazon Web Services account ID of the route creator.public void setCreatedTime(Date createdTime)
The timestamp of when the route is created.
createdTime
- The timestamp of when the route is created.public Date getCreatedTime()
The timestamp of when the route is created.
public GetRouteResult withCreatedTime(Date createdTime)
The timestamp of when the route is created.
createdTime
- The timestamp of when the route is created.public void setEnvironmentId(String environmentId)
Unique identifier of the environment.
environmentId
- Unique identifier of the environment.public String getEnvironmentId()
Unique identifier of the environment.
public GetRouteResult withEnvironmentId(String environmentId)
Unique identifier of the environment.
environmentId
- Unique identifier of the environment.public void setError(ErrorResponse error)
Any error associated with the route resource.
error
- Any error associated with the route resource.public ErrorResponse getError()
Any error associated with the route resource.
public GetRouteResult withError(ErrorResponse error)
Any error associated with the route resource.
error
- Any error associated with the route resource.public void setIncludeChildPaths(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.
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.public Boolean getIncludeChildPaths()
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.
false
,
requests must match the source path exactly before they are forwarded to this route's service.public GetRouteResult withIncludeChildPaths(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.
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.public Boolean isIncludeChildPaths()
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.
false
,
requests must match the source path exactly before they are forwarded to this route's service.public void setLastUpdatedTime(Date lastUpdatedTime)
A timestamp that indicates when the route was last updated.
lastUpdatedTime
- A timestamp that indicates when the route was last updated.public Date getLastUpdatedTime()
A timestamp that indicates when the route was last updated.
public GetRouteResult withLastUpdatedTime(Date lastUpdatedTime)
A timestamp that indicates when the route was last updated.
lastUpdatedTime
- A timestamp that indicates when the route was last updated.public List<String> getMethods()
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.
HttpMethod
public void setMethods(Collection<String> 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.
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.HttpMethod
public GetRouteResult withMethods(String... 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.
NOTE: This method appends the values to the existing list (if any). Use
setMethods(java.util.Collection)
or withMethods(java.util.Collection)
if you want to override
the existing values.
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.HttpMethod
public GetRouteResult withMethods(Collection<String> 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.
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.HttpMethod
public GetRouteResult withMethods(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.
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.HttpMethod
public void setOwnerAccountId(String ownerAccountId)
The Amazon Web Services account ID of the route owner.
ownerAccountId
- The Amazon Web Services account ID of the route owner.public String getOwnerAccountId()
The Amazon Web Services account ID of the route owner.
public GetRouteResult withOwnerAccountId(String ownerAccountId)
The Amazon Web Services account ID of the route owner.
ownerAccountId
- The Amazon Web Services account ID of the route owner.public Map<String,String> getPathResourceToId()
A mapping of Amazon API Gateway path resources to resource IDs.
public void setPathResourceToId(Map<String,String> pathResourceToId)
A mapping of Amazon API Gateway path resources to resource IDs.
pathResourceToId
- A mapping of Amazon API Gateway path resources to resource IDs.public GetRouteResult withPathResourceToId(Map<String,String> pathResourceToId)
A mapping of Amazon API Gateway path resources to resource IDs.
pathResourceToId
- A mapping of Amazon API Gateway path resources to resource IDs.public GetRouteResult addPathResourceToIdEntry(String key, String value)
public GetRouteResult clearPathResourceToIdEntries()
public void setRouteId(String 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.
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.
public String getRouteId()
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.
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.
public GetRouteResult withRouteId(String 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.
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.
public void setRouteType(String routeType)
The type of route.
routeType
- The type of route.RouteType
public String getRouteType()
The type of route.
RouteType
public GetRouteResult withRouteType(String routeType)
The type of route.
routeType
- The type of route.RouteType
public GetRouteResult withRouteType(RouteType routeType)
The type of route.
routeType
- The type of route.RouteType
public void setServiceId(String serviceId)
The unique identifier of the service.
serviceId
- The unique identifier of the service.public String getServiceId()
The unique identifier of the service.
public GetRouteResult withServiceId(String serviceId)
The unique identifier of the service.
serviceId
- The unique identifier of the service.public void setSourcePath(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'.
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'.public String getSourcePath()
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'.
/
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'.public GetRouteResult withSourcePath(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'.
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'.public void setState(String state)
The current state of the route.
state
- The current state of the route.RouteState
public String getState()
The current state of the route.
RouteState
public GetRouteResult withState(String state)
The current state of the route.
state
- The current state of the route.RouteState
public GetRouteResult withState(RouteState state)
The current state of the route.
state
- The current state of the route.RouteState
public Map<String,String> getTags()
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.
public void setTags(Map<String,String> 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.
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.public GetRouteResult withTags(Map<String,String> 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.
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.public GetRouteResult addTagsEntry(String key, String value)
public GetRouteResult clearTagsEntries()
public String toString()
toString
in class Object
Object.toString()
public GetRouteResult clone()