Class CreateRouteResponseRequest

    • Method Detail

      • apiId

        public final String apiId()

        The API identifier.

        Returns:
        The API identifier.
      • modelSelectionExpression

        public final String modelSelectionExpression()

        The model selection expression for the route response. Supported only for WebSocket APIs.

        Returns:
        The model selection expression for the route response. Supported only for WebSocket APIs.
      • hasResponseModels

        public final boolean hasResponseModels()
        For responses, this returns true if the service returned a value for the ResponseModels 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.
      • responseModels

        public final Map<String,​String> responseModels()

        The response models for the route response.

        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 hasResponseModels() method.

        Returns:
        The response models for the route response.
      • hasResponseParameters

        public final boolean hasResponseParameters()
        For responses, this returns true if the service returned a value for the ResponseParameters 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.
      • responseParameters

        public final Map<String,​ParameterConstraints> responseParameters()

        The route response parameters.

        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 hasResponseParameters() method.

        Returns:
        The route response parameters.
      • routeId

        public final String routeId()

        The route ID.

        Returns:
        The route ID.
      • routeResponseKey

        public final String routeResponseKey()

        The route response key.

        Returns:
        The route response key.
      • 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