Skip to content

Pipelines

All URIs are relative to https://api.ubiops.com/v2.1

Method HTTP request Description
pipeline_audit_events_list GET /projects/{project_name}/pipelines/{pipeline_name}/audit List audit events for a pipeline
pipeline_version_object_attachments_create POST /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/attachments Create object attachments
pipeline_version_object_attachments_delete DELETE /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/attachments/{attachment_id} Delete object attachment
pipeline_version_object_attachments_destination_get GET /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/objects/{destination_name}/attachments List the attachments of a destination object
pipeline_version_object_attachments_get GET /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/attachments/{attachment_id} Get object attachment
pipeline_version_object_attachments_list GET /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/attachments List object attachments
pipeline_version_object_environment_variables_list GET /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/objects/{name}/environment-variables List pipeline object environment variables
pipeline_version_objects_create POST /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/objects Create pipeline object
pipeline_version_objects_delete DELETE /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/objects/{name} Delete pipeline object
pipeline_version_objects_get GET /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/objects/{name} Get pipeline object
pipeline_version_objects_list GET /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/objects List pipeline objects
pipeline_version_objects_update PATCH /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/objects/{name} Update pipeline object
pipeline_versions_create POST /projects/{project_name}/pipelines/{pipeline_name}/versions Create pipeline versions
pipeline_versions_delete DELETE /projects/{project_name}/pipelines/{pipeline_name}/versions/{version} Delete pipeline version
pipeline_versions_get GET /projects/{project_name}/pipelines/{pipeline_name}/versions/{version} Get pipeline version
pipeline_versions_list GET /projects/{project_name}/pipelines/{pipeline_name}/versions List pipeline versions
pipeline_versions_update PATCH /projects/{project_name}/pipelines/{pipeline_name}/versions/{version} Update pipeline version
pipelines_create POST /projects/{project_name}/pipelines Create pipelines
pipelines_delete DELETE /projects/{project_name}/pipelines/{pipeline_name} Delete a pipeline
pipelines_get GET /projects/{project_name}/pipelines/{pipeline_name} Get details of a pipeline
pipelines_list GET /projects/{project_name}/pipelines List pipelines
pipelines_update PATCH /projects/{project_name}/pipelines/{pipeline_name} Update a pipeline

pipeline_audit_events_list

pipeline_audit_events_list(pipeline.name, action=NULL, limit=NULL, offset=NULL)

List audit events for a pipeline

Description

List all audit events for a pipeline including objects and attachments

Optional Parameters

The following parameters should be given as query parameters:

  • action: Type of action. It can be one of: create, update, delete, info.
  • limit: The maximum number of audit events given back, default is 50
  • offset: The number which forms the starting point of the audit events given back. If offset equals 2, then the first 2 events will be omitted from the list.

Response Structure

A list of details of the audit events for a pipeline

  • id: Unique identifier for the audit event (UUID)
  • date: The date when the action was performed
  • action: Type of action. It can be one of: create, update, delete, info. info action denotes that the action does not fall into create, update or delete categories.
  • user: Email of the user who performed the action
  • event: Description of the event
  • object_type: Type of the object on which the action was performed
  • object_name: Name of the object on which the action was performed. If the object is deleted at the time of listing audit events, this field is empty.

Response Examples

[
  {
    "id": "44f326de-0ee3-4741-b72e-69e31b3ec55f",
    "date": "2020-10-23T12:21:12.460+00:00",
    "action": "create",
    "user": "[email protected]",
    "event": "Created pipeline object deployment-1 in version v1 of pipeline pipeline-1",
    "object_type": "pipeline",
    "object_name": "pipeline-1"
  },
  {
    "id": "905cdc19-a02c-4f09-b2fb-42d92da21bda",
    "date": "2020-10-23T12:21:37.247+00:00",
    "action": "update",
    "user": "[email protected]",
    "event": "Updated pipeline object deployment-object in version v1 of pipeline pipeline-1: name changed from deployment-1 to deployment-object",
    "object_type": "pipeline",
    "object_name": "pipeline-1"
  }
]

Example

# Use environment variables
Sys.setenv("UBIOPS_PROJECT" = "YOUR PROJECT NAME")
Sys.setenv("UBIOPS_API_TOKEN" = "YOUR API TOKEN")
result <- ubiops::pipeline_audit_events_list(
  pipeline.name,
  action = NULL, limit = NULL, offset = NULL
)

# Or provide directly
result <- ubiops::pipeline_audit_events_list(
  pipeline.name,
  action = NULL, limit = NULL, offset = NULL, 
  UBIOPS_PROJECT = "YOUR PROJECT NAME", UBIOPS_API_TOKEN = "YOUR API TOKEN"
)

print(result)

# Or print in JSON format
print(jsonlite::toJSON(result, auto_unbox=TRUE))

# The default API url is https://api.ubiops.com/v2.1
# Want to use a different API url? Provide `UBIOPS_API_URL`, either directly or as environment variable.

pipeline_version_object_attachments_create

pipeline_version_object_attachments_create(pipeline.name, version, data)

Create object attachments

Description

Create an attachment between objects in a pipeline version. An attachment can only be made between objects that have already been added to the pipeline version. The objects where the attachment starts is called the source objects. The object that is linked is called the destination object. When attaching source objects to a destination object, one must also define which source object output fields map to which destination object input fields. All the input fields in the destination object must be provided in the mapping. In contrast, not all output fields of all source objects need to be used in the mapping. It is also possible that one source output field links to multiple destination input fields.

The pipeline_start object can only be a source object. The pipeline_end object can only be a destination object.

In case of plain type of objects, the mapping source_field_name and destination_field_name must be omitted or given as null.

Required Parameters

  • destination_name: Name of the destination object in the pipeline version
  • sources: A list of dictionaries containing the link between a source object (source_name) and mapping of the source output field (source_field_name) and destination object input field (destination_field_name). Each item in the sources list must contain source_field_name and destination_field_name keys. The source and destination fields should match in data type, e.g. integer source fields can only be mapped to integer type destination fields.

Request Examples

An attachment between two structured deployments

{
  "destination_name": "deployment-2-v1",
  "sources": [
    {
      "source_name": "deployment-1-v1",
      "mapping": [
        {
          "source_field_name": "deployment-output-field-1",
          "destination_field_name": "deployment-2-input-field-1"
        },
        {
          "source_field_name": "deployment-output-field-2",
          "destination_field_name": "deployment-2-input-field-2"
        },
        {
          "source_field_name": "deployment-output-field-3",
          "destination_field_name": "deployment-2-input-field-3"
        }
      ]
    },
  ]
}
An attachment between two plain input/output type deployments

{
  "destination_name": "plain-deployment-v4",
  "sources": [
    {
      "source_name": "plain-deployment-v3",
      "mapping": []
    }
  ]
}

