Build.md

Build

Method	HTTP request
create	POST /v2/orchestration/builds/create
get	GET /v2/orchestration/builds/{buildRid}

create

Parameters

Name	Type	Description	Notes
fallback_branches	FallbackBranches
target	BuildTargetDict	The targets of the schedule.
abort_on_failure	Optional[AbortOnFailure]		[optional]
branch_name	Optional[BranchName]	The target branch the build should run on.	[optional]
force_build	Optional[ForceBuild]		[optional]
notifications_enabled	Optional[NotificationsEnabled]		[optional]
preview	Optional[PreviewMode]	preview	[optional]
retry_backoff_duration	Optional[RetryBackoffDurationDict]		[optional]
retry_count	Optional[RetryCount]	The number of retry attempts for failed jobs.	[optional]

Return type

Build

Example

from foundry.v2 import FoundryClient
from foundry import PalantirRPCException
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# FallbackBranches |
fallback_branches = ["master"]
# BuildTargetDict | The targets of the schedule.
target = None
# Optional[AbortOnFailure] |
abort_on_failure = None
# Optional[BranchName] | The target branch the build should run on.
branch_name = "master"
# Optional[ForceBuild] |
force_build = None
# Optional[NotificationsEnabled] |
notifications_enabled = None
# Optional[PreviewMode] | preview
preview = None
# Optional[RetryBackoffDurationDict] |
retry_backoff_duration = {"unit": "SECONDS", "value": 30}
# Optional[RetryCount] | The number of retry attempts for failed jobs.
retry_count = None


try:
    api_response = foundry_client.orchestration.Build.create(
        fallback_branches=fallback_branches,
        target=target,
        abort_on_failure=abort_on_failure,
        branch_name=branch_name,
        force_build=force_build,
        notifications_enabled=notifications_enabled,
        preview=preview,
        retry_backoff_duration=retry_backoff_duration,
        retry_count=retry_count,
    )
    print("The create response:\n")
    pprint(api_response)
except PalantirRPCException as e:
    print("HTTP error when calling Build.create: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	Build		application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get

Get the Build with the specified rid.

Parameters

Name	Type	Description	Notes
build_rid	BuildRid	buildRid
preview	Optional[PreviewMode]	preview	[optional]

Return type

Build

Example

from foundry.v2 import FoundryClient
from foundry import PalantirRPCException
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# BuildRid | buildRid
build_rid = "ri.foundry.main.build.a4386b7e-d546-49be-8a36-eefc355f5c58"
# Optional[PreviewMode] | preview
preview = None


try:
    api_response = foundry_client.orchestration.Build.get(
        build_rid,
        preview=preview,
    )
    print("The get response:\n")
    pprint(api_response)
except PalantirRPCException as e:
    print("HTTP error when calling Build.get: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	Build		application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]