Package com.mypurecloud.sdk.v2.model

Class ActionOutput

java.lang.Object
com.mypurecloud.sdk.v2.model.ActionOutput
All Implemented Interfaces:
Serializable
public class ActionOutput extends Object implements Serializable
Output definition of Action.
See Also:

  • Constructor Details

    • ActionOutput

      public ActionOutput()

    • ActionOutput

      public ActionOutput(Boolean initWithEmptyList)

  • Method Details

    • successSchema

      public ActionOutput successSchema(JsonSchemaDocument successSchema)
      JSON schema that defines the transformed, successful result that will be sent back to the caller. If the 'flatten' query parameter is omitted or false, this field will be returned. Either successSchema or successSchemaFlattened will be returned, not both.

    • getSuccessSchema

      public JsonSchemaDocument getSuccessSchema()

    • setSuccessSchema

      public void setSuccessSchema(JsonSchemaDocument successSchema)

    • successSchemaUri

      public ActionOutput successSchemaUri(String successSchemaUri)
      URI to retrieve success schema

    • getSuccessSchemaUri

      public String getSuccessSchemaUri()

    • setSuccessSchemaUri

      public void setSuccessSchemaUri(String successSchemaUri)

    • errorSchema

      public ActionOutput errorSchema(JsonSchemaDocument errorSchema)
      JSON schema that defines the body of response when request is not successful. If the 'flatten' query parameter is omitted or false, this field will be returned. Either errorSchema or errorSchemaFlattened will be returned, not both.

    • getErrorSchema

      public JsonSchemaDocument getErrorSchema()

    • setErrorSchema

      public void setErrorSchema(JsonSchemaDocument errorSchema)

    • errorSchemaUri

      public ActionOutput errorSchemaUri(String errorSchemaUri)
      URI to retrieve error schema

    • getErrorSchemaUri

      public String getErrorSchemaUri()

    • setErrorSchemaUri

      public void setErrorSchemaUri(String errorSchemaUri)

    • successSchemaFlattened

      public ActionOutput successSchemaFlattened(FlattenedJsonSchemaDocument successSchemaFlattened)
      JSON schema that defines the transformed, successful result that will be sent back to the caller. The schema is transformed based on Architect's flattened format. If the 'flatten' query parameter is supplied as true, this field will be returned. Either successSchema or successSchemaFlattened will be returned, not both.

    • getSuccessSchemaFlattened

      public FlattenedJsonSchemaDocument getSuccessSchemaFlattened()

    • setSuccessSchemaFlattened

      public void setSuccessSchemaFlattened(FlattenedJsonSchemaDocument successSchemaFlattened)

    • errorSchemaFlattened

      public ActionOutput errorSchemaFlattened(FlattenedJsonSchemaDocument errorSchemaFlattened)
      JSON schema that defines the body of response when request is not successful. The schema is transformed based on Architect's flattened format. If the 'flatten' query parameter is supplied as true, this field will be returned. Either errorSchema or errorSchemaFlattened will be returned, not both.

    • getErrorSchemaFlattened

      public FlattenedJsonSchemaDocument getErrorSchemaFlattened()

    • setErrorSchemaFlattened

      public void setErrorSchemaFlattened(FlattenedJsonSchemaDocument errorSchemaFlattened)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object