An attachment between a pipeline_start object and deployment

{
  "destination_name": "deployment-2-v2",
  "sources": [
    {
      "source_name": "pipeline_start",
      "mapping": [
        {
          "source_field_name": "pipeline-input-field-1",
          "destination_field_name": "deployment-input-field-1"
        },
        {
          "source_field_name": "pipeline-input-field-2",
          "destination_field_name": "deployment-input-field-2"
        }
      ]
    }
  ]
}

An attachment between a deployment and a pipeline_end object 

{
  "destination_name": "pipeline_end",
  "sources": [
    {
      "source_name": "deployment-3-v1",
      "mapping": [
        {
          "source_field_name": "deployment-3-output-field-1",
          "destination_field_name": "pipeline-output-field-1"
        },
        {
          "source_field_name": "deployment-3-output-field-2",
          "destination_field_name": "pipeline-output-field-2"
        }
      ]
    }
  ]
}

Response Structure

Details of the created attachment

  • destination_name: Name of the destination pipeline object
  • sources: A list of dictionaries containing the link between a source object (source_name) and mapping of the source output field (source_field_name) and destination object input field (destination_field_name)

Response Examples

{
  "destination_name": "deployment-2-v2",
  "sources": [
    {
      "source_name": "pipeline_start",
      "mapping": [
        {
          "source_field_name": "pipeline-input-field-1",
          "destination_field_name": "deployment-input-field-1"
        },
        {
          "source_field_name": "pipeline-input-field-2",
          "destination_field_name": "deployment-input-field-2"
        }
      ]
    }
  ]
}

Example

data <- list(
  destination_name = "destination_name",
  sources = list(  # (optional)
    list(
      source_name = "source_name",
      mapping = list(  # (optional)
        list(
          source_field_name = "source_field_name",
          destination_field_name = "destination_field_name"
        )
      )
    )
  )
)

# Use environment variables
Sys.setenv("UBIOPS_PROJECT" = "YOUR PROJECT NAME")
Sys.setenv("UBIOPS_API_TOKEN" = "YOUR API TOKEN")
result <- ubiops::pipeline_version_object_attachments_create(
  pipeline.name, version, data
)

# Or provide directly
result <- ubiops::pipeline_version_object_attachments_create(
  pipeline.name, version, data,
  UBIOPS_PROJECT = "YOUR PROJECT NAME", UBIOPS_API_TOKEN = "YOUR API TOKEN"
)

print(result)

# Or print in JSON format
print(jsonlite::toJSON(result, auto_unbox=TRUE))

# The default API url is https://api.ubiops.com/v2.1
# Want to use a different API url? Provide `UBIOPS_API_URL`, either directly or as environment variable.

pipeline_version_object_attachments_delete

pipeline_version_object_attachments_delete(attachment.id, pipeline.name, version)

Delete object attachment

Description

Delete an attachment in a pipeline version. The referenced and original objects of the attachment still exist in the pipeline version, only the link between them is deleted.

Example

# Use environment variables
Sys.setenv("UBIOPS_PROJECT" = "YOUR PROJECT NAME")
Sys.setenv("UBIOPS_API_TOKEN" = "YOUR API TOKEN")
ubiops::pipeline_version_object_attachments_delete(
  attachment.id, pipeline.name, version
)

# Or provide directly
ubiops::pipeline_version_object_attachments_delete(
  attachment.id, pipeline.name, version,
  UBIOPS_PROJECT = "YOUR PROJECT NAME", UBIOPS_API_TOKEN = "YOUR API TOKEN"
)

# The default API url is https://api.ubiops.com/v2.1
# Want to use a different API url? Provide `UBIOPS_API_URL`, either directly or as environment variable.

pipeline_version_object_attachments_destination_get

pipeline_version_object_attachments_destination_get(destination.name, pipeline.name, version)

List the attachments of a destination object

Description

List attachments of a destination object in a pipeline version

Response Structure

A list of details of the attachments of the given destination object in the pipeline version

  • destination_name: Name of the destination object
  • sources: A list of dictionaries containing the link between a source object (source_name) and mapping of the source output field (source_field_name) and destination object input field (destination_field_name)

Response Examples

[
  {
    "destination_name": "deployment-3-v1",
    "sources": [
      {
        "source_name": "deployment-2-v1",
        "mapping": [
          {
            "source_field_name": "deployment-2-output-field-1",
            "destination_field_name": "deployment-3-input-field-1"
          },
          {
            "source_field_name": "deployment-2-output-field-2",
            "destination_field_name": "deployment-3-input-field-2"
          }
        ]
      }
    ]
  },
  {
    "destination_name": "deployment-3-v1",
    "sources": [
      {
        "source_name": "deployment-2-v2",
        "mapping": [
          {
            "source_field_name": "deployment-2-output-field-1",
            "destination_field_name": "deployment-3-input-field-1"
          },
          {
            "source_field_name": "deployment-2-output-field-2",
            "destination_field_name": "deployment-3-input-field-2"
          }
        ]
      }
    ]
  }
]

Example

# Use environment variables
Sys.setenv("UBIOPS_PROJECT" = "YOUR PROJECT NAME")
Sys.setenv("UBIOPS_API_TOKEN" = "YOUR API TOKEN")
result <- ubiops::pipeline_version_object_attachments_destination_get(
  destination.name, pipeline.name, version
)

# Or provide directly
result <- ubiops::pipeline_version_object_attachments_destination_get(
  destination.name, pipeline.name, version,
  UBIOPS_PROJECT = "YOUR PROJECT NAME", UBIOPS_API_TOKEN = "YOUR API TOKEN"
)

print(result)

# Or print in JSON format
print(jsonlite::toJSON(result, auto_unbox=TRUE))

# The default API url is https://api.ubiops.com/v2.1
# Want to use a different API url? Provide `UBIOPS_API_URL`, either directly or as environment variable.

pipeline_version_object_attachments_get

pipeline_version_object_attachments_get(attachment.id, pipeline.name, version)

Get object attachment

Description

Get the details of a single attachment in a pipeline

Response Structure

Details of the attachment

  • destination_name: Name of the destination pipeline object
  • sources: A list of dictionaries containing the link between a source object (source_name) and mapping of the source output field (source_field_name) and destination object input field (destination_field_name)

Response Examples

{
  "destination_name": "deployment-3-v1",
  "sources": [
    {
      "source_name": "deployment-2-v2",
      "mapping": [
        {
          "source_field_name": "deployment-2-output-field-1",
          "destination_field_name": "deployment-3-input-field-1"
        },
        {
          "source_field_name": "deployment-2-output-field-2",
          "destination_field_name": "deployment-3-input-field-2"
        }
      ]
    }
  ]
}

