{"openapi":"3.0.2","info":{"title":"Pipeline Management API v2","description":"The Pipelines API enables programmatic access and control over\n    data processing pipelines. Pipelines can be used to process and enrich data\n    in the HERE Workspace at scale. The Workspace supports the following types of\n    pipelines:\n\n      Stream Pipeline: A continuously-running pipeline that processes unbounded data as it arrives.\n      Batch Pipeline: An intermittently-running pipeline that processes bounded data when an input Data Catalog changes.\n\n    Using this API, these pipelines can be managed from a Continuous\n    Integration/Continuous Delivery platform.","version":"2.17.10"},"externalDocs":{"description":"The developer guide and changelogs are available here.","url":"https://www.here.com/docs/category/pipelines-api"},"servers":[{"url":"Use API Lookup for a base URL"}],"security":[{"Bearer":[]}],"tags":[{"name":"PipelineVersions"},{"name":"Packages"},{"name":"Pipelines"},{"name":"PipelineTemplates"},{"name":"EgressRules"}],"paths":{"/v2/packages":{"parameters":[{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"post":{"tags":["Packages"],"summary":"Upload a new Package.","description":"A Package is the jar file that contains the Pipeline code that you want to run. This endpoint receives and stores the Package file and returns the information about the stored Package. The filename of the jar file has a 200 character limit and the Package file size has 500 MB limit.","operationId":"createPackage","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["jarPackage"],"properties":{"jarPackage":{"type":"string","description":"Jar file to upload. The filename of the jar file has a 200 character limit and the Package file size has a 500 MB limit.","format":"binary"}}}}},"required":true},"responses":{"201":{"description":"Package is successfully uploaded and returned with an id.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelPackage"}}}},"400":{"description":"Package required fields or jar file not provided.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"413":{"description":"Package is too large. Package size limit is 500 MB.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"415":{"description":"Uploaded Package is not a valid Java Archive.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while storing the Package.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/v2/pipelines":{"parameters":[{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"get":{"tags":["Pipelines"],"summary":"Get the list of Pipelines.","description":"This endpoint returns a list of all Pipelines currently defined.","operationId":"listPipelines","responses":{"200":{"description":"List retrieved successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Pipeline"}}}}},"500":{"description":"Internal error while retrieving the list of Pipelines.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Pipelines"],"summary":"Create a new Pipeline.","description":"A Pipeline is the top-level entity introduced to group the work of implementing an actual data processing pipeline, in the form of one or more related PipelineVersions. This endpoint creates a Pipeline with no initial PipelineVersion and returns its metadata, that includes the id assigned to it.","operationId":"createPipeline","requestBody":{"description":"Pipeline to be created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}},"required":true},"responses":{"201":{"description":"Pipeline successfully defined and returned with its id.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}}},"400":{"description":"Required parameters are missing or invalid values were provided.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while defining the Pipeline.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}},"x-codegen-request-body-name":"body"}},"/v2/pipelines/{pipelineId}":{"parameters":[{"$ref":"#/components/parameters/PipelineIdPathParam"},{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"get":{"tags":["Pipelines"],"summary":"Get a Pipeline.","description":"This endpoint returns the details about the Pipeline identified by the pipelineId path parameter.","operationId":"getPipeline","responses":{"200":{"description":"Pipeline retrieved successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}}},"404":{"description":"Pipeline with provided id not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while retrieving the Pipeline.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Pipelines"],"summary":"Update a Pipeline.","description":"Updates the metadata about a pipeline identified by pipelineId. The PUT body contains the updated data. Note that the group field in Pipeline cannot be updated.","operationId":"updatePipeline","requestBody":{"description":"Pipeline details to be updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}},"required":true},"responses":{"200":{"description":"Pipeline updated successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}}},"404":{"description":"Pipeline with provided ID not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while updating the pipeline.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}},"x-codegen-request-body-name":"body"},"delete":{"tags":["Pipelines"],"summary":"Delete a Pipeline.","description":"This endpoint deletes a Pipeline and its set of Pipeline Versions and associated content. The API will return an error if one or more of its Pipeline Versions are either 'running' or 'paused'.","operationId":"deletePipeline","responses":{"204":{"description":"Pipeline deleted successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{}},"404":{"description":"Pipeline with provided id not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"412":{"description":"The specified Pipeline can not be deleted because it has one or more dependent Pipeline Versions which have a state of 'running' or 'paused'.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while deleting the Pipeline.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/v2/pipelines/{pipelineId}/hrn":{"parameters":[{"$ref":"#/components/parameters/PipelineIdPathParam"},{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"get":{"tags":["Pipelines"],"summary":"Get a Pipeline HRN.","description":"This endpoint returns the HRN of the Pipeline identified by the pipelineId path parameter.","operationId":"getPipelineHrn","responses":{"200":{"description":"Pipeline HRN retrieved successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrnResponse"}}}},"404":{"description":"Pipeline with provided id not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while retrieving the Pipeline HRN.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/v2/pipelines/{pipelineId}/snapshots":{"get":{"description":"This endpoint returns a list of the Snapshots associated with a Pipeline, sorted in descending order of time created, limited to the last 7 days and a max of 350 snapshots.","operationId":"listSnapshots","parameters":[{"description":"Identifier for a specific http request. If not present, one should be generated. This header and value should be returned in the http response.","in":"header","name":"X-Request-ID","schema":{"type":"string"}},{"description":"Identifier for all http requests made in service of an incoming http request. If not present, one should be generated. This header and value should be included in all outgoing http requests and should be returned in the response.","in":"header","name":"X-Correlation-ID","schema":{"type":"string"}},{"in":"header","name":"Authorization","schema":{"type":"string"}},{"in":"header","name":"Authorization-Claims","schema":{"type":"string"}},{"description":"System generated identifier (UUID or HRN) for the Pipeline.","examples":{"hrn":{"description":"hrn","summary":"pipelineId in HRN format","value":"hrn:here:pipeline::olp-here:00000000-0000-0000-0000-000000000000"},"uuid":{"description":"uuid","summary":"pipelineId in UUID format","value":"00000000-0000-0000-0000-000000000000"}},"in":"path","name":"pipelineId","required":true,"schema":{"type":"string"}}],"responses":{"201":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Snapshot"},"type":"array"}}},"description":"List retrieved successfully."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}},"description":"Pipeline with provided id not found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}},"description":"Internal error while retrieving the list of Snapshots."}},"summary":"List Snapshots of a Pipeline.","tags":["Snapshots"]}},"/v2/pipelines/{pipelineId}/snapshots/{snapshotId}":{"get":{"description":"This endpoint returns the details about the Snapshot identified by the snapshotId path parameter.","operationId":"getSnapshot","parameters":[{"description":"Identifier for a specific http request. If not present, one should be generated. This header and value should be returned in the http response.","in":"header","name":"X-Request-ID","schema":{"type":"string"}},{"description":"Identifier for all http requests made in service of an incoming http request. If not present, one should be generated. This header and value should be included in all outgoing http requests and should be returned in the response.","in":"header","name":"X-Correlation-ID","schema":{"type":"string"}},{"in":"header","name":"Authorization","schema":{"type":"string"}},{"in":"header","name":"Authorization-Claims","schema":{"type":"string"}},{"description":"System generated identifier (UUID or HRN) for the Pipeline.","examples":{"hrn":{"description":"hrn","summary":"pipelineId in HRN format","value":"hrn:here:pipeline::olp-here:00000000-0000-0000-0000-000000000000"},"uuid":{"description":"uuid","summary":"pipelineId in UUID format","value":"00000000-0000-0000-0000-000000000000"}},"in":"path","name":"pipelineId","required":true,"schema":{"type":"string"}},{"description":"System generated identifier (UUID) for the Snapshot.","in":"path","name":"snapshotId","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Snapshot"}}},"description":"Snapshot retrieved successfully."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}},"description":"Snapshot with provided id not found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}},"description":"Internal error while retrieving the Snapshot."}},"summary":"Get a Snapshot.","tags":["Snapshots"]}},"/v2/pipelines/{pipelineId}/versions":{"parameters":[{"$ref":"#/components/parameters/PipelineIdPathParam"},{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"get":{"tags":["PipelineVersions"],"summary":"Get the list of PipelineVersions for a Pipeline.","description":"This endpoint returns a list of all PipelinesVersions currently defined for a given Pipeline.","operationId":"listPipelineVersions","parameters":[{"$ref":"#/components/parameters/PipelineVersionVerboseQueryParam"}],"responses":{"200":{"description":"List retrieved successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PipelineVersion"}}}}},"500":{"description":"Internal error while retrieving the list of PipelineVersions.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["PipelineVersions"],"summary":"Create a new PipelineVersion.","description":"Defines a new version for the given Pipeline. This includes all the information to run actual processing, including the Pipeline Template, actual input & output catalogs and configurations. This endpoint instantiates the PipelineVersion and returns its metadata, that includes the id assigned to it.","operationId":"createPipelineVersion","requestBody":{"description":"PipelineVersion to be created, with PipelineTemplate id and HRNs of input and output catalogs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineVersion"}}},"required":true},"responses":{"201":{"description":"PipelineVersion successfully created.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineVersion"}}}},"400":{"description":"Required parameters are missing or invalid values were provided.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Pipeline with provided id not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while instantiating the PipelineVersion.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}},"x-codegen-request-body-name":"body"}},"/v2/pipelines/{pipelineId}/versions/{versionId}":{"parameters":[{"$ref":"#/components/parameters/PipelineIdPathParam"},{"$ref":"#/components/parameters/PipelineVersionIdPathParam"},{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"get":{"tags":["PipelineVersions"],"summary":"Get a PipelineVersion.","description":"This endpoint returns the details about the PipelineVersion identified by the versionId path parameter.","operationId":"getPipelineVersion","parameters":[{"$ref":"#/components/parameters/PipelineVersionVerboseQueryParam"}],"responses":{"200":{"description":"PipelineVersion retrieved successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineVersion"}}}},"404":{"description":"Pipeline or PipelineVersion with provided id not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while retrieving the PipelineVersion.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["PipelineVersions"],"summary":"Delete a PipelineVersion.","description":"This endpoint deletes a PipelineVersion. The API will throw an error if the Pipeline Version is in any state other than Ready, or if there are any pending operations.","operationId":"deletePipelineVersion","responses":{"204":{"description":"PipelineVersion deleted successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{}},"404":{"description":"Pipeline or PipelineVersion with provided id not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"412":{"description":"Can't delete a PipelineVersion that is not in READY state or has active operations.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while deleting the PipelineVersion.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/v2/pipelines/{pipelineId}/versions/{versionId}/jobs":{"parameters":[{"$ref":"#/components/parameters/PipelineIdPathParam"},{"$ref":"#/components/parameters/PipelineVersionIdPathParam"},{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"get":{"tags":["PipelineVersions"],"summary":"List Jobs of a PipelineVersion.","description":"This endpoint returns a list of the Jobs a PipelineVersion ran or is currently running.","operationId":"listPipelineVersionJobs","responses":{"200":{"description":"List retrieved successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Job"}}}}},"404":{"description":"Pipeline or PipelineVersion with provided id not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"}}}}},"500":{"description":"Internal error while retrieving the list of Jobs.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}}},"/v2/pipelines/{pipelineId}/versions/{versionId}/logging-configuration":{"parameters":[{"$ref":"#/components/parameters/PipelineIdPathParam"},{"$ref":"#/components/parameters/PipelineVersionIdPathParam"},{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"get":{"tags":["PipelineVersions"],"summary":"The logging configuration.","description":"This endpoint returns the current logging configuration that is set for the PipelineVersion.","operationId":"getLoggingConfiguration","responses":{"200":{"description":"Logging configuration retrieved successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoggingConfiguration"}}}},"404":{"description":"Logging configuration was not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while retrieving the logging configuration.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["PipelineVersions"],"summary":"Update logging configuration for pipeline version.","description":"Updates the logging configuration for the pipeline version. If there is a job currently running, the logging configuration will be applied to that job, and will be applied to the future jobs.","operationId":"updateLoggingConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoggingConfiguration"}}},"required":false},"responses":{"200":{"description":"Logging configuration updated successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoggingConfiguration"}}}},"307":{"description":"To update Logging configuration, please follow the redirect or use URL in the Location header.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"Location":{"description":"To proceed with the operation please follow the URL.","example":"https://xxx.yyy.zzz/operation","schema":{"type":"string"}}}},"400":{"description":"Cannot update logging configuration from current region.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Pipeline or PipelineVersion with provided id not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while updating the pipeline.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}},"x-codegen-request-body-name":"body"}},"/v2/pipelines/{pipelineId}/versions/{versionId}/operations":{"parameters":[{"$ref":"#/components/parameters/PipelineIdPathParam"},{"$ref":"#/components/parameters/PipelineVersionIdPathParam"},{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"get":{"tags":["PipelineVersions"],"summary":"List Operations of a PipelineVersion.","description":"This endpoint returns a list of all Operations completed or pending on a PipelineVersion.","operationId":"listOperations","responses":{"200":{"description":"List retrieved successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Operation"}}}}},"404":{"description":"Combination of Pipeline and PipelineVersion ids not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"}}}}},"500":{"description":"Internal error while retrieving the list of Operations.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}}},"/v2/pipelines/{pipelineId}/versions/{versionId}/operations/activate":{"parameters":[{"$ref":"#/components/parameters/PipelineIdPathParam"},{"$ref":"#/components/parameters/PipelineVersionIdPathParam"},{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"post":{"tags":["PipelineVersions"],"summary":"Schedules a PipelineVersion.","description":"This endpoint updates the state of a PipelineVersion to Scheduled.","operationId":"schedulePipelineVersion","requestBody":{"description":"Optional CatalogVersions to use when running the pipeline;  when CatalogVersions is passed the Version Resolver library will not be used. This becomes a one-time, 'run-now' scenario. If the ScheduledConfiguration of this Pipeline Version was 'version_resolver', this is automatically reset (to empty) to indicate the one-time, 'run-now' scenario and match the fact that CatalogVersions was passed in. The Pipeline Version will be automatically deactivated after this run attempt (whether the run is successful or not) so that this Pipeline Version will not be run automatically again in the future. The JobCatalogVersions (whether passed, or calculated by the Version Resolver) will be stored in the resulting Job record, which will be available via the 'List Jobs' API - after the job starts running on the Spark / Flink cluster.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobCatalogVersions"}}},"required":false},"responses":{"202":{"description":"The PipelineVersion has been scheduled.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}},"307":{"description":"To activate the PipelineVersion, please follow the redirect or use URL in the Location header.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"Location":{"description":"To proceed with the operation please follow the URL.","example":"https://xxx.yyy.zzz/operation","schema":{"type":"string"}}}},"400":{"description":"Cannot schedule a PipelineVersion given its current state, or the state of related data. Pre-requisites to scheduling a PipelineVersion include:\na) the parent Template must have reached a state of 'created'\nb) there can be no other sibling PipelineVersion that is already 'active' (has any State other than 'ready').","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Pipeline id or PipelineVersion id provided was not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while scheduling the PipelineVersion.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}},"x-codegen-request-body-name":"body"}},"/v2/pipelines/{pipelineId}/versions/{versionId}/operations/cancel":{"parameters":[{"$ref":"#/components/parameters/PipelineIdPathParam"},{"$ref":"#/components/parameters/PipelineVersionIdPathParam"},{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"post":{"tags":["PipelineVersions"],"summary":"Cancel a PipelineVersion.","description":"This endpoint cancels a running or paused PipelineVersion. The cancel operation does not save the state of the pipeline version.","operationId":"cancelPipelineVersion","responses":{"202":{"description":"Request to cancel the PipelineVersion is created and returned with its id.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}},"307":{"description":"To cancel the PipelineVersion, please follow the redirect or use URL in the Location header.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"Location":{"description":"To proceed with the operation please follow the URL.","example":"https://xxx.yyy.zzz/operation","schema":{"type":"string"}}}},"400":{"description":"Cannot cancel a PipelineVersion given its current state.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Pipeline or PipelineVersion with provided id not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while submitting the request to cancel the PipelineVersion.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/v2/pipelines/{pipelineId}/versions/{versionId}/operations/deactivate":{"parameters":[{"$ref":"#/components/parameters/PipelineIdPathParam"},{"$ref":"#/components/parameters/PipelineVersionIdPathParam"},{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"post":{"tags":["PipelineVersions"],"summary":"Deactivate a PipelineVersion.","description":"This endpoint deactivates a scheduled PipelineVersion.","operationId":"deactivatePipelineVersion","responses":{"202":{"description":"Request to deactivate the PipelineVersion is created and returned with its id.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}},"400":{"description":"Cannot activate a PipelineVersion given its current state.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Pipeline or PipelineVersion with provided id not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while submitting the request to activate the PipelineVersion.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/v2/pipelines/{pipelineId}/versions/{versionId}/operations/pause":{"parameters":[{"$ref":"#/components/parameters/PipelineIdPathParam"},{"$ref":"#/components/parameters/PipelineVersionIdPathParam"},{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"post":{"tags":["PipelineVersions"],"summary":"Pause a running PipelineVersion.","description":"This endpoint pauses a running PipelineVersion. For a pipeline version using template created for Streaming runtime environment, the pause operation saves a snapshot of the current state of processing. When the pipeline is resumed or upgraded, the pipeline starts from the last saved state. For a pipeline version using template create for Batch runtime environment, the pause operation pauses the future scheduled runs. If a pipeline is currently running then that run will continue until it is successful or failed. For a non scheduled batch pipeline this will return an HTTP status code of 400","operationId":"pausePipelineVersion","responses":{"202":{"description":"Request to pause the PipelineVersion is created and returned with its id.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}},"307":{"description":"To pause the PipelineVersion, please follow the redirect or use URL in the Location header.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"Location":{"description":"To proceed with the operation please follow the URL.","example":"https://xxx.yyy.zzz/operation","schema":{"type":"string"}}}},"400":{"description":"Cannot pause a PipelineVersion given its current state.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Pipeline or PipelineVersion with provided id not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while submitting the request to pause the PipelineVersion.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/v2/pipelines/{pipelineId}/versions/{versionId}/operations/resume":{"parameters":[{"$ref":"#/components/parameters/PipelineIdPathParam"},{"$ref":"#/components/parameters/PipelineVersionIdPathParam"},{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"post":{"tags":["PipelineVersions"],"summary":"Resume a paused PipelineVersion.","description":"This endpoint resumes a paused PipelineVersion.  For a PipelineVersion using template created for Streaming runtime environment, it restarts from the state previously saved when paused. For a pipeline version using template with created for Batch runtime environment, it activates the scheduled runs. For non scheduled batch pipelines this will return a HTTP status code of 400","operationId":"resumePipeline","requestBody":{"description":"Resume request options containing the request details of PipelineVersion to resume.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResumeRequest"}}},"required":false},"responses":{"202":{"description":"Request to resume the PipelineVersion is created and returned with its id.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}},"307":{"description":"To resume the PipelineVersion, please follow the redirect or use URL in the Location header.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"Location":{"description":"To proceed with the operation please follow the URL.","example":"https://xxx.yyy.zzz/operation","schema":{"type":"string"}}}},"400":{"description":"Cannot pause a PipelineVersion given its current state.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Pipeline or PipelineVersion with provided id not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while submitting the request to resume the PipelineVersion.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}},"x-codegen-request-body-name":"body"}},"/v2/pipelines/{pipelineId}/versions/{versionId}/operations/upgrade":{"parameters":[{"$ref":"#/components/parameters/PipelineIdPathParam"},{"$ref":"#/components/parameters/PipelineVersionIdPathParam"},{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"post":{"tags":["PipelineVersions"],"summary":"Upgrade a PipelineVersion.","description":"This endpoint upgrades this PipelineVersion to a different pipeline version as provided in the request. For a pipeline version using template created for Streaming runtime environment, the framework saves the snapshot of the current state of processing and uses the saved state to run the new pipeline version. For pipeline version using template created for Batch runtime environment, the current running job for the version is not stopped, however, the future scheduled runs are canceled. The new pipeline version is scheduled.","operationId":"upgradePipelineVersion","requestBody":{"description":"Upgrade request options containing system generated identifier (UUID) of the PipelineVersion to upgrade to.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpgradeRequest"}}},"required":true},"responses":{"202":{"description":"Request to upgrade the PipelineVersion is created and returned with its id.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}},"307":{"description":"To upgrade the PipelineVersion, please follow the redirect or use URL in the Location header.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"Location":{"description":"To proceed with the operation please follow the URL.","example":"https://xxx.yyy.zzz/operation","schema":{"type":"string"}}}},"400":{"description":"Cannot upgrade a PipelineVersion given its current state.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Pipeline or PipelineVersion with provided id not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while submitting the request to upgrade the PipelineVersion.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}},"x-codegen-request-body-name":"body"}},"/v2/pipelines/{pipelineId}/versions/{versionId}/operations/{operationId}":{"parameters":[{"$ref":"#/components/parameters/PipelineIdPathParam"},{"$ref":"#/components/parameters/PipelineVersionIdPathParam"},{"$ref":"#/components/parameters/OperationIdPathParam"},{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"get":{"tags":["PipelineVersions"],"summary":"Get an Operation of a PipelineVersion.","description":"This endpoint returns the Operation specified.","operationId":"getPipelineVersionOperation","responses":{"200":{"description":"Operation retrieved successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}},"404":{"description":"Specified Pipeline, PipelineVersion or Operation not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while retrieving the Operation.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/v2/runtimeEnvironments":{"parameters":[{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"get":{"tags":["RuntimeEnvironments"],"summary":"Get runtime environments information.","description":"This endpoint returns information about runtime environments currently enabled for the customer or their organization.","operationId":"listRuntimeEnvironments","responses":{"200":{"description":"Runtime environment information retrieved successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuntimeEnvironments"}}}},"500":{"description":"Internal error while retrieving the Runtime Environment information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}},"headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}}}}}},"/v2/resourceProfiles":{"parameters":[{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"get":{"tags":["ResourceProfiles"],"summary":"Get available resource profiles.","description":"This endpoint returns information about resource profiles currently enabled for the customer or their organization.","operationId":"listResourceProfiles","responses":{"200":{"description":"Resource profile information retrieved successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceProfiles"}}}},"500":{"description":"Internal error while retrieving the resource profile information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}},"headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}}}}}},"/v2/templates":{"parameters":[{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"get":{"parameters":[{"name":"linkable","in":"query","description":"If true, get all linkable templates available to the caller to attach as a link to a project.","schema":{"type":"boolean"}}],"tags":["PipelineTemplates"],"summary":"Get the list of PipelineTemplates.","description":"This endpoint returns a list of all PipelineTemplates defined.","operationId":"listPipelineTemplates","responses":{"200":{"description":"List retrieved successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PipelineTemplate"}}}}},"500":{"description":"Internal error while retrieving the list of PipelineTemplates.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"post":{"tags":["PipelineTemplates"],"summary":"Create a new PipelineTemplate.","description":"A PipelineTemplate is the top-level entity which holds the information to fully define and independently reuse a data processing Pipeline, including its implementation. This endpoint creates a PipelineTemplate and returns its metadata, that includes the id assigned to it.","operationId":"createPipelineTemplate","requestBody":{"description":"PipelineTemplate to be created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineTemplate"}}},"required":true},"responses":{"201":{"description":"PipelineTemplate successfully defined and returned with its id.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineTemplate"}}}},"400":{"description":"Required parameters are missing or invalid values were provided.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while defining the PipelineTemplate.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}},"x-codegen-request-body-name":"body"}},"/v2/templates/{templateId}":{"parameters":[{"$ref":"#/components/parameters/TemplateIdPathParam"},{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"get":{"tags":["PipelineTemplates"],"summary":"Get a PipelineTemplate.","description":"This endpoint returns the details about the PipelineTemplate identified by the templateId path parameter.","operationId":"getPipelineTemplate","responses":{"200":{"description":"PipelineTemplate retrieved successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineTemplate"}}}},"404":{"description":"PipelineTemplate with provided id not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while retrieving the PipelineTemplate.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["PipelineTemplates"],"summary":"Delete a PipelineTemplate.","description":"This endpoint delete the PipelineTemplate identified by the templateId path parameter. The PipelineTemplate cannot be in use, meaning that there are PipelineVersions defined with the PipelineTemplate.","operationId":"deletePipelineTemplate","responses":{"204":{"description":"PipelineTemplate deleted successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{}},"404":{"description":"PipelineTemplate with provided id not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"412":{"description":"The specified Pipeline Template can not be deleted because it has one or more dependent Pipeline Versions.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while deleting the PipelineTemplate.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/v2/templates/{templateId}/hrn":{"parameters":[{"$ref":"#/components/parameters/TemplateIdPathParam"},{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"get":{"tags":["PipelineTemplates"],"summary":"Get a PipelineTemplate HRN.","description":"This endpoint returns the HRN of the PipelineTemplate identified by the templateId path parameter.","operationId":"getPipelineTemplateHrn","responses":{"200":{"description":"PipelineTemplate HRN retrieved successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrnResponse"}}}},"404":{"description":"PipelineTemplate with provided id not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while retrieving the PipelineTemplate HRN.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/v2/pipelines/{pipelineId}/versions/{versionId}/scheduler-configuration":{"parameters":[{"$ref":"#/components/parameters/PipelineIdPathParam"},{"$ref":"#/components/parameters/PipelineVersionIdPathParam"},{"$ref":"#/components/parameters/RequestIdHeaderParam"},{"$ref":"#/components/parameters/CorrelationIdHeaderParam"}],"get":{"tags":["PipelineVersions"],"summary":"The scheduler configuration.","description":"This endpoint returns the current scheduler configuration that is set for the PipelineVersion.","operationId":"getSchedulerConfiguration","responses":{"200":{"description":"Scheduler configuration retrieved successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchedulerConfiguration"}}}},"404":{"description":"Pipeline, PipelineVersion or Scheduler configuration was not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while retrieving the scheduler configuration.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["PipelineVersions"],"summary":"Update scheduler configuration for PipelineVersion.","description":"Updates the scheduler configuration for the PipelineVersion. This can only be applied to PipelineVersions that are in the READY state.","operationId":"updateSchedulerConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchedulerConfiguration"}}},"required":false},"responses":{"200":{"description":"Scheduler configuration updated successfully.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchedulerConfiguration"}}}},"404":{"description":"Pipeline or PipelineVersion with provided id not found.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal error while updating the pipeline.","headers":{"X-Request-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"value of the request header or generated value.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}},"x-codegen-request-body-name":"body"}},"/v2/egressRules":{"get":{"tags":["EgressRules"],"summary":"List all egress rules in a realm. Any user authenticated with realm can access this endpoint.","operationId":"listEgressRules","parameters":[{"name":"X-Request-ID","in":"header","description":"Identifier for a specific http request. If not present, one should be generated. This header and value should be returned in the http response.","schema":{"type":"string"}},{"name":"X-Correlation-ID","in":"header","description":"Identifier for all http requests made in service of an incoming http request. If not present, one should be generated. This header and value should be included in all outgoing http requests and should be returned in the response.","schema":{"type":"string"}}],"responses":{"200":{"description":"List retrieved successfully.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EgressRule"}}}}},"403":{"description":"Authorization for this request failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["EgressRules"],"summary":"Create one or more egress rules atomically. If one or more rules supplied by the request already exist for the realm then request is declined. User should have OrgAdmin role within the realm to be able to access this endpoint.","operationId":"createEgressRules","parameters":[{"name":"X-Request-ID","in":"header","description":"Identifier for a specific http request. If not present, one should be generated. This header and value should be returned in the http response.","schema":{"type":"string"}},{"name":"X-Correlation-ID","in":"header","description":"Identifier for all http requests made in service of an incoming http request. If not present, one should be generated. This header and value should be included in all outgoing http requests and should be returned in the response.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"List of egress rules to be created.","items":{"$ref":"#/components/schemas/EgressRule"}}}},"required":true},"responses":{"201":{"description":"Rules created successfully","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EgressRule"}}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Authorization for this request failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"409":{"description":"Conflict with existing rules. Error message provides information on destinations that are already exist in realm.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/v2/egressRules/{ruleId}":{"get":{"tags":["EgressRules"],"summary":"Get a specific egress rule. Any user authenticated with realm can access this endpoint.","operationId":"getEgressRule","parameters":[{"name":"X-Request-ID","in":"header","description":"Identifier for a specific http request. If not present, one should be generated. This header and value should be returned in the http response.","schema":{"type":"string"}},{"name":"X-Correlation-ID","in":"header","description":"Identifier for all http requests made in service of an incoming http request. If not present, one should be generated. This header and value should be included in all outgoing http requests and should be returned in the response.","schema":{"type":"string"}},{"name":"ruleId","in":"path","required":true,"schema":{"maxLength":36,"minLength":0,"type":"string"}}],"responses":{"200":{"description":"Egress rule details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EgressRule"}}}},"403":{"description":"Authorization for this request failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"409":{"description":"EgressRule not found for the provided identifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["EgressRules"],"summary":"Delete a specific egress rule. User should have OrgAdmin role within the realm to be able to access this endpoint.","operationId":"deleteEgressRule","parameters":[{"name":"X-Request-ID","in":"header","description":"Identifier for a specific http request. If not present, one should be generated. This header and value should be returned in the http response.","schema":{"type":"string"}},{"name":"X-Correlation-ID","in":"header","description":"Identifier for all http requests made in service of an incoming http request. If not present, one should be generated. This header and value should be included in all outgoing http requests and should be returned in the response.","schema":{"type":"string"}},{"name":"ruleId","in":"path","required":true,"schema":{"maxLength":36,"minLength":0,"type":"string"}}],"responses":{"204":{"description":"Rule deleted successfully.","headers":{"X-Request-ID":{"description":"Value of the request header or generated value.","schema":{"type":"string"}},"X-Correlation-ID":{"description":"Value of the request header or generated value.","schema":{"type":"string"}}},"content":{}},"403":{"description":"Authorization for this request failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"EgressRule not found for the provided identifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/v2/egressRules/auditlog":{"get":{"tags":["EgressRules"],"summary":"Retrieve a list of actions applied to EgressRules in a realm. User should have OrgAdmin role within the realm to be able to access this endpoint.","operationId":"getEgressRulesAuditLog","parameters":[{"name":"X-Request-ID","in":"header","description":"Identifier for a specific http request. If not present, one should be generated. This header and value should be returned in the http response.","schema":{"type":"string"}},{"name":"X-Correlation-ID","in":"header","description":"Identifier for all http requests made in service of an incoming http request. If not present, one should be generated. This header and value should be included in all outgoing http requests and should be returned in the response.","schema":{"type":"string"}},{"name":"ruleId","in":"query","description":"Filter actions applied to EgressRules in a realm to only include those with a ruleId that matches the ruleId query parameter.","schema":{"type":"string"}},{"name":"ruleDestination","in":"query","description":"Filter actions applied to EgressRules in a realm to only include those with a ruleDestination that matches the ruleDestination query parameter.","schema":{"type":"string"}},{"name":"action","in":"query","description":"Filter actions applied to EgressRules in a realm to only include those with an action that matches the action query parameter.","schema":{"pattern":"created|deleted","type":"string","enum":["created","deleted"]}},{"name":"principal","in":"query","description":"Filter actions applied to EgressRules in a realm to only include those with a principal that matches the principal query parameter.","schema":{"type":"string"}}],"responses":{"200":{"description":"List retrieved successfully.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AuditLogEntry"}}}}},"403":{"description":"Authorization for this request failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}}},"components":{"parameters":{"CorrelationIdHeaderParam":{"name":"X-Correlation-ID","in":"header","description":"Common identifier for multiple http requests to indicate they are associated in some way. If not present, one will be generated.","schema":{"type":"string"}},"OperationIdPathParam":{"name":"operationId","in":"path","description":"System generated identifier for the Operation.","required":true,"schema":{"type":"string"}},"PipelineIdPathParam":{"name":"pipelineId","in":"path","description":"System generated identifier for the Pipeline.","required":true,"schema":{"type":"string"}},"PipelineVersionIdPathParam":{"name":"versionId","in":"path","description":"System generated identifier for the PipelineVersion.","required":true,"schema":{"type":"string"}},"PipelineVersionVerboseQueryParam":{"name":"verbose","in":"query","description":"Include the latest Job and Operation status","schema":{"type":"boolean"}},"RequestIdHeaderParam":{"name":"X-Request-ID","in":"header","description":"Identifier for a specific http request. If not present, one will be generated.","schema":{"type":"string"}},"TemplateIdPathParam":{"name":"templateId","in":"path","description":"System generated identifier for the PipelineTemplate.","required":true,"schema":{"type":"string"}}},"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A token obtained from a separate endpoint using client credentials and an OAuth 1.0a HMAC-SHA256 signed request. For more information on how to get a bearer token, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html."}},"schemas":{"AuditLogEntry":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"ruleId":{"type":"string","description":"Identifier of EgressRule that was affected by action.","example":"286aad61-50f2-4745-a336-a087aaa0e746"},"ruleDestination":{"type":"string","description":"Destination of EgressRule that was affected by action.","example":"*.weather.gov"},"action":{"type":"string","description":"Action applied to EgressRule.","example":"created","enum":["created","deleted"]},"principal":{"type":"string","description":"HERE identifier for user/client that issued this action.","example":"HERE-e6b0d0ee-cf88-344f-a75d-26c678161234"},"realm":{"type":"string","description":"System generated: Realm under which EgressRule exists.","example":"olp-here"}},"description":"Record representing change made to an EgressRule."},"ClusterConfiguration":{"required":["supervisorUnits","workerUnits","workers"],"type":"object","properties":{"workers":{"minimum":1,"type":"integer","description":"Number of workers.","format":"int32","example":4},"workerUnits":{"maximum":15,"minimum":1,"type":"integer","description":"Number of resource units per worker.","format":"int32","example":2},"workerResourceProfileId":{"type":"string","description":"Identifier of the resource profile requested for workers.","example":"HS1"},"workerAdditionalOverheadMemory":{"multipleOf":0.01,"minimum":0,"exclusiveMinimum":false,"type":"number","description":"The factor of proportionality of additional overhead memory per worker unit in fraction, can be greater than or equal to zero. The default maximum value is 0.05 (but that could be raised on a realm basis).","format":"float","example":0.02},"supervisorUnits":{"maximum":15,"minimum":1,"type":"integer","description":"Number of resource units per supervisor.","format":"int32","example":3},"supervisorResourceProfileId":{"type":"string","description":"Identifier of the resource profile requested for the supervisor.","example":"HS1"},"supervisorAdditionalOverheadMemory":{"multipleOf":0.01,"minimum":0,"exclusiveMinimum":false,"type":"number","description":"The factor of proportionality of additional overhead memory per supervisor unit in fraction, can be greater than or equal to zero. The default maximum value is 0.05 (but that could be raised on a realm basis).","format":"float","example":0.02},"gcProfile":{"type":"string","description":"GC selected for this PipelineVersion. Refer to the GcProfileDefinition component for details.","example":"g1gc"}},"description":"Configuration for the cluster when submitting a pipeline version."},"EgressRule":{"type":"object","properties":{"created":{"type":"string","description":"System generated: Time when this EgressRule was created. This is in ISO-8601 calendar system.","format":"date-time","example":"2007-12-03T09:15:30Z"},"id":{"type":"string","description":"System generated: Unique id of this Egress Rule","example":"286aad61-50f2-4745-a336-a087aaa0e746"},"description":{"type":"string","description":"Optional Egress Rule description","example":"Allow access to National Weather Services APIs"},"destination":{"type":"string","description":"IP address or DNS name for this egress Rule. Wildcards are allowed in DNS names only in leftmost part and not right before a public suffix. For example, *.example.com is allowed, but *.*.com or *.com or *.co.uk are not. DNS name cannot be a public suffix.","example":"*.weather.gov"},"destinationType":{"type":"string","description":"Defines destination type for this EgressRule.","example":"host","readOnly":true,"enum":["ipAddress","host"]},"realm":{"type":"string","description":"System generated: The realm under which the rule will be applied.","example":"olp-here"}},"description":"Represents a rule that allows access from a pipeline namespace to host or IP address."},"ErrorMessage":{"type":"object","properties":{"status":{"type":"integer","description":"Duplicate of the HTTP status that is returned.","format":"int32","readOnly":true,"example":400},"code":{"type":"string","description":"Error code that pertains to a specific error.","readOnly":true,"example":"E1000"},"message":{"type":"string","description":"This is the message for the error.","readOnly":true,"example":"Validation Failed"},"messageTemplate":{"type":"string","description":"Message template key that is used to look up a template for localization support. The curly brackets are utilized for looking up the property to get the message. If there are no curly brackets, then the message does not have a template key.","readOnly":true,"example":"{validation.error}"},"templateOptions":{"type":"object","additionalProperties":{"type":"object","properties":{}},"description":"Key -> value map of options to be used in a template. This can be passed in for localization to insert in values. A localized template that uses these may look like \"The value must be larger than {exampleKey}\" where {exampleKey} is replaced with a value for \"exampleKey\" from the returned map.","readOnly":true},"errors":{"uniqueItems":true,"type":"array","description":"Set of validation error messages.","readOnly":true,"items":{"$ref":"#/components/schemas/ValidationErrorMessage"}}},"description":"HTTP Error message thrown by the service"},"GcProfileDefinition":{"description":"Model representing Garbage Collector (GC) profile. Each GC profile is identified by unique ID, name, and description that describes its behavior and settings. These profiles are used to configure the garbage collection strategy for the pipeline execution.","type":"object","properties":{"id":{"description":"The unique identifier for a GC profile.","type":"string","readOnly":true,"example":"g1gc"},"name":{"description":"The human-readable name of a GC profile.","type":"string","readOnly":true,"example":"G1 GC"},"description":{"description":"The description of a GC profile that outlines its unique characteristics.","type":"string","readOnly":true,"example":"G1 GC is low-pause, region-based collector optimized for large heaps and throughput."}}},"HrnResponse":{"type":"object","properties":{"hrn":{"type":"string","description":"Unique HERE Resource Name of an entity.","readOnly":true,"example":"hrn:here:pipeline:::6d9c8dd6-56dc-49af-83f2-d97896aa8bf0"}},"description":"HRN of an entity."},"InputCatalogVersion":{"required":["processingType","version"],"type":"object","properties":{"processingType":{"type":"string","description":"How the input catalog should be processed.","example":"changes","enum":["changes","reprocess","no_changes"]},"version":{"type":"integer","description":"Version of the input catalog to process.","format":"int64","example":2},"sinceVersion":{"type":"integer","description":"Changes should be processed since this given version.","format":"int64","example":1}}},"Job":{"type":"object","properties":{"id":{"type":"string","description":"System generated identifier (UUID) for the Job.","format":"uuid","readOnly":true,"example":"00112233-4455-6677-8899-aabbccddeeff"},"state":{"type":"string","description":"The current state of the Job. Immediately after creation, Job has state 'starting'","readOnly":true,"example":"running","enum":["starting","running","completed","failed","canceled"]},"catalogVersions":{"$ref":"#/components/schemas/JobCatalogVersions"},"created":{"type":"string","description":"Time when this Job was created. This is in ISO-8601 calendar system.","format":"date-time","readOnly":true,"example":"2017-12-03T10:15:30+01:00"},"updated":{"type":"string","description":"Time when this Job last updated. This is in ISO-8601 calendar system.","format":"date-time","readOnly":true,"example":"2017-12-03T10:15:30+01:00"},"runAsId":{"type":"string","description":"RunAsId Id that the job was run with.","readOnly":true},"runtimeEnvironmentPatch":{"description":"This field describes the internal runtime environment in format x.y.z","example":"batch-3.0.0","readOnly":true,"type":"string"},"loggingUrl":{"type":"string","description":"URL pointing to the logs of the running Job.","readOnly":true,"example":"https://splunk.metrics.platform.here.com/en-US/app/olp-realm/search?q=search+index%3Dolp-realm+source%3D%22*%2Fapplication_1122334455667_8899%2F*%22+"},"pipelineUIUrl":{"type":"string","description":"URL pointing to pipeline UI endpoint of running Job.","readOnly":true,"example":"https://pipelines.platform.here.com/jobs/bd03d684-3371-40ba-81f8-3ffbede12506/sparkui"},"executionMode":{"type":"string","description":"How this Job was started: 'on-demand' (i.e. 'run now'), 'scheduled', or based on a time-based schedule","readOnly":true,"example":"scheduled","enum":["on-demand","scheduled","time-schedule"]},"highAvailability":{"type":"boolean","description":"Is High Availability enabled or disabled (true/false) using standby master.","readOnly":true,"example":true},"actualRegionId":{"type":"string","description":"This field describes the region where this Pipeline Job is executing or was executed.","readOnly":true,"example":"eu-ireland"},"pipelineVersionId":{"deprecated":true,"description":"System generated identifier (UUID) of the parent PipelineVersion.","example":"00112233-4455-6677-8899-aabbccddeeff","format":"uuid","readOnly":true,"type":"string"}},"description":"Description of one processing Job submitted to the processing cluster by an active PipelineVersion."},"JobCatalogVersions":{"description":"Versions of the input and output catalog submitted to be passed to the Job when it is run.","allOf":[{"$ref":"#/components/schemas/OperationOptions"},{"type":"object","properties":{"inputCatalogs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/InputCatalogVersion"},"description":"Versions of the input catalogs the Job processes, identified by symbolic catalog name."},"outputCatalog":{"$ref":"#/components/schemas/OutputCatalogVersion"},"runAsId":{"pattern":"hrn:(here|here-dev|here-cn|here-cn-dev):account:[a-zA-Z-]*:[a-zA-Z-]+:[a-zA-Z0-9/-]{3,63}","type":"string","description":"RunAsId Id to run the pipeline","example":"hrn:here-dev:account::HERE:app/test-runas-id"},"snapshotId":{"type":"string","format":"uuid","description":"Optional snapshot id to activate pipeline with","example":"183f9bcc-c86e-11e9-1836-2a2ae2d83743"},"useLatestCheckpoint":{"description":"True if the latest available checkpoint should be used to activate this pipeline.  Activation will fail if no checkpoint is found (e.g., the checkpoint has expired).","example":false,"type":"boolean"}}}]},"Logger":{"required":["level","name"],"type":"object","properties":{"level":{"type":"string","description":"Logger level.","example":"debug","enum":["error","warn","info","debug"]},"name":{"type":"string","description":"The logging name that ws set in the Logger for the class.","example":"com.some.package.MyPipeline"}},"description":"Logger."},"Loggers":{"required":["root"],"type":"object","properties":{"logger":{"type":"array","description":"List of Loggers.","items":{"$ref":"#/components/schemas/Logger"}},"root":{"$ref":"#/components/schemas/RootLogger"}}},"LoggingConfiguration":{"required":["configuration"],"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/LoggingConfigurationWrapper"}},"description":"A logging configuration. This supports the JSON format for Log4j 2. It will only support the configurable options that are supported by pipeline management. This setting the root logger level as well as adding individual loggers and their respective levels."},"LoggingConfigurationWrapper":{"required":["loggers"],"type":"object","properties":{"loggers":{"$ref":"#/components/schemas/Loggers"}}},"ModelPackage":{"required":["fileName"],"type":"object","properties":{"id":{"type":"string","description":"System generated identifier (UUID) for the Package.","format":"uuid","readOnly":true,"example":"00112233-4455-6677-8899-aabbccddeeff"},"fileName":{"type":"string","description":"Name of the uploaded .jar file (200 character max length)","example":"streaming_traffic_analyzer.jar"},"mainClass":{"type":"string","description":"Main class found in the Manifest file of the Package jar file. This is optional and can be utilized by a client to indicate a default main class, for example. To set this in the Manifest file, the conventional label of 'Main-Class' is expected.","readOnly":true,"example":"com.here.Pipeline"},"entryPoints":{"type":"array","description":"Entry points Entry points found in the Manifest file of the Package jar file. This is optional and can be utilized by a client to recommend possible main class choices, for example. To set this in the Manifest file, the label of 'Entry-Point' (singular) is expected. Note: although the label 'Entry-Point' is singular, this will provide a list of one or more fully-qualified classnames  (separated by spaces) in the Manifest file.","readOnly":true,"example":"com.here.Pipeline1, com.here.Pipeline2","items":{"type":"string"}}},"description":"A Package is JAR file that contains the implementation code of a Pipeline and is used in one or more PipelineTemplates."},"Operation":{"required":["requestType"],"type":"object","properties":{"id":{"type":"string","description":"System generated identifier (UUID) for the Operation.","format":"uuid","readOnly":true,"example":"00112233-4455-6677-8899-aabbccddeeff"},"pipelineVersionId":{"deprecated":true,"description":"System generated identifier (UUID) for the Pipeline Version of the Operation.","example":"00112233-4455-6677-8899-aabbccddeeff","format":"uuid","readOnly":true,"type":"string"},"requestType":{"type":"string","description":"The type of the Operation requested.","example":"activate","enum":["activate","deactivate","pause","resume","cancel","upgrade","restart","run","job_terminate","job_terminate_to_ready","maintenance"]},"state":{"type":"string","description":"Current state of the Operation.","readOnly":true,"example":"accepted","enum":["accepted","being_processed","succeeded","failed"]},"message":{"type":"string","description":"Message related to the state of the Operation.","readOnly":true,"example":"Operation failed with error - Main class not found"},"userId":{"type":"string","description":"HERE System generated identifier (UUID) for the user that requested the Operation.","readOnly":true,"example":"HERE-e6b0d0ee-cf88-344f-a75d-26c678161234"},"clientId":{"type":"string","description":"HERE Client identifier for the app used by the user that requested the Operation.","readOnly":true},"runAsId":{"type":"string","description":"RunAsId that the pipeline will run as.","readOnly":true},"created":{"type":"string","description":"Time when the Operation event was created. This is in ISO-8601 calendar system.","format":"date-time","readOnly":true,"example":"2007-12-03T10:15:30+01:00"},"options":{"$ref":"#/components/schemas/OperationOptions"}},"description":"An Operation represents a request to control, and change state, submitted by the user for a PipelineVersion."},"OperationOptions":{"type":"object","properties":{"highAvailability":{"type":"boolean","description":"Defines if the pipeline is highly available using a standby master","example":true}},"description":"Common options for an operation."},"OutputCatalogVersion":{"required":["baseVersion"],"type":"object","properties":{"baseVersion":{"type":"integer","description":"Latest version available in the output catalog when the Job is submitted. The Job commits new data on top of this version.","format":"int64","example":3}}},"Pipeline":{"required":["name"],"type":"object","properties":{"id":{"type":"string","description":"System generated identifier (UUID) for the Pipeline.","format":"uuid","readOnly":true,"example":"00112233-4455-6677-8899-aabbccddeeff"},"name":{"maxLength":64,"minLength":3,"type":"string","description":"User provided name of the Pipeline.","example":"Tire traction weather adjustment"},"description":{"maxLength":512,"minLength":0,"type":"string","description":"Additional text describing the Pipeline.","example":"Weather analysis per region processed to adjust tire traction in real time."},"realm":{"type":"string","description":"The realm under which the pipeline will run and be shared.","readOnly":true,"example":"olp-here"},"groupId":{"pattern":"GROUP-\\p{XDigit}{8}-(\\p{XDigit}{4}-){3}\\p{XDigit}{12}","type":"string","description":"Sharing group identifier in which this pipeline will be created.  Required unless this pipeline is created in project scope (with a project-scoped token) in which case this field must be null.","example":"GROUP-00000000-0000-0000-0000-000000000000"},"hrn":{"type":"string","description":"Unique HERE Resource Name of this pipeline.","readOnly":true,"example":"hrn:here:pipeline:::00112233-4455-6677-8899-aabbccddeeff"},"contactEmail":{"maxLength":256,"type":"string","description":"A single contact e-mail address for this Pipeline. A 'distribution list' or 'group' e-mail address is strongly recommended. This field is required.","example":"group.list@example.com"},"home":{"type":"string","description":"Resource Home for this pipeline, if available. At this time, only Project HRN is supported as resource home. See Authorization API","readOnly":true,"example":"hrn:here:authorization::olp-here:project/11111111-0000-1111-0000-111111111111"},"homeStatus":{"type":"integer","format":"int32","description":"HTTP status code returned from the Resource Home system of record (Authorization Project Administration) while retrieving the \"home\" value, if any. This field may be useful to differentiate between null home values due to the Resource Home not existing from errors communicating with the Resource Home system of record.","readOnly":true,"example":200},"created":{"type":"string","description":"Time when this Pipeline was created. This is in ISO-8601 calendar system.","format":"date-time","readOnly":true,"example":"2007-12-03T10:15:30+01:00"},"updated":{"type":"string","description":"Time when this Pipeline was last updated. This is in ISO-8601 calendar system.","format":"date-time","readOnly":true,"example":"2007-12-03T10:15:30+01:00"}},"description":"A Pipeline is the top-level entity introduced to group the work of implementing an actual data processing pipeline, in the form of one or more related PipelineVersions."},"PipelineTemplate":{"required":["defaultClusterConfiguration","entryPointClassName","inputCatalogIds","name","packageId"],"type":"object","properties":{"id":{"type":"string","description":"System generated identifier (UUID) of the Pipeline Template.","format":"uuid","readOnly":true,"example":"00112233-4455-6677-8899-aabbccddeeff"},"name":{"maxLength":64,"minLength":3,"type":"string","description":"User provided name for the Pipeline Template.","example":"Road Sign Processing Template"},"state":{"type":"string","description":"Current state of the Pipeline Template.","readOnly":true,"example":"created","enum":["creating","created","creation_failed"]},"runtimeEnvironment":{"type":"string","description":"The runtime environment to run. For the list of supported runtime environments, see developer documentation at https://developer.here.com/documentation/pipeline/dev_guide/topics/creating-pipelines.html and the list of available runtimes for the customer returned by the GET ./runtimeEnvironments endpoint.","example":"stream-x.y.z"},"packageId":{"type":"string","description":"System generated identifier (UUID) for the Package containing the implementation of this PipelineTemplate.","format":"uuid","example":"00112233-4455-6677-8899-aabbccddeeff"},"entryPointClassName":{"pattern":"([\\p{L}_$][\\p{L}\\p{N}_$]*\\.)*[\\p{L}_$][\\p{L}\\p{N}_$]*","type":"string","description":"The fully qualified class name of the entry point of this PipelineTemplate.","example":"com.some.package.MyPipeline"},"groupId":{"pattern":"GROUP-\\p{XDigit}{8}-(\\p{XDigit}{4}-){3}\\p{XDigit}{12}","type":"string","description":"Sharing group identifier in which this pipeline template will be created.  Required unless this pipeline template is created in project scope (with a project-scoped token) in which case this field must be null.","example":"GROUP-00000000-0000-0000-0000-000000000000"},"hrn":{"type":"string","description":"Unique HERE Resource Name of this pipeline template.","readOnly":true,"example":"hrn:here:pipeline-template:::00112233-4455-6677-8899-aabbccddeeff"},"defaultClusterConfiguration":{"$ref":"#/components/schemas/ClusterConfiguration"},"inputCatalogIds":{"type":"array","description":"List of input catalog identifiers for PipelineTemplate.  This list of identifiers can be used by a client to describe a list of HRNs needed for a valid Pipeline Version. Each identifier is an alpha-numeric string (_- are also allowed) providing a label for a catalog HRN.","example":"\"weather\", \"traffic\"","items":{"type":"string"}},"description":{"maxLength":512,"minLength":0,"type":"string","description":"Additional text describing the Pipeline Template.","example":"Road sign processing template to be applied to all RSP Pipelines"},"defaultRuntimeConfiguration":{"type":"string","description":"Default runtime config in Java Properties format (as a String). Any runtime configuration values supplied in this PipelineTemplate will provide default values for PipelineVersions using this Template. If a PipelineVersion has its own runtime configuration values, they will be added to any defaults available from the parent PipelineTemplate. PipelineVersion runtime configuration values with the same key will over-ride any default configuration values from the PipelineTemplate. The application of these default values occurs dynamically whenever the PipelineVersion is run.  The combined configuration values are made available in a resource file named `application.properties` on the runtime classpath.  For more information, see the \"Configuration File Reference\" section of the developer documentation.\n\nThe maximum property 'name' size is 2048 characters, the maximum property 'value' size is 8192 characters, and the maximum total size of this defaultRuntimeConfiguration string is 10243 characters.","example":"processing.type=defaultoverwrite=disabledskipDuplicates=enabled"},"created":{"type":"string","description":"Time when this PipelineTemplate was created. This is in ISO-8601 calendar system.","format":"date-time","readOnly":true,"example":"2007-12-03T10:15:30+01:00"},"updated":{"type":"string","description":"Time when this PipelineTemplate was last updated. This is in ISO-8601 calendar system.","format":"date-time","readOnly":true,"example":"2007-12-03T10:15:30+01:00"},"realm":{"type":"string","description":"The realm for this PipelineTemplate","readOnly":true,"example":"olp-here"}},"description":"A PipelineTemplate is the top-level entity which holds the information to fully define and independently reuse a data processing Pipeline, including its implementation, the schema for its required input and output catalogs, and its default configuration."},"PipelineVersion":{"required":["inputCatalogs","name","outputCatalogHRN","pipelineTemplateId"],"type":"object","properties":{"id":{"type":"string","description":"System generated identifier (UUID) for this PipelineVersion.","format":"uuid","readOnly":true,"example":"00112233-4455-6677-8899-aabbccddeeff"},"pipelineId":{"deprecated":true,"description":"System generated identifier (UUID) for the parent Pipeline.","example":"00112233-4455-6677-8899-aabbccddeeff","format":"uuid","readOnly":true,"type":"string"},"name":{"maxLength":64,"minLength":3,"type":"string","description":"Name of this PipelineVersion, provided by the user.","example":"Northern Europe Weather Analysis"},"state":{"type":"string","description":"Current state of the PipelineVersion.","readOnly":true,"example":"ready","enum":["ready","scheduled","running","paused"]},"pipelineTemplateId":{"type":"string","description":"System generated identifier (UUID) for the Pipeline Template that specifies implementation and relative metadata to run the Pipeline Version.","format":"uuid","example":"00112233-4455-6677-8899-aabbccddeeff"},"inputCatalogs":{"type":"object","additionalProperties":{"type":"string"},"description":"Input catalogs for the PipelineVersion as key, HRN pairs. Each key is an alpha-numeric string (_- are also allowed) identifying the catalog."},"outputCatalogHRN":{"pattern":"hrn:(here|here-dev):data:::[a-z][a-z0-9\\-]{2,62}","type":"string","description":"Unique HERE Resource Name of the output catalog.","example":"hrn:here:data:::my-output"},"schedulerConfiguration":{"$ref":"#/components/schemas/SchedulerConfiguration"},"nextJobAttempt":{"type":"string","description":"Time when this PipelineVersion is set to be triggered next, or empty if not applicable. This is in ISO-8601 calendar system.","format":"date-time","readOnly":true},"versionNumber":{"type":"integer","description":"The version number of this PipelineVersion for a given Pipeline.  Starts with 1, incrementing for each new PipelineVersion associated with a given Pipeline.","format":"int32","readOnly":true,"example":2},"clusterConfiguration":{"$ref":"#/components/schemas/ClusterConfiguration"},"customRuntimeConfiguration":{"type":"string","description":"The custom runtime configuration for this Pipeline Version. Runtime configuration settings supplied here will be added to any default runtime configuration settings from the parent Pipeline Template. Any runtime configuration settings here will over-ride any defaults from the parent Pipeline Template which are using the same key. The configuration settings are combined and applied dynamically whenever this Pipeline Version is run.   The combined configuration values are made available in a resource file named `application.properties` on the runtime classpath. When a particular Pipeline Version is retrieved, only the runtime configuration settings that were stored directly as part of the PipelineVersion will be returned; any runtime configuration settings from the parent Pipeline Template are visible only in the Template. For more information, see the \"Configuration File Reference\" section of the developer documentation.\n\nThe maximum property 'name' size is 2048 characters, the maximum property 'value' size is 8192 characters, and the maximum total size of this customRuntimeConfiguration string is 10243 characters.","example":"processing.type=live\noverwrite=enabled\nskipDuplicates=disabled\n"},"streamConfiguration":{"type":"object","additionalProperties":{"type":"object","properties":{},"description":"Allows overriding of the Flink Configuration. The properties that are allowed are limited.","example":{"taskmanager.numberOfTaskSlots":2}},"description":"Allows overriding of the Flink Configuration. The properties that are allowed are limited.","example":{"taskmanager.numberOfTaskSlots":2}},"runAsId":{"type":"string","description":"RunAsId Id to run the pipeline","example":"hrn:here-dev:account::HERE:app/test-runas-id"},"runtimeEnvironmentPatch":{"description":"This field describes the internal runtime environment in format x.y.z","example":"batch-3.0.0","readOnly":true,"type":"string"},"billingTag":{"maxLength":16,"minLength":4,"pattern":"[0-9a-zA-Z_-]*","type":"string","description":"Billing tag for this Pipeline Version. Might be required for a realm.","example":"dataProcessing"},"loggingUrl":{"type":"string","description":"URL pointing to the logs of the running PipelineVersion.","readOnly":true,"example":"https://splunk.metrics.platform.here.com/en-US/app/olp-realm/search?q=search+index%3Dolp-realm+source%3D%22*%2Fapplication_1122334455667_8899%2F*%22+"},"pipelineUIUrl":{"type":"string","description":"URL pointing to pipeline UI endpoint of running PipelineVersion.","readOnly":true,"example":"https://pipelines.platform.here.com/jobs/bd03d684-3371-40ba-81f8-3ffbede12506/sparkui"},"latestOperation":{"$ref":"#/components/schemas/Operation"},"latestJob":{"$ref":"#/components/schemas/Job"},"multiRegionEnabled":{"type":"boolean","description":"This field determines whether the Multi-Region Failover feature is enabled for this Pipeline Version.","example":true},"targetRegionId":{"type":"string","description":"This field describes the region where this Pipeline Version would run, if started at this point of time. Its value is either the primary or secondary region, depending on which is considered active for this pipeline version.","readOnly":true,"example":"eu-ireland"},"created":{"type":"string","description":"Time when this PipelineVersion was created. This is in ISO-8601 calendar system.","format":"date-time","readOnly":true,"example":"2007-12-03T10:15:30+01:00"},"updated":{"type":"string","description":"Time when this PipelineVersion was last updated. This is in ISO-8601 calendar system.","format":"date-time","readOnly":true,"example":"2007-12-03T10:15:30+01:00"}},"description":"Model representing a configured PipelineVersion. This includes all the configuration to run actual processing, in particular the PipelineTemplate to be used, that contains the implementation and provides metadata to instantiate and run it, and actual input and output catalog instances, identified via HRNs."},"ResourceProfile":{"type":"object","description":"Model representing details about a resource profile.","properties":{"id":{"type":"string","description":"Identifier for the resource profile.  Use this value when creating a pipeline template.","readOnly":true,"example":"profileId"},"label":{"type":"string","description":"Label for the resource profile.","example":"User-friendly label for display"},"name":{"type":"string","description":"Name for the resource profile.","example":"Description of the profile"},"cpuPerUnit":{"type":"number","format":"float","example":1,"description":"The number of cpus per resource unit."},"memoryInGiBPerUnit":{"type":"number","format":"float","example":3.5,"description":"The amount of memory (in GiB) per resource unit."},"diskInGiBPerUnit":{"type":"number","format":"float","example":3.5,"description":"The amount of disk (in GiB) per resource unit."}}},"ResourceProfiles":{"type":"object","properties":{"availableResourceProfiles":{"type":"array","description":"A list of the resource profiles currently available to the user.","readOnly":true,"items":{"$ref":"#/components/schemas/ResourceProfile"}}}},"ResumeRequest":{"description":"Resume request options containing the request details of PipelineVersion to resume.","allOf":[{"$ref":"#/components/schemas/OperationOptions"},{"type":"object"}]},"RootLogger":{"required":["level"],"type":"object","properties":{"level":{"type":"string","description":"Logger level.","example":"debug","enum":["error","warn","info","debug"]}},"description":"The Root logger. The level set here will apply to all classes and loggers that don't have a logger configured in the logging configuration."},"RuntimeEnvironment":{"type":"object","properties":{"id":{"type":"string","description":"Identifier for the runtime environment.  Use this value when creating a pipeline template.","readOnly":true,"example":"batch-x.y.z"},"availableResourceProfileIds":{"type":"array","description":"Identifiers for the resource profiles available for this runtime environment.","readOnly":true,"items":{"type":"string","example":["HS1"]}},"defaultWorkerResourceProfileId":{"type":"string","description":"Identifier for the default resource profile for workers in this runtime environment.","readOnly":true,"example":"HS1"},"defaultSupervisorResourceProfileId":{"type":"string","description":"Identifier for the default resource profile for supervisors in this runtime environment.","readOnly":true,"example":"HS1"},"maxWorkerUnits":{"type":"integer","example":15,"description":"The maximum number of worker resource units available for this runtime environment."},"maxSupervisorUnits":{"type":"integer","example":15,"description":"The maximum number of supervisor resource units available for this runtime environment."},"maxAdditionalOverheadMemory":{"type":"number","description":"The maximum additional overhead memory available for supervisor and worker for this runtime environment.","format":"float","readOnly":true,"example":0.05},"description":{"type":"string","description":"Description of this runtime environment.","readOnly":true,"example":"Spark x.y.z, Java x, Scala y"},"deprecationPeriodAnnounced":{"type":"string","description":"Date this runtime environment was or will be deprecated. This is in ISO-8601 calendar system.","format":"date-time","readOnly":true,"example":"2007-12-03T10:15:30+01:00"},"deprecationPeriodEnd":{"type":"string","description":"Date this runtime environment is subject to removal. This is in ISO-8601 calendar system.","format":"date-time","readOnly":true,"example":"2007-12-03T10:15:30+01:00"},"displayName":{"type":"string","description":"Display name of this runtime environment.","readOnly":true,"example":"Batch x.y.z"},"defaultGcProfile":{"type":"string","description":"Identifier of the default GC profile for this runtime environment.","readOnly":true,"example":"g1gc"},"availableGcProfiles":{"type":"array","description":"Identifiers for the GC profiles available for this runtime environment.","readOnly":true,"items":{"$ref":"#/components/schemas/GcProfileDefinition"}}},"description":"Model representing details about a runtime environment."},"RuntimeEnvironments":{"type":"object","properties":{"availableRuntimes":{"type":"array","description":"A list of runtime environments currently available to the caller.","readOnly":true,"items":{"$ref":"#/components/schemas/RuntimeEnvironment"}}},"description":"Model representing details about runtime environments."},"SchedulerConfiguration":{"type":"object","properties":{"catalogTriggerOptions":{"type":"string","description":"The CatalogTriggerOptions support running the pipeline version based on changes detected on the input catalogs. Either `catalogTriggerOptions` or `timeTriggerOptions` must be present.","example":"version_resolver","enum":["version_resolver"]},"timeTriggerOptions":{"required":["cronJobExpression","processingType"],"type":"object","properties":{"cronJobExpression":{"type":"string","description":"Schedule of when to attempt to trigger pipeline version, in the Linux crontab format.","example":"0 4 * * *"},"processingType":{"type":"string","description":"Whether to wait for catalog changes, or to run without checking for changes.","example":"force","enum":["changes","force"]}},"description":"The TimeTriggerOptions support running the pipeline version on a window-bounded frequency, optionally based on changes detected on the input catalogs by the version resolver. Either `catalogTriggerOptions` or `timeTriggerOptions` must be present."}},"description":"The configuration of the scheduler for running the Jobs based on the provided criteria. If scheduler configuration is not provided then the platform runs the version immediately."},"Snapshot":{"description":"Snapshot for a Pipeline.","properties":{"created":{"description":"Time and Date when the snapshot was created. This is in ISO-8601 calendar system.","example":"2007-12-03T10:15:30+01:00","format":"date-time","readOnly":true,"type":"string"},"id":{"description":"System generated identifier (UUID) for this object.","example":"00112233-4455-6677-8899-aabbccddeeff","format":"uuid","readOnly":true,"type":"string"},"jobId":{"description":"System generated identifier (UUID) for the Job associated with this snapshot.","example":"00112233-4455-6677-8899-aabbccddeeff","format":"uuid","type":"string"},"pipelineId":{"description":"System generated identifier (UUID) for the Pipeline associated with this snapshot.","example":"00112233-4455-6677-8899-aabbccddeeff","format":"uuid","type":"string"},"pipelineVersionId":{"description":"System generated identifier (UUID) for the PipelineVersion associated with this snapshot.","example":"00112233-4455-6677-8899-aabbccddeeff","format":"uuid","type":"string"},"region":{"description":"Region where snapshot was taken.","type":"string"},"templateId":{"description":"System generated identifier (UUID) for the PipelineTemplate associated with this snapshot.","example":"00112233-4455-6677-8899-aabbccddeeff","format":"uuid","type":"string"},"templateVersionId":{"description":"System generated identifier for the PipelineTemplateVersion associated with this snapshot, if applicable.","example":"1","type":"string"}},"required":["created","jobId","pipelineId","pipelineVersionId","templateId"],"type":"object"},"UpgradeRequest":{"description":"Upgrade request options containing the request details of PipelineVersion to upgrade to.","allOf":[{"$ref":"#/components/schemas/OperationOptions"},{"required":["toVersionId"],"type":"object","properties":{"runAsId":{"pattern":"hrn:(here|here-dev|here-cn|here-cn-dev):account:[a-zA-Z-]*:[a-zA-Z-]+:[a-zA-Z0-9/-]{3,63}","type":"string","description":"RunAsId Id to run the pipeline","example":"hrn:here-dev:account::HERE:app/test-runas-id"},"toVersionId":{"type":"string","description":"System generated identifier (UUID) for the PipelineVersion to upgrade to.","format":"uuid","example":"00112233-4455-6677-8899-aabbccddeeff"}}}]},"ValidationErrorMessage":{"description":"Extends ErrorMessage to add a JSON pointer field and invalid value to the message","properties":{"code":{"description":"Error code that pertains to a specific error.This field will only be populated in the event of known errors. Some errors like field validation may not be able to be done in a reproducible way so it may be omitted in these cases","example":"E1000","readOnly":true,"type":"string"},"errors":{"description":"Set of validation error messages.","items":{"$ref":"#/components/schemas/ValidationErrorMessage"},"readOnly":true,"type":"array","uniqueItems":true},"field":{"description":"Field of the object that is invalid. The field follows RFC 6901 JSON pointer.","example":"/parent/list/1/value","externalDocs":{"url":"https://tools.ietf.org/html/rfc6901"},"readOnly":true,"type":"string"},"invalidValue":{"description":"The invalid value that was sent","example":"sample string","readOnly":true,"type":"object"},"message":{"description":"This is the message for the error.","example":"Validation Failed","readOnly":true,"type":"string"},"messageTemplate":{"description":"Message template key that is used to look up a template for localization support. The curly brackets are utilized for looking up the property to get the message. If there are no curly brackets, then the message does not have a template key.","example":"{validation.error}","readOnly":true,"type":"string"},"status":{"description":"Duplicate of the HTTP status that is returned. Where possible utilize the HTTP status. This one is here for convenience.","example":400,"format":"int32","readOnly":true,"type":"integer"},"templateOptions":{"additionalProperties":{"description":"Key -> value map of options to be used in a template. This can be passed in for localization to insert in values. A localized template that uses these may look like \"The value must be larger than {exampleKey}\" where {exampleKey} is replaced with a value for \"exampleKey\" from the returned map.","readOnly":true,"type":"object"},"description":"Key -> value map of options to be used in a template. This can be passed in for localization to insert in values. A localized template that uses these may look like \"The value must be larger than {exampleKey}\" where {exampleKey} is replaced with a value for \"exampleKey\" from the returned map.","readOnly":true,"type":"object"}},"readOnly":true,"type":"object"}}}}