Class GetRouteResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.migrationhubrefactorspaces.model.MigrationHubRefactorSpacesResponse
software.amazon.awssdk.services.migrationhubrefactorspaces.model.GetRouteResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetRouteResponse.Builder,GetRouteResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetRouteResponse extends MigrationHubRefactorSpacesResponse implements ToCopyableBuilder<GetRouteResponse.Builder,GetRouteResponse>

  • Method Details

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

    • applicationId

      public final String applicationId()

      The ID of the application that the route belongs to.

      Returns:
      The ID of the application that the route belongs to.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the route.

      Returns:
      The Amazon Resource Name (ARN) of the route.

    • createdByAccountId

      public final String createdByAccountId()

      The Amazon Web Services account ID of the route creator.

      Returns:
      The Amazon Web Services account ID of the route creator.

    • createdTime

      public final Instant createdTime()

      The timestamp of when the route is created.

      Returns:
      The timestamp of when the route is created.

    • environmentId

      public final String environmentId()

      Unique identifier of the environment.

      Returns:
      Unique identifier of the environment.

    • error

      public final ErrorResponse error()

      Any error associated with the route resource.

      Returns:
      Any error associated with the route resource.

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

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      A timestamp that indicates when the route was last updated.

      Returns:
      A timestamp that indicates when the route was last updated.

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

    • ownerAccountId

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

    • pathResourceToId

      public final Map<String,String> 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

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

      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

      public final RouteType routeType()

      The type of route.

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

      Returns:
      The type of route.
      See Also:

    • routeTypeAsString

      public final String routeTypeAsString()

      The type of route.

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

      Returns:
      The type of route.
      See Also:

    • serviceId

      public final String serviceId()

      The unique identifier of the service.

      Returns:
      The unique identifier of the 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'.

    • state

      public final RouteState 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 return RouteState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The current state of the route.
      See Also:

    • stateAsString

      public final String 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 return RouteState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

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

    • tags

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

      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

      public GetRouteResponse.Builder 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 interface ToCopyableBuilder<GetRouteResponse.Builder,GetRouteResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetRouteResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.