TalendAdminApi Class

Summary

Provides functionality for performing Talend Admin API calls.
Assembly
Cake.Talend.dll
Namespace
Cake.Talend
Interfaces
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["ITalendAdminApi"] click Interface0 "/api/Cake.Talend/ITalendAdminApi" Type["TalendAdminApi"] class Type type-node

Syntax

public class TalendAdminApi : ITalendAdminApi

Constructors

Name Summary
TalendAdminApi(string, string, string) Initializes a new instance of the TalendAdminApi class.
TalendAdminApi(string, string, string, IRestClient) Initializes a new instance of the TalendAdminApi class.

Methods

Name Value Summary
DeployEsbTask(int) void
Deploys an ESB task.
GetEsbTaskIdByName(string) int
Gets the ID of a task from its name.
GetEsbTaskList() IEnumerable<EsbTask>
Lists all ESB tasks on this API.
GetServerList() IEnumerable<Server>
Lists all servers on this API.
GetTaskIdByName(string) int
Gets the ID of a task from its name.
GetTaskList() IEnumerable<Task>
Lists all tasks on this API.
StartEsbTask(int) void
Starts an ESB task.
StopEsbTask(int) void
Stops an ESB task.
UndeployEsbTask(int) void
Undeploys an ESB task.
UpdateEsbTask(UpdateEsbTaskSettings) void
Updates an ESB task with the given information.

Extension Methods

Name Value Summary
Dump<TalendAdminApi>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<TalendAdminApi>(TalendAdminApi[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<TalendAdminApi>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<TalendAdminApi>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<TalendAdminApi>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<TalendAdminApi>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin