dohq_teamcity.api package¶

Submodules¶

dohq_teamcity.api.agent_api module¶

TeamCity REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 2018.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class dohq_teamcity.api.agent_api.AgentApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

base_name = 'Agent'¶

delete_agent(agent_locator, **kwargs)¶

delete_agent # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_agent(agent_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool agent_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

ge_incompatible_build_types(agent_locator, **kwargs)¶

ge_incompatible_build_types # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.ge_incompatible_build_types(agent_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool agent_locator (str) – (required) fields (str) –
Returns:	Compatibilities If the method is called asynchronously, returns the request thread.

get_agent_pool(agent_locator, **kwargs)¶

get_agent_pool # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_agent_pool(agent_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool agent_locator (str) – (required) fields (str) –
Returns:	AgentPool If the method is called asynchronously, returns the request thread.

get_authorized_info(agent_locator, **kwargs)¶

get_authorized_info # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_authorized_info(agent_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool agent_locator (str) – (required) fields (str) –
Returns:	AuthorizedInfo If the method is called asynchronously, returns the request thread.

get_compatible_build_types(agent_locator, **kwargs)¶

get_compatible_build_types # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_compatible_build_types(agent_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool agent_locator (str) – (required) fields (str) –
Returns:	BuildTypes If the method is called asynchronously, returns the request thread.

get_enabled_info(agent_locator, **kwargs)¶

get_enabled_info # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_enabled_info(agent_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool agent_locator (str) – (required) fields (str) –
Returns:	EnabledInfo If the method is called asynchronously, returns the request thread.

serve_agent(agent_locator, **kwargs)¶

serve_agent # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_agent(agent_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool agent_locator (str) – (required) fields (str) –
Returns:	Agent If the method is called asynchronously, returns the request thread.

serve_agent_field(agent_locator, field, **kwargs)¶

serve_agent_field # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_agent_field(agent_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool agent_locator (str) – (required) field (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

serve_agents(**kwargs)¶

serve_agents # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_agents(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool include_disconnected (bool) – include_unauthorized (bool) – locator (str) – fields (str) –
Returns:	Agents If the method is called asynchronously, returns the request thread.

set_agent_field(agent_locator, field, **kwargs)¶

set_agent_field # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_agent_field(agent_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool agent_locator (str) – (required) field (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

set_agent_pool(agent_locator, **kwargs)¶

set_agent_pool # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_agent_pool(agent_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool agent_locator (str) – (required) body (AgentPool) – fields (str) –
Returns:	AgentPool If the method is called asynchronously, returns the request thread.

set_authorized_info(agent_locator, **kwargs)¶

set_authorized_info # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_authorized_info(agent_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool agent_locator (str) – (required) body (AuthorizedInfo) – fields (str) –
Returns:	AuthorizedInfo If the method is called asynchronously, returns the request thread.

set_enabled_info(agent_locator, **kwargs)¶

set_enabled_info # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_enabled_info(agent_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool agent_locator (str) – (required) body (EnabledInfo) – fields (str) –
Returns:	EnabledInfo If the method is called asynchronously, returns the request thread.

dohq_teamcity.api.agent_pool_api module¶

TeamCity REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 2018.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class dohq_teamcity.api.agent_pool_api.AgentPoolApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

add_agent(agent_pool_locator, **kwargs)¶

add_agent # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_agent(agent_pool_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool agent_pool_locator (str) – (required) body (Agent) – fields (str) –
Returns:	Agent If the method is called asynchronously, returns the request thread.

add_project(agent_pool_locator, **kwargs)¶

add_project # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_project(agent_pool_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool agent_pool_locator (str) – (required) body (Project) –
Returns:	Project If the method is called asynchronously, returns the request thread.

base_name = 'AgentPool'¶

create_pool(**kwargs)¶

create_pool # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_pool(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool body (AgentPool) –
Returns:	AgentPool If the method is called asynchronously, returns the request thread.

delete_pool(agent_pool_locator, **kwargs)¶

delete_pool # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_pool(agent_pool_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool agent_pool_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_pool_project(agent_pool_locator, project_locator, **kwargs)¶

delete_pool_project # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_pool_project(agent_pool_locator, project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool agent_pool_locator (str) – (required) project_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_projects(agent_pool_locator, **kwargs)¶

delete_projects # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_projects(agent_pool_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool agent_pool_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

get_field(agent_pool_locator, field, **kwargs)¶

get_field # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_field(agent_pool_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool agent_pool_locator (str) – (required) field (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_pool(agent_pool_locator, **kwargs)¶

get_pool # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_pool(agent_pool_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool agent_pool_locator (str) – (required) fields (str) –
Returns:	AgentPool If the method is called asynchronously, returns the request thread.

get_pool_agents(agent_pool_locator, **kwargs)¶

get_pool_agents # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_pool_agents(agent_pool_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool agent_pool_locator (str) – (required) locator (str) – fields (str) –
Returns:	Agents If the method is called asynchronously, returns the request thread.

get_pool_project(agent_pool_locator, project_locator, **kwargs)¶

get_pool_project # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_pool_project(agent_pool_locator, project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool agent_pool_locator (str) – (required) project_locator (str) – (required) fields (str) –
Returns:	Project If the method is called asynchronously, returns the request thread.

get_pool_projects(agent_pool_locator, **kwargs)¶

get_pool_projects # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_pool_projects(agent_pool_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool agent_pool_locator (str) – (required) fields (str) –
Returns:	Projects If the method is called asynchronously, returns the request thread.

get_pools(**kwargs)¶

get_pools # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_pools(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool locator (str) – fields (str) –
Returns:	AgentPools If the method is called asynchronously, returns the request thread.

replace_projects(agent_pool_locator, **kwargs)¶

replace_projects # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace_projects(agent_pool_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool agent_pool_locator (str) – (required) body (Projects) –
Returns:	Projects If the method is called asynchronously, returns the request thread.

set_field(agent_pool_locator, field, **kwargs)¶

set_field # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_field(agent_pool_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool agent_pool_locator (str) – (required) field (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

dohq_teamcity.api.build_api module¶

TeamCity REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 2018.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class dohq_teamcity.api.build_api.BuildApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

add_tags(build_locator, **kwargs)¶

add_tags # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_tags(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) body (Tags) – fields (str) –
Returns:	Tags If the method is called asynchronously, returns the request thread.

base_name = 'Build'¶

cancel_build(build_locator, **kwargs)¶

cancel_build # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.cancel_build(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) body (BuildCancelRequest) – fields (str) –
Returns:	Build If the method is called asynchronously, returns the request thread.

cancel_build_0(build_locator, **kwargs)¶

cancel_build_0 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.cancel_build_0(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required)
Returns:	BuildCancelRequest If the method is called asynchronously, returns the request thread.

delete_all_parameters(build_locator, **kwargs)¶

delete_all_parameters # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_parameters(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) fields (str) –
Returns:	None If the method is called asynchronously, returns the request thread.

delete_build(build_locator, **kwargs)¶

delete_build # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_build(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_builds(**kwargs)¶

delete_builds # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_builds(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool locator (str) –
Returns:	None If the method is called asynchronously, returns the request thread.

delete_comment(build_locator, **kwargs)¶

delete_comment # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_comment(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_parameter(name, build_locator, **kwargs)¶

delete_parameter # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_parameter(name, build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) build_locator (str) – (required) fields (str) –
Returns:	None If the method is called asynchronously, returns the request thread.

get_artifact_dependency_changes(build_locator, **kwargs)¶

get_artifact_dependency_changes # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_artifact_dependency_changes(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) fields (str) –
Returns:	BuildChanges If the method is called asynchronously, returns the request thread.

get_artifacts_directory(build_locator, **kwargs)¶

get_artifacts_directory # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_artifacts_directory(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_build_number(build_locator, **kwargs)¶

get_build_number # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_build_number(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_build_status_text(build_locator, **kwargs)¶

get_build_status_text # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_build_status_text(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_canceled_info(build_locator, **kwargs)¶

get_canceled_info # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_canceled_info(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) fields (str) –
Returns:	Comment If the method is called asynchronously, returns the request thread.

get_children(path, build_locator, **kwargs)¶

get_children # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_children(path, build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool path (str) – (required) build_locator (str) – (required) base_path (str) – locator (str) – fields (str) – resolve_parameters (bool) – log_build_usage (bool) –
Returns:	Files If the method is called asynchronously, returns the request thread.

get_children_alias(path, build_locator, **kwargs)¶

get_children_alias # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_children_alias(path, build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool path (str) – (required) build_locator (str) – (required) base_path (str) – locator (str) – fields (str) – resolve_parameters (bool) – log_build_usage (bool) –
Returns:	Files If the method is called asynchronously, returns the request thread.

get_content(path, build_locator, **kwargs)¶

get_content # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_content(path, build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool path (str) – (required) build_locator (str) – (required) response_builder (str) – resolve_parameters (bool) – log_build_usage (bool) –
Returns:	None If the method is called asynchronously, returns the request thread.

get_content_alias(path, build_locator, **kwargs)¶

get_content_alias # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_content_alias(path, build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool path (str) – (required) build_locator (str) – (required) resolve_parameters (bool) – log_build_usage (bool) –
Returns:	None If the method is called asynchronously, returns the request thread.

get_metadata(path, build_locator, **kwargs)¶

get_metadata # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_metadata(path, build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool path (str) – (required) build_locator (str) – (required) fields (str) – resolve_parameters (bool) – log_build_usage (bool) –
Returns:	file If the method is called asynchronously, returns the request thread.

get_parameter(name, build_locator, **kwargs)¶

get_parameter # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_parameter(name, build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) build_locator (str) – (required) fields (str) – fields2 (str) –
Returns:	ModelProperty If the method is called asynchronously, returns the request thread.

get_parameter_0(build_locator, property_name, **kwargs)¶

