cancel(name, body=None, x__xgafv=None)
Cancel jobs running for the task resource.
Close httplib2 connections.
Get job resource.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists Jobs under the given task.
Retrieves the next page of results.
cancel(name, body=None, x__xgafv=None)
Cancel jobs running for the task resource.
Args:
name: string, Required. The resource name of the job: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}/job/{job_id}. (required)
body: object, The request body.
The object takes the form of:
{ # Cancel task jobs.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
close()
Close httplib2 connections.
get(name, x__xgafv=None)
Get job resource.
Args:
name: string, Required. The resource name of the job: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A job represents an instance of a task.
"endTime": "A String", # Output only. The time when the job ended.
"executionSpec": { # Execution related settings, like retry and service_account. # Output only. Spec related to how a task is executed.
"args": { # Optional. The arguments to pass to the task. The args can use placeholders of the format ${placeholder} as part of key/value string. These will be interpolated before passing the args to the driver. Currently supported placeholders: - ${task_id} - ${job_time} To pass positional args, set the key as TASK_ARGS. The value should be a comma-separated string of all the positional arguments. To use a delimiter other than comma, refer to https://cloud.google.com/sdk/gcloud/reference/topic/escaping. In case of other keys being present in the args, then TASK_ARGS will be passed as the last argument.
"a_key": "A String",
},
"kmsKey": "A String", # Optional. The Cloud KMS key to use for encryption, of the form: projects/{project_number}/locations/{location_id}/keyRings/{key-ring-name}/cryptoKeys/{key-name}.
"maxJobExecutionLifetime": "A String", # Optional. The maximum duration after which the job execution is expired.
"project": "A String", # Optional. The project in which jobs are run. By default, the project containing the Lake is used. If a project is provided, the ExecutionSpec.service_account must belong to this project.
"serviceAccount": "A String", # Required. Service account to use to execute a task. If not provided, the default Compute service account for the project is used.
},
"labels": { # Output only. User-defined labels for the task.
"a_key": "A String",
},
"message": "A String", # Output only. Additional information about the current state.
"name": "A String", # Output only. The relative resource name of the job, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}.
"retryCount": 42, # Output only. The number of times the job has been retried (excluding the initial attempt).
"service": "A String", # Output only. The underlying service running a job.
"serviceJob": "A String", # Output only. The full resource name for the job run under a particular service.
"startTime": "A String", # Output only. The time when the job was started.
"state": "A String", # Output only. Execution state for the job.
"trigger": "A String", # Output only. Job execution trigger.
"uid": "A String", # Output only. System generated globally unique ID for the job.
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists Jobs under the given task.
Args:
parent: string, Required. The resource name of the parent environment: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}. (required)
pageSize: integer, Optional. Maximum number of jobs to return. The service may return fewer than this value. If unspecified, at most 10 jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Optional. Page token received from a previous ListJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListJobs must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # List jobs response.
"jobs": [ # Jobs under a given task.
{ # A job represents an instance of a task.
"endTime": "A String", # Output only. The time when the job ended.
"executionSpec": { # Execution related settings, like retry and service_account. # Output only. Spec related to how a task is executed.
"args": { # Optional. The arguments to pass to the task. The args can use placeholders of the format ${placeholder} as part of key/value string. These will be interpolated before passing the args to the driver. Currently supported placeholders: - ${task_id} - ${job_time} To pass positional args, set the key as TASK_ARGS. The value should be a comma-separated string of all the positional arguments. To use a delimiter other than comma, refer to https://cloud.google.com/sdk/gcloud/reference/topic/escaping. In case of other keys being present in the args, then TASK_ARGS will be passed as the last argument.
"a_key": "A String",
},
"kmsKey": "A String", # Optional. The Cloud KMS key to use for encryption, of the form: projects/{project_number}/locations/{location_id}/keyRings/{key-ring-name}/cryptoKeys/{key-name}.
"maxJobExecutionLifetime": "A String", # Optional. The maximum duration after which the job execution is expired.
"project": "A String", # Optional. The project in which jobs are run. By default, the project containing the Lake is used. If a project is provided, the ExecutionSpec.service_account must belong to this project.
"serviceAccount": "A String", # Required. Service account to use to execute a task. If not provided, the default Compute service account for the project is used.
},
"labels": { # Output only. User-defined labels for the task.
"a_key": "A String",
},
"message": "A String", # Output only. Additional information about the current state.
"name": "A String", # Output only. The relative resource name of the job, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}.
"retryCount": 42, # Output only. The number of times the job has been retried (excluding the initial attempt).
"service": "A String", # Output only. The underlying service running a job.
"serviceJob": "A String", # Output only. The full resource name for the job run under a particular service.
"startTime": "A String", # Output only. The time when the job was started.
"state": "A String", # Output only. Execution state for the job.
"trigger": "A String", # Output only. Job execution trigger.
"uid": "A String", # Output only. System generated globally unique ID for the job.
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.