Skip to content

Get Template Sync Status

proton_get_template_sync_status R Documentation

Get the status of a template sync

Description

Get the status of a template sync.

Usage

proton_get_template_sync_status(templateName, templateType,
  templateVersion)

Arguments

templateName

[required] The template name.

templateType

[required] The template type.

templateVersion

[required] The template major version.

Value

A list with the following syntax: 

list(
  desiredState = list(
    branch = "string",
    directory = "string",
    repositoryName = "string",
    repositoryProvider = "GITHUB"|"GITHUB_ENTERPRISE"|"BITBUCKET",
    sha = "string"
  ),
  latestSuccessfulSync = list(
    events = list(
      list(
        event = "string",
        externalId = "string",
        time = as.POSIXct(
          "2015-01-01"
        ),
        type = "string"
      )
    ),
    initialRevision = list(
      branch = "string",
      directory = "string",
      repositoryName = "string",
      repositoryProvider = "GITHUB"|"GITHUB_ENTERPRISE"|"BITBUCKET",
      sha = "string"
    ),
    startedAt = as.POSIXct(
      "2015-01-01"
    ),
    status = "INITIATED"|"IN_PROGRESS"|"SUCCEEDED"|"FAILED",
    target = "string",
    targetRevision = list(
      branch = "string",
      directory = "string",
      repositoryName = "string",
      repositoryProvider = "GITHUB"|"GITHUB_ENTERPRISE"|"BITBUCKET",
      sha = "string"
    )
  ),
  latestSync = list(
    events = list(
      list(
        event = "string",
        externalId = "string",
        time = as.POSIXct(
          "2015-01-01"
        ),
        type = "string"
      )
    ),
    initialRevision = list(
      branch = "string",
      directory = "string",
      repositoryName = "string",
      repositoryProvider = "GITHUB"|"GITHUB_ENTERPRISE"|"BITBUCKET",
      sha = "string"
    ),
    startedAt = as.POSIXct(
      "2015-01-01"
    ),
    status = "INITIATED"|"IN_PROGRESS"|"SUCCEEDED"|"FAILED",
    target = "string",
    targetRevision = list(
      branch = "string",
      directory = "string",
      repositoryName = "string",
      repositoryProvider = "GITHUB"|"GITHUB_ENTERPRISE"|"BITBUCKET",
      sha = "string"
    )
  )
)

Request syntax

svc$get_template_sync_status(
  templateName = "string",
  templateType = "ENVIRONMENT"|"SERVICE",
  templateVersion = "string"
)