com.imsweb.seerapi.client.staging

Interface StagingService

public interface StagingService

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<java.util.List<StagingAlgorithm>>	algorithms() Return a list of all supported staging algorithms
retrofit2.Call<java.util.List<StagingSchema>>	involvedSchemas(java.lang.String algorithm, java.lang.String version, java.lang.String tableId) Return a list of schemas which the specified table is involved in
retrofit2.Call<java.util.List<StagingTable>>	involvedTables(java.lang.String algorithm, java.lang.String version, java.lang.String schemaId) Return a list of tables which are involved in the specified schema
retrofit2.Call<StagingSchema>	schemaById(java.lang.String algorithm, java.lang.String version, java.lang.String id) Return a single schema definition by schema identifier
retrofit2.Call<java.util.List<StagingSchemaInfo>>	schemaLookup(java.lang.String algorithm, java.lang.String version, java.util.Map<java.lang.String,java.lang.String> data) Perform a schema lookup
retrofit2.Call<java.util.List<StagingSchemaInfo>>	schemas(java.lang.String algorithm, java.lang.String version) Return a list of matching schemas
retrofit2.Call<java.util.List<StagingSchemaInfo>>	schemas(java.lang.String algorithm, java.lang.String version, java.lang.String query) Return a list of matching schemas
retrofit2.Call<StagingData>	stage(java.lang.String algorithm, java.lang.String version, java.util.Map<java.lang.String,java.lang.String> input) Stage the passed input
retrofit2.Call<StagingTable>	tableById(java.lang.String algorithm, java.lang.String version, java.lang.String id) Return a single table definition by table identifier
retrofit2.Call<java.util.List<StagingTable>>	tables(java.lang.String algorithm, java.lang.String version) Return a list of matching tables
retrofit2.Call<java.util.List<StagingTable>>	tables(java.lang.String algorithm, java.lang.String version, java.lang.String query) Return a list of matching tables
retrofit2.Call<java.util.List<StagingVersion>>	versions(java.lang.String algorithm) Return a list of supported versions for the passed algorithm

Method Detail

algorithms

@GET(value="staging/algorithms")
retrofit2.Call<java.util.List<StagingAlgorithm>> algorithms()

Return a list of all supported staging algorithms

Returns:

a list of StagingAlgorithm objects

versions

@GET(value="staging/{algorithm}/versions")
retrofit2.Call<java.util.List<StagingVersion>> versions(@Path(value="algorithm")
                                                                                                   java.lang.String algorithm)

Return a list of supported versions for the passed algorithm

Parameters:

algorithm - an algorithm identifier

Returns:

a list of schema versions

schemas

@GET(value="staging/{algorithm}/{version}/schemas")
retrofit2.Call<java.util.List<StagingSchemaInfo>> schemas(@Path(value="algorithm")
                                                                                                              java.lang.String algorithm,
                                                                                                              @Path(value="version")
                                                                                                              java.lang.String version)

Return a list of matching schemas

Parameters:

algorithm - an algorithm identifier

version - a version

Returns:

a list of schemas

schemas

@GET(value="staging/{algorithm}/{version}/schemas")
retrofit2.Call<java.util.List<StagingSchemaInfo>> schemas(@Path(value="algorithm")
                                                                                                              java.lang.String algorithm,
                                                                                                              @Path(value="version")
                                                                                                              java.lang.String version,
                                                                                                              @Query(value="q")
                                                                                                              java.lang.String query)

Return a list of matching schemas

Parameters:

algorithm - an algorithm identifier

version - a version

query - an optional text query

Returns:

a list of schemas

schemaLookup

@POST(value="staging/{algorithm}/{version}/schemas/lookup")
retrofit2.Call<java.util.List<StagingSchemaInfo>> schemaLookup(@Path(value="algorithm")
                                                                                                                           java.lang.String algorithm,
                                                                                                                           @Path(value="version")
                                                                                                                           java.lang.String version,
                                                                                                                           @Body
                                                                                                                           java.util.Map<java.lang.String,java.lang.String> data)

Perform a schema lookup

Parameters:

algorithm - an algorithm identifier

version - a version

data - a map of key/value pairs containing the input for the lookup

Returns:

a list of schemas

schemaById

@GET(value="staging/{algorithm}/{version}/schema/{id}")
retrofit2.Call<StagingSchema> schemaById(@Path(value="algorithm")
                                                                                                 java.lang.String algorithm,
                                                                                                 @Path(value="version")
                                                                                                 java.lang.String version,
                                                                                                 @Path(value="id")
                                                                                                 java.lang.String id)

Return a single schema definition by schema identifier

Parameters:

algorithm - an algorithm identifier

version - a version

id - a schema identifier

Returns:

a schema object

involvedTables

@GET(value="staging/{algorithm}/{version}/schema/{id}/tables")
retrofit2.Call<java.util.List<StagingTable>> involvedTables(@Path(value="algorithm")
                                                                                                                           java.lang.String algorithm,
                                                                                                                           @Path(value="version")
                                                                                                                           java.lang.String version,
                                                                                                                           @Path(value="id")
                                                                                                                           java.lang.String schemaId)

Return a list of tables which are involved in the specified schema

Parameters:

algorithm - an algorithm identifier

version - a version

schemaId - a schema identifier

Returns:

a list of staging tables

tables

@GET(value="staging/{algorithm}/{version}/tables")
retrofit2.Call<java.util.List<StagingTable>> tables(@Path(value="algorithm")
                                                                                                       java.lang.String algorithm,
                                                                                                       @Path(value="version")
                                                                                                       java.lang.String version)

Return a list of matching tables

Parameters:

algorithm - an algorithm identifier

version - a version

Returns:

a list of staging tables

tables

@GET(value="staging/{algorithm}/{version}/tables")
retrofit2.Call<java.util.List<StagingTable>> tables(@Path(value="algorithm")
                                                                                                       java.lang.String algorithm,
                                                                                                       @Path(value="version")
                                                                                                       java.lang.String version,
                                                                                                       @Query(value="q")
                                                                                                       java.lang.String query)

Return a list of matching tables

Parameters:

algorithm - an algorithm identifier

version - a version

query - an optional text query

Returns:

a list of staging tables

tableById

@GET(value="staging/{algorithm}/{version}/table/{id}")
retrofit2.Call<StagingTable> tableById(@Path(value="algorithm")
                                                                                              java.lang.String algorithm,
                                                                                              @Path(value="version")
                                                                                              java.lang.String version,
                                                                                              @Path(value="id")
                                                                                              java.lang.String id)

Return a single table definition by table identifier

Parameters:

algorithm - an algorithm identifier

version - a version

id - a table identifier

Returns:

a staging table

involvedSchemas

@GET(value="staging/{algorithm}/{version}/table/{id}/schemas")
retrofit2.Call<java.util.List<StagingSchema>> involvedSchemas(@Path(value="algorithm")
                                                                                                                             java.lang.String algorithm,
                                                                                                                             @Path(value="version")
                                                                                                                             java.lang.String version,
                                                                                                                             @Path(value="id")
                                                                                                                             java.lang.String tableId)

Return a list of schemas which the specified table is involved in

Parameters:

algorithm - an algorithm identifier

version - a version

tableId - a table identifier

Returns:

a list of staging schemas

stage

@POST(value="staging/{algorithm}/{version}/stage")
retrofit2.Call<StagingData> stage(@Path(value="algorithm")
                                                                                     java.lang.String algorithm,
                                                                                     @Path(value="version")
                                                                                     java.lang.String version,
                                                                                     @Body
                                                                                     java.util.Map<java.lang.String,java.lang.String> input)

Stage the passed input

Parameters:

algorithm - an algorithm identifier

version - a version

input - a map of key/value pairs containing the input for the staging call

Returns:

a StagingData object representing the results of the staging process