Example

# Use environment variables
Sys.setenv("UBIOPS_PROJECT" = "YOUR PROJECT NAME")
Sys.setenv("UBIOPS_API_TOKEN" = "YOUR API TOKEN")
result <- ubiops::pipeline_version_object_attachments_get(
  attachment.id, pipeline.name, version
)

# Or provide directly
result <- ubiops::pipeline_version_object_attachments_get(
  attachment.id, pipeline.name, version,
  UBIOPS_PROJECT = "YOUR PROJECT NAME", UBIOPS_API_TOKEN = "YOUR API TOKEN"
)

print(result)

# Or print in JSON format
print(jsonlite::toJSON(result, auto_unbox=TRUE))

# The default API url is https://api.ubiops.com/v2.1
# Want to use a different API url? Provide `UBIOPS_API_URL`, either directly or as environment variable.

pipeline_version_object_attachments_list

pipeline_version_object_attachments_list(pipeline.name, version)

List object attachments

Description

List all attachments in a pipeline version

Response Structure

A list of details of the attachments in the pipeline

  • destination_name: Name of the destination pipeline object
  • sources: A list of dictionaries containing the source object(s) and mapping of the fields. One attachment can have multiple source objects.

Response Examples

[
  {
    "destination_name": "deployment-2-v2",
    "sources": [
      {
        "source_name": "pipeline_start",
        "mapping": [
          {
            "source_field_name": "pipeline-input-field-1",
            "destination_field_name": "deployment-input-field-1"
          },
          {
            "source_field_name": "pipeline-input-field-2",
            "destination_field_name": "deployment-input-field-2"
          }
        ]
      }
    ]
  },
  {
    "destination_name": "deployment-3-v1",
    "sources": [
      {
        "source_name": "deployment-2-v2",
        "mapping": [
          {
            "source_field_name": "deployment-output-field-1",
            "destination_field_name": "deployment-3-input-field-1"
          },
          {
            "source_field_name": "deployment-output-field-2",
            "destination_field_name": "deployment-3-input-field-2"
          },
          {
            "source_field_name": "deployment-output-field-3",
            "destination_field_name": "deployment-3-input-field-3"
          }
        ]
      }
    ]
  },
  {
    "destination_name": "pipeline_end",
    "sources": [
      {
        "source_name": "deployment-3-v1",
        "mapping": [
          {
            "source_field_name": "deployment-3-output-field-1",
            "destination_field_name": "pipeline-output-field-1"
          },
          {
            "source_field_name": "deployment-3-output-field-2",
            "destination_field_name": "pipeline-output-field-2"
          }
        ]
      }
    ]
  }
]

Example

# Use environment variables
Sys.setenv("UBIOPS_PROJECT" = "YOUR PROJECT NAME")
Sys.setenv("UBIOPS_API_TOKEN" = "YOUR API TOKEN")
result <- ubiops::pipeline_version_object_attachments_list(
  pipeline.name, version
)

# Or provide directly
result <- ubiops::pipeline_version_object_attachments_list(
  pipeline.name, version,
  UBIOPS_PROJECT = "YOUR PROJECT NAME", UBIOPS_API_TOKEN = "YOUR API TOKEN"
)

print(result)

# Or print in JSON format
print(jsonlite::toJSON(result, auto_unbox=TRUE))

# The default API url is https://api.ubiops.com/v2.1
# Want to use a different API url? Provide `UBIOPS_API_URL`, either directly or as environment variable.

pipeline_version_object_environment_variables_list

pipeline_version_object_environment_variables_list(name, pipeline.name, version)

List pipeline object environment variables

Description

List environment variables accessible to objects in the pipeline version

Response Structure

A list of variables described by the following fields:

  • id: Unique identifier for the environment variable
  • name: Variable name
  • value: Variable value (will be null for secret variables)
  • secret: Boolean that indicates if this variable contains sensitive information
  • inheritance_type: Type of parent object that this variable is inherited from - can be project, deployment, or version
  • inheritance_name: Name of the parent object that this variable is inherited from

Response Examples

[
  {
    "id": "4c15a27e-25ea-4be0-86c7-f4790389d061",
    "name": "database_schema",
    "value": "public",
    "secret": false,
    "inheritance_type": "deployment",
    "inheritance_name": "deployment_name"
  },
  {
    "id": "06c2c8be-507e-4fae-981d-54e94f22dab0",
    "name": "database_password",
    "value": null,
    "secret": true,
    "inheritance_type": "project",
    "inheritance_name": "project_name"
  }
]

Example

# Use environment variables
Sys.setenv("UBIOPS_PROJECT" = "YOUR PROJECT NAME")
Sys.setenv("UBIOPS_API_TOKEN" = "YOUR API TOKEN")
result <- ubiops::pipeline_version_object_environment_variables_list(
  name, pipeline.name, version
)

# Or provide directly
result <- ubiops::pipeline_version_object_environment_variables_list(
  name, pipeline.name, version,
  UBIOPS_PROJECT = "YOUR PROJECT NAME", UBIOPS_API_TOKEN = "YOUR API TOKEN"
)

print(result)

# Or print in JSON format
print(jsonlite::toJSON(result, auto_unbox=TRUE))

# The default API url is https://api.ubiops.com/v2.1
# Want to use a different API url? Provide `UBIOPS_API_URL`, either directly or as environment variable.

pipeline_version_objects_create

pipeline_version_objects_create(pipeline.name, version, data)

Create pipeline object

Description

Create a pipeline object for a pipeline version. The pipeline object that is added is a reference to the real object. In this way, multiple references to the same object may be added to a pipeline version. The reference_name refers to the deployment name and the version is the version of the deployment which will be added to the pipeline version as an object.

Required Parameters

  • name: Name of the pipeline object. It is unique within a pipeline version.
  • reference_name: Name of the object it will reference
  • version: Version name of reference object. Do not provide this field to refer to the default version of the reference.

Request Examples

{
  "name": "deployment-1-v1",
  "reference_name": "deployment-1",
  "version": "version-1"
}

Response Structure

Details of the created pipeline object

  • id: Unique identifier for the pipeline object (UUID)
  • name: Name of the pipeline object
  • reference_name: Name of the object it will reference
  • version: Version name of reference object

Response Examples

{
  "id": "c91724b6-d73c-4933-b2aa-aefd9e34ce3e",
  "name": "deployment-1-v1",
  "reference_name": "deployment-1",
  "version": "version-1"
}

Example

data <- list(
  name = "name",
  reference_name = "reference_name",
  version = "version"  # (optional)
)

# Use environment variables
Sys.setenv("UBIOPS_PROJECT" = "YOUR PROJECT NAME")
Sys.setenv("UBIOPS_API_TOKEN" = "YOUR API TOKEN")
result <- ubiops::pipeline_version_objects_create(
  pipeline.name, version, data
)

# Or provide directly
result <- ubiops::pipeline_version_objects_create(
  pipeline.name, version, data,
  UBIOPS_PROJECT = "YOUR PROJECT NAME", UBIOPS_API_TOKEN = "YOUR API TOKEN"
)

print(result)

# Or print in JSON format
print(jsonlite::toJSON(result, auto_unbox=TRUE))

# The default API url is https://api.ubiops.com/v2.1
# Want to use a different API url? Provide `UBIOPS_API_URL`, either directly or as environment variable.

pipeline_version_objects_delete

pipeline_version_objects_delete(name, pipeline.name, version)

Delete pipeline object

Description

Delete a pipeline object. Only the reference in the pipeline version is deleted. The original object (deployment and version) still exists. If the object is attached to another object, the attachment is also deleted.

Example

# Use environment variables
Sys.setenv("UBIOPS_PROJECT" = "YOUR PROJECT NAME")
Sys.setenv("UBIOPS_API_TOKEN" = "YOUR API TOKEN")
ubiops::pipeline_version_objects_delete(
  name, pipeline.name, version
)

# Or provide directly
ubiops::pipeline_version_objects_delete(
  name, pipeline.name, version,
  UBIOPS_PROJECT = "YOUR PROJECT NAME", UBIOPS_API_TOKEN = "YOUR API TOKEN"
)

# The default API url is https://api.ubiops.com/v2.1
# Want to use a different API url? Provide `UBIOPS_API_URL`, either directly or as environment variable.

pipeline_version_objects_get

pipeline_version_objects_get(name, pipeline.name, version)

Get pipeline object

Description

Retrieve the details of a single pipeline object

Response Structure

Details of the pipeline object

  • id: Unique identifier for the pipeline object (UUID)
  • name: Name of the pipeline object
  • reference_name: Name of the object it references
  • version: Version name of reference object

Response Examples

A dictionary containing details of the pipeline object

{
  "id": "c91724b6-d73c-4933-b2aa-aefd9e34ce3e",
  "name": "deployment-1-v1",
  "reference_name": "deployment-1",
  "version": "version-1"
}

Example

# Use environment variables
Sys.setenv("UBIOPS_PROJECT" = "YOUR PROJECT NAME")
Sys.setenv("UBIOPS_API_TOKEN" = "YOUR API TOKEN")
result <- ubiops::pipeline_version_objects_get(
  name, pipeline.name, version
)

# Or provide directly
result <- ubiops::pipeline_version_objects_get(
  name, pipeline.name, version,
  UBIOPS_PROJECT = "YOUR PROJECT NAME", UBIOPS_API_TOKEN = "YOUR API TOKEN"
)

print(result)

# Or print in JSON format
print(jsonlite::toJSON(result, auto_unbox=TRUE))

# The default API url is https://api.ubiops.com/v2.1
# Want to use a different API url? Provide `UBIOPS_API_URL`, either directly or as environment variable.

pipeline_version_objects_list

pipeline_version_objects_list(pipeline.name, version)

List pipeline objects

Description

List all pipeline objects in a pipeline version

Response Structure

A list of details of the pipeline objects in the pipeline version

  • id: Unique identifier for the pipeline object (UUID)
  • name: Name of the pipeline object
  • reference_name: Name of the object it references
  • version: Version name of reference object

Response Examples

A list of pipeline objects

[
  {
    "id": "c91724b6-d73c-4933-b2aa-aefd9e34ce3e",
    "name": "deployment-1-v1",
    "reference_name": "deployment-1",
    "version": "version-1"
  },
  {
    "id": "1a4b0e28-3de1-442a-b1eb-947f22a69381",
    "name": "deployment-2-v1",
    "reference_name": "deployment-2",
    "version": "v1"
  }
]

Example

# Use environment variables
Sys.setenv("UBIOPS_PROJECT" = "YOUR PROJECT NAME")
Sys.setenv("UBIOPS_API_TOKEN" = "YOUR API TOKEN")
result <- ubiops::pipeline_version_objects_list(
  pipeline.name, version
)

# Or provide directly
result <- ubiops::pipeline_version_objects_list(
  pipeline.name, version,
  UBIOPS_PROJECT = "YOUR PROJECT NAME", UBIOPS_API_TOKEN = "YOUR API TOKEN"
)

print(result)

# Or print in JSON format
print(jsonlite::toJSON(result, auto_unbox=TRUE))

# The default API url is https://api.ubiops.com/v2.1
# Want to use a different API url? Provide `UBIOPS_API_URL`, either directly or as environment variable.

pipeline_version_objects_update

pipeline_version_objects_update(name, pipeline.name, version, data)

Update pipeline object

Description

Update a pipeline object. It is not possible to update the reference_name. All necessary fields are validated again.

Optional Parameters

  • name: New name for the pipeline object
  • version: New version for the pipeline object. Since the input/output fields of different versions are the same, the version of a deployment pipeline object can be changed with another version of the same deployment. To use the default version of the reference deployment, provide NULL for this field.

Request Examples

{
  "name": "new-pipeline-object-name"
}

{
  "name": "deployment-1-v2"
  "version": "version-2"
}

Response Structure

Details of the updated pipeline object

  • id: Unique identifier for the pipeline object (UUID)
  • name: Name of the pipeline object
  • reference_name: Name of the object it references
  • version: Version name of reference object

Response Examples

{
  "id": "c91724b6-d73c-4933-b2aa-aefd9e34ce3e",
  "name": "deployment-1-v2",
  "reference_name": "deployment-1",
  "version": "version-2"
}

Example

data <- list(
  name = "name",  # (optional)
  version = "version"  # (optional)
)

# Use environment variables
Sys.setenv("UBIOPS_PROJECT" = "YOUR PROJECT NAME")
Sys.setenv("UBIOPS_API_TOKEN" = "YOUR API TOKEN")
result <- ubiops::pipeline_version_objects_update(
  name, pipeline.name, version, data
)

# Or provide directly
result <- ubiops::pipeline_version_objects_update(
  name, pipeline.name, version, data,
  UBIOPS_PROJECT = "YOUR PROJECT NAME", UBIOPS_API_TOKEN = "YOUR API TOKEN"
)

print(result)

# Or print in JSON format
print(jsonlite::toJSON(result, auto_unbox=TRUE))

# The default API url is https://api.ubiops.com/v2.1
# Want to use a different API url? Provide `UBIOPS_API_URL`, either directly or as environment variable.

pipeline_versions_create

pipeline_versions_create(pipeline.name, data)

Create pipeline versions

Description

Create a version for a pipeline. The first version of a pipeline is set as default.

Required Parameters

  • version: Name of the version of the pipeline

Optional Parameters

  • description: Description of the pipeline version
  • labels: Dictionary containing key/value pairs where key indicates the label and value is the corresponding value of that label
  • request_retention_time: Number of seconds to store requests to the pipeline version
  • request_retention_mode: Mode of request retention for requests to the pipeline version. It can be one of the following:
    • none - the requests will not be stored
    • metadata - only the metadata of the requests will be stored
    • full - both the metadata and input/output of the requests will be stored

Request Examples

{
  "version": "v1"
}

{
  "version": "v1",
  "description": "my description",
  "labels": {
    "type": "production"
  }
}

Response Structure

Details of the created pipeline version

  • id: Unique identifier for the pipeline version (UUID)
  • pipeline: Name of the pipeline to which the version is associated
  • version: Name of the version of the pipeline
  • description: Description of the pipeline version
  • labels: Dictionary containing key/value pairs where key indicates the label and value is the corresponding value of that label
  • creation_date: The date when the pipeline version was created
  • last_updated: The date when the pipeline version was last updated
  • request_retention_time: Number of seconds to store requests to the pipeline version
  • request_retention_mode: Mode of request retention for requests to the pipeline version. It can be one of the following: none, metadata or full.

Response Examples

{
  "id": "6b0cea21-2657-4fa3-a331-de646e3cfdc4",
  "pipeline": "pipeline-1",
  "version": "v1",
  "description": "my description",
  "labels": {
    "tag": "production"
  },
  "creation_date": "2020-05-12T16:23:15.456812Z",
  "last_updated": "2020-06-22T18:04:76.123754Z",
  "request_retention_time": 604800,
  "request_retention_mode": "full"
}

Example

data <- list(
  version = "version",
  description = "description",  # (optional)
  labels = list(key = "value"),  # (optional)
  request_retention_time = 0,  # [min: 3.6E+3; max: 2.4192E+6] (optional)
  request_retention_mode = 'full'  # one of: [none, metadata, full]  (optional)
)

# Use environment variables
Sys.setenv("UBIOPS_PROJECT" = "YOUR PROJECT NAME")
Sys.setenv("UBIOPS_API_TOKEN" = "YOUR API TOKEN")
result <- ubiops::pipeline_versions_create(
  pipeline.name, data
)

# Or provide directly
result <- ubiops::pipeline_versions_create(
  pipeline.name, data,
  UBIOPS_PROJECT = "YOUR PROJECT NAME", UBIOPS_API_TOKEN = "YOUR API TOKEN"
)

print(result)

# Or print in JSON format
print(jsonlite::toJSON(result, auto_unbox=TRUE))

# The default API url is https://api.ubiops.com/v2.1
# Want to use a different API url? Provide `UBIOPS_API_URL`, either directly or as environment variable.

pipeline_versions_delete

pipeline_versions_delete(pipeline.name, version)

Delete pipeline version

Description

Delete a pipeline version. This will also delete all objects and attachments in the pipeline version.

Example

# Use environment variables
Sys.setenv("UBIOPS_PROJECT" = "YOUR PROJECT NAME")
Sys.setenv("UBIOPS_API_TOKEN" = "YOUR API TOKEN")
ubiops::pipeline_versions_delete(
  pipeline.name, version
)

# Or provide directly
ubiops::pipeline_versions_delete(
  pipeline.name, version,
  UBIOPS_PROJECT = "YOUR PROJECT NAME", UBIOPS_API_TOKEN = "YOUR API TOKEN"
)

# The default API url is https://api.ubiops.com/v2.1
# Want to use a different API url? Provide `UBIOPS_API_URL`, either directly or as environment variable.

pipeline_versions_get

pipeline_versions_get(pipeline.name, version)

Get pipeline version

Description

Get the details of a single pipeline version

Response Structure

Details of the pipeline version

  • id: Unique identifier for the pipeline version (UUID)
  • pipeline: Name of the pipeline to which the version is associated
  • version: Name of the version of the pipeline
  • description: Description of the pipeline version
  • labels: Dictionary containing key/value pairs where key indicates the label and value is the corresponding value of that label
  • creation_date: The date when the pipeline version was created
  • last_updated: The date when the pipeline version was last updated
  • request_retention_time: Number of seconds to store requests to the pipeline version
  • request_retention_mode: Mode of request retention for requests to the pipeline version. It can be one of the following:
    • none - the requests will not be stored
    • metadata - only the metadata of the requests will be stored
    • full - both the metadata and input/output of the requests will be stored

Response Examples

{
  "id": "6b0cea21-2657-4fa3-a331-de646e3cfdc4",
  "pipeline": "pipeline-1",
  "version": "v1",
  "description": "my description",
  "labels": {
    "tag": "production"
  },
  "creation_date": "2020-05-12T16:23:15.456812Z",
  "last_updated": "2020-06-22T18:04:76.123754Z",
  "request_retention_time": 604800,
  "request_retention_mode": "full"
}

Example

# Use environment variables
Sys.setenv("UBIOPS_PROJECT" = "YOUR PROJECT NAME")
Sys.setenv("UBIOPS_API_TOKEN" = "YOUR API TOKEN")
result <- ubiops::pipeline_versions_get(
  pipeline.name, version
)

# Or provide directly
result <- ubiops::pipeline_versions_get(
  pipeline.name, version,
  UBIOPS_PROJECT = "YOUR PROJECT NAME", UBIOPS_API_TOKEN = "YOUR API TOKEN"
)

print(result)

# Or print in JSON format
print(jsonlite::toJSON(result, auto_unbox=TRUE))

# The default API url is https://api.ubiops.com/v2.1
# Want to use a different API url? Provide `UBIOPS_API_URL`, either directly or as environment variable.

pipeline_versions_list

pipeline_versions_list(pipeline.name, labels=NULL)

List pipeline versions

Description

Pipeline versions can be filtered according to the labels they have by giving labels as a query parameter. Pipeline versions that have at least one of the labels on which is filtered, are returned.

Optional Parameters

  • labels: Filter on labels of the pipeline version. Should be given in the format 'label:label_value'. Separate multiple label-pairs with a comma (,). This parameter should be given as query parameter.

Response Structure

A list of details of the versions of the pipeline

  • id: Unique identifier for the pipeline version (UUID)
  • pipeline: Name of the pipeline to which the version is associated
  • version: Name of the version of the pipeline
  • description: Description of the pipeline version
  • labels: Dictionary containing key/value pairs where key indicates the label and value is the corresponding value of that label
  • creation_date: The date when the pipeline version was created
  • last_updated: The date when the pipeline version was last updated
  • request_retention_time: Number of seconds to store requests to the pipeline version
  • request_retention_mode: Mode of request retention for requests to the pipeline version. It can be one of the following:
    • none - the requests will not be stored
    • metadata - only the metadata of the requests will be stored
    • full - both the metadata and input/output of the requests will be stored

Response Examples

[
  {
    "id": "6b0cea21-2657-4fa3-a331-de646e3cfdc4",
    "pipeline": "pipeline-1",
    "version": "v1",
    "description": "my description",
    "labels": {
      "tag": "production"
    },
    "creation_date": "2020-05-12T16:23:15.456812Z",
    "last_updated": "2020-06-22T18:04:76.123754Z",
    "request_retention_time": 604800,
    "request_retention_mode": "full"
  },
  {
    "id": "6b0cea21-2657-4fa3-a331-de646e3cfdc4",
    "pipeline": "pipeline-1",
    "version": "v1",
    "description": "my description",
    "labels": {
      "tag": "production"
    },
    "creation_date": "2020-05-12T16:23:15.456812Z",
    "last_updated": "2020-06-22T18:04:76.123754Z",
    "request_retention_time": 86400,
    "request_retention_mode": "metadata"
  }
]

Example

# Use environment variables
Sys.setenv("UBIOPS_PROJECT" = "YOUR PROJECT NAME")
Sys.setenv("UBIOPS_API_TOKEN" = "YOUR API TOKEN")
result <- ubiops::pipeline_versions_list(
  pipeline.name,
  labels = NULL
)

# Or provide directly
result <- ubiops::pipeline_versions_list(
  pipeline.name,
  labels = NULL, 
  UBIOPS_PROJECT = "YOUR PROJECT NAME", UBIOPS_API_TOKEN = "YOUR API TOKEN"
)

print(result)

# Or print in JSON format
print(jsonlite::toJSON(result, auto_unbox=TRUE))

# The default API url is https://api.ubiops.com/v2.1
# Want to use a different API url? Provide `UBIOPS_API_URL`, either directly or as environment variable.

pipeline_versions_update

pipeline_versions_update(pipeline.name, version, data)

Update pipeline version

Description

Update a pipeline version. When updating labels, the labels will replace the existing value for labels.

Optional Parameters

  • version: Name of the version of the pipeline
  • description: Description of the pipeline version
  • labels: Dictionary containing key/value pairs where key indicates the label and value is the corresponding value of that label
  • request_retention_time: Number of seconds to store requests to the pipeline version
  • request_retention_mode: Mode of request retention for requests to the pipeline version. It can be one of the following:
    • none - the requests will not be stored
    • metadata - only the metadata of the requests will be stored
    • full - both the metadata and input/output of the requests will be stored

Request Examples

{
  "version": "v1",
  "description": "my description",
  "labels": {
    "type": "production"
  }
}

Response Structure

Details of the created pipeline

  • id: Unique identifier for the pipeline version (UUID)
  • pipeline: Name of the pipeline to which the version is associated
  • version: Name of the version of the pipeline
  • description: Description of the pipeline version
  • labels: Dictionary containing key/value pairs where key indicates the label and value is the corresponding value of that label
  • creation_date: The date when the pipeline version was created
  • last_updated: The date when the pipeline version was last updated
  • request_retention_time: Number of seconds to store requests to the pipeline version
  • request_retention_mode: Mode of request retention for requests to the pipeline version. It can be one of the following: none, metadata or full.

Response Examples

{
  "id": "6b0cea21-2657-4fa3-a331-de646e3cfdc4",
  "pipeline": "pipeline-1",
  "version": "v1",
  "description": "my description",
  "labels": {
    "tag": "production"
  },
  "creation_date": "2020-05-12T16:23:15.456812Z",
  "last_updated": "2020-06-22T18:04:76.123754Z",
  "request_retention_time": 604800,
  "request_retention_mode": "full"
}

Example

data <- list(
  version = "version",  # (optional)
  description = "description",  # (optional)
  labels = list(key = "value"),  # (optional)
  request_retention_time = 0,  # [min: 3.6E+3; max: 2.4192E+6] (optional)
  request_retention_mode = "request_retention_mode"  # one of: [none, metadata, full]  (optional)
)

# Use environment variables
Sys.setenv("UBIOPS_PROJECT" = "YOUR PROJECT NAME")
Sys.setenv("UBIOPS_API_TOKEN" = "YOUR API TOKEN")
result <- ubiops::pipeline_versions_update(
  pipeline.name, version, data
)

# Or provide directly
result <- ubiops::pipeline_versions_update(
  pipeline.name, version, data,
  UBIOPS_PROJECT = "YOUR PROJECT NAME", UBIOPS_API_TOKEN = "YOUR API TOKEN"
)

print(result)

# Or print in JSON format
print(jsonlite::toJSON(result, auto_unbox=TRUE))

# The default API url is https://api.ubiops.com/v2.1
# Want to use a different API url? Provide `UBIOPS_API_URL`, either directly or as environment variable.

pipelines_create

pipelines_create(data)

Create pipelines

Description

Create a pipeline in a project.

The input_fields represent the fields that the input data for pipeline requests should contain. When an object is attached to the pipeline, it means that the input data will be forwarded to these objects.

Required Parameters

  • name: Name of the pipeline. It is unique within a project.
  • input_type: Type of the pipeline input. It can be either structured or plain.
  • input_fields: A list of input fields with name and data_type. In case of plain pipelines, the input_fields should be omitted or given as an empty list. For structured pipelines, it is possible to leave this field empty.
  • output_type: Type of the pipeline output. It can be either structured or plain.
  • output_fields: A list of output fields with name and data_type. In case of plain pipelines, the output_fields should be omitted or given as an empty list. For structured pipelines, it is possible to leave this field empty.

Optional Parameters

  • description: Description of the pipeline
  • labels: Dictionary containing key/value pairs where key indicates the label and value is the corresponding value of that label

Request Examples

A structured pipeline

{
  "name": "pipeline-1",
  "input_type": "structured",
  "input_fields": [
    {
      "name": "field-1",
      "data_type": "int"
    },
    {
      "name": "field-2",
      "data_type": "double"
    }
  ],
  "output_type": "structured",
  "output_fields": [
    {
      "name": "field-1",
      "data_type": "int"
    },
    {
      "name": "field-2",
      "data_type": "double"
    }
  ]
}

A plain pipeline

{
  "name": "pipeline-2",
  "input_type": "plain",
  "output_type": "plain",
  "description": "my description"
}

Response Structure

Details of the created pipeline

  • id: Unique identifier for the pipeline (UUID)
  • name: Name of the pipeline
  • description: Description of the pipeline
  • project: Project name in which the pipeline is created
  • input_type: Type of the pipeline input
  • input_fields: A list of pipeline input fields with name and data_type
  • output_type: Type of the pipeline output
  • output_fields: A list of pipeline output fields with name and data_type
  • labels: Dictionary containing key/value pairs where key indicates the label and value is the corresponding value of that label
  • creation_date: The date when the pipeline was created
  • last_updated: The date when the pipeline was last updated

Response Examples

{
  "id": "6b0cea21-2657-4fa3-a331-de646e3cfdc4",
  "name": "pipeline-1",
  "project": "project-1",
  "description": "my description",
  "input_type": "structured",
  "input_fields": [
    {
      "name": "field-1",
      "data_type": "int"
    },
    {
      "name": "field-2",
      "data_type": "double"
    }
  ],
  "output_type": "structured",
  "output_fields": [
    {
      "name": "field-1",
      "data_type": "int"
    },
    {
      "name": "field-2",
      "data_type": "double"
    }
  ],
  "labels": {
    "tag": "production"
  },
  "creation_date": "2020-03-24T09:43:51.791253Z",
  "last_updated": "2020-03-24T09:43:51.791253Z"
}

{
  "id": "b6f60ebf-48ef-4084-9fbb-9ac0f934093e",
  "name": "pipeline-2",
  "project": "project-1",
  "description": "my description",
  "input_type": "plain",
  "input_fields": [],
  "output_type": "plain",
  "output_fields": [],
  "labels": {
    "tag": "production"
  },
  "creation_date": "2020-05-12T16:23:15.456812Z",
  "last_updated": "2020-05-12T16:23:15.456812Z"
}

Example

data <- list(
  name = "name",
  description = "description",  # (optional)
  input_type = "input_type",  # one of: [structured, plain] 
  input_fields = list(  # (optional)
    list(
      name = "name",
      data_type = "data_type"  # one of: [int, string, double, bool, array_int, array_double, array_string, blob] 
    )
  ),
  output_type = "output_type",  # one of: [structured, plain]  (optional)
  output_fields = list(  # (optional)
    list(
      name = "name",
      data_type = "data_type"  # one of: [int, string, double, bool, array_int, array_double, array_string, blob] 
    )
  ),
  labels = list(key = "value")  # (optional)
)

# Use environment variables
Sys.setenv("UBIOPS_PROJECT" = "YOUR PROJECT NAME")
Sys.setenv("UBIOPS_API_TOKEN" = "YOUR API TOKEN")
result <- ubiops::pipelines_create(
  data
)

# Or provide directly
result <- ubiops::pipelines_create(
  data,
  UBIOPS_PROJECT = "YOUR PROJECT NAME", UBIOPS_API_TOKEN = "YOUR API TOKEN"
)

print(result)

# Or print in JSON format
print(jsonlite::toJSON(result, auto_unbox=TRUE))

# The default API url is https://api.ubiops.com/v2.1
# Want to use a different API url? Provide `UBIOPS_API_URL`, either directly or as environment variable.

pipelines_delete

pipelines_delete(pipeline.name)

Delete a pipeline

Description

Delete a pipeline. This will also delete all versions of the pipeline.

Example

# Use environment variables
Sys.setenv("UBIOPS_PROJECT" = "YOUR PROJECT NAME")
Sys.setenv("UBIOPS_API_TOKEN" = "YOUR API TOKEN")
ubiops::pipelines_delete(
  pipeline.name
)

# Or provide directly
ubiops::pipelines_delete(
  pipeline.name,
  UBIOPS_PROJECT = "YOUR PROJECT NAME", UBIOPS_API_TOKEN = "YOUR API TOKEN"
)

# The default API url is https://api.ubiops.com/v2.1
# Want to use a different API url? Provide `UBIOPS_API_URL`, either directly or as environment variable.

pipelines_get

pipelines_get(pipeline.name)

Get details of a pipeline

Description

Get the details of a single pipeline

Response Structure

Details of the pipeline

  • id: Unique identifier for the pipeline (UUID)
  • name: Name of the pipeline
  • description Description of the pipeline
  • project: Project name in which the pipeline is defined
  • input_type: Type of the pipeline input
  • input_fields: A list of pipeline input fields with name and data_type
  • output_type: Type of the pipeline output
  • output_fields: A list of pipeline output fields with name and data_type
  • labels: Dictionary containing key/value pairs where key indicates the label and value is the corresponding value of that label
  • creation_date: The date when the pipeline was created
  • last_updated: The date when the pipeline was last updated
  • default_version: Default version of the pipeline. If it does not have a default version, it is not set.

Response Examples

{
  "id": "b6f60ebf-48ef-4084-9fbb-9ac0f934093e",
  "name": "pipeline-2",
  "project": "project-1",
  "description": "my description",
  "input_type": "plain",
  "input_fields": [],
  "output_type": "plain",
  "output_fields": [],
  "labels": {
    "tag": "production"
  },
  "creation_date": "2020-03-24T09:43:51.791253Z",
  "last_updated": "2020-05-19T11:52:21.163270Z",
  "default_version": "v1"
}

Example

# Use environment variables
Sys.setenv("UBIOPS_PROJECT" = "YOUR PROJECT NAME")
Sys.setenv("UBIOPS_API_TOKEN" = "YOUR API TOKEN")
result <- ubiops::pipelines_get(
  pipeline.name
)

# Or provide directly
result <- ubiops::pipelines_get(
  pipeline.name,
  UBIOPS_PROJECT = "YOUR PROJECT NAME", UBIOPS_API_TOKEN = "YOUR API TOKEN"
)

print(result)

# Or print in JSON format
print(jsonlite::toJSON(result, auto_unbox=TRUE))

# The default API url is https://api.ubiops.com/v2.1
# Want to use a different API url? Provide `UBIOPS_API_URL`, either directly or as environment variable.

pipelines_list

pipelines_list(labels=NULL)

List pipelines

Description

Pipelines can be filtered according to the labels they have by giving labels as a query parameter. Pipelines that have at least one of the labels on which is filtered, are returned.

Optional Parameters

  • labels: Filter on labels of the pipeline. Should be given in the format 'label:label_value'. Separate multiple label-pairs with a comma (,). This parameter should be given as query parameter.

Response Structure

A list of details of the pipelines in the project

  • id: Unique identifier for the pipeline (UUID)
  • name: Name of the pipeline
  • project: Project name in which the pipeline is defined
  • description: Description of the pipeline
  • input_type: Type of the pipeline input
  • input_fields: A list of pipeline input fields with name and data_type
  • output_type: Type of the pipeline output
  • output_fields: A list of pipeline output fields with name and data_type
  • labels: Dictionary containing key/value pairs where key indicates the label and value is the corresponding value of that label
  • creation_date: The date when the pipeline was created
  • last_updated: The date when the pipeline was last updated

Response Examples

[
  {
    "id": "6b0cea21-2657-4fa3-a331-de646e3cfdc4",
    "name": "pipeline-1",
    "project": "project-1",
    "description": "my description",
    "input_type": "structured",
    "input_fields": [
      {
        "name": "field-1",
        "data_type": "int"
      },
      {
        "name": "field-2",
        "data_type": "double"
      }
    ],
    "output_type": "structured",
    "output_fields": [
      {
        "name": "field-1",
        "data_type": "int"
      },
      {
        "name": "field-2",
        "data_type": "double"
      }
    ],
    "labels": {
      "tag": "production"
    },
    "creation_date": "2020-05-12T16:23:15.456812Z",
    "last_updated": "2020-06-22T18:04:76.123754Z"
  },
  {
    "id": "b6f60ebf-48ef-4084-9fbb-9ac0f934093e",
    "name": "pipeline-2",
    "project": "project-1",
    "description": "my description",
    "input_type": "plain",
    "input_fields": [],
    "output_type": "plain",
    "output_fields": [],
    "labels": {
      "tag": "production"
    },
    "creation_date": "2020-03-24T09:43:51.791253Z",
    "last_updated": "2020-05-19T11:52:21.163270Z"
  }
]

Example

# Use environment variables
Sys.setenv("UBIOPS_PROJECT" = "YOUR PROJECT NAME")
Sys.setenv("UBIOPS_API_TOKEN" = "YOUR API TOKEN")
result <- ubiops::pipelines_list(

  labels = NULL
)

# Or provide directly
result <- ubiops::pipelines_list(

  labels = NULL, 
  UBIOPS_PROJECT = "YOUR PROJECT NAME", UBIOPS_API_TOKEN = "YOUR API TOKEN"
)

print(result)

# Or print in JSON format
print(jsonlite::toJSON(result, auto_unbox=TRUE))

# The default API url is https://api.ubiops.com/v2.1
# Want to use a different API url? Provide `UBIOPS_API_URL`, either directly or as environment variable.

pipelines_update

pipelines_update(pipeline.name, data)

Update a pipeline

Description

Update a pipeline. All necessary fields are validated again. When updating labels, the labels will replace the existing value for labels.

Optional Parameters

  • name: New name for the pipeline
  • description: New description for the pipeline
  • labels: New dictionary containing key/value pairs where key indicates the label and value is the corresponding value of that label. The new labels will replace the existing value for labels.
  • input_type: New type for the pipeline input. It is possible to change the type from plain to structured and vice versa.
  • input_fields: New input fields for the pipeline
  • output_type: New type for the pipeline output. It is possible to change the type from plain to structured and vice versa.
  • output_fields: New output fields for the pipeline
  • default_version: Name of a version of this pipeline which will be assigned as default

If the input type of pipeline is updated to plain, the input fields are deleted. In this case, input_fields should either be omitted or provided as en empty list. If the input type of pipeline is updated to structured, the old input fields are deleted, if there existed any. The new fields are created, if any is provided. If one or more old fields need to be kept, they must be provided again. The same goes for updating the pipeline output.

To delete the input/output fields of a pipeline, provide an empty list for input_fields/output_fields field.

Request Examples

{
  "name": "new-pipeline-name"
}

{
  "description": "New pipeline description",
  "labels": {
    "tag": "production"
  }
}

{
  "input_type": "plain"
}

{
  "input_type": "structured",
  "input_fields": [
    {
      "name": "new-field-1",
      "data_type": "array_double"
    },
    {
      "name": "new-field-2",
      "data_type": "array_string"
    }
  ]
}

{
  "input_type": "structured",
  "input_fields": []
}

{
  "output_type": "structured",
  "output_fields": [
    {
      "name": "new-field-1",
      "data_type": "array_double"
    },
    {
      "name": "new-field-2",
      "data_type": "array_string"
    }
  ]
}

Response Structure

Details of the updated pipeline

  • id: Unique identifier for the pipeline (UUID)
  • name: Name of the pipeline
  • project: Project name in which the pipeline is defined
  • description: Description for the pipeline
  • input_type: Type of the pipeline input
  • input_fields: A list of pipeline input fields with name and data_type
  • output_type: Type of the pipeline output
  • output_fields: A list of pipeline output fields with name and data_type
  • labels: Dictionary containing key/value pairs where key indicates the label and value is the corresponding value of that label
  • creation_date: The date when the pipeline was created
  • last_updated: The date when the pipeline was last updated
  • default_version: Default version of the pipeline. If it does not have a default version, it is not set.

Response Examples

{
  "id": "b6f60ebf-48ef-4084-9fbb-9ac0f934093e",
  "name": "new-pipeline-name",
  "project": "project-1",
  "description": "my description",
  "input_type": "structured",
  "input_fields": [
    {
      "name": "new-field-1",
      "data_type": "array_double"
    },
    {
      "name": "new-field-2",
      "data_type": "array_string"
    }
  ],
  "output_type": "structured",
  "output_fields": [
    {
      "name": "new-field-1",
      "data_type": "array_double"
    },
    {
      "name": "new-field-2",
      "data_type": "array_string"
    }
  ],
  "labels": {
    "tag": "production"
  },
  "creation_date": "2020-03-24T09:43:51.791253Z",
  "last_updated": "2020-05-19T11:52:21.163270Z",
  "default_version": "v1"
}

Example

data <- list(
  name = "name",  # (optional)
  description = "description",  # (optional)
  input_type = "input_type",  # one of: [structured, plain]  (optional)
  input_fields = list(  # (optional)
    list(
      name = "name",
      data_type = "data_type"  # one of: [int, string, double, bool, array_int, array_double, array_string, blob] 
    )
  ),
  output_type = "output_type",  # one of: [structured, plain]  (optional)
  output_fields = list(  # (optional)
    list(
      name = "name",
      data_type = "data_type"  # one of: [int, string, double, bool, array_int, array_double, array_string, blob] 
    )
  ),
  labels = list(key = "value"),  # (optional)
  default_version = "default_version"  # (optional)
)

# Use environment variables
Sys.setenv("UBIOPS_PROJECT" = "YOUR PROJECT NAME")
Sys.setenv("UBIOPS_API_TOKEN" = "YOUR API TOKEN")
result <- ubiops::pipelines_update(
  pipeline.name, data
)

# Or provide directly
result <- ubiops::pipelines_update(
  pipeline.name, data,
  UBIOPS_PROJECT = "YOUR PROJECT NAME", UBIOPS_API_TOKEN = "YOUR API TOKEN"
)

print(result)

# Or print in JSON format
print(jsonlite::toJSON(result, auto_unbox=TRUE))

# The default API url is https://api.ubiops.com/v2.1
# Want to use a different API url? Provide `UBIOPS_API_URL`, either directly or as environment variable.