Index (jpostman 1.0.4-be9158c5 API)

A B C D E F G H I J L M N O P R S T U V W X
All Classes and Interfaces|All Packages|Serialized Form

A

add(Property) - Method in class com.postman.collection.PropertyList
addAll(int, PropertyList<Property>) - Method in class com.postman.collection.PropertyList
addAll(PropertyList<Property>) - Method in class com.postman.collection.PropertyList
addCollection(Collection) - Method in class com.postman.collection.Collection: Add another collection and it's array of item, variable, and event arrays to this collection in a new Folder.
addCollection(Collection, boolean, boolean) - Method in class com.postman.collection.Collection: Add another collection and it's array of item, optionally variable, and optionally event arrays to this collection as children of a new Folder child item of this collection.
addCollection(Collection, ItemGroup) - Method in class com.postman.collection.Collection: Add another collection and it's array of item, variable, and event arrays to this collection as children of parent
addCollection(Collection, ItemGroup, boolean, boolean) - Method in class com.postman.collection.Collection: Add another collection and it's array of item, optionally variable, and optionally event arrays to this collection as children of the specified parent.
addFolder(String) - Method in class com.postman.collection.Collection: Convenience method to add an item with no child items to this collection.
addFolder(String, int) - Method in class com.postman.collection.Collection: Convenience method to add an item with no child items to this collection.
addItem(Item) - Method in class com.postman.collection.ItemGroup: Append a new direct child item to the array of items in the item property.
addItem(Item, int) - Method in class com.postman.collection.ItemGroup: Add a new direct child item to the array of items in the item property at the specified index.
addItems(ArrayList<Item>) - Method in class com.postman.collection.ItemGroup: Add multiple items to this item.
addPathVariable(Property) - Method in class com.postman.collection.Url
addPathVariable(String, String, String) - Method in class com.postman.collection.Url: Add a variable to the array of query elements
addProperty(Property) - Method in class com.postman.collection.RequestAuth: Add a new property, or replace an existing property
addProperty(String, String) - Method in class com.postman.collection.RequestAuth: Convenience method create and then add a new property to this auth object
addQuery(String) - Method in class com.postman.collection.Url: Populate the elements of the query array with an http query string.
addQuery(String, String) - Method in class com.postman.collection.Url: Add an element to the query array using raw string values.
addQuery(String, String, String) - Method in class com.postman.collection.Url: Add an element to the query array using raw String values, with a description property
addRequest(RequestBody, String) - Method in class com.postman.collection.Collection: Convenience method to add a new request item as a top level child item of this collection
addRequest(RequestBody, String, int) - Method in class com.postman.collection.Collection: Add a new request to this collection at the specified position in the array of request elements
addRequest(RequestBody, String, Response) - Method in class com.postman.collection.Collection: Create and add a new request as a top level child item of this collection.
addRequest(RequestBody, String, ArrayList<Response>) - Method in class com.postman.collection.Collection: Convenience method to add a request with a pre-constructed ArrayList<Response> of response items.
addRequest(String) - Method in class com.postman.collection.Collection: Create and add a new request as a top level child item of this collection.
addResponse(Response) - Method in class com.postman.collection.Request: Add a Response object to the response array
addResponse(String, Response) - Method in class com.postman.collection.Request: Add a response object to the request contained by this collection specified by requestKey
addSourceCodeElement(String, int) - Method in class com.postman.collection.Event: Pre-pend source code to the end of the exec property array.
addSourceCodeElement(String, int) - Method in class com.postman.collection.Event.PostmanScript
addVariable(Property) - Method in class com.postman.collection.Collection: Add or replace variable to the collection of variables comprising this collections variable array property.
addVariables(PropertyList<Property>) - Method in class com.postman.collection.Collection
AKAMAI - Enum constant in enum class com.postman.collection.enumAuthType
APIKEY - Enum constant in enum class com.postman.collection.enumAuthType
AuthDeserializer - Class in com.postman.collection.adapter: Custom deserializer for the auth property object.
AuthDeserializer() - Constructor for class com.postman.collection.adapter.AuthDeserializer
AuthSerializer - Class in com.postman.collection.adapter: Custom serializer for the auth element.
AuthSerializer() - Constructor for class com.postman.collection.adapter.AuthSerializer
AWS - Enum constant in enum class com.postman.collection.enumAuthType

B

BASIC - Enum constant in enum class com.postman.collection.enumAuthType
BEARER - Enum constant in enum class com.postman.collection.enumAuthType
BodyElement - Class in com.postman.collection: Encapsulates the body property of a Request object.
BodyElement(enumRequestBodyMode) - Constructor for class com.postman.collection.BodyElement: Convenience constructor, creates an empty body object of the specified mode
BodyElement(enumRequestBodyMode, String, enumRawBodyLanguage) - Constructor for class com.postman.collection.BodyElement: Constructs a body with the provided mode, content, and language.

C

Collection - Class in com.postman.collection: Encapsulates a Postman collection
Collection(String) - Constructor for class com.postman.collection.Collection: Construct a new, empty collection with the specified name
CollectionElement - Class in com.postman.collection: Abstract Base Class for all objects which are part of a collection
CollectionElement() - Constructor for class com.postman.collection.CollectionElement
CollectionNotFoundException - Exception Class in com.postman.collection: Thrown when a collection is not found in Postman, or if a 404 is thrown attempting to retrieve a collection from Postman by URI
CollectionNotFoundException(String) - Constructor for exception class com.postman.collection.CollectionNotFoundException: Default constructor
CollectionSerializer - Class in com.postman.collection.adapter: Custom serializer for the collection element.
CollectionSerializer() - Constructor for class com.postman.collection.adapter.CollectionSerializer
com.postman.collection - package com.postman.collection: Encapsulates a Postman JSON collection and emulates functionality of the Postman SDK.
com.postman.collection.adapter - package com.postman.collection.adapter
contains(Property) - Method in class com.postman.collection.PropertyList
containsKey(String) - Method in class com.postman.collection.PropertyList
Cookie - Class in com.postman.collection: Encapsulates the cookie property of a Postman Collection.
Cookie() - Constructor for class com.postman.collection.Cookie
COPY - Enum constant in enum class com.postman.collection.enumHTTPRequestMethod

D

DELETE - Enum constant in enum class com.postman.collection.enumHTTPRequestMethod
deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class com.postman.collection.adapter.AuthDeserializer: Custom GSON deserializer for the RequestAuth object.
deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class com.postman.collection.adapter.ItemDeserializer: Deserialize a Item
deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class com.postman.collection.adapter.ItemGroupDeserializer: Deserialize a ItemGroup from the item propertyList
deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class com.postman.collection.adapter.PropertyDeserializer: Custom GSON deserializer for the RequestAuth object.
DIGEST - Enum constant in enum class com.postman.collection.enumAuthType
DuplicateVariableKeyException - Exception Class in com.postman.collection: Exception thrown when an attempt is made to add a Property to a PropertyList with a duplicate key
DuplicateVariableKeyException(String) - Constructor for exception class com.postman.collection.DuplicateVariableKeyException: Constructs the exception

E

enumAuthType - Enum Class in com.postman.collection: Enumerates valid values for the type property of the auth element of a collection or request.
enumEventType - Enum Class in com.postman.collection: Enumerates the valid values for the listen property of an Event element.
enumHTTPRequestMethod - Enum Class in com.postman.collection: Enumerates valid HTTP methods, e.g, for the method property of a RequestBody element
enumItemType - Enum Class in com.postman.collection: Enumerates the two types of objects that can serve as an element in a collections item array.
enumRawBodyLanguage - Enum Class in com.postman.collection: Enumerates valid values for the value of the options/raw/language property of a RequestBody object when that body's mode property is set to raw
enumRequestBodyMode - Enum Class in com.postman.collection: Enumeration listing the possible values for the name of the property containing body data in a Request
enumVariableResolution - Enum Class in com.postman.collection: Enumeration listing variable resolution strategies
equals(Object) - Method in class com.postman.collection.Property
Event - Class in com.postman.collection: Encapsulates members of the event array object.
Event(enumEventType, String) - Constructor for class com.postman.collection.Event: Create a new Event object with the specified EventType (eg., pre-request or test) and source code.
Event.PostmanScript - Class in com.postman.collection

F

FILE - Enum constant in enum class com.postman.collection.enumRequestBodyMode
Folder - Class in com.postman.collection: Convenience class for the concept of a Folder in a Postman Collection.
Folder(String) - Constructor for class com.postman.collection.Folder
FOLDER - Enum constant in enum class com.postman.collection.enumItemType
FORMDATA - Enum constant in enum class com.postman.collection.enumRequestBodyMode

G

generateURL() - Method in class com.postman.collection.Url: Generate the raw URL from the component properties of this Url.
get(int) - Method in class com.postman.collection.PropertyList
get(String) - Method in class com.postman.collection.PropertyList: Get a variable whose key matches key, or null if it is not present
GET - Enum constant in enum class com.postman.collection.enumHTTPRequestMethod
getAuth() - Method in class com.postman.collection.Collection: Return the values in the auth object property of this collection, or null if it has not been set.
getAuth() - Method in class com.postman.collection.RequestBody: Get the RequestAuth object containing the values of the auth array, or null if it has not been set.
getAuthType() - Method in class com.postman.collection.RequestAuth: Get the value of the type property of this authentication object.
getAuthTypeAsString() - Method in class com.postman.collection.RequestAuth: Convenience method to return the type property of this auth object as a String
getBody() - Method in class com.postman.collection.RequestBody: Return the PostmanBody object containing the values in the body property object, or null if it has not been set.
getBody() - Method in class com.postman.collection.Response: Get the value of the body property of the response, or null if not set.
getCode() - Method in class com.postman.collection.Response: Get the value of the code property, the HTML status code associated with this response.
getCollection() - Method in class com.postman.collection.CollectionElement: Traverse the chain of parent elements upwards until a Collection is reached, or null if this element is not part of a collection.
getCookies() - Method in class com.postman.collection.Response: Return an ArrayList containing the Cookie objects comprising the value of the cookie array property
getDefaultCollectionSchema() - Static method in class com.postman.collection.CollectionElement: Return the default schema appearing in the schema property in exported collections.
getDefaultValidationSchema() - Static method in class com.postman.collection.CollectionElement: Return the default schema used to validate schemas.
getDescription() - Method in class com.postman.collection.Collection
getDescription() - Method in class com.postman.collection.Item: Return the value of the description property
getDescription() - Method in class com.postman.collection.Property: Returns the description property, or null if it is not set
getDescription() - Method in class com.postman.collection.RequestBody: Get the value of the description property, generally the documentation for the request
getDomain() - Method in class com.postman.collection.Cookie
getEvent(enumEventType) - Method in class com.postman.collection.Item: Get an event, specifying whether to return the pre-request script or test script associated with this item.
getEvents() - Method in class com.postman.collection.Item: Return the ArrayList<Event> containing the objects comprising the event array
getEventType() - Method in class com.postman.collection.Event: Returns the type of this script, eg., pre-request or test, as an enumerated value.
getExpires() - Method in class com.postman.collection.Cookie
getExtensions() - Method in class com.postman.collection.Cookie
getFile() - Method in class com.postman.collection.BodyElement: Returns the value of the file/src property, the path to the file
getFolder(String) - Method in class com.postman.collection.ItemGroup
getFormdata() - Method in class com.postman.collection.BodyElement: Returns an ArrayList<Property> containing formdata paramters:
getFormdata(int) - Method in class com.postman.collection.BodyElement: Returns a Property containing formdata property at the specified position in the array
getGraphql() - Method in class com.postman.collection.BodyElement: Return an HashMap<String, String> containing the GraphQL query and variables source code.
getHeader() - Method in class com.postman.collection.RequestBody: Return an ArrayList of Property objects containing the key-value pair values for the header property array
getHeader() - Method in class com.postman.collection.Response: Get the ArrayList containing the key-value paris in the header element array
getHosts() - Method in class com.postman.collection.Url: Return the array of elements in the host array.
getID() - Method in class com.postman.collection.PostmanID
getInfo() - Method in class com.postman.collection.Collection: Return a Map<String> containing the key-value pairs comprising the info object property of this collection.
getItem(String) - Method in class com.postman.collection.ItemGroup: Recursively search the contents of the item array for the item with the specified key.
getItem(String, enumItemType) - Method in class com.postman.collection.ItemGroup: Recursively search the contents of the item array for the item with the specified key, optionally returning the item or it's parent item.
getItems() - Method in class com.postman.collection.ItemGroup: Return an ArrayList<Item> containing the tree of items owned by this item.
getItems(enumItemType) - Method in class com.postman.collection.ItemGroup: Recursively search the entire tree of items in the item property, optionally filter by item type (eg.
getKey() - Method in class com.postman.collection.BodyElement
getKey() - Method in class com.postman.collection.Collection
getKey() - Method in class com.postman.collection.CollectionElement
getKey() - Method in class com.postman.collection.Cookie
getKey() - Method in class com.postman.collection.Event
getKey() - Method in class com.postman.collection.Event.PostmanScript
getKey() - Method in class com.postman.collection.Item
getKey() - Method in class com.postman.collection.Property: returns the value of the key property
getKey() - Method in class com.postman.collection.RequestAuth: Returns the key of this CollectionElement for use in retrieving from arrays, etc.
getKey() - Method in class com.postman.collection.RequestBody: Returns the value of the name property
getKey() - Method in class com.postman.collection.Response: Return the Key for this object.
getKey() - Method in class com.postman.collection.Url: Currently unimplemented
getMaxAge() - Method in class com.postman.collection.Cookie
getMethod() - Method in class com.postman.collection.RequestBody: Return the enumerated value of the method property
getMode() - Method in class com.postman.collection.BodyElement: Returns the mode property as an enumerated value
getName() - Method in class com.postman.collection.Collection
getName() - Method in class com.postman.collection.Cookie
getName() - Method in class com.postman.collection.Item
getName() - Method in class com.postman.collection.Response: Get the name of this response.
getOriginalRequest() - Method in class com.postman.collection.Response: Get the value of the originalRequest for this response as a RequestBody, or null if it has not been set.
getParent() - Method in class com.postman.collection.CollectionElement: Get the parent element, or null if it is not set.
getParent() - Method in class com.postman.collection.Item: Get the parent of this item, or null if one is not defined (eg.
getPath() - Method in class com.postman.collection.Cookie
getPaths() - Method in class com.postman.collection.Url: Returns the contents of the path element array
getPathVariable(String) - Method in class com.postman.collection.Url
getPathVariables() - Method in class com.postman.collection.Url: Get an ArrayList<Property> containing the key-value pairs comprising the variable array, or null if none exit.
getPort() - Method in class com.postman.collection.Url: Get the value of the port property
getPostmanID() - Method in class com.postman.collection.Collection: Return the _postman_id property of the info object property of this collection
getPostmanPreviewlanguage() - Method in class com.postman.collection.Response: Get the value of the _postman_previewlanguage property
getPreRequestScript() - Method in class com.postman.collection.Item
getProperties() - Method in class com.postman.collection.RequestAuth: Return the complete array of properties as a HashMap<String,Property>, or null if none are set.
getProperty(String) - Method in class com.postman.collection.RequestAuth: Retrieve a single element from the array of authentication elements comprising this authentication object.
getProtocol() - Method in class com.postman.collection.Url
getQueryElement(int) - Method in class com.postman.collection.Url
getQueryElement(String) - Method in class com.postman.collection.Url
getQueryElements() - Method in class com.postman.collection.Url: Return an ArrayList<Property> of key value pairs comprising the query array
getQueryString() - Method in class com.postman.collection.Url: Get the raw query string for this URL.
getRaw() - Method in class com.postman.collection.BodyElement: Returns the content of the raw property of the body, or null if it has not been set
getRaw() - Method in class com.postman.collection.Url: Returns the value of the raw property, or null if it has not been set.
getRawLanguage() - Method in class com.postman.collection.BodyElement: Returns the enumerated value of the language property of the options property
getRequest(String) - Method in class com.postman.collection.Collection: Return a request from this Collections item property, or null if it doesn't exist.
getRequest(String) - Method in class com.postman.collection.ItemGroup
getRequestBody() - Method in class com.postman.collection.Request: Return the object containing the values in the request property, or null if this item does not contain a request (e.g., is a folder);
getResponses() - Method in class com.postman.collection.Request: Return an ArrayList<Response> containing the values in the response property array, or null if none are defined.
getScriptType() - Method in class com.postman.collection.Event
getSourceCode() - Method in class com.postman.collection.Event: Get complete source for this script, or null if none is set.
getSourceCode() - Method in class com.postman.collection.Event.PostmanScript
getSourceCodeElement(int) - Method in class com.postman.collection.Event.PostmanScript
getSourceCodeElements() - Method in class com.postman.collection.Event
getStatus() - Method in class com.postman.collection.Response: Get the value of the status property for this response, the string associated with the code> property, eg.
getTestScript() - Method in class com.postman.collection.Item
getToken() - Method in class com.postman.collection.Property: Returns the Postman token for a variable, eg.
getType() - Method in class com.postman.collection.Event.PostmanScript
getType() - Method in class com.postman.collection.Property: Returns the type property for this variable
getUrl() - Method in class com.postman.collection.RequestBody: Return the Url containing the values of the url property array
getUrl(boolean) - Method in class com.postman.collection.RequestBody
getUrl(boolean) - Method in class com.postman.collection.Url
getUUID() - Method in class com.postman.collection.CollectionElement: Get a unique UUID for this element.
getValidationMessages() - Method in class com.postman.collection.CollectionElement: If an element is invalid, returns an ArrayList<ValidationMessage> containing one or more diff messages describing the differences.
getValue() - Method in class com.postman.collection.Cookie
getValue() - Method in class com.postman.collection.Property: Sets the value property for this property
getVariable(String) - Method in class com.postman.collection.Collection: Return the Property key-value pair from this collection's variable array element, or null if it is not present.
getVariables() - Method in class com.postman.collection.Collection: Get the ArrayList<Property> containing the key-value pairs comprising the variable array element of this collection
GRAPHQL - Enum constant in enum class com.postman.collection.enumRawBodyLanguage
GRAPHQL - Enum constant in enum class com.postman.collection.enumRequestBodyMode

H

hasItem(Item) - Method in class com.postman.collection.ItemGroup: Searches the direct children of this item (eg., non-recursively) to find an entry in the array that is the same Java instance as this item (Object.equals())
HAWK - Enum constant in enum class com.postman.collection.enumAuthType
HEAD - Enum constant in enum class com.postman.collection.enumHTTPRequestMethod
HTML - Enum constant in enum class com.postman.collection.enumRawBodyLanguage

I

IllegalPropertyAccessException - Exception Class in com.postman.collection: Exception thrown when an invalid action is taken against PropertyList, eg., IndexOutOfBounds, attempts to set the raw property of a BodyElement when that body's mode is not raw etc.
IllegalPropertyAccessException(String) - Constructor for exception class com.postman.collection.IllegalPropertyAccessException
indexOf(Property) - Method in class com.postman.collection.PropertyList
InvalidCollectionActionException - Exception Class in com.postman.collection: Exception thrown when an invalid action is attempted on a collection, eg.
InvalidCollectionActionException(String) - Constructor for exception class com.postman.collection.InvalidCollectionActionException
InvalidCollectionActionException(Throwable) - Constructor for exception class com.postman.collection.InvalidCollectionActionException
InvalidPropertyException - Exception Class in com.postman.collection: Exception thrown when an invalid action is taken against an object property, eg., an attempt to see an Event's exec property to null, etc.
InvalidPropertyException(String) - Constructor for exception class com.postman.collection.InvalidPropertyException
isEquivalentTo(CollectionElement) - Method in class com.postman.collection.CollectionElement: Determine whether 2 seperate instance of a JPostman class render semantically identical JSON.
isHostOnly() - Method in class com.postman.collection.Cookie
isHttpOnly() - Method in class com.postman.collection.Cookie
isSecure() - Method in class com.postman.collection.Cookie
isSession() - Method in class com.postman.collection.Cookie
Item - Class in com.postman.collection: Encapsulates the item object in the postman schema
Item() - Constructor for class com.postman.collection.Item
Item(String) - Constructor for class com.postman.collection.Item: * Construct an empty item with only a name>; property.
Item(String, ItemGroup) - Constructor for class com.postman.collection.Item: Construct an empty item with only a name property and assign it as a child of parent
ItemDeserializer - Class in com.postman.collection.adapter: Custom deserializer for writing out the Item class, the item propertyList
ItemDeserializer() - Constructor for class com.postman.collection.adapter.ItemDeserializer
ItemGroup - Class in com.postman.collection: Abstract class encapsulating a Postman ItemGroup.
ItemGroup(String) - Constructor for class com.postman.collection.ItemGroup
ItemGroupDeserializer - Class in com.postman.collection.adapter: Deserializes ItemGroup objects, the item propertyList in a collection
ItemGroupDeserializer() - Constructor for class com.postman.collection.adapter.ItemGroupDeserializer

J

JAVASCRIPT - Enum constant in enum class com.postman.collection.enumRawBodyLanguage
JSON - Enum constant in enum class com.postman.collection.enumRawBodyLanguage

L

LINK - Enum constant in enum class com.postman.collection.enumHTTPRequestMethod
LOCK - Enum constant in enum class com.postman.collection.enumHTTPRequestMethod

M

moveItem(Item, ItemGroup) - Method in class com.postman.collection.Collection: Move an item to a different parent item.
moveItem(String, String) - Method in class com.postman.collection.Collection: Moves an item in the array of items contained by this collection from one parent to another.

N

NONE - Enum constant in enum class com.postman.collection.enumVariableResolution
NTLM - Enum constant in enum class com.postman.collection.enumAuthType

O

OAUTH1 - Enum constant in enum class com.postman.collection.enumAuthType
OAUTH2 - Enum constant in enum class com.postman.collection.enumAuthType
OPTIONS - Enum constant in enum class com.postman.collection.enumHTTPRequestMethod

P

PATCH - Enum constant in enum class com.postman.collection.enumHTTPRequestMethod
pmcFactory() - Static method in class com.postman.collection.Collection: Static factory method to create the new collection.
pmcFactory(PostmanID) - Static method in class com.postman.collection.Collection
pmcFactory(File) - Static method in class com.postman.collection.Collection: Static factory method to create a new Collection from a Postman collection JSON file.
pmcFactory(String) - Static method in class com.postman.collection.Collection
pmcFactory(URL) - Static method in class com.postman.collection.Collection: Create a collection via the Postman API
POST - Enum constant in enum class com.postman.collection.enumHTTPRequestMethod
PostmanID - Class in com.postman.collection: Convenience class to enable TypeSafe references to Postman UUIDs.
PostmanID(String) - Constructor for class com.postman.collection.PostmanID
PostmanScript(String, String) - Constructor for class com.postman.collection.Event.PostmanScript
PostmanScript(String, ArrayList<String>) - Constructor for class com.postman.collection.Event.PostmanScript
PRE_REQUEST - Enum constant in enum class com.postman.collection.enumEventType
Property - Class in com.postman.collection: Postman SDK analog: Not directly related, but probably close to PropertyBase
Property(String, String) - Constructor for class com.postman.collection.Property: Constructs a Property with with just key and value properties
Property(String, String, String) - Constructor for class com.postman.collection.Property: Constructs a Property with the specified properties.
Property(String, String, String, String) - Constructor for class com.postman.collection.Property: Constructs a Property with all specified properties.
PropertyDeserializer - Class in com.postman.collection.adapter
PropertyDeserializer() - Constructor for class com.postman.collection.adapter.PropertyDeserializer
PropertyList<T> - Class in com.postman.collection: Postman SDK analog: PropertyList
PropertyList() - Constructor for class com.postman.collection.PropertyList: Returns an empty PropertyList
PropertyList(ArrayList<Property>) - Constructor for class com.postman.collection.PropertyList: Returns a PropertyList populated with the contents of vars
PropertyListSerializer - Class in com.postman.collection.adapter
PropertyListSerializer() - Constructor for class com.postman.collection.adapter.PropertyListSerializer
PropertySerializer - Class in com.postman.collection.adapter
PropertySerializer() - Constructor for class com.postman.collection.adapter.PropertySerializer
PROPFIND - Enum constant in enum class com.postman.collection.enumHTTPRequestMethod
PURGE - Enum constant in enum class com.postman.collection.enumHTTPRequestMethod
PUT - Enum constant in enum class com.postman.collection.enumHTTPRequestMethod

R

RAW - Enum constant in enum class com.postman.collection.enumRequestBodyMode
RecursiveItemAddException - Exception Class in com.postman.collection: Exception thrown if there is an attempt to add an item as a child to itself.
RecursiveItemAddException(String) - Constructor for exception class com.postman.collection.RecursiveItemAddException
remove(String) - Method in class com.postman.collection.PropertyList
removeFormData(int) - Method in class com.postman.collection.BodyElement: Removes the formdata element at the specified position in the formdata array
removeFormData(Property) - Method in class com.postman.collection.BodyElement: Removes the formdata element at the specified position in the formdata array
removeItem(Item) - Method in class com.postman.collection.ItemGroup: Removes an item from the tree of items comprising the item property
removeItem(String) - Method in class com.postman.collection.ItemGroup: Removes an item with the specified key from the tree of items comprising the item property
removePathVariable(String) - Method in class com.postman.collection.Url
removeQueryElement(Property) - Method in class com.postman.collection.Url: Remove a query element key-value pair from the array of query elements, if it exists.
removeSourceCodeElement(int) - Method in class com.postman.collection.Event.PostmanScript
removeSourceCodeElement(int) - Method in class com.postman.collection.Event
removeVariable(Property) - Method in class com.postman.collection.Collection: Remove variable from the array of key-value pairs comprising this collections variable array element.
removeVariable(String) - Method in class com.postman.collection.Collection: Remove variable with the specified key from the array of key-value pairs comprising this collections variable array element.
Request - Class in com.postman.collection: Encapsulates a Postman collection request.
Request(RequestBody, String) - Constructor for class com.postman.collection.Request: Create a request with the specific name and pre-populated RequestBody.
Request(String) - Constructor for class com.postman.collection.Request: Create an empety Request with the specific name
REQUEST - Enum constant in enum class com.postman.collection.enumItemType
RequestAuth - Class in com.postman.collection: Postman SDK analog: RequestAuth.
RequestAuth() - Constructor for class com.postman.collection.RequestAuth: Default constructor.
RequestAuth(enumAuthType) - Constructor for class com.postman.collection.RequestAuth: Conveninence constructor to initialize an Auth object with the specified type as an enumerated value.
RequestAuth(enumAuthType, PropertyList<Property>) - Constructor for class com.postman.collection.RequestAuth: Conveninence constructor to initialize an Auth object with a pre-created HashMap of authentication properties
RequestAuth(String) - Constructor for class com.postman.collection.RequestAuth: Conveninence constructor to initialize an Auth object with the specified type as String.
RequestBody - Class in com.postman.collection: Encapsulates the request object property of a Request
RequestBody(enumHTTPRequestMethod, Url) - Constructor for class com.postman.collection.RequestBody: Construct a RequestBody with the specified HTTP method, and Url.
RequestBody(enumHTTPRequestMethod, String) - Constructor for class com.postman.collection.RequestBody: Construct a RequestBody object from a raw URL.
RequestBody(enumHTTPRequestMethod, String, String) - Constructor for class com.postman.collection.RequestBody: Construct a RequestBody with the specified HTTP method, host and path.
RESOLVE - Enum constant in enum class com.postman.collection.enumVariableResolution
resolveVariables(String) - Method in class com.postman.collection.Collection
Response - Class in com.postman.collection: Class to encapsulate the response object property of a Request.
Response(String, RequestBody, int, String, String, ArrayList<Cookie>, String) - Constructor for class com.postman.collection.Response
Response(String, RequestBody, String, int, String) - Constructor for class com.postman.collection.Response

S

serialize(Collection, Type, JsonSerializationContext) - Method in class com.postman.collection.adapter.CollectionSerializer
serialize(Property, Type, JsonSerializationContext) - Method in class com.postman.collection.adapter.PropertySerializer
serialize(RequestAuth, Type, JsonSerializationContext) - Method in class com.postman.collection.adapter.AuthSerializer
serialize(HashMap<String, Property>, Type, JsonSerializationContext) - Method in class com.postman.collection.adapter.PropertyListSerializer
serialize(HashMap<String, String>, Type, JsonSerializationContext) - Method in class com.postman.collection.adapter.StringMapSerializer
set(int, Property) - Method in class com.postman.collection.PropertyList
set(Property) - Method in class com.postman.collection.PropertyList
setAuth(RequestAuth) - Method in class com.postman.collection.Collection: Set the auth object property of this collection with a RequestAuth object containing the values.
setAuth(RequestAuth) - Method in class com.postman.collection.RequestBody: Set the values in the auth array with a pre-populated RequestAuth object.
setAuthType(enumAuthType) - Method in class com.postman.collection.RequestAuth: Set the underlying type property of this auth object using an enumerated value.
setBinarySrc(String) - Method in class com.postman.collection.BodyElement: Sets the value of the file/src property, the path to the file
setBody(BodyElement) - Method in class com.postman.collection.RequestBody: Set the value of the body property object
setBody(enumRequestBodyMode) - Method in class com.postman.collection.RequestBody: Populate the body array with an empty body property object with the specified mode value.
setBody(enumRequestBodyMode, String) - Method in class com.postman.collection.RequestBody: Populate the body array with the specified body content.
setBody(String) - Method in class com.postman.collection.Response: Set the value of the body property of the response
setCode(int) - Method in class com.postman.collection.Response: Set the value of the code property, the HTML status code associated with this response.
setCookies(ArrayList<Cookie>) - Method in class com.postman.collection.Response: Set the value of the cookie array property with a pre-populated ArrayList
setDescription(String) - Method in class com.postman.collection.Collection
setDescription(String) - Method in class com.postman.collection.Item: Set the value of the description property
setDescription(String) - Method in class com.postman.collection.Property: Sets the description property
setDescription(String) - Method in class com.postman.collection.RequestBody: Set the value of the description property, generally the documentation for the request
setDomain(String) - Method in class com.postman.collection.Cookie
setEvents(ArrayList<Event>) - Method in class com.postman.collection.Item: Set the ArrayList<Event> comprising the values in the event array.
setEventType(enumEventType) - Method in class com.postman.collection.Event: Sets the type of this event, eg.
setExpires(String) - Method in class com.postman.collection.Cookie
setExporterID(String) - Method in class com.postman.collection.Collection: Set the _exporter_id property of the info object property of this collection
setExtensions(PropertyList<Property>) - Method in class com.postman.collection.Cookie
setFormdata(Property) - Method in class com.postman.collection.BodyElement: Sets an element of the formdata or urlencoded property array
setFormdata(PropertyList<Property>) - Method in class com.postman.collection.BodyElement: Convenience method to set the formdata with an already filled ArrayList<Property> of properties
setFormdata(String, String, String) - Method in class com.postman.collection.BodyElement: Add a formdata element by string values
setGraphql(String) - Method in class com.postman.collection.BodyElement: Sets the query portion of the graphql property
setGraphql(String, String) - Method in class com.postman.collection.BodyElement: Sets both the query and variables properties of the graphql element
setHeader(PropertyList<Property>) - Method in class com.postman.collection.RequestBody: Set the key-value pair values for the header property array
setHeader(PropertyList<Property>) - Method in class com.postman.collection.Response: Set the value of the header element array with a pre-populated ArrayList of Property key-value pairs
setHost(String) - Method in class com.postman.collection.Url: Set the host component of the URL with a string.
setHostOnly(boolean) - Method in class com.postman.collection.Cookie
setHosts(ArrayList<String>) - Method in class com.postman.collection.Url: Set the value of the elements in the host array with a pre-populated ArrayList<String>
setHttpOnly(boolean) - Method in class com.postman.collection.Cookie
setInfo(String, String, String, String, String) - Method in class com.postman.collection.Collection: set all elements of the info property object of this collection.
setInfo(HashMap<String, String>) - Method in class com.postman.collection.Collection: Set the value of this collections info object property with a populated Hash<String> containing the key-value pairs.
setItems(ArrayList<Item>) - Method in class com.postman.collection.ItemGroup: Set the value of the item array with an ArrayList<Item>.
setKey(String) - Method in class com.postman.collection.Property: Sets the key value for this property
setMaxAge(String) - Method in class com.postman.collection.Cookie
setMethod(enumHTTPRequestMethod) - Method in class com.postman.collection.RequestBody: Set the value of the method property
setMode(enumRequestBodyMode) - Method in class com.postman.collection.BodyElement: Sets the value of the mode property and initializes relevant internal properties
setName(String) - Method in class com.postman.collection.Collection
setName(String) - Method in class com.postman.collection.Cookie
setName(String) - Method in class com.postman.collection.Item
setName(String) - Method in class com.postman.collection.Response: Set the name of this response
setOriginalRequest(RequestBody) - Method in class com.postman.collection.Response: Set the value of the originalRequest property
setParent(CollectionElement) - Method in class com.postman.collection.CollectionElement: Set the parent of this element, allowing for traversal up the chain of elements
setParent(ItemGroup) - Method in class com.postman.collection.Item: Set the parent of this item.
setPath(String) - Method in class com.postman.collection.Cookie
setPath(String) - Method in class com.postman.collection.Url: Set the path element using a String.
setPaths(ArrayList<String>) - Method in class com.postman.collection.Url: Set the elements of the path element array
setPathVariable(Property) - Method in class com.postman.collection.Url
setPathVariables(PropertyList<Property>) - Method in class com.postman.collection.Url: Set the values of the variable array with a pre-populated ArrayList<Property> containing the key-value paris
setPort(String) - Method in class com.postman.collection.Url: Set the value of the port property
setPostmanID(String) - Method in class com.postman.collection.Collection: Set the _postman_id property of the info object property of this collection
SetPostmanPreviewlanguage(String) - Method in class com.postman.collection.Response: Set the value of the _postman_previewlanguage property
setPreRequestScript(String) - Method in class com.postman.collection.Item: Set the pre-request script for this item in the event array
setProperties(PropertyList<Property>) - Method in class com.postman.collection.RequestAuth: Set the properties of the Auth object using a pre-created HashMap<String,Property> of properties.
setProtocol(String) - Method in class com.postman.collection.Url: Set the value of the protocol property with a string.
setQueries(PropertyList<Property>) - Method in class com.postman.collection.Url: Set the contents of the query array with a pre-populated ArrayList<Property> containing the key value pairs
setQuery(String) - Method in class com.postman.collection.Url: Set the elements of the query array with a string
setQueryELement(Property, int) - Method in class com.postman.collection.Url
setRaw(String) - Method in class com.postman.collection.BodyElement: Sets the raw property of the body, or null if it has not been set
setRaw(String) - Method in class com.postman.collection.Url: Sets the raw URL.
setRaw(String, enumRawBodyLanguage) - Method in class com.postman.collection.BodyElement: Sets the content (raw) and the language property of the options object
setRawLanguage(enumRawBodyLanguage) - Method in class com.postman.collection.BodyElement: Sets the langauge property of the options property
setRequestBody(RequestBody) - Method in class com.postman.collection.Request: Set the object containing the values in the request property
setResponses(ArrayList<Response>) - Method in class com.postman.collection.Request: Set the ArrayList<Response> containing the values in the response property array.
setSchemaURI(URI) - Method in class com.postman.collection.Collection: Set the schema property of the info object property of this collection
setSecure(boolean) - Method in class com.postman.collection.Cookie
setSession(boolean) - Method in class com.postman.collection.Cookie
setSourceCode(String) - Method in class com.postman.collection.Event: Set the source code for this script
setSourceCode(ArrayList<String>) - Method in class com.postman.collection.Event.PostmanScript
setStatus(String) - Method in class com.postman.collection.Response: Set the value of the status property for this response, the string associated with the code> property, eg.
setTestScript(String) - Method in class com.postman.collection.Item: Set the test script for this item in the event array
setType(String) - Method in class com.postman.collection.Event.PostmanScript
setType(String) - Method in class com.postman.collection.Property: Sets the type property for this variable
setUrl(Url) - Method in class com.postman.collection.RequestBody: Set the values of the url property
setUUID(UUID) - Method in class com.postman.collection.CollectionElement: Set a new unique UUID for this element.
setValue(String) - Method in class com.postman.collection.Cookie
setValue(String) - Method in class com.postman.collection.Property: Sets the value property for this variable
setVariables(PropertyList<Property>) - Method in class com.postman.collection.Collection: Set the array of key-value pairs in this collections variable array element
StringMapSerializer - Class in com.postman.collection.adapter
StringMapSerializer() - Constructor for class com.postman.collection.adapter.StringMapSerializer

T

TEST - Enum constant in enum class com.postman.collection.enumEventType
TEXT - Enum constant in enum class com.postman.collection.enumRawBodyLanguage
TEXT - Enum constant in enum class com.postman.collection.enumRequestBodyMode
toJson() - Method in class com.postman.collection.Collection: Generate JSON as text from the values in this collection.
toJson() - Method in class com.postman.collection.CollectionElement: Render this element to JSON using the Gson conversion library.
toJson(boolean, boolean) - Method in class com.postman.collection.CollectionElement: Render this element to JSON using the Gson conversion library.
toString() - Method in class com.postman.collection.PostmanID
TRACE - Enum constant in enum class com.postman.collection.enumHTTPRequestMethod
TRANSFORM - Enum constant in enum class com.postman.collection.enumVariableResolution

U

UNLINK - Enum constant in enum class com.postman.collection.enumHTTPRequestMethod
UNLOCK - Enum constant in enum class com.postman.collection.enumHTTPRequestMethod
upsertToPostman() - Method in class com.postman.collection.Collection
upsertToPostman(PostmanID) - Method in class com.postman.collection.Collection: Create or update this collection in Postman.
Url - Class in com.postman.collection: Class to encapsulate the properties in the url object of a RequestBody object.
Url(String) - Constructor for class com.postman.collection.Url: Create a Url with the specified URL
Url(String, String) - Constructor for class com.postman.collection.Url: Create a Url with the specified host and path.
URLENCODED - Enum constant in enum class com.postman.collection.enumRequestBodyMode

V

validate() - Method in class com.postman.collection.CollectionElement: Validate the gson produced by this element against the PostmanSchema.
validate(String) - Method in class com.postman.collection.CollectionElement: Convenience method allowing validation against a user-provided schema
ValidationException - Exception Class in com.postman.collection: Exception thrown if there is a system, syntax or other error/exception which interrupts or prevents actual validation of the element.
ValidationException(String) - Constructor for exception class com.postman.collection.ValidationException
ValidationException(Throwable) - Constructor for exception class com.postman.collection.ValidationException
valueOf(String) - Static method in enum class com.postman.collection.enumAuthType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.postman.collection.enumEventType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.postman.collection.enumHTTPRequestMethod: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.postman.collection.enumItemType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.postman.collection.enumRawBodyLanguage: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.postman.collection.enumRequestBodyMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.postman.collection.enumVariableResolution: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.postman.collection.enumAuthType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.postman.collection.enumEventType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.postman.collection.enumHTTPRequestMethod: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.postman.collection.enumItemType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.postman.collection.enumRawBodyLanguage: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.postman.collection.enumRequestBodyMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.postman.collection.enumVariableResolution: Returns an array containing the constants of this enum class, in the order they are declared.
VariableResolutionException - Exception Class in com.postman.collection: Error thrown if something prevents the resolution of a variable value, eg., the specified variable doesn't exist, etc.
VariableResolutionException(String) - Constructor for exception class com.postman.collection.VariableResolutionException
VIEW - Enum constant in enum class com.postman.collection.enumHTTPRequestMethod

W

writeToFile(File) - Method in class com.postman.collection.Collection: Write this collections generated JSON to a file at the specified path.

X

XML - Enum constant in enum class com.postman.collection.enumRawBodyLanguage

A B C D E F G H I J L M N O P R S T U V W X
All Classes and Interfaces|All Packages|Serialized Form