DataSphere Jobs API v2, gRPC: ProjectJobService.List
Lists jobs.
gRPC request
rpc List (ListProjectJobRequest) returns (ListProjectJobResponse)
ListProjectJobRequest
{
"projectId": "string",
"pageSize": "int64",
"pageToken": "string",
"filter": "string"
}
|
Field |
Description |
|
projectId |
string ID of the project. |
|
pageSize |
int64 The maximum number of results per page to return. If the number of available |
|
pageToken |
string Page token. To get the next page of results, set |
|
filter |
string restrictions:
|
ListProjectJobResponse
{
"jobs": [
{
"id": "string",
"name": "string",
"desc": "string",
"createdAt": "google.protobuf.Timestamp",
"finishedAt": "google.protobuf.Timestamp",
"status": "JobStatus",
"config": "string",
"createdById": "string",
"projectId": "string",
"jobParameters": {
"inputFiles": [
{
"desc": {
"path": "string",
"var": "string"
},
"sha256": "string",
"sizeBytes": "int64",
"compressionType": "FileCompressionType"
}
],
"outputFiles": [
{
"path": "string",
"var": "string"
}
],
"s3MountIds": [
"string"
],
"datasetIds": [
"string"
],
"cmd": "string",
"env": {
"vars": "string",
// Includes only one of the fields `dockerImageResourceId`, `dockerImageSpec`
"dockerImageResourceId": "string",
"dockerImageSpec": {
"imageUrl": "string",
"username": "string",
// Includes only one of the fields `passwordPlainText`, `passwordDsSecretName`
"passwordPlainText": "string",
"passwordDsSecretName": "string"
// end of the list of possible fields
},
// end of the list of possible fields
"pythonEnv": {
"condaYaml": "string",
"localModules": [
{
"desc": {
"path": "string",
"var": "string"
},
"sha256": "string",
"sizeBytes": "int64",
"compressionType": "FileCompressionType"
}
],
"pythonVersion": "string",
"requirements": [
"string"
],
"pipOptions": {
"indexUrl": "string",
"extraIndexUrls": [
"string"
],
"trustedHosts": [
"string"
],
"noDeps": "bool"
}
}
},
"attachProjectDisk": "bool",
"cloudInstanceTypes": [
{
"name": "string"
}
],
"extendedWorkingStorage": {
"type": "StorageType",
"sizeGb": "int64"
},
"arguments": [
{
"name": "string",
"value": "string"
}
],
"outputDatasets": [
{
"name": "string",
"description": "string",
"labels": "string",
"sizeGb": "int64",
"var": "string"
}
],
"gracefulShutdownParameters": {
"timeout": "google.protobuf.Duration",
"signal": "int64"
}
},
"dataExpiresAt": "google.protobuf.Timestamp",
"dataCleared": "bool",
"outputFiles": [
{
"desc": {
"path": "string",
"var": "string"
},
"sha256": "string",
"sizeBytes": "int64",
"compressionType": "FileCompressionType"
}
],
"logFiles": [
{
"desc": {
"path": "string",
"var": "string"
},
"sha256": "string",
"sizeBytes": "int64",
"compressionType": "FileCompressionType"
}
],
"diagnosticFiles": [
{
"desc": {
"path": "string",
"var": "string"
},
"sha256": "string",
"sizeBytes": "int64",
"compressionType": "FileCompressionType"
}
],
"dataSizeBytes": "int64",
"startedAt": "google.protobuf.Timestamp",
"statusDetails": "string",
"actualCloudInstanceType": {
"name": "string"
},
"parentJobId": "string",
"fileErrors": [
{
// Includes only one of the fields `outputFileDesc`, `logFileName`
"outputFileDesc": {
"path": "string",
"var": "string"
},
"logFileName": "string",
// end of the list of possible fields
"description": "string"
}
],
"outputDatasets": [
{
"desc": {
"name": "string",
"description": "string",
"labels": "string",
"sizeGb": "int64",
"var": "string"
},
"id": "string"
}
]
}
],
"nextPageToken": "string"
}
|
Field |
Description |
|
jobs[] |
Instances of the jobs. |
|
nextPageToken |
string This token allows you to get the next page of results for list requests. If the number of results |
Job
Instance of the job.
|
Field |
Description |
|
id |
string ID of the job. |
|
name |
string Name of the job. |
|
desc |
string Description of the job. |
|
createdAt |
Create job timestamp. |
|
finishedAt |
Finish job timestamp. |
|
status |
enum JobStatus Status of the job.
|
|
config |
string Config of the job, copied from configuration file. |
|
createdById |
string ID of the user who created the job. |
|
projectId |
string ID of the project. |
|
jobParameters |
|
|
dataExpiresAt |
Job data expiration timestamp. |
|
dataCleared |
bool Marks if the job data has been cleared. |
|
outputFiles[] |
Output files of the job. |
|
logFiles[] |
Job log files. |
|
diagnosticFiles[] |
Job diagnostics files. |
|
dataSizeBytes |
int64 Job total data size. |
|
startedAt |
Start job timestamp. |
|
statusDetails |
string Details. |
|
actualCloudInstanceType |
Actual VM instance type, job is running on. |
|
parentJobId |
string Reference to the parent job. |
|
fileErrors[] |
Failed uploads. |
|
outputDatasets[] |
Created datasets. |
JobParameters
Job parameters.
|
Field |
Description |
|
inputFiles[] |
List of input files. |
|
outputFiles[] |
List of output files descriptions. |
|
s3MountIds[] |
string List of DataSphere S3 mount ids. |
|
datasetIds[] |
string List of DataSphere dataset ids. |
|
cmd |
string Job run command. |
|
env |
Job environment description. |
|
attachProjectDisk |
bool Should project disk be attached to VM. |
|
cloudInstanceTypes[] |
VM specification. |
|
extendedWorkingStorage |
Extended working storage configuration. |
|
arguments[] |
List of literal arguments. |
|
outputDatasets[] |
List of DataSets descriptions to create. |
|
gracefulShutdownParameters |
Graceful shutdown settings. |
File
|
Field |
Description |
|
desc |
|
|
sha256 |
string SHA256 of the file. |
|
sizeBytes |
int64 File size in bytes. |
|
compressionType |
enum FileCompressionType File compression info
|
FileDesc
|
Field |
Description |
|
path |
string Path of the file on filesystem. |
|
var |
string Variable to use in cmd substitution. |
Environment
|
Field |
Description |
|
vars |
string Environment variables. |
|
dockerImageResourceId |
string DS docker image id. Includes only one of the fields |
|
dockerImageSpec |
Includes only one of the fields |
|
pythonEnv |
DockerImageSpec
|
Field |
Description |
|
imageUrl |
string Docker image URL. |
|
username |
string Username for container registry. |
|
passwordPlainText |
string Plaintext password. Includes only one of the fields Password for container registry. |
|
passwordDsSecretName |
string ID of DataSphere secret containing password. Includes only one of the fields Password for container registry. |
PythonEnv
|
Field |
Description |
|
condaYaml |
string Conda YAML. |
|
localModules[] |
List of local modules descriptions. |
|
pythonVersion |
string Python version reduced to major.minor |
|
requirements[] |
string List of pip requirements |
|
pipOptions |
Pip install options |
PipOptions
|
Field |
Description |
|
indexUrl |
string --index-url option |
|
extraIndexUrls[] |
string --extra-index-urls option |
|
trustedHosts[] |
string --trusted-hosts option |
|
noDeps |
bool --no-deps option |
CloudInstanceType
|
Field |
Description |
|
name |
string Name of DataSphere VM configuration. |
ExtendedWorkingStorage
Extended working storage configuration.
|
Field |
Description |
|
type |
enum StorageType
|
|
sizeGb |
int64 |
Argument
|
Field |
Description |
|
name |
string |
|
value |
string |
OutputDatasetDesc
|
Field |
Description |
|
name |
string Name to create dataset with |
|
description |
string Description to show in UI |
|
labels |
string |
|
sizeGb |
int64 Size of dataset to create |
|
var |
string Var name to replace in cmd, like in FileDesc |
GracefulShutdownParameters
|
Field |
Description |
|
timeout |
|
|
signal |
int64 default 15 (SIGTERM) |
FileUploadError
|
Field |
Description |
|
outputFileDesc |
Includes only one of the fields |
|
logFileName |
string Includes only one of the fields |
|
description |
string |
OutputDataset
|
Field |
Description |
|
desc |
Dataset description |
|
id |
string Id of created dataset |