JobControllerClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dataproc_v1.services.job_controller.transports.base.JobControllerTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
The JobController provides methods to manage jobs.
Inheritance
builtins.object > JobControllerClientProperties
transport
Returns the transport used by the client instance.
Type | Description |
JobControllerTransport | The transport used by the client instance. |
Methods
JobControllerClient
JobControllerClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dataproc_v1.services.job_controller.transports.base.JobControllerTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the job controller client.
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str, JobControllerTransport]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
cancel_job
cancel_job(request: Optional[google.cloud.dataproc_v1.types.jobs.CancelJobRequest] = None, *, project_id: Optional[str] = None, region: Optional[str] = None, job_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Starts a job cancellation request. To access the job resource
after cancellation, call
regions/{region}/jobs.list <https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/list>
or
regions/{region}/jobs.get <https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/get>
.
Name | Description |
request |
google.cloud.dataproc_v1.types.CancelJobRequest
The request object. A request to cancel a job. |
project_id |
str
Required. The ID of the Google Cloud Platform project that the job belongs to. This corresponds to the |
region |
str
Required. The Dataproc region in which to handle the request. This corresponds to the |
job_id |
str
Required. The job ID. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.dataproc_v1.types.Job | A Dataproc job resource. |
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
delete_job
delete_job(request: Optional[google.cloud.dataproc_v1.types.jobs.DeleteJobRequest] = None, *, project_id: Optional[str] = None, region: Optional[str] = None, job_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes the job from the project. If the job is active, the
delete fails, and the response returns FAILED_PRECONDITION
.
Name | Description |
request |
google.cloud.dataproc_v1.types.DeleteJobRequest
The request object. A request to delete a job. |
project_id |
str
Required. The ID of the Google Cloud Platform project that the job belongs to. This corresponds to the |
region |
str
Required. The Dataproc region in which to handle the request. This corresponds to the |
job_id |
str
Required. The job ID. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
JobControllerClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Name | Description |
info |
dict
The service account private key info. |
Type | Description |
JobControllerClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
JobControllerClient | The constructed client. |
get_job
get_job(request: Optional[google.cloud.dataproc_v1.types.jobs.GetJobRequest] = None, *, project_id: Optional[str] = None, region: Optional[str] = None, job_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets the resource representation for a job in a project.
Name | Description |
request |
google.cloud.dataproc_v1.types.GetJobRequest
The request object. A request to get the resource representation for a job in a project. |
project_id |
str
Required. The ID of the Google Cloud Platform project that the job belongs to. This corresponds to the |
region |
str
Required. The Dataproc region in which to handle the request. This corresponds to the |
job_id |
str
Required. The job ID. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.dataproc_v1.types.Job | A Dataproc job resource. |
list_jobs
list_jobs(request: Optional[google.cloud.dataproc_v1.types.jobs.ListJobsRequest] = None, *, project_id: Optional[str] = None, region: Optional[str] = None, filter: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists regions/{region}/jobs in a project.
Name | Description |
request |
google.cloud.dataproc_v1.types.ListJobsRequest
The request object. A request to list jobs in a project. |
project_id |
str
Required. The ID of the Google Cloud Platform project that the job belongs to. This corresponds to the |
region |
str
Required. The Dataproc region in which to handle the request. This corresponds to the |
filter |
str
Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax: [field = value] AND [field [= value]] ... where field is |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.dataproc_v1.services.job_controller.pagers.ListJobsPager | A list of jobs in a project. Iterating over this object will yield results and resolve additional pages automatically. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
submit_job
submit_job(request: Optional[google.cloud.dataproc_v1.types.jobs.SubmitJobRequest] = None, *, project_id: Optional[str] = None, region: Optional[str] = None, job: Optional[google.cloud.dataproc_v1.types.jobs.Job] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Submits a job to a cluster.
Name | Description |
request |
google.cloud.dataproc_v1.types.SubmitJobRequest
The request object. A request to submit a job. |
project_id |
str
Required. The ID of the Google Cloud Platform project that the job belongs to. This corresponds to the |
region |
str
Required. The Dataproc region in which to handle the request. This corresponds to the |
job |
google.cloud.dataproc_v1.types.Job
Required. The job resource. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.dataproc_v1.types.Job | A Dataproc job resource. |
submit_job_as_operation
submit_job_as_operation(request: Optional[google.cloud.dataproc_v1.types.jobs.SubmitJobRequest] = None, *, project_id: Optional[str] = None, region: Optional[str] = None, job: Optional[google.cloud.dataproc_v1.types.jobs.Job] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Submits job to a cluster.
Name | Description |
request |
google.cloud.dataproc_v1.types.SubmitJobRequest
The request object. A request to submit a job. |
project_id |
str
Required. The ID of the Google Cloud Platform project that the job belongs to. This corresponds to the |
region |
str
Required. The Dataproc region in which to handle the request. This corresponds to the |
job |
google.cloud.dataproc_v1.types.Job
Required. The job resource. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be Job A Dataproc job resource. |
update_job
update_job(request: Optional[google.cloud.dataproc_v1.types.jobs.UpdateJobRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates a job in a project.
Name | Description |
request |
google.cloud.dataproc_v1.types.UpdateJobRequest
The request object. A request to update a job. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.dataproc_v1.types.Job | A Dataproc job resource. |