@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class RouteSummary extends Object implements Serializable, Cloneable, StructuredPojo
The summary information for the routes as a response to ListRoutes
.
Constructor and Description |
---|
RouteSummary() |
Modifier and Type | Method and Description |
---|---|
RouteSummary |
addPathResourceToIdEntry(String key,
String value)
Add a single PathResourceToId entry
|
RouteSummary |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
RouteSummary |
clearPathResourceToIdEntries()
Removes all the entries added into PathResourceToId.
|
RouteSummary |
clearTagsEntries()
Removes all the entries added into Tags.
|
RouteSummary |
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 unique identifier of the application.
|
String |
getArn()
The Amazon Resource Name (ARN) of the route.
|
String |
getCreatedByAccountId()
The Amazon Web Services account ID of the route creator.
|
Date |
getCreatedTime()
A timestamp that indicates when the route is created.
|
String |
getEnvironmentId()
The 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 route type of the 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 |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAppendSourcePath(Boolean appendSourcePath)
If set to
true , this option appends the source path to the service URL endpoint. |
void |
setApplicationId(String applicationId)
The unique identifier of the application.
|
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)
A timestamp that indicates when the route is created.
|
void |
setEnvironmentId(String environmentId)
The 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 route type of the 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.
|
RouteSummary |
withAppendSourcePath(Boolean appendSourcePath)
If set to
true , this option appends the source path to the service URL endpoint. |
RouteSummary |
withApplicationId(String applicationId)
The unique identifier of the application.
|
RouteSummary |
withArn(String arn)
The Amazon Resource Name (ARN) of the route.
|
RouteSummary |
withCreatedByAccountId(String createdByAccountId)
The Amazon Web Services account ID of the route creator.
|
RouteSummary |
withCreatedTime(Date createdTime)
A timestamp that indicates when the route is created.
|
RouteSummary |
withEnvironmentId(String environmentId)
The unique identifier of the environment.
|
RouteSummary |
withError(ErrorResponse error)
Any error associated with the route resource.
|
RouteSummary |
withIncludeChildPaths(Boolean includeChildPaths)
Indicates whether to match all subpaths of the given source path.
|
RouteSummary |
withLastUpdatedTime(Date lastUpdatedTime)
A timestamp that indicates when the route was last updated.
|
RouteSummary |
withMethods(Collection<String> methods)
A list of HTTP methods to match.
|
RouteSummary |
withMethods(HttpMethod... methods)
A list of HTTP methods to match.
|
RouteSummary |
withMethods(String... methods)
A list of HTTP methods to match.
|
RouteSummary |
withOwnerAccountId(String ownerAccountId)
The Amazon Web Services account ID of the route owner.
|
RouteSummary |
withPathResourceToId(Map<String,String> pathResourceToId)
A mapping of Amazon API Gateway path resources to resource IDs.
|
RouteSummary |
withRouteId(String routeId)
The unique identifier of the route.
|
RouteSummary |
withRouteType(RouteType routeType)
The route type of the route.
|
RouteSummary |
withRouteType(String routeType)
The route type of the route.
|
RouteSummary |
withServiceId(String serviceId)
The unique identifier of the service.
|
RouteSummary |
withSourcePath(String sourcePath)
This is the path that Refactor Spaces uses to match traffic.
|
RouteSummary |
withState(RouteState state)
The current state of the route.
|
RouteSummary |
withState(String state)
The current state of the route.
|
RouteSummary |
withTags(Map<String,String> tags)
The tags assigned to the route.
|
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 RouteSummary 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 unique identifier of the application.
applicationId
- The unique identifier of the application.public String getApplicationId()
The unique identifier of the application.
public RouteSummary withApplicationId(String applicationId)
The unique identifier of the application.
applicationId
- The unique identifier of the application.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 RouteSummary 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 RouteSummary 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)
A timestamp that indicates when the route is created.
createdTime
- A timestamp that indicates when the route is created.public Date getCreatedTime()
A timestamp that indicates when the route is created.
public RouteSummary withCreatedTime(Date createdTime)
A timestamp that indicates when the route is created.
createdTime
- A timestamp that indicates when the route is created.public void setEnvironmentId(String environmentId)
The unique identifier of the environment.
environmentId
- The unique identifier of the environment.public String getEnvironmentId()
The unique identifier of the environment.
public RouteSummary withEnvironmentId(String environmentId)
The unique identifier of the environment.
environmentId
- The 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 RouteSummary 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 RouteSummary 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 RouteSummary 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 RouteSummary 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 RouteSummary 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 RouteSummary 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 RouteSummary 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 RouteSummary 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 RouteSummary addPathResourceToIdEntry(String key, String value)
public RouteSummary clearPathResourceToIdEntries()
public void setRouteId(String routeId)
The unique identifier of the route.
routeId
- The unique identifier of the route.public String getRouteId()
The unique identifier of the route.
public RouteSummary withRouteId(String routeId)
The unique identifier of the route.
routeId
- The unique identifier of the route.public void setRouteType(String routeType)
The route type of the route.
routeType
- The route type of the route.RouteType
public String getRouteType()
The route type of the route.
RouteType
public RouteSummary withRouteType(String routeType)
The route type of the route.
routeType
- The route type of the route.RouteType
public RouteSummary withRouteType(RouteType routeType)
The route type of the route.
routeType
- The route type of the 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 RouteSummary 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 RouteSummary 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 RouteSummary withState(String state)
The current state of the route.
state
- The current state of the route.RouteState
public RouteSummary 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.
public void setTags(Map<String,String> tags)
The tags assigned to the route.
tags
- The tags assigned to the route.public RouteSummary withTags(Map<String,String> tags)
The tags assigned to the route.
tags
- The tags assigned to the route.public RouteSummary addTagsEntry(String key, String value)
public RouteSummary clearTagsEntries()
public String toString()
toString
in class Object
Object.toString()
public RouteSummary clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.