# Copyright 2017 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Accesses the google.cloud.dataproc.v1 JobController API."""

import functools
import pkg_resources

import google.api_core.gapic_v1.client_info
import google.api_core.gapic_v1.config
import google.api_core.gapic_v1.method
import google.api_core.grpc_helpers
import google.api_core.page_iterator

from google.cloud.dataproc_v1.gapic import enums
from google.cloud.dataproc_v1.gapic import job_controller_client_config
from google.cloud.dataproc_v1.proto import clusters_pb2
from google.cloud.dataproc_v1.proto import jobs_pb2
from google.cloud.dataproc_v1.proto import operations_pb2
from google.protobuf import empty_pb2
from google.protobuf import field_mask_pb2

_GAPIC_LIBRARY_VERSION = pkg_resources.get_distribution(
    'google-cloud-dataproc', ).version


class JobControllerClient(object):
    """The JobController provides methods to manage jobs."""

    SERVICE_ADDRESS = 'dataproc.googleapis.com:443'
    """The default address of the service."""

    # The scopes needed to make gRPC calls to all of the methods defined in
    # this service
    _DEFAULT_SCOPES = ('https://www.googleapis.com/auth/cloud-platform', )

    # The name of the interface for this client. This is the key used to find
    # method configuration in the client_config dictionary.
    _INTERFACE_NAME = 'google.cloud.dataproc.v1.JobController'

    def __init__(self,
                 channel=None,
                 credentials=None,
                 client_config=job_controller_client_config.config,
                 client_info=None):
        """Constructor.

        Args:
            channel (grpc.Channel): A ``Channel`` instance through
                which to make calls. This argument is mutually exclusive
                with ``credentials``; providing both will raise an exception.
            credentials (google.auth.credentials.Credentials): The
                authorization credentials to attach to requests. These
                credentials identify this application to the service. If none
                are specified, the client will attempt to ascertain the
                credentials from the environment.
            client_config (dict): A dictionary of call options for each
                method. If not specified, the default configuration is used.
            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 ``None``, then default info will be used.
                Generally, you only need to set this if you're developing
                your own client library.
        """
        # If both `channel` and `credentials` are specified, raise an
        # exception (channels come with credentials baked in already).
        if channel is not None and credentials is not None:
            raise ValueError(
                'The `channel` and `credentials` arguments to {} are mutually '
                'exclusive.'.format(self.__class__.__name__), )

        # Create the channel.
        if channel is None:
            channel = google.api_core.grpc_helpers.create_channel(
                self.SERVICE_ADDRESS,
                credentials=credentials,
                scopes=self._DEFAULT_SCOPES,
            )

        # Create the gRPC stubs.
        self.job_controller_stub = (jobs_pb2.JobControllerStub(channel))

        if client_info is None:
            client_info = (
                google.api_core.gapic_v1.client_info.DEFAULT_CLIENT_INFO)
        client_info.gapic_version = _GAPIC_LIBRARY_VERSION

        # Parse out the default settings for retry and timeout for each RPC
        # from the client configuration.
        # (Ordinarily, these are the defaults specified in the `*_config.py`
        # file next to this one.)
        method_configs = google.api_core.gapic_v1.config.parse_method_configs(
            client_config['interfaces'][self._INTERFACE_NAME], )

        # Write the "inner API call" methods to the class.
        # These are wrapped versions of the gRPC stub methods, with retry and
        # timeout configuration applied, called by the public methods on
        # this class.
        self._submit_job = google.api_core.gapic_v1.method.wrap_method(
            self.job_controller_stub.SubmitJob,
            default_retry=method_configs['SubmitJob'].retry,
            default_timeout=method_configs['SubmitJob'].timeout,
            client_info=client_info,
        )
        self._get_job = google.api_core.gapic_v1.method.wrap_method(
            self.job_controller_stub.GetJob,
            default_retry=method_configs['GetJob'].retry,
            default_timeout=method_configs['GetJob'].timeout,
            client_info=client_info,
        )
        self._list_jobs = google.api_core.gapic_v1.method.wrap_method(
            self.job_controller_stub.ListJobs,
            default_retry=method_configs['ListJobs'].retry,
            default_timeout=method_configs['ListJobs'].timeout,
            client_info=client_info,
        )
        self._update_job = google.api_core.gapic_v1.method.wrap_method(
            self.job_controller_stub.UpdateJob,
            default_retry=method_configs['UpdateJob'].retry,
            default_timeout=method_configs['UpdateJob'].timeout,
            client_info=client_info,
        )
        self._cancel_job = google.api_core.gapic_v1.method.wrap_method(
            self.job_controller_stub.CancelJob,
            default_retry=method_configs['CancelJob'].retry,
            default_timeout=method_configs['CancelJob'].timeout,
            client_info=client_info,
        )
        self._delete_job = google.api_core.gapic_v1.method.wrap_method(
            self.job_controller_stub.DeleteJob,
            default_retry=method_configs['DeleteJob'].retry,
            default_timeout=method_configs['DeleteJob'].timeout,
            client_info=client_info,
        )

    # Service calls
    def submit_job(self,
                   project_id,
                   region,
                   job,
                   retry=google.api_core.gapic_v1.method.DEFAULT,
                   timeout=google.api_core.gapic_v1.method.DEFAULT):
        """
        Submits a job to a cluster.

        Example:
            >>> from google.cloud import dataproc_v1
            >>>
            >>> client = dataproc_v1.JobControllerClient()
            >>>
            >>> project_id = ''
            >>> region = ''
            >>> job = {}
            >>>
            >>> response = client.submit_job(project_id, region, job)

        Args:
            project_id (str): Required. The ID of the Google Cloud Platform project that the job
                belongs to.
            region (str): Required. The Cloud Dataproc region in which to handle the request.
            job (Union[dict, ~google.cloud.dataproc_v1.types.Job]): Required. The job resource.
                If a dict is provided, it must be of the same form as the protobuf
                message :class:`~google.cloud.dataproc_v1.types.Job`
            retry (Optional[google.api_core.retry.Retry]):  A retry object used
                to retry requests. If ``None`` is specified, requests will not
                be retried.
            timeout (Optional[float]): The amount of time, in seconds, to wait
                for the request to complete. Note that if ``retry`` is
                specified, the timeout applies to each individual attempt.

        Returns:
            A :class:`~google.cloud.dataproc_v1.types.Job` instance.

        Raises:
            google.api_core.exceptions.GoogleAPICallError: If the request
                    failed for any reason.
            google.api_core.exceptions.RetryError: If the request failed due
                    to a retryable error and retry attempts failed.
            ValueError: If the parameters are invalid.
        """
        request = jobs_pb2.SubmitJobRequest(
            project_id=project_id,
            region=region,
            job=job,
        )
        return self._submit_job(request, retry=retry, timeout=timeout)

    def get_job(self,
                project_id,
                region,
                job_id,
                retry=google.api_core.gapic_v1.method.DEFAULT,
                timeout=google.api_core.gapic_v1.method.DEFAULT):
        """
        Gets the resource representation for a job in a project.

        Example:
            >>> from google.cloud import dataproc_v1
            >>>
            >>> client = dataproc_v1.JobControllerClient()
            >>>
            >>> project_id = ''
            >>> region = ''
            >>> job_id = ''
            >>>
            >>> response = client.get_job(project_id, region, job_id)

        Args:
            project_id (str): Required. The ID of the Google Cloud Platform project that the job
                belongs to.
            region (str): Required. The Cloud Dataproc region in which to handle the request.
            job_id (str): Required. The job ID.
            retry (Optional[google.api_core.retry.Retry]):  A retry object used
                to retry requests. If ``None`` is specified, requests will not
                be retried.
            timeout (Optional[float]): The amount of time, in seconds, to wait
                for the request to complete. Note that if ``retry`` is
                specified, the timeout applies to each individual attempt.

        Returns:
            A :class:`~google.cloud.dataproc_v1.types.Job` instance.

        Raises:
            google.api_core.exceptions.GoogleAPICallError: If the request
                    failed for any reason.
            google.api_core.exceptions.RetryError: If the request failed due
                    to a retryable error and retry attempts failed.
            ValueError: If the parameters are invalid.
        """
        request = jobs_pb2.GetJobRequest(
            project_id=project_id,
            region=region,
            job_id=job_id,
        )
        return self._get_job(request, retry=retry, timeout=timeout)

    def list_jobs(self,
                  project_id,
                  region,
                  page_size=None,
                  cluster_name=None,
                  job_state_matcher=None,
                  filter_=None,
                  retry=google.api_core.gapic_v1.method.DEFAULT,
                  timeout=google.api_core.gapic_v1.method.DEFAULT):
        """
        Lists regions/{region}/jobs in a project.

        Example:
            >>> from google.cloud import dataproc_v1
            >>>
            >>> client = dataproc_v1.JobControllerClient()
            >>>
            >>> project_id = ''
            >>> region = ''
            >>>
            >>>
            >>> # Iterate over all results
            >>> for element in client.list_jobs(project_id, region):
            ...     # process element
            ...     pass
            >>>
            >>> # Or iterate over results one page at a time
            >>> for page in client.list_jobs(project_id, region, options=CallOptions(page_token=INITIAL_PAGE)):
            ...     for element in page:
            ...         # process element
            ...         pass

        Args:
            project_id (str): Required. The ID of the Google Cloud Platform project that the job
                belongs to.
            region (str): Required. The Cloud Dataproc region in which to handle the request.
            page_size (int): The maximum number of resources contained in the
                underlying API response. If page streaming is performed per-
                resource, this parameter does not affect the return value. If page
                streaming is performed per-page, this determines the maximum number
                of resources in a page.
            cluster_name (str): Optional. If set, the returned jobs list includes only jobs that were
                submitted to the named cluster.
            job_state_matcher (~google.cloud.dataproc_v1.types.JobStateMatcher): Optional. Specifies enumerated categories of jobs to list.
                (default = match ALL jobs).

                If ``filter`` is provided, ``jobStateMatcher`` will be ignored.
            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 ``status.state`` or ``labels.[KEY]``, and ``[KEY]`` is a label
                key. **value** can be ``*`` to match all values.
                ``status.state`` can be either ``ACTIVE`` or ``NON_ACTIVE``.
                Only the logical ``AND`` operator is supported; space-separated items are
                treated as having an implicit ``AND`` operator.

                Example filter:

                status.state = ACTIVE AND labels.env = staging AND labels.starred = *
            retry (Optional[google.api_core.retry.Retry]):  A retry object used
                to retry requests. If ``None`` is specified, requests will not
                be retried.
            timeout (Optional[float]): The amount of time, in seconds, to wait
                for the request to complete. Note that if ``retry`` is
                specified, the timeout applies to each individual attempt.

        Returns:
            A :class:`~google.gax.PageIterator` instance. By default, this
            is an iterable of :class:`~google.cloud.dataproc_v1.types.Job` instances.
            This object can also be configured to iterate over the pages
            of the response through the `options` parameter.

        Raises:
            google.api_core.exceptions.GoogleAPICallError: If the request
                    failed for any reason.
            google.api_core.exceptions.RetryError: If the request failed due
                    to a retryable error and retry attempts failed.
            ValueError: If the parameters are invalid.
        """
        request = jobs_pb2.ListJobsRequest(
            project_id=project_id,
            region=region,
            page_size=page_size,
            cluster_name=cluster_name,
            job_state_matcher=job_state_matcher,
            filter=filter_,
        )
        iterator = google.api_core.page_iterator.GRPCIterator(
            client=None,
            method=functools.partial(
                self._list_jobs, retry=retry, timeout=timeout),
            request=request,
            items_field='jobs',
            request_token_field='page_token',
            response_token_field='next_page_token',
        )
        return iterator

    def update_job(self,
                   project_id,
                   region,
                   job_id,
                   job,
                   update_mask,
                   retry=google.api_core.gapic_v1.method.DEFAULT,
                   timeout=google.api_core.gapic_v1.method.DEFAULT):
        """
        Updates a job in a project.

        Example:
            >>> from google.cloud import dataproc_v1
            >>>
            >>> client = dataproc_v1.JobControllerClient()
            >>>
            >>> project_id = ''
            >>> region = ''
            >>> job_id = ''
            >>> job = {}
            >>> update_mask = {}
            >>>
            >>> response = client.update_job(project_id, region, job_id, job, update_mask)

        Args:
            project_id (str): Required. The ID of the Google Cloud Platform project that the job
                belongs to.
            region (str): Required. The Cloud Dataproc region in which to handle the request.
            job_id (str): Required. The job ID.
            job (Union[dict, ~google.cloud.dataproc_v1.types.Job]): Required. The changes to the job.
                If a dict is provided, it must be of the same form as the protobuf
                message :class:`~google.cloud.dataproc_v1.types.Job`
            update_mask (Union[dict, ~google.cloud.dataproc_v1.types.FieldMask]): Required. Specifies the path, relative to <code>Job</code>, of
                the field to update. For example, to update the labels of a Job the
                <code>update_mask</code> parameter would be specified as
                <code>labels</code>, and the ``PATCH`` request body would specify the new
                value. <strong>Note:</strong> Currently, <code>labels</code> is the only
                field that can be updated.
                If a dict is provided, it must be of the same form as the protobuf
                message :class:`~google.cloud.dataproc_v1.types.FieldMask`
            retry (Optional[google.api_core.retry.Retry]):  A retry object used
                to retry requests. If ``None`` is specified, requests will not
                be retried.
            timeout (Optional[float]): The amount of time, in seconds, to wait
                for the request to complete. Note that if ``retry`` is
                specified, the timeout applies to each individual attempt.

        Returns:
            A :class:`~google.cloud.dataproc_v1.types.Job` instance.

        Raises:
            google.api_core.exceptions.GoogleAPICallError: If the request
                    failed for any reason.
            google.api_core.exceptions.RetryError: If the request failed due
                    to a retryable error and retry attempts failed.
            ValueError: If the parameters are invalid.
        """
        request = jobs_pb2.UpdateJobRequest(
            project_id=project_id,
            region=region,
            job_id=job_id,
            job=job,
            update_mask=update_mask,
        )
        return self._update_job(request, retry=retry, timeout=timeout)

    def cancel_job(self,
                   project_id,
                   region,
                   job_id,
                   retry=google.api_core.gapic_v1.method.DEFAULT,
                   timeout=google.api_core.gapic_v1.method.DEFAULT):
        """
        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>`_.

        Example:
            >>> from google.cloud import dataproc_v1
            >>>
            >>> client = dataproc_v1.JobControllerClient()
            >>>
            >>> project_id = ''
            >>> region = ''
            >>> job_id = ''
            >>>
            >>> response = client.cancel_job(project_id, region, job_id)

        Args:
            project_id (str): Required. The ID of the Google Cloud Platform project that the job
                belongs to.
            region (str): Required. The Cloud Dataproc region in which to handle the request.
            job_id (str): Required. The job ID.
            retry (Optional[google.api_core.retry.Retry]):  A retry object used
                to retry requests. If ``None`` is specified, requests will not
                be retried.
            timeout (Optional[float]): The amount of time, in seconds, to wait
                for the request to complete. Note that if ``retry`` is
                specified, the timeout applies to each individual attempt.

        Returns:
            A :class:`~google.cloud.dataproc_v1.types.Job` instance.

        Raises:
            google.api_core.exceptions.GoogleAPICallError: If the request
                    failed for any reason.
            google.api_core.exceptions.RetryError: If the request failed due
                    to a retryable error and retry attempts failed.
            ValueError: If the parameters are invalid.
        """
        request = jobs_pb2.CancelJobRequest(
            project_id=project_id,
            region=region,
            job_id=job_id,
        )
        return self._cancel_job(request, retry=retry, timeout=timeout)

    def delete_job(self,
                   project_id,
                   region,
                   job_id,
                   retry=google.api_core.gapic_v1.method.DEFAULT,
                   timeout=google.api_core.gapic_v1.method.DEFAULT):
        """
        Deletes the job from the project. If the job is active, the delete fails,
        and the response returns ``FAILED_PRECONDITION``.

        Example:
            >>> from google.cloud import dataproc_v1
            >>>
            >>> client = dataproc_v1.JobControllerClient()
            >>>
            >>> project_id = ''
            >>> region = ''
            >>> job_id = ''
            >>>
            >>> client.delete_job(project_id, region, job_id)

        Args:
            project_id (str): Required. The ID of the Google Cloud Platform project that the job
                belongs to.
            region (str): Required. The Cloud Dataproc region in which to handle the request.
            job_id (str): Required. The job ID.
            retry (Optional[google.api_core.retry.Retry]):  A retry object used
                to retry requests. If ``None`` is specified, requests will not
                be retried.
            timeout (Optional[float]): The amount of time, in seconds, to wait
                for the request to complete. Note that if ``retry`` is
                specified, the timeout applies to each individual attempt.

        Raises:
            google.api_core.exceptions.GoogleAPICallError: If the request
                    failed for any reason.
            google.api_core.exceptions.RetryError: If the request failed due
                    to a retryable error and retry attempts failed.
            ValueError: If the parameters are invalid.
        """
        request = jobs_pb2.DeleteJobRequest(
            project_id=project_id,
            region=region,
            job_id=job_id,
        )
        self._delete_job(request, retry=retry, timeout=timeout)