get_parameter_0 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_parameter_0(build_locator, property_name, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) property_name (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_parameter_value_long(name, build_locator, **kwargs)¶

get_parameter_value_long # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_parameter_value_long(name, build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) build_locator (str) – (required) fields (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

get_parameters(build_locator, **kwargs)¶

get_parameters # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_parameters(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) locator (str) – fields (str) – fields2 (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

get_pinned(build_locator, **kwargs)¶

get_pinned # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_pinned(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_problems(build_locator, **kwargs)¶

get_problems # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_problems(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) fields (str) –
Returns:	ProblemOccurrences If the method is called asynchronously, returns the request thread.

get_resolved_parameter(build_locator, value, **kwargs)¶

get_resolved_parameter # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_resolved_parameter(build_locator, value, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) value (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_root(build_locator, **kwargs)¶

get_root # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_root(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) base_path (str) – locator (str) – fields (str) – resolve_parameters (bool) – log_build_usage (bool) –
Returns:	Files If the method is called asynchronously, returns the request thread.

get_tests(build_locator, **kwargs)¶

get_tests # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_tests(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) fields (str) –
Returns:	TestOccurrences If the method is called asynchronously, returns the request thread.

get_zipped(path, build_locator, **kwargs)¶

get_zipped # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_zipped(path, build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool path (str) – (required) build_locator (str) – (required) base_path (str) – locator (str) – name (str) – resolve_parameters (bool) – log_build_usage (bool) –
Returns:	None If the method is called asynchronously, returns the request thread.

pin_build(build_locator, **kwargs)¶

pin_build # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.pin_build(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) body (str) –
Returns:	None If the method is called asynchronously, returns the request thread.

replace_comment(build_locator, **kwargs)¶

replace_comment # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace_comment(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) body (str) –
Returns:	None If the method is called asynchronously, returns the request thread.

replace_tags(build_locator, **kwargs)¶

replace_tags # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace_tags(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) locator (str) – body (Tags) – fields (str) –
Returns:	Tags If the method is called asynchronously, returns the request thread.

reset_build_finish_parameters(build_locator, **kwargs)¶

reset_build_finish_parameters # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.reset_build_finish_parameters(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

serve_aggregated_build_status(build_locator, **kwargs)¶

serve_aggregated_build_status # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_aggregated_build_status(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

serve_aggregated_build_status_icon(build_locator, suffix, **kwargs)¶

serve_aggregated_build_status_icon # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_aggregated_build_status_icon(build_locator, suffix, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) suffix (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

serve_all_builds(**kwargs)¶

serve_all_builds # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_all_builds(async_req=True) >>> result = thread.get()

Parameters:

async_req – bool
build_type (str) –
status (str) –
triggered_by_user (str) –
include_personal (bool) –
include_canceled (bool) –
only_pinned (bool) –
tag (list[str]) –
agent_name (str) –
since_build (str) –
since_date (str) –
start (int) –
count (int) –
locator (str) –
fields (str) –

Returns:

Builds If the method is called asynchronously, returns the request thread.

serve_build(build_locator, **kwargs)¶

serve_build # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_build(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) fields (str) –
Returns:	Build If the method is called asynchronously, returns the request thread.

serve_build_actual_parameters(build_locator, **kwargs)¶

serve_build_actual_parameters # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_build_actual_parameters(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) fields (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

serve_build_field_by_build_only(build_locator, field, **kwargs)¶

serve_build_field_by_build_only # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_build_field_by_build_only(build_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) field (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

serve_build_related_issues(build_locator, **kwargs)¶

serve_build_related_issues # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_build_related_issues(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) fields (str) –
Returns:	IssuesUsages If the method is called asynchronously, returns the request thread.

serve_build_related_issues_old(build_locator, **kwargs)¶

serve_build_related_issues_old # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_build_related_issues_old(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) fields (str) –
Returns:	IssuesUsages If the method is called asynchronously, returns the request thread.

serve_build_statistic_value(build_locator, name, **kwargs)¶

serve_build_statistic_value # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_build_statistic_value(build_locator, name, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) name (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

serve_build_statistic_values(build_locator, **kwargs)¶

serve_build_statistic_values # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_build_statistic_values(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) fields (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

serve_build_status_icon(build_locator, suffix, **kwargs)¶

serve_build_status_icon # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_build_status_icon(build_locator, suffix, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) suffix (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

serve_source_file(build_locator, file_name, **kwargs)¶

serve_source_file # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_source_file(build_locator, file_name, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) file_name (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

serve_tags(build_locator, **kwargs)¶

serve_tags # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_tags(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) locator (str) – fields (str) –
Returns:	Tags If the method is called asynchronously, returns the request thread.

set_build_number(build_locator, **kwargs)¶

set_build_number # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_build_number(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

set_build_status_text(build_locator, **kwargs)¶

set_build_status_text # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_build_status_text(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

set_parameter(build_locator, **kwargs)¶

set_parameter # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_parameter(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) body (ModelProperty) – fields (str) – fields2 (str) –
Returns:	ModelProperty If the method is called asynchronously, returns the request thread.

set_parameter_0(name, build_locator, **kwargs)¶

set_parameter_0 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_parameter_0(name, build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) build_locator (str) – (required) body (ModelProperty) – fields (str) – fields2 (str) –
Returns:	ModelProperty If the method is called asynchronously, returns the request thread.

set_parameter_value_long(name, build_locator, **kwargs)¶

set_parameter_value_long # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_parameter_value_long(name, build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) build_locator (str) – (required) body (str) – fields (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

set_parameters(build_locator, **kwargs)¶

set_parameters # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_parameters(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) body (Properties) – fields (str) – fields2 (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

unpin_build(build_locator, **kwargs)¶

unpin_build # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.unpin_build(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) body (str) –
Returns:	None If the method is called asynchronously, returns the request thread.

dohq_teamcity.api.build_queue_api module¶

TeamCity REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 2018.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class dohq_teamcity.api.build_queue_api.BuildQueueApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

add_tags(build_locator, **kwargs)¶

add_tags # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_tags(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) body (Tags) –
Returns:	None If the method is called asynchronously, returns the request thread.

base_name = 'BuildQueue'¶

cancel_build(build_locator, **kwargs)¶

cancel_build # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.cancel_build(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required)
Returns:	BuildCancelRequest If the method is called asynchronously, returns the request thread.

cancel_build_0(queued_build_locator, **kwargs)¶

cancel_build_0 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.cancel_build_0(queued_build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool queued_build_locator (str) – (required) body (BuildCancelRequest) –
Returns:	Build If the method is called asynchronously, returns the request thread.

delete_build(queued_build_locator, **kwargs)¶

delete_build # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_build(queued_build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool queued_build_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_builds_experimental(**kwargs)¶

delete_builds_experimental # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_builds_experimental(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool locator (str) – fields (str) –
Returns:	None If the method is called asynchronously, returns the request thread.

get_build(queued_build_locator, **kwargs)¶

get_build # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_build(queued_build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool queued_build_locator (str) – (required) fields (str) –
Returns:	Build If the method is called asynchronously, returns the request thread.

get_builds(**kwargs)¶

get_builds # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_builds(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool locator (str) – fields (str) –
Returns:	Builds If the method is called asynchronously, returns the request thread.

queue_new_build(**kwargs)¶

queue_new_build # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.queue_new_build(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool body (Build) – move_to_top (bool) –
Returns:	Build If the method is called asynchronously, returns the request thread.

replace_builds(**kwargs)¶

replace_builds # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace_builds(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool body (Builds) – fields (str) –
Returns:	Builds If the method is called asynchronously, returns the request thread.

replace_tags(build_locator, **kwargs)¶

replace_tags # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace_tags(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) locator (str) – body (Tags) – fields (str) –
Returns:	Tags If the method is called asynchronously, returns the request thread.

serve_build_field_by_build_only(build_locator, field, **kwargs)¶

serve_build_field_by_build_only # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_build_field_by_build_only(build_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) field (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

serve_compatible_agents(queued_build_locator, **kwargs)¶

serve_compatible_agents # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_compatible_agents(queued_build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool queued_build_locator (str) – (required) fields (str) –
Returns:	Agents If the method is called asynchronously, returns the request thread.

serve_tags(build_locator, **kwargs)¶

serve_tags # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_tags(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required) locator (str) – fields (str) –
Returns:	Tags If the method is called asynchronously, returns the request thread.

set_build_queue_order(**kwargs)¶

set_build_queue_order # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_build_queue_order(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool body (Builds) – fields (str) –
Returns:	Builds If the method is called asynchronously, returns the request thread.

set_build_queue_position(queue_position, **kwargs)¶

set_build_queue_position # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_build_queue_position(queue_position, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool queue_position (str) – (required) fields (str) –
Returns:	Build If the method is called asynchronously, returns the request thread.

set_build_queue_position_0(queue_position, **kwargs)¶

set_build_queue_position_0 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_build_queue_position_0(queue_position, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool queue_position (str) – (required) body (Build) – fields (str) –
Returns:	Build If the method is called asynchronously, returns the request thread.

dohq_teamcity.api.build_type_api module¶

TeamCity REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 2018.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class dohq_teamcity.api.build_type_api.BuildTypeApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

add_agent_requirement(bt_locator, **kwargs)¶

add_agent_requirement # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_agent_requirement(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) fields (str) – body (AgentRequirement) –
Returns:	AgentRequirement If the method is called asynchronously, returns the request thread.

add_artifact_dep(bt_locator, **kwargs)¶

add_artifact_dep # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_artifact_dep(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) fields (str) – body (ArtifactDependency) –
Returns:	ArtifactDependency If the method is called asynchronously, returns the request thread.

add_build_type(**kwargs)¶

add_build_type # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_build_type(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool body (BuildType) – fields (str) –
Returns:	BuildType If the method is called asynchronously, returns the request thread.

add_feature(bt_locator, **kwargs)¶

add_feature # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_feature(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) fields (str) – body (Feature) –
Returns:	Feature If the method is called asynchronously, returns the request thread.

add_feature_parameter(bt_locator, feature_id, parameter_name, **kwargs)¶

add_feature_parameter # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_feature_parameter(bt_locator, feature_id, parameter_name, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) feature_id (str) – (required) parameter_name (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

add_snapshot_dep(bt_locator, **kwargs)¶

add_snapshot_dep # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_snapshot_dep(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) fields (str) – body (SnapshotDependency) –
Returns:	SnapshotDependency If the method is called asynchronously, returns the request thread.

add_step(bt_locator, **kwargs)¶

add_step # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_step(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) fields (str) – body (Step) –
Returns:	Step If the method is called asynchronously, returns the request thread.

add_step_parameter(bt_locator, step_id, parameter_name, **kwargs)¶

add_step_parameter # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_step_parameter(bt_locator, step_id, parameter_name, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) step_id (str) – (required) parameter_name (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

add_template(bt_locator, **kwargs)¶

add_template # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_template(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) body (BuildType) – optimize_settings (bool) – fields (str) –
Returns:	BuildType If the method is called asynchronously, returns the request thread.

add_trigger(bt_locator, **kwargs)¶

add_trigger # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_trigger(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) fields (str) – body (Trigger) –
Returns:	Trigger If the method is called asynchronously, returns the request thread.

add_vcs_root_entry(bt_locator, **kwargs)¶

add_vcs_root_entry # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_vcs_root_entry(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) body (VcsRootEntry) – fields (str) –
Returns:	VcsRootEntry If the method is called asynchronously, returns the request thread.

base_name = 'BuildType'¶

change_artifact_dep_setting(bt_locator, artifact_dep_locator, field_name, **kwargs)¶

change_artifact_dep_setting # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.change_artifact_dep_setting(bt_locator, artifact_dep_locator, field_name, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) artifact_dep_locator (str) – (required) field_name (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

change_feature_setting(bt_locator, feature_id, name, **kwargs)¶

change_feature_setting # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.change_feature_setting(bt_locator, feature_id, name, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) feature_id (str) – (required) name (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

change_requirement_setting(bt_locator, agent_requirement_locator, field_name, **kwargs)¶

change_requirement_setting # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.change_requirement_setting(bt_locator, agent_requirement_locator, field_name, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) agent_requirement_locator (str) – (required) field_name (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

change_step_setting(bt_locator, step_id, field_name, **kwargs)¶

change_step_setting # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.change_step_setting(bt_locator, step_id, field_name, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) step_id (str) – (required) field_name (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

change_trigger_setting(bt_locator, trigger_locator, field_name, **kwargs)¶

change_trigger_setting # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.change_trigger_setting(bt_locator, trigger_locator, field_name, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) trigger_locator (str) – (required) field_name (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

delete_agent_requirement(bt_locator, agent_requirement_locator, **kwargs)¶

delete_agent_requirement # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_agent_requirement(bt_locator, agent_requirement_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) agent_requirement_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_all_parameters(bt_locator, **kwargs)¶

delete_all_parameters # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_parameters(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_all_parameters_0(bt_locator, **kwargs)¶

delete_all_parameters_0 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_parameters_0(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_artifact_dep(bt_locator, artifact_dep_locator, **kwargs)¶

delete_artifact_dep # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_artifact_dep(bt_locator, artifact_dep_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) artifact_dep_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_build_type(bt_locator, **kwargs)¶

delete_build_type # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_build_type(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_feature(bt_locator, feature_id, **kwargs)¶

delete_feature # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_feature(bt_locator, feature_id, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) feature_id (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_parameter(name, bt_locator, **kwargs)¶

delete_parameter # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_parameter(name, bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) bt_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_parameter_0(name, bt_locator, **kwargs)¶

delete_parameter_0 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_parameter_0(name, bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) bt_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_snapshot_dep(bt_locator, snapshot_dep_locator, **kwargs)¶

delete_snapshot_dep # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_snapshot_dep(bt_locator, snapshot_dep_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) snapshot_dep_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_step(bt_locator, step_id, **kwargs)¶

delete_step # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_step(bt_locator, step_id, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) step_id (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_trigger(bt_locator, trigger_locator, **kwargs)¶

delete_trigger # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_trigger(bt_locator, trigger_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) trigger_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_vcs_root_entry(bt_locator, vcs_root_locator, **kwargs)¶

delete_vcs_root_entry # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_vcs_root_entry(bt_locator, vcs_root_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) vcs_root_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

get_agent_requirement(bt_locator, agent_requirement_locator, **kwargs)¶

get_agent_requirement # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_agent_requirement(bt_locator, agent_requirement_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) agent_requirement_locator (str) – (required) fields (str) –
Returns:	AgentRequirement If the method is called asynchronously, returns the request thread.

get_agent_requirements(bt_locator, **kwargs)¶

get_agent_requirements # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_agent_requirements(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) fields (str) –
Returns:	AgentRequirements If the method is called asynchronously, returns the request thread.

get_aliases(bt_locator, field, **kwargs)¶

get_aliases # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_aliases(bt_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) field (str) – (required)
Returns:	Items If the method is called asynchronously, returns the request thread.

get_artifact_dep(bt_locator, artifact_dep_locator, **kwargs)¶

get_artifact_dep # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_artifact_dep(bt_locator, artifact_dep_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) artifact_dep_locator (str) – (required) fields (str) –
Returns:	ArtifactDependency If the method is called asynchronously, returns the request thread.

get_artifact_dep_setting(bt_locator, artifact_dep_locator, field_name, **kwargs)¶

get_artifact_dep_setting # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_artifact_dep_setting(bt_locator, artifact_dep_locator, field_name, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) artifact_dep_locator (str) – (required) field_name (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_artifact_deps(bt_locator, **kwargs)¶

get_artifact_deps # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_artifact_deps(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) fields (str) –
Returns:	ArtifactDependencies If the method is called asynchronously, returns the request thread.

get_build_types(**kwargs)¶

get_build_types # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_build_types(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool locator (str) – fields (str) –
Returns:	BuildTypes If the method is called asynchronously, returns the request thread.

get_children(path, bt_locator, **kwargs)¶

get_children # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_children(path, bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool path (str) – (required) bt_locator (str) – (required) base_path (str) – locator (str) – fields (str) – resolve_parameters (bool) –
Returns:	Files If the method is called asynchronously, returns the request thread.

get_children_alias(path, bt_locator, **kwargs)¶

get_children_alias # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_children_alias(path, bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool path (str) – (required) bt_locator (str) – (required) base_path (str) – locator (str) – fields (str) – resolve_parameters (bool) –
Returns:	Files If the method is called asynchronously, returns the request thread.

get_content(path, bt_locator, **kwargs)¶

get_content # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_content(path, bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool path (str) – (required) bt_locator (str) – (required) response_builder (str) – resolve_parameters (bool) –
Returns:	None If the method is called asynchronously, returns the request thread.

get_content_alias(path, bt_locator, **kwargs)¶

get_content_alias # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_content_alias(path, bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool path (str) – (required) bt_locator (str) – (required) resolve_parameters (bool) –
Returns:	None If the method is called asynchronously, returns the request thread.

get_current_vcs_instances(bt_locator, **kwargs)¶

get_current_vcs_instances # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_current_vcs_instances(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) fields (str) –
Returns:	VcsRootInstances If the method is called asynchronously, returns the request thread.

get_current_vcs_instances_obsolete(bt_locator, **kwargs)¶

get_current_vcs_instances_obsolete # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_current_vcs_instances_obsolete(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) fields (str) –
Returns:	VcsRootInstances If the method is called asynchronously, returns the request thread.

get_example_new_project_description(bt_locator, **kwargs)¶

get_example_new_project_description # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_example_new_project_description(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required)
Returns:	NewBuildTypeDescription If the method is called asynchronously, returns the request thread.

get_example_new_project_description_compatibility_version1(bt_locator, **kwargs)¶

get_example_new_project_description_compatibility_version1 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_example_new_project_description_compatibility_version1(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required)
Returns:	NewBuildTypeDescription If the method is called asynchronously, returns the request thread.

get_feature(bt_locator, feature_id, **kwargs)¶

get_feature # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_feature(bt_locator, feature_id, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) feature_id (str) – (required) fields (str) –
Returns:	Feature If the method is called asynchronously, returns the request thread.

get_feature_parameter(bt_locator, feature_id, parameter_name, **kwargs)¶

get_feature_parameter # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_feature_parameter(bt_locator, feature_id, parameter_name, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) feature_id (str) – (required) parameter_name (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_feature_parameters(bt_locator, feature_id, **kwargs)¶

get_feature_parameters # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_feature_parameters(bt_locator, feature_id, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) feature_id (str) – (required) fields (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

get_feature_setting(bt_locator, feature_id, name, **kwargs)¶

get_feature_setting # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_feature_setting(bt_locator, feature_id, name, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) feature_id (str) – (required) name (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_features(bt_locator, **kwargs)¶

get_features # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_features(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) fields (str) –
Returns:	Features If the method is called asynchronously, returns the request thread.

get_investigations(bt_locator, **kwargs)¶

get_investigations # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_investigations(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) fields (str) –
Returns:	Investigations If the method is called asynchronously, returns the request thread.

get_metadata(path, bt_locator, **kwargs)¶

get_metadata # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_metadata(path, bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool path (str) – (required) bt_locator (str) – (required) fields (str) – resolve_parameters (bool) –
Returns:	file If the method is called asynchronously, returns the request thread.

get_parameter(name, bt_locator, **kwargs)¶

get_parameter # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_parameter(name, bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) bt_locator (str) – (required) fields (str) –
Returns:	ModelProperty If the method is called asynchronously, returns the request thread.

get_parameter_0(name, bt_locator, **kwargs)¶

get_parameter_0 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_parameter_0(name, bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) bt_locator (str) – (required) fields (str) –
Returns:	ModelProperty If the method is called asynchronously, returns the request thread.

get_parameter_type(name, bt_locator, **kwargs)¶

get_parameter_type # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_parameter_type(name, bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) bt_locator (str) – (required)
Returns:	Type If the method is called asynchronously, returns the request thread.

get_parameter_type_raw_value(name, bt_locator, **kwargs)¶

get_parameter_type_raw_value # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_parameter_type_raw_value(name, bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) bt_locator (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_parameter_value_long(name, bt_locator, **kwargs)¶

get_parameter_value_long # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_parameter_value_long(name, bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) bt_locator (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_parameter_value_long_0(name, bt_locator, **kwargs)¶

get_parameter_value_long_0 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_parameter_value_long_0(name, bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) bt_locator (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_parameters(bt_locator, **kwargs)¶

get_parameters # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_parameters(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) locator (str) – fields (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

get_parameters_0(bt_locator, **kwargs)¶

get_parameters_0 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_parameters_0(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) locator (str) – fields (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

get_requirement_setting(bt_locator, agent_requirement_locator, field_name, **kwargs)¶

get_requirement_setting # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_requirement_setting(bt_locator, agent_requirement_locator, field_name, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) agent_requirement_locator (str) – (required) field_name (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_root(bt_locator, **kwargs)¶

get_root # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_root(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) base_path (str) – locator (str) – fields (str) – resolve_parameters (bool) –
Returns:	Files If the method is called asynchronously, returns the request thread.

get_settings_file(bt_locator, **kwargs)¶

get_settings_file # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_settings_file(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_snapshot_dep(bt_locator, snapshot_dep_locator, **kwargs)¶

get_snapshot_dep # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_snapshot_dep(bt_locator, snapshot_dep_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) snapshot_dep_locator (str) – (required) fields (str) –
Returns:	SnapshotDependency If the method is called asynchronously, returns the request thread.

get_snapshot_deps(bt_locator, **kwargs)¶

get_snapshot_deps # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_snapshot_deps(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) fields (str) –
Returns:	SnapshotDependencies If the method is called asynchronously, returns the request thread.

get_step(bt_locator, step_id, **kwargs)¶

get_step # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_step(bt_locator, step_id, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) step_id (str) – (required) fields (str) –
Returns:	Step If the method is called asynchronously, returns the request thread.

get_step_parameter(bt_locator, step_id, parameter_name, **kwargs)¶

get_step_parameter # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_step_parameter(bt_locator, step_id, parameter_name, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) step_id (str) – (required) parameter_name (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_step_parameters(bt_locator, step_id, **kwargs)¶

get_step_parameters # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_step_parameters(bt_locator, step_id, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) step_id (str) – (required) fields (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

get_step_setting(bt_locator, step_id, field_name, **kwargs)¶

get_step_setting # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_step_setting(bt_locator, step_id, field_name, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) step_id (str) – (required) field_name (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_steps(bt_locator, **kwargs)¶

get_steps # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_steps(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) fields (str) –
Returns:	Steps If the method is called asynchronously, returns the request thread.

get_template(bt_locator, template_locator, **kwargs)¶

get_template # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_template(bt_locator, template_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) template_locator (str) – (required) fields (str) –
Returns:	BuildType If the method is called asynchronously, returns the request thread.

get_templates(bt_locator, **kwargs)¶

get_templates # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_templates(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) fields (str) –
Returns:	BuildTypes If the method is called asynchronously, returns the request thread.

get_trigger(bt_locator, trigger_locator, **kwargs)¶

get_trigger # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_trigger(bt_locator, trigger_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) trigger_locator (str) – (required) fields (str) –
Returns:	Trigger If the method is called asynchronously, returns the request thread.

get_trigger_setting(bt_locator, trigger_locator, field_name, **kwargs)¶

get_trigger_setting # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_trigger_setting(bt_locator, trigger_locator, field_name, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) trigger_locator (str) – (required) field_name (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_triggers(bt_locator, **kwargs)¶

get_triggers # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_triggers(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) fields (str) –
Returns:	Triggers If the method is called asynchronously, returns the request thread.

get_vcs_labeling_options(bt_locator, **kwargs)¶

get_vcs_labeling_options # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_vcs_labeling_options(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required)
Returns:	VcsLabeling If the method is called asynchronously, returns the request thread.

get_vcs_root_entries(bt_locator, **kwargs)¶

get_vcs_root_entries # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_vcs_root_entries(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) fields (str) –
Returns:	VcsRootEntries If the method is called asynchronously, returns the request thread.

get_vcs_root_entry(bt_locator, vcs_root_locator, **kwargs)¶

get_vcs_root_entry # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_vcs_root_entry(bt_locator, vcs_root_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) vcs_root_locator (str) – (required) fields (str) –
Returns:	VcsRootEntry If the method is called asynchronously, returns the request thread.

get_vcs_root_entry_checkout_rules(bt_locator, vcs_root_locator, **kwargs)¶

get_vcs_root_entry_checkout_rules # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_vcs_root_entry_checkout_rules(bt_locator, vcs_root_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) vcs_root_locator (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_zipped(path, bt_locator, **kwargs)¶

get_zipped # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_zipped(path, bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool path (str) – (required) bt_locator (str) – (required) base_path (str) – locator (str) – name (str) – resolve_parameters (bool) –
Returns:	None If the method is called asynchronously, returns the request thread.

remove_all_templates(bt_locator, **kwargs)¶

remove_all_templates # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.remove_all_templates(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) inline_settings (bool) –
Returns:	None If the method is called asynchronously, returns the request thread.

remove_template(bt_locator, template_locator, **kwargs)¶

remove_template # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.remove_template(bt_locator, template_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) template_locator (str) – (required) inline_settings (bool) –
Returns:	None If the method is called asynchronously, returns the request thread.

replace_agent_requirement(bt_locator, agent_requirement_locator, **kwargs)¶

replace_agent_requirement # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace_agent_requirement(bt_locator, agent_requirement_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) agent_requirement_locator (str) – (required) fields (str) – body (AgentRequirement) –
Returns:	AgentRequirement If the method is called asynchronously, returns the request thread.

replace_agent_requirements(bt_locator, **kwargs)¶

replace_agent_requirements # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace_agent_requirements(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) fields (str) – body (AgentRequirements) –
Returns:	AgentRequirements If the method is called asynchronously, returns the request thread.

replace_artifact_dep(bt_locator, artifact_dep_locator, **kwargs)¶

replace_artifact_dep # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace_artifact_dep(bt_locator, artifact_dep_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) artifact_dep_locator (str) – (required) fields (str) – body (ArtifactDependency) –
Returns:	ArtifactDependency If the method is called asynchronously, returns the request thread.

replace_artifact_deps(bt_locator, **kwargs)¶

replace_artifact_deps # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace_artifact_deps(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) fields (str) – body (ArtifactDependencies) –
Returns:	ArtifactDependencies If the method is called asynchronously, returns the request thread.

replace_feature(bt_locator, feature_id, **kwargs)¶

replace_feature # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace_feature(bt_locator, feature_id, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) feature_id (str) – (required) fields (str) – body (Feature) –
Returns:	Feature If the method is called asynchronously, returns the request thread.

replace_feature_parameters(bt_locator, feature_id, **kwargs)¶

replace_feature_parameters # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace_feature_parameters(bt_locator, feature_id, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) feature_id (str) – (required) body (Properties) – fields (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

replace_features(bt_locator, **kwargs)¶

replace_features # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace_features(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) fields (str) – body (Features) –
Returns:	Features If the method is called asynchronously, returns the request thread.

replace_snapshot_dep(bt_locator, snapshot_dep_locator, **kwargs)¶

replace_snapshot_dep # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace_snapshot_dep(bt_locator, snapshot_dep_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) snapshot_dep_locator (str) – (required) fields (str) – body (SnapshotDependency) –
Returns:	SnapshotDependency If the method is called asynchronously, returns the request thread.

replace_snapshot_deps(bt_locator, **kwargs)¶

replace_snapshot_deps # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace_snapshot_deps(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) fields (str) – body (SnapshotDependencies) –
Returns:	SnapshotDependencies If the method is called asynchronously, returns the request thread.

replace_step(bt_locator, step_id, **kwargs)¶

replace_step # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace_step(bt_locator, step_id, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) step_id (str) – (required) fields (str) – body (Step) –
Returns:	Step If the method is called asynchronously, returns the request thread.

replace_step_parameters(bt_locator, step_id, **kwargs)¶

replace_step_parameters # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace_step_parameters(bt_locator, step_id, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) step_id (str) – (required) body (Properties) – fields (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

replace_steps(bt_locator, **kwargs)¶

replace_steps # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace_steps(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) fields (str) – body (Steps) –
Returns:	Steps If the method is called asynchronously, returns the request thread.

replace_trigger(bt_locator, trigger_locator, **kwargs)¶

replace_trigger # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace_trigger(bt_locator, trigger_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) trigger_locator (str) – (required) fields (str) – body (Trigger) –
Returns:	Trigger If the method is called asynchronously, returns the request thread.

replace_triggers(bt_locator, **kwargs)¶

replace_triggers # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace_triggers(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) fields (str) – body (Triggers) –
Returns:	Triggers If the method is called asynchronously, returns the request thread.

replace_vcs_root_entries(bt_locator, **kwargs)¶

replace_vcs_root_entries # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace_vcs_root_entries(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) body (VcsRootEntries) – fields (str) –
Returns:	VcsRootEntries If the method is called asynchronously, returns the request thread.

serve_branches(bt_locator, **kwargs)¶

serve_branches # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_branches(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) locator (str) – fields (str) –
Returns:	Branches If the method is called asynchronously, returns the request thread.

serve_build_field(bt_locator, build_locator, field, **kwargs)¶

serve_build_field # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_build_field(bt_locator, build_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) build_locator (str) – (required) field (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

serve_build_type_builds_tags(bt_locator, field, **kwargs)¶

serve_build_type_builds_tags # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_build_type_builds_tags(bt_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) field (str) – (required)
Returns:	Tags If the method is called asynchronously, returns the request thread.

serve_build_type_field(bt_locator, field, **kwargs)¶

serve_build_type_field # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_build_type_field(bt_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) field (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

serve_build_type_xml(bt_locator, **kwargs)¶

serve_build_type_xml # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_build_type_xml(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) fields (str) –
Returns:	BuildType If the method is called asynchronously, returns the request thread.

serve_build_with_project(bt_locator, build_locator, **kwargs)¶

serve_build_with_project # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_build_with_project(bt_locator, build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) build_locator (str) – (required) fields (str) –
Returns:	Build If the method is called asynchronously, returns the request thread.

serve_builds(bt_locator, **kwargs)¶

serve_builds # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_builds(bt_locator, async_req=True) >>> result = thread.get()

Parameters:

async_req – bool
bt_locator (str) – (required)
status (str) –
triggered_by_user (str) –
include_personal (bool) –
include_canceled (bool) –
only_pinned (bool) –
tag (list[str]) –
agent_name (str) –
since_build (str) –
since_date (str) –
start (int) –
count (int) –
locator (str) –
fields (str) –

Returns:

Builds If the method is called asynchronously, returns the request thread.

set_build_type_field(bt_locator, field, **kwargs)¶

set_build_type_field # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_build_type_field(bt_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) field (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

set_parameter(bt_locator, **kwargs)¶

set_parameter # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_parameter(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) body (ModelProperty) – fields (str) –
Returns:	ModelProperty If the method is called asynchronously, returns the request thread.

set_parameter_0(name, bt_locator, **kwargs)¶

set_parameter_0 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_parameter_0(name, bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) bt_locator (str) – (required) body (ModelProperty) – fields (str) –
Returns:	ModelProperty If the method is called asynchronously, returns the request thread.

set_parameter_1(bt_locator, **kwargs)¶

set_parameter_1 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_parameter_1(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) body (ModelProperty) – fields (str) –
Returns:	ModelProperty If the method is called asynchronously, returns the request thread.

set_parameter_2(name, bt_locator, **kwargs)¶

set_parameter_2 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_parameter_2(name, bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) bt_locator (str) – (required) body (ModelProperty) – fields (str) –
Returns:	ModelProperty If the method is called asynchronously, returns the request thread.

set_parameter_type(name, bt_locator, **kwargs)¶

set_parameter_type # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_parameter_type(name, bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) bt_locator (str) – (required) body (Type) –
Returns:	Type If the method is called asynchronously, returns the request thread.

set_parameter_type_raw_value(name, bt_locator, **kwargs)¶

set_parameter_type_raw_value # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_parameter_type_raw_value(name, bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) bt_locator (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

set_parameter_value_long(name, bt_locator, **kwargs)¶

set_parameter_value_long # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_parameter_value_long(name, bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) bt_locator (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

set_parameter_value_long_0(name, bt_locator, **kwargs)¶

set_parameter_value_long_0 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_parameter_value_long_0(name, bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) bt_locator (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

set_parameters(bt_locator, **kwargs)¶

set_parameters # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_parameters(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) body (Properties) – fields (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

set_parameters_0(bt_locator, **kwargs)¶

set_parameters_0 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_parameters_0(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) body (Properties) – fields (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

set_templates(bt_locator, **kwargs)¶

set_templates # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_templates(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) body (BuildTypes) – optimize_settings (bool) – fields (str) –
Returns:	BuildTypes If the method is called asynchronously, returns the request thread.

set_vcs_labeling_options(bt_locator, **kwargs)¶

set_vcs_labeling_options # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_vcs_labeling_options(bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) body (VcsLabeling) –
Returns:	VcsLabeling If the method is called asynchronously, returns the request thread.

update_vcs_root_entry(bt_locator, vcs_root_locator, **kwargs)¶

update_vcs_root_entry # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_vcs_root_entry(bt_locator, vcs_root_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) vcs_root_locator (str) – (required) body (VcsRootEntry) – fields (str) –
Returns:	VcsRootEntry If the method is called asynchronously, returns the request thread.

update_vcs_root_entry_checkout_rules(bt_locator, vcs_root_locator, **kwargs)¶

update_vcs_root_entry_checkout_rules # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_vcs_root_entry_checkout_rules(bt_locator, vcs_root_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool bt_locator (str) – (required) vcs_root_locator (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

dohq_teamcity.api.change_api module¶

TeamCity REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 2018.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class dohq_teamcity.api.change_api.ChangeApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

base_name = 'Change'¶

get_change_attributes(change_locator, **kwargs)¶

get_change_attributes # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_change_attributes(change_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool change_locator (str) – (required) fields (str) –
Returns:	Entries If the method is called asynchronously, returns the request thread.

get_change_duplicates(change_locator, **kwargs)¶

get_change_duplicates # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_change_duplicates(change_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool change_locator (str) – (required) fields (str) –
Returns:	Changes If the method is called asynchronously, returns the request thread.

get_change_field(change_locator, field, **kwargs)¶

get_change_field # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_change_field(change_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool change_locator (str) – (required) field (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_change_first_builds(change_locator, **kwargs)¶

get_change_first_builds # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_change_first_builds(change_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool change_locator (str) – (required) fields (str) –
Returns:	Builds If the method is called asynchronously, returns the request thread.

get_change_issue(change_locator, **kwargs)¶

get_change_issue # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_change_issue(change_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool change_locator (str) – (required)
Returns:	Issues If the method is called asynchronously, returns the request thread.

get_change_parent_revisions(change_locator, **kwargs)¶

get_change_parent_revisions # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_change_parent_revisions(change_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool change_locator (str) – (required)
Returns:	Items If the method is called asynchronously, returns the request thread.

get_change_vcs_root(change_locator, **kwargs)¶

get_change_vcs_root # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_change_vcs_root(change_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool change_locator (str) – (required) fields (str) –
Returns:	VcsRootInstance If the method is called asynchronously, returns the request thread.

get_change_vcs_root_instance(change_locator, **kwargs)¶

get_change_vcs_root_instance # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_change_vcs_root_instance(change_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool change_locator (str) – (required) fields (str) –
Returns:	VcsRootInstance If the method is called asynchronously, returns the request thread.

get_parent_changes(change_locator, **kwargs)¶

get_parent_changes # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_parent_changes(change_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool change_locator (str) – (required) fields (str) –
Returns:	Changes If the method is called asynchronously, returns the request thread.

get_related_build_types(change_locator, **kwargs)¶

get_related_build_types # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_related_build_types(change_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool change_locator (str) – (required) fields (str) –
Returns:	BuildTypes If the method is called asynchronously, returns the request thread.

serve_change(change_locator, **kwargs)¶

serve_change # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_change(change_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool change_locator (str) – (required) fields (str) –
Returns:	Change If the method is called asynchronously, returns the request thread.

serve_changes(**kwargs)¶

serve_changes # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_changes(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project (str) – build_type (str) – build (str) – vcs_root (str) – since_change (str) – start (int) – count (int) – locator (str) – fields (str) –
Returns:	Changes If the method is called asynchronously, returns the request thread.

dohq_teamcity.api.debug_api module¶

TeamCity REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 2018.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class dohq_teamcity.api.debug_api.DebugApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

base_name = 'Debug'¶

delete_current_remember_me(**kwargs)¶

delete_current_remember_me # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_current_remember_me(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool
Returns:	None If the method is called asynchronously, returns the request thread.

empty_task(**kwargs)¶

empty_task # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.empty_task(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool time (str) – load (int) – memory (int) – memory_chunks (int) –
Returns:	str If the method is called asynchronously, returns the request thread.

execute_db_query(query, **kwargs)¶

execute_db_query # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.execute_db_query(query, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool query (str) – (required) field_delimiter (str) – data_retrieve_query (str) – count (int) –
Returns:	str If the method is called asynchronously, returns the request thread.

get_build_chain_optimization_log(build_locator, **kwargs)¶

get_build_chain_optimization_log # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_build_chain_optimization_log(build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_locator (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_cached_build_promotions(**kwargs)¶

get_cached_build_promotions # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_cached_build_promotions(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool build_type_locator (str) – fields (str) –
Returns:	Builds If the method is called asynchronously, returns the request thread.

get_cached_build_promotions_stats(**kwargs)¶

get_cached_build_promotions_stats # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_cached_build_promotions_stats(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool fields (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

get_cached_builds_stat(**kwargs)¶

get_cached_builds_stat # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_cached_builds_stat(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool fields (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

get_current_session(**kwargs)¶

get_current_session # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_current_session(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool fields (str) –
Returns:	Session If the method is called asynchronously, returns the request thread.

get_current_session_max_inactive_interval(**kwargs)¶

get_current_session_max_inactive_interval # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_current_session_max_inactive_interval(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool
Returns:	str If the method is called asynchronously, returns the request thread.

get_current_user_permissions(**kwargs)¶

get_current_user_permissions # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_current_user_permissions(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool
Returns:	str If the method is called asynchronously, returns the request thread.

get_date(date_locator, **kwargs)¶

get_date # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_date(date_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool date_locator (str) – (required) format (str) – timezone (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

get_diagnostics_perf_stats(**kwargs)¶

get_diagnostics_perf_stats # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_diagnostics_perf_stats(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool fields (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

get_environment_variables(**kwargs)¶

get_environment_variables # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_environment_variables(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool fields (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

get_hashed(method, **kwargs)¶

get_hashed # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_hashed(method, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool method (str) – (required) value (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

get_ip_address(host, **kwargs)¶

get_ip_address # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_ip_address(host, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool host (str) – (required)
Returns:	Items If the method is called asynchronously, returns the request thread.

get_raw_investigations(**kwargs)¶

get_raw_investigations # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_raw_investigations(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool fields (str) –
Returns:	Investigations If the method is called asynchronously, returns the request thread.

get_request_details(extra, **kwargs)¶

get_request_details # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_request_details(extra, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool extra (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_scrambled(**kwargs)¶

get_scrambled # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_scrambled(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool value (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

get_sessions(**kwargs)¶

get_sessions # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_sessions(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool manager (int) – fields (str) –
Returns:	Sessions If the method is called asynchronously, returns the request thread.

get_system_properties(**kwargs)¶

get_system_properties # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_system_properties(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool fields (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

get_thread_dump(**kwargs)¶

get_thread_dump # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_thread_dump(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool locked_monitors (str) – locked_synchronizers (str) – detect_locks (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

get_thread_interrupted(thread_locator, **kwargs)¶

get_thread_interrupted # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_thread_interrupted(thread_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool thread_locator (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_unscrambled(**kwargs)¶

get_unscrambled # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_unscrambled(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool value (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

interrupt_thread(thread_locator, **kwargs)¶

interrupt_thread # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.interrupt_thread(thread_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool thread_locator (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

invalidate_current_session(**kwargs)¶

invalidate_current_session # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.invalidate_current_session(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool
Returns:	None If the method is called asynchronously, returns the request thread.

list_db_tables(**kwargs)¶

list_db_tables # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_db_tables(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool
Returns:	str If the method is called asynchronously, returns the request thread.

new_remember_me(**kwargs)¶

new_remember_me # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.new_remember_me(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool
Returns:	str If the method is called asynchronously, returns the request thread.

post_request_details(extra, **kwargs)¶

post_request_details # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.post_request_details(extra, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool extra (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

put_request_details(extra, **kwargs)¶

put_request_details # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.put_request_details(extra, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool extra (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

save_memory_dump(**kwargs)¶

save_memory_dump # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.save_memory_dump(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool archived (bool) –
Returns:	str If the method is called asynchronously, returns the request thread.

schedule_checking_for_changes(**kwargs)¶

schedule_checking_for_changes # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.schedule_checking_for_changes(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool locator (str) – requestor (str) – fields (str) –
Returns:	VcsRootInstances If the method is called asynchronously, returns the request thread.

set_current_session_max_inactive_interval(**kwargs)¶

set_current_session_max_inactive_interval # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_current_session_max_inactive_interval(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

dohq_teamcity.api.default_api module¶

TeamCity REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 2018.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class dohq_teamcity.api.default_api.DefaultApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

base_name = 'default'¶

serve_api_version(**kwargs)¶

serve_api_version # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_api_version(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool
Returns:	str If the method is called asynchronously, returns the request thread.

serve_build_field_short(project_locator, bt_locator, build_locator, field, **kwargs)¶

serve_build_field_short # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_build_field_short(project_locator, bt_locator, build_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) bt_locator (str) – (required) build_locator (str) – (required) field (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

serve_plugin_info(**kwargs)¶

serve_plugin_info # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_plugin_info(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool fields (str) –
Returns:	Plugin If the method is called asynchronously, returns the request thread.

serve_root(**kwargs)¶

serve_root # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_root(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool
Returns:	str If the method is called asynchronously, returns the request thread.

serve_version(**kwargs)¶

serve_version # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_version(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool
Returns:	str If the method is called asynchronously, returns the request thread.

dohq_teamcity.api.federation_api module¶

TeamCity REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 2018.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class dohq_teamcity.api.federation_api.FederationApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

add_server(**kwargs)¶

add_server # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_server(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool body (Servers) –
Returns:	Servers If the method is called asynchronously, returns the request thread.

base_name = 'Federation'¶

servers(**kwargs)¶

servers # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.servers(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool fields (str) –
Returns:	Servers If the method is called asynchronously, returns the request thread.

dohq_teamcity.api.group_api module¶

TeamCity REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 2018.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class dohq_teamcity.api.group_api.GroupApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

add_group(**kwargs)¶

add_group # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_group(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool body (Group) – fields (str) –
Returns:	Group If the method is called asynchronously, returns the request thread.

add_role(group_locator, **kwargs)¶

add_role # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_role(group_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool group_locator (str) – (required) body (Role) –
Returns:	Role If the method is called asynchronously, returns the request thread.

add_role_simple(group_locator, role_id, scope, **kwargs)¶

add_role_simple # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_role_simple(group_locator, role_id, scope, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool group_locator (str) – (required) role_id (str) – (required) scope (str) – (required)
Returns:	Role If the method is called asynchronously, returns the request thread.

base_name = 'Group'¶

delete_group(group_locator, **kwargs)¶

delete_group # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_group(group_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool group_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_role(group_locator, role_id, scope, **kwargs)¶

delete_role # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_role(group_locator, role_id, scope, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool group_locator (str) – (required) role_id (str) – (required) scope (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

get_parent_groups(group_locator, **kwargs)¶

get_parent_groups # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_parent_groups(group_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool group_locator (str) – (required) fields (str) –
Returns:	Groups If the method is called asynchronously, returns the request thread.

get_permissions(group_locator, **kwargs)¶

get_permissions # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_permissions(group_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool group_locator (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_properties(group_locator, **kwargs)¶

get_properties # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_properties(group_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool group_locator (str) – (required) fields (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

list_role(group_locator, role_id, scope, **kwargs)¶

list_role # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_role(group_locator, role_id, scope, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool group_locator (str) – (required) role_id (str) – (required) scope (str) – (required)
Returns:	Role If the method is called asynchronously, returns the request thread.

list_roles(group_locator, **kwargs)¶

list_roles # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_roles(group_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool group_locator (str) – (required)
Returns:	Roles If the method is called asynchronously, returns the request thread.

put_user_property(group_locator, name, **kwargs)¶

put_user_property # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.put_user_property(group_locator, name, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool group_locator (str) – (required) name (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

remove_user_property(group_locator, name, **kwargs)¶

remove_user_property # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.remove_user_property(group_locator, name, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool group_locator (str) – (required) name (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

serve_group(group_locator, **kwargs)¶

serve_group # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_group(group_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool group_locator (str) – (required) fields (str) –
Returns:	Group If the method is called asynchronously, returns the request thread.

serve_groups(**kwargs)¶

serve_groups # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_groups(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool fields (str) –
Returns:	Groups If the method is called asynchronously, returns the request thread.

serve_user_properties(group_locator, name, **kwargs)¶

serve_user_properties # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_user_properties(group_locator, name, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool group_locator (str) – (required) name (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

set_parent_groups(group_locator, **kwargs)¶

set_parent_groups # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_parent_groups(group_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool group_locator (str) – (required) body (Groups) – fields (str) –
Returns:	Groups If the method is called asynchronously, returns the request thread.

set_roles(group_locator, **kwargs)¶

set_roles # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_roles(group_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool group_locator (str) – (required) body (Roles) –
Returns:	Roles If the method is called asynchronously, returns the request thread.

dohq_teamcity.api.investigation_api module¶

TeamCity REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 2018.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class dohq_teamcity.api.investigation_api.InvestigationApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

base_name = 'Investigation'¶

create_instance(**kwargs)¶

create_instance # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_instance(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool body (Investigation) – fields (str) –
Returns:	Investigation If the method is called asynchronously, returns the request thread.

create_instances(**kwargs)¶

create_instances # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_instances(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool body (Investigations) – fields (str) –
Returns:	Investigations If the method is called asynchronously, returns the request thread.

delete_instance(investigation_locator, **kwargs)¶

delete_instance # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_instance(investigation_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool investigation_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

get_investigations(**kwargs)¶

get_investigations # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_investigations(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool locator (str) – fields (str) –
Returns:	Investigations If the method is called asynchronously, returns the request thread.

replace_instance(investigation_locator, **kwargs)¶

replace_instance # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace_instance(investigation_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool investigation_locator (str) – (required) body (Investigation) – fields (str) –
Returns:	Investigation If the method is called asynchronously, returns the request thread.

serve_instance(investigation_locator, **kwargs)¶

serve_instance # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_instance(investigation_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool investigation_locator (str) – (required) fields (str) –
Returns:	Investigation If the method is called asynchronously, returns the request thread.

dohq_teamcity.api.problem_api module¶

TeamCity REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 2018.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class dohq_teamcity.api.problem_api.ProblemApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

base_name = 'Problem'¶

get_problems(**kwargs)¶

get_problems # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_problems(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool locator (str) – fields (str) –
Returns:	Problems If the method is called asynchronously, returns the request thread.

serve_instance(problem_locator, **kwargs)¶

serve_instance # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_instance(problem_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool problem_locator (str) – (required) fields (str) –
Returns:	Problem If the method is called asynchronously, returns the request thread.

dohq_teamcity.api.problem_occurrence_api module¶

TeamCity REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 2018.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class dohq_teamcity.api.problem_occurrence_api.ProblemOccurrenceApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

base_name = 'ProblemOccurrence'¶

get_problems(**kwargs)¶

get_problems # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_problems(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool locator (str) – fields (str) –
Returns:	ProblemOccurrences If the method is called asynchronously, returns the request thread.

serve_instance(problem_locator, **kwargs)¶

serve_instance # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_instance(problem_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool problem_locator (str) – (required) fields (str) –
Returns:	ProblemOccurrence If the method is called asynchronously, returns the request thread.

dohq_teamcity.api.project_api module¶

TeamCity REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 2018.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class dohq_teamcity.api.project_api.ProjectApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

add(project_locator, **kwargs)¶

add # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) body (ProjectFeature) – fields (str) –
Returns:	object If the method is called asynchronously, returns the request thread.

base_name = 'Project'¶

create_build_type(project_locator, **kwargs)¶

create_build_type # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_build_type(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) body (NewBuildTypeDescription) – fields (str) –
Returns:	BuildType If the method is called asynchronously, returns the request thread.

create_build_type_template(project_locator, **kwargs)¶

create_build_type_template # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_build_type_template(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) body (NewBuildTypeDescription) – fields (str) –
Returns:	BuildType If the method is called asynchronously, returns the request thread.

create_project(**kwargs)¶

create_project # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_project(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool body (NewProjectDescription) –
Returns:	Project If the method is called asynchronously, returns the request thread.

create_secure_token(project_locator, **kwargs)¶

create_secure_token # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_secure_token(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

delete(feature_locator, project_locator, **kwargs)¶

delete # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete(feature_locator, project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool feature_locator (str) – (required) project_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_all_parameters(project_locator, **kwargs)¶

delete_all_parameters # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_parameters(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_all_parameters_0(feature_locator, project_locator, **kwargs)¶

delete_all_parameters_0 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_parameters_0(feature_locator, project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool feature_locator (str) – (required) project_locator (str) – (required) fields (str) –
Returns:	None If the method is called asynchronously, returns the request thread.

delete_parameter(name, project_locator, **kwargs)¶

delete_parameter # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_parameter(name, project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) project_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_parameter_0(name, feature_locator, project_locator, **kwargs)¶

delete_parameter_0 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_parameter_0(name, feature_locator, project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) feature_locator (str) – (required) project_locator (str) – (required) fields (str) –
Returns:	None If the method is called asynchronously, returns the request thread.

delete_project(project_locator, **kwargs)¶

delete_project # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_project(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_project_agent_pools(project_locator, agent_pool_locator, **kwargs)¶

delete_project_agent_pools # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_project_agent_pools(project_locator, agent_pool_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) agent_pool_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

get(project_locator, **kwargs)¶

get # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) locator (str) – fields (str) –
Returns:	object If the method is called asynchronously, returns the request thread.

get_branches(project_locator, **kwargs)¶

get_branches # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_branches(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) locator (str) – fields (str) –
Returns:	Branches If the method is called asynchronously, returns the request thread.

get_build_types_order(project_locator, field, **kwargs)¶

get_build_types_order # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_build_types_order(project_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) field (str) – (required)
Returns:	BuildTypes If the method is called asynchronously, returns the request thread.

get_default_template(project_locator, **kwargs)¶

get_default_template # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_default_template(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) fields (str) –
Returns:	BuildType If the method is called asynchronously, returns the request thread.

get_example_new_project_description(project_locator, **kwargs)¶

get_example_new_project_description # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_example_new_project_description(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) id (str) –
Returns:	NewProjectDescription If the method is called asynchronously, returns the request thread.

get_example_new_project_description_compatibility_version1(project_locator, **kwargs)¶

get_example_new_project_description_compatibility_version1 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_example_new_project_description_compatibility_version1(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) id (str) –
Returns:	NewProjectDescription If the method is called asynchronously, returns the request thread.

get_parameter(name, project_locator, **kwargs)¶

get_parameter # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_parameter(name, project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) project_locator (str) – (required) fields (str) –
Returns:	ModelProperty If the method is called asynchronously, returns the request thread.

get_parameter_0(name, feature_locator, project_locator, **kwargs)¶

get_parameter_0 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_parameter_0(name, feature_locator, project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) feature_locator (str) – (required) project_locator (str) – (required) fields (str) – fields2 (str) –
Returns:	ModelProperty If the method is called asynchronously, returns the request thread.

get_parameter_type(name, project_locator, **kwargs)¶

get_parameter_type # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_parameter_type(name, project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) project_locator (str) – (required)
Returns:	Type If the method is called asynchronously, returns the request thread.

get_parameter_type_raw_value(name, project_locator, **kwargs)¶

get_parameter_type_raw_value # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_parameter_type_raw_value(name, project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) project_locator (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_parameter_value_long(name, project_locator, **kwargs)¶

get_parameter_value_long # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_parameter_value_long(name, project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) project_locator (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_parameter_value_long_0(name, feature_locator, project_locator, **kwargs)¶

get_parameter_value_long_0 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_parameter_value_long_0(name, feature_locator, project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) feature_locator (str) – (required) project_locator (str) – (required) fields (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

get_parameters(project_locator, **kwargs)¶

get_parameters # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_parameters(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) locator (str) – fields (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

get_parameters_0(feature_locator, project_locator, **kwargs)¶

get_parameters_0 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_parameters_0(feature_locator, project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool feature_locator (str) – (required) project_locator (str) – (required) locator (str) – fields (str) – fields2 (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

get_parent_project(project_locator, **kwargs)¶

get_parent_project # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_parent_project(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) fields (str) –
Returns:	Project If the method is called asynchronously, returns the request thread.

get_project_agent_pools(project_locator, **kwargs)¶

get_project_agent_pools # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_project_agent_pools(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) fields (str) –
Returns:	AgentPools If the method is called asynchronously, returns the request thread.

get_projects_order(project_locator, field, **kwargs)¶

get_projects_order # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_projects_order(project_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) field (str) – (required)
Returns:	Projects If the method is called asynchronously, returns the request thread.

get_secure_value(project_locator, token, **kwargs)¶

get_secure_value # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_secure_value(project_locator, token, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) token (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_settings_file(project_locator, **kwargs)¶

get_settings_file # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_settings_file(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_single(feature_locator, project_locator, **kwargs)¶

get_single # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_single(feature_locator, project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool feature_locator (str) – (required) project_locator (str) – (required) fields (str) –
Returns:	object If the method is called asynchronously, returns the request thread.

reload_settings_file(project_locator, **kwargs)¶

reload_settings_file # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.reload_settings_file(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) fields (str) –
Returns:	Project If the method is called asynchronously, returns the request thread.

remove_default_template(project_locator, **kwargs)¶

remove_default_template # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.remove_default_template(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) fields (str) –
Returns:	None If the method is called asynchronously, returns the request thread.

replace(feature_locator, project_locator, **kwargs)¶

replace # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace(feature_locator, project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool feature_locator (str) – (required) project_locator (str) – (required) body (ProjectFeature) – fields (str) –
Returns:	object If the method is called asynchronously, returns the request thread.

replace_all(project_locator, **kwargs)¶

replace_all # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace_all(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) body (ProjectFeatures) – fields (str) –
Returns:	object If the method is called asynchronously, returns the request thread.

serve_build_field_with_project(project_locator, bt_locator, build_locator, field, **kwargs)¶

serve_build_field_with_project # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_build_field_with_project(project_locator, bt_locator, build_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) bt_locator (str) – (required) build_locator (str) – (required) field (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

serve_build_type(project_locator, bt_locator, **kwargs)¶

serve_build_type # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_build_type(project_locator, bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) bt_locator (str) – (required) fields (str) –
Returns:	BuildType If the method is called asynchronously, returns the request thread.

serve_build_type_field_with_project(project_locator, bt_locator, field, **kwargs)¶

serve_build_type_field_with_project # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_build_type_field_with_project(project_locator, bt_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) bt_locator (str) – (required) field (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

serve_build_type_templates(project_locator, bt_locator, **kwargs)¶

serve_build_type_templates # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_build_type_templates(project_locator, bt_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) bt_locator (str) – (required) fields (str) –
Returns:	BuildType If the method is called asynchronously, returns the request thread.

serve_build_types_in_project(project_locator, **kwargs)¶

serve_build_types_in_project # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_build_types_in_project(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) fields (str) –
Returns:	BuildTypes If the method is called asynchronously, returns the request thread.

serve_build_with_project(project_locator, bt_locator, build_locator, **kwargs)¶

serve_build_with_project # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_build_with_project(project_locator, bt_locator, build_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) bt_locator (str) – (required) build_locator (str) – (required) fields (str) –
Returns:	Build If the method is called asynchronously, returns the request thread.

serve_builds(project_locator, bt_locator, **kwargs)¶

serve_builds # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_builds(project_locator, bt_locator, async_req=True) >>> result = thread.get()

Parameters:

async_req – bool
project_locator (str) – (required)
bt_locator (str) – (required)
status (str) –
triggered_by_user (str) –
include_personal (bool) –
include_canceled (bool) –
only_pinned (bool) –
tag (list[str]) –
agent_name (str) –
since_build (str) –
since_date (str) –
start (int) –
count (int) –
locator (str) –
fields (str) –

Returns:

Builds If the method is called asynchronously, returns the request thread.

serve_project(project_locator, **kwargs)¶

serve_project # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_project(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) fields (str) –
Returns:	Project If the method is called asynchronously, returns the request thread.

serve_project_field(project_locator, field, **kwargs)¶

serve_project_field # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_project_field(project_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) field (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

serve_projects(**kwargs)¶

serve_projects # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_projects(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool locator (str) – fields (str) –
Returns:	Projects If the method is called asynchronously, returns the request thread.

serve_templates_in_project(project_locator, **kwargs)¶

serve_templates_in_project # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_templates_in_project(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) fields (str) –
Returns:	BuildTypes If the method is called asynchronously, returns the request thread.

set_build_types_order(project_locator, field, **kwargs)¶

set_build_types_order # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_build_types_order(project_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) field (str) – (required) body (BuildTypes) –
Returns:	BuildTypes If the method is called asynchronously, returns the request thread.

set_default_template(project_locator, **kwargs)¶

set_default_template # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_default_template(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) body (BuildType) – fields (str) –
Returns:	BuildType If the method is called asynchronously, returns the request thread.

set_parameter(project_locator, **kwargs)¶

set_parameter # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_parameter(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) body (ModelProperty) – fields (str) –
Returns:	ModelProperty If the method is called asynchronously, returns the request thread.

set_parameter_0(name, project_locator, **kwargs)¶

set_parameter_0 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_parameter_0(name, project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) project_locator (str) – (required) body (ModelProperty) – fields (str) –
Returns:	ModelProperty If the method is called asynchronously, returns the request thread.

set_parameter_1(feature_locator, project_locator, **kwargs)¶

set_parameter_1 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_parameter_1(feature_locator, project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool feature_locator (str) – (required) project_locator (str) – (required) body (ModelProperty) – fields (str) – fields2 (str) –
Returns:	ModelProperty If the method is called asynchronously, returns the request thread.

set_parameter_2(name, feature_locator, project_locator, **kwargs)¶

set_parameter_2 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_parameter_2(name, feature_locator, project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) feature_locator (str) – (required) project_locator (str) – (required) body (ModelProperty) – fields (str) – fields2 (str) –
Returns:	ModelProperty If the method is called asynchronously, returns the request thread.

set_parameter_type(name, project_locator, **kwargs)¶

set_parameter_type # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_parameter_type(name, project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) project_locator (str) – (required) body (Type) –
Returns:	Type If the method is called asynchronously, returns the request thread.

set_parameter_type_raw_value(name, project_locator, **kwargs)¶

set_parameter_type_raw_value # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_parameter_type_raw_value(name, project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) project_locator (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

set_parameter_value_long(name, project_locator, **kwargs)¶

set_parameter_value_long # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_parameter_value_long(name, project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) project_locator (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

set_parameter_value_long_0(name, feature_locator, project_locator, **kwargs)¶

set_parameter_value_long_0 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_parameter_value_long_0(name, feature_locator, project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool name (str) – (required) feature_locator (str) – (required) project_locator (str) – (required) body (str) – fields (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

set_parameters(project_locator, **kwargs)¶

set_parameters # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_parameters(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) body (Properties) – fields (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

set_parameters_0(feature_locator, project_locator, **kwargs)¶

set_parameters_0 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_parameters_0(feature_locator, project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool feature_locator (str) – (required) project_locator (str) – (required) body (Properties) – fields (str) – fields2 (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

set_parent_project(project_locator, **kwargs)¶

set_parent_project # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_parent_project(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) body (Project) – fields (str) –
Returns:	Project If the method is called asynchronously, returns the request thread.

set_project_agent_pools(project_locator, **kwargs)¶

set_project_agent_pools # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_project_agent_pools(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) body (AgentPools) – fields (str) –
Returns:	AgentPools If the method is called asynchronously, returns the request thread.

set_project_agent_pools_0(project_locator, **kwargs)¶

set_project_agent_pools_0 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_project_agent_pools_0(project_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) body (AgentPool) –
Returns:	AgentPool If the method is called asynchronously, returns the request thread.

set_project_field(project_locator, field, **kwargs)¶

set_project_field # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_project_field(project_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) field (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

set_projects_order(project_locator, field, **kwargs)¶

set_projects_order # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_projects_order(project_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool project_locator (str) – (required) field (str) – (required) body (Projects) –
Returns:	Projects If the method is called asynchronously, returns the request thread.

dohq_teamcity.api.server_api module¶

TeamCity REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 2018.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class dohq_teamcity.api.server_api.ServerApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

add_license_keys(**kwargs)¶

add_license_keys # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_license_keys(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool body (str) – fields (str) –
Returns:	LicenseKeys If the method is called asynchronously, returns the request thread.

base_name = 'Server'¶

delete_license_key(license_key, **kwargs)¶

delete_license_key # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_license_key(license_key, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool license_key (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

get_backup_status(**kwargs)¶

get_backup_status # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_backup_status(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool body (BackupProcessManager) –
Returns:	str If the method is called asynchronously, returns the request thread.

get_children(path, area_id, **kwargs)¶

get_children # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_children(path, area_id, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool path (str) – (required) area_id (str) – (required) base_path (str) – locator (str) – fields (str) –
Returns:	Files If the method is called asynchronously, returns the request thread.

get_children_alias(path, area_id, **kwargs)¶

get_children_alias # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_children_alias(path, area_id, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool path (str) – (required) area_id (str) – (required) base_path (str) – locator (str) – fields (str) –
Returns:	Files If the method is called asynchronously, returns the request thread.

get_content(path, area_id, **kwargs)¶

get_content # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_content(path, area_id, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool path (str) – (required) area_id (str) – (required) response_builder (str) –
Returns:	None If the method is called asynchronously, returns the request thread.

get_content_alias(path, area_id, **kwargs)¶

get_content_alias # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_content_alias(path, area_id, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool path (str) – (required) area_id (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

get_license_key(license_key, **kwargs)¶

get_license_key # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_license_key(license_key, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool license_key (str) – (required) fields (str) –
Returns:	LicenseKey If the method is called asynchronously, returns the request thread.

get_license_keys(**kwargs)¶

get_license_keys # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_license_keys(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool fields (str) –
Returns:	LicenseKeys If the method is called asynchronously, returns the request thread.

get_licensing_data(**kwargs)¶

get_licensing_data # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_licensing_data(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool fields (str) –
Returns:	LicensingData If the method is called asynchronously, returns the request thread.

get_metadata(path, area_id, **kwargs)¶

get_metadata # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_metadata(path, area_id, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool path (str) – (required) area_id (str) – (required) fields (str) –
Returns:	file If the method is called asynchronously, returns the request thread.

get_root(area_id, **kwargs)¶

get_root # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_root(area_id, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool area_id (str) – (required) base_path (str) – locator (str) – fields (str) –
Returns:	Files If the method is called asynchronously, returns the request thread.

get_zipped(path, area_id, **kwargs)¶

get_zipped # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_zipped(path, area_id, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool path (str) – (required) area_id (str) – (required) base_path (str) – locator (str) – name (str) –
Returns:	None If the method is called asynchronously, returns the request thread.

serve_plugins(**kwargs)¶

serve_plugins # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_plugins(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool fields (str) –
Returns:	Plugins If the method is called asynchronously, returns the request thread.

serve_server_info(**kwargs)¶

serve_server_info # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_server_info(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool fields (str) –
Returns:	Server If the method is called asynchronously, returns the request thread.

serve_server_version(field, **kwargs)¶

serve_server_version # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_server_version(field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool field (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

start_backup(**kwargs)¶

start_backup # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.start_backup(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool file_name (str) – add_timestamp (bool) – include_configs (bool) – include_database (bool) – include_build_logs (bool) – include_personal_changes (bool) – include_running_builds (bool) – include_supplimentary_data (bool) – body (BackupProcessManager) –
Returns:	str If the method is called asynchronously, returns the request thread.

dohq_teamcity.api.test_api module¶

TeamCity REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 2018.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class dohq_teamcity.api.test_api.TestApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

base_name = 'Test'¶

get_tests(**kwargs)¶

get_tests # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_tests(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool locator (str) – fields (str) –
Returns:	Tests If the method is called asynchronously, returns the request thread.

serve_instance(test_locator, **kwargs)¶

serve_instance # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_instance(test_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool test_locator (str) – (required) fields (str) –
Returns:	Test If the method is called asynchronously, returns the request thread.

dohq_teamcity.api.test_occurrence_api module¶

TeamCity REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 2018.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class dohq_teamcity.api.test_occurrence_api.TestOccurrenceApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

base_name = 'TestOccurrence'¶

get_test_occurrences(**kwargs)¶

get_test_occurrences # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_test_occurrences(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool locator (str) – fields (str) –
Returns:	TestOccurrences If the method is called asynchronously, returns the request thread.

serve_instance(test_locator, **kwargs)¶

serve_instance # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_instance(test_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool test_locator (str) – (required) fields (str) –
Returns:	TestOccurrence If the method is called asynchronously, returns the request thread.

dohq_teamcity.api.user_api module¶

TeamCity REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 2018.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class dohq_teamcity.api.user_api.UserApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

add_group(user_locator, **kwargs)¶

add_group # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_group(user_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool user_locator (str) – (required) body (Group) – fields (str) –
Returns:	Group If the method is called asynchronously, returns the request thread.

add_role(user_locator, **kwargs)¶

add_role # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_role(user_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool user_locator (str) – (required) body (Role) –
Returns:	Role If the method is called asynchronously, returns the request thread.

add_role_simple(user_locator, role_id, scope, **kwargs)¶

add_role_simple # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_role_simple(user_locator, role_id, scope, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool user_locator (str) – (required) role_id (str) – (required) scope (str) – (required)
Returns:	Role If the method is called asynchronously, returns the request thread.

add_role_simple_post(user_locator, role_id, scope, **kwargs)¶

add_role_simple_post # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_role_simple_post(user_locator, role_id, scope, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool user_locator (str) – (required) role_id (str) – (required) scope (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

base_name = 'User'¶

create_user(**kwargs)¶

create_user # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_user(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool body (User) – fields (str) –
Returns:	User If the method is called asynchronously, returns the request thread.

delete_remember_me(user_locator, **kwargs)¶

delete_remember_me # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_remember_me(user_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool user_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_role(user_locator, role_id, scope, **kwargs)¶

delete_role # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_role(user_locator, role_id, scope, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool user_locator (str) – (required) role_id (str) – (required) scope (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_user(user_locator, **kwargs)¶

delete_user # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_user(user_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool user_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_user_field(user_locator, field, **kwargs)¶

delete_user_field # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_user_field(user_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool user_locator (str) – (required) field (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

get_group(user_locator, group_locator, **kwargs)¶

get_group # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_group(user_locator, group_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool user_locator (str) – (required) group_locator (str) – (required) fields (str) –
Returns:	Group If the method is called asynchronously, returns the request thread.

get_groups(user_locator, **kwargs)¶

get_groups # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_groups(user_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool user_locator (str) – (required) fields (str) –
Returns:	Groups If the method is called asynchronously, returns the request thread.

get_permissions(user_locator, **kwargs)¶

get_permissions # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_permissions(user_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool user_locator (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_permissions_0(user_locator, **kwargs)¶

get_permissions_0 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_permissions_0(user_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool user_locator (str) – (required) locator (str) – fields (str) –
Returns:	PermissionAssignments If the method is called asynchronously, returns the request thread.

list_role(user_locator, role_id, scope, **kwargs)¶

list_role # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_role(user_locator, role_id, scope, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool user_locator (str) – (required) role_id (str) – (required) scope (str) – (required)
Returns:	Role If the method is called asynchronously, returns the request thread.

list_roles(user_locator, **kwargs)¶

list_roles # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_roles(user_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool user_locator (str) – (required)
Returns:	Roles If the method is called asynchronously, returns the request thread.

put_user_property(user_locator, name, **kwargs)¶

put_user_property # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.put_user_property(user_locator, name, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool user_locator (str) – (required) name (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

remove_group(user_locator, group_locator, **kwargs)¶

remove_group # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.remove_group(user_locator, group_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool user_locator (str) – (required) group_locator (str) – (required) fields (str) –
Returns:	None If the method is called asynchronously, returns the request thread.

remove_user_property(user_locator, name, **kwargs)¶

remove_user_property # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.remove_user_property(user_locator, name, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool user_locator (str) – (required) name (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

replace_groups(user_locator, **kwargs)¶

replace_groups # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace_groups(user_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool user_locator (str) – (required) body (Groups) – fields (str) –
Returns:	Groups If the method is called asynchronously, returns the request thread.

replace_roles(user_locator, **kwargs)¶

replace_roles # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace_roles(user_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool user_locator (str) – (required) body (Roles) –
Returns:	Roles If the method is called asynchronously, returns the request thread.

serve_user(user_locator, **kwargs)¶

serve_user # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_user(user_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool user_locator (str) – (required) fields (str) –
Returns:	User If the method is called asynchronously, returns the request thread.

serve_user_field(user_locator, field, **kwargs)¶

serve_user_field # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_user_field(user_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool user_locator (str) – (required) field (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

serve_user_properties(user_locator, **kwargs)¶

serve_user_properties # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_user_properties(user_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool user_locator (str) – (required) fields (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

serve_user_property(user_locator, name, **kwargs)¶

serve_user_property # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_user_property(user_locator, name, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool user_locator (str) – (required) name (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

serve_users(**kwargs)¶

serve_users # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_users(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool locator (str) – fields (str) –
Returns:	Users If the method is called asynchronously, returns the request thread.

set_user_field(user_locator, field, **kwargs)¶

set_user_field # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_user_field(user_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool user_locator (str) – (required) field (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

update_user(user_locator, **kwargs)¶

update_user # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_user(user_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool user_locator (str) – (required) body (User) – fields (str) –
Returns:	User If the method is called asynchronously, returns the request thread.

dohq_teamcity.api.vcs_root_api module¶

TeamCity REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 2018.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class dohq_teamcity.api.vcs_root_api.VcsRootApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

add_root(**kwargs)¶

add_root # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.add_root(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool body (VcsRoot) – fields (str) –
Returns:	VcsRoot If the method is called asynchronously, returns the request thread.

base_name = 'VcsRoot'¶

change_properties(vcs_root_locator, **kwargs)¶

change_properties # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.change_properties(vcs_root_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool vcs_root_locator (str) – (required) body (Properties) – fields (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

delete_all_properties(vcs_root_locator, **kwargs)¶

delete_all_properties # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_all_properties(vcs_root_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool vcs_root_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_parameter(vcs_root_locator, name, **kwargs)¶

delete_parameter # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_parameter(vcs_root_locator, name, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool vcs_root_locator (str) – (required) name (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_root(vcs_root_locator, **kwargs)¶

delete_root # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_root(vcs_root_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool vcs_root_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

get_settings_file(vcs_root_locator, **kwargs)¶

get_settings_file # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_settings_file(vcs_root_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool vcs_root_locator (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

put_parameter(vcs_root_locator, name, **kwargs)¶

put_parameter # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.put_parameter(vcs_root_locator, name, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool vcs_root_locator (str) – (required) name (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

serve_field(vcs_root_locator, field, **kwargs)¶

serve_field # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_field(vcs_root_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool vcs_root_locator (str) – (required) field (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

serve_instance_field(vcs_root_locator, vcs_root_instance_locator, field, **kwargs)¶

serve_instance_field # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_instance_field(vcs_root_locator, vcs_root_instance_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool vcs_root_locator (str) – (required) vcs_root_instance_locator (str) – (required) field (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

serve_properties(vcs_root_locator, **kwargs)¶

serve_properties # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_properties(vcs_root_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool vcs_root_locator (str) – (required) fields (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

serve_property(vcs_root_locator, name, **kwargs)¶

serve_property # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_property(vcs_root_locator, name, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool vcs_root_locator (str) – (required) name (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

serve_root(vcs_root_locator, **kwargs)¶

serve_root # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_root(vcs_root_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool vcs_root_locator (str) – (required) fields (str) –
Returns:	VcsRoot If the method is called asynchronously, returns the request thread.

serve_root_instance(vcs_root_locator, vcs_root_instance_locator, **kwargs)¶

serve_root_instance # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_root_instance(vcs_root_locator, vcs_root_instance_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool vcs_root_locator (str) – (required) vcs_root_instance_locator (str) – (required) fields (str) –
Returns:	VcsRootInstance If the method is called asynchronously, returns the request thread.

serve_root_instance_properties(vcs_root_locator, vcs_root_instance_locator, **kwargs)¶

serve_root_instance_properties # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_root_instance_properties(vcs_root_locator, vcs_root_instance_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool vcs_root_locator (str) – (required) vcs_root_instance_locator (str) – (required) fields (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

serve_root_instances(vcs_root_locator, **kwargs)¶

serve_root_instances # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_root_instances(vcs_root_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool vcs_root_locator (str) – (required) fields (str) –
Returns:	VcsRootInstances If the method is called asynchronously, returns the request thread.

serve_roots(**kwargs)¶

serve_roots # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_roots(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool locator (str) – fields (str) –
Returns:	VcsRoots If the method is called asynchronously, returns the request thread.

set_field(vcs_root_locator, field, **kwargs)¶

set_field # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_field(vcs_root_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool vcs_root_locator (str) – (required) field (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

set_instance_field(vcs_root_locator, vcs_root_instance_locator, field, **kwargs)¶

set_instance_field # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_instance_field(vcs_root_locator, vcs_root_instance_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool vcs_root_locator (str) – (required) vcs_root_instance_locator (str) – (required) field (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

dohq_teamcity.api.vcs_root_instance_api module¶

TeamCity REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 2018.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class dohq_teamcity.api.vcs_root_instance_api.VcsRootInstanceApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

base_name = 'VcsRootInstance'¶

delete_instance_field(vcs_root_instance_locator, field, **kwargs)¶

delete_instance_field # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_instance_field(vcs_root_instance_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool vcs_root_instance_locator (str) – (required) field (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

delete_repository_state(vcs_root_instance_locator, **kwargs)¶

delete_repository_state # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_repository_state(vcs_root_instance_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool vcs_root_instance_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

get_children(path, vcs_root_instance_locator, **kwargs)¶

get_children # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_children(path, vcs_root_instance_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool path (str) – (required) vcs_root_instance_locator (str) – (required) base_path (str) – locator (str) – fields (str) –
Returns:	Files If the method is called asynchronously, returns the request thread.

get_children_alias(path, vcs_root_instance_locator, **kwargs)¶

get_children_alias # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_children_alias(path, vcs_root_instance_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool path (str) – (required) vcs_root_instance_locator (str) – (required) base_path (str) – locator (str) – fields (str) –
Returns:	Files If the method is called asynchronously, returns the request thread.

get_content(path, vcs_root_instance_locator, **kwargs)¶

get_content # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_content(path, vcs_root_instance_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool path (str) – (required) vcs_root_instance_locator (str) – (required) response_builder (str) –
Returns:	None If the method is called asynchronously, returns the request thread.

get_content_alias(path, vcs_root_instance_locator, **kwargs)¶

get_content_alias # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_content_alias(path, vcs_root_instance_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool path (str) – (required) vcs_root_instance_locator (str) – (required)
Returns:	None If the method is called asynchronously, returns the request thread.

get_metadata(path, vcs_root_instance_locator, **kwargs)¶

get_metadata # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_metadata(path, vcs_root_instance_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool path (str) – (required) vcs_root_instance_locator (str) – (required) fields (str) –
Returns:	file If the method is called asynchronously, returns the request thread.

get_repository_state(vcs_root_instance_locator, **kwargs)¶

get_repository_state # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_repository_state(vcs_root_instance_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool vcs_root_instance_locator (str) – (required) fields (str) –
Returns:	Entries If the method is called asynchronously, returns the request thread.

get_repository_state_creation_date(vcs_root_instance_locator, **kwargs)¶

get_repository_state_creation_date # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_repository_state_creation_date(vcs_root_instance_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool vcs_root_instance_locator (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

get_root(vcs_root_instance_locator, **kwargs)¶

get_root # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_root(vcs_root_instance_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool vcs_root_instance_locator (str) – (required) base_path (str) – locator (str) – fields (str) –
Returns:	Files If the method is called asynchronously, returns the request thread.

get_zipped(path, vcs_root_instance_locator, **kwargs)¶

get_zipped # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_zipped(path, vcs_root_instance_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool path (str) – (required) vcs_root_instance_locator (str) – (required) base_path (str) – locator (str) – name (str) –
Returns:	None If the method is called asynchronously, returns the request thread.

schedule_checking_for_changes(**kwargs)¶

schedule_checking_for_changes # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.schedule_checking_for_changes(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool locator (str) – requestor (str) – fields (str) –
Returns:	VcsRootInstances If the method is called asynchronously, returns the request thread.

schedule_checking_for_changes_0(**kwargs)¶

schedule_checking_for_changes_0 # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.schedule_checking_for_changes_0(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool locator (str) – ok_on_nothing_found (bool) –
Returns:	None If the method is called asynchronously, returns the request thread.

serve_instance(vcs_root_instance_locator, **kwargs)¶

serve_instance # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_instance(vcs_root_instance_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool vcs_root_instance_locator (str) – (required) fields (str) –
Returns:	VcsRootInstance If the method is called asynchronously, returns the request thread.

serve_instance_field(vcs_root_instance_locator, field, **kwargs)¶

serve_instance_field # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_instance_field(vcs_root_instance_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool vcs_root_instance_locator (str) – (required) field (str) – (required)
Returns:	str If the method is called asynchronously, returns the request thread.

serve_instances(**kwargs)¶

serve_instances # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_instances(async_req=True) >>> result = thread.get()

Parameters:	async_req – bool locator (str) – fields (str) –
Returns:	VcsRootInstances If the method is called asynchronously, returns the request thread.

serve_root_instance_properties(vcs_root_instance_locator, **kwargs)¶

serve_root_instance_properties # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.serve_root_instance_properties(vcs_root_instance_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool vcs_root_instance_locator (str) – (required) fields (str) –
Returns:	Properties If the method is called asynchronously, returns the request thread.

set_instance_field(vcs_root_instance_locator, field, **kwargs)¶

set_instance_field # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_instance_field(vcs_root_instance_locator, field, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool vcs_root_instance_locator (str) – (required) field (str) – (required) body (str) –
Returns:	str If the method is called asynchronously, returns the request thread.

set_repository_state(vcs_root_instance_locator, **kwargs)¶

set_repository_state # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.set_repository_state(vcs_root_instance_locator, async_req=True) >>> result = thread.get()

Parameters:	async_req – bool vcs_root_instance_locator (str) – (required) body (Entries) – fields (str) –
Returns:	Entries If the method is called asynchronously, returns the request thread.

dohq_teamcity.api package¶

Submodules¶

dohq_teamcity.api.agent_api module¶

dohq_teamcity.api.agent_pool_api module¶

dohq_teamcity.api.build_api module¶

dohq_teamcity.api.build_queue_api module¶

dohq_teamcity.api.build_type_api module¶

dohq_teamcity.api.change_api module¶

dohq_teamcity.api.debug_api module¶

dohq_teamcity.api.default_api module¶

dohq_teamcity.api.federation_api module¶

dohq_teamcity.api.group_api module¶

dohq_teamcity.api.investigation_api module¶

dohq_teamcity.api.problem_api module¶

dohq_teamcity.api.problem_occurrence_api module¶

dohq_teamcity.api.project_api module¶

dohq_teamcity.api.server_api module¶

dohq_teamcity.api.test_api module¶

dohq_teamcity.api.test_occurrence_api module¶

dohq_teamcity.api.user_api module¶

dohq_teamcity.api.vcs_root_api module¶

dohq_teamcity.api.vcs_root_instance_api module¶

Module contents¶