text: # -*- coding: utf-8 -*-
  #
  # Copyright 2019 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.devtools.containeranalysis.v1 ContainerAnalysis API."""
  
  import pkg_resources
  import warnings
  
  from google.oauth2 import service_account
  import google.api_core.client_options
  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.gapic_v1.routing_header
  import google.api_core.grpc_helpers
  import google.api_core.path_template
  import grpc
  
  from google.cloud.devtools.containeranalysis_v1.gapic import (
      container_analysis_client_config,
  )
  from google.cloud.devtools.containeranalysis_v1.gapic.transports import (
      container_analysis_grpc_transport,
  )
  from google.cloud.devtools.containeranalysis_v1.proto import containeranalysis_pb2_grpc
  from google.iam.v1 import iam_policy_pb2
  from google.iam.v1 import options_pb2
  from google.iam.v1 import policy_pb2
  
  
  from grafeas import grafeas_v1
  from grafeas.grafeas_v1.gapic.transports import grafeas_grpc_transport
  
  _GAPIC_LIBRARY_VERSION = pkg_resources.get_distribution(
      "google-cloud-containeranalysis"
  ).version
  
  
  class ContainerAnalysisClient(object):
      """
      Retrieves analysis results of Cloud components such as Docker container
      images. The Container Analysis API is an implementation of the
      `Grafeas <https://grafeas.io>`__ API.
  
      Analysis results are stored as a series of occurrences. An
      ``Occurrence`` contains information about a specific analysis instance
      on a resource. An occurrence refers to a ``Note``. A note contains
      details describing the analysis and is generally stored in a separate
      project, called a ``Provider``. Multiple occurrences can refer to the
      same note.
  
      For example, an SSL vulnerability could affect multiple images. In this
      case, there would be one note for the vulnerability and an occurrence
      for each image with the vulnerability referring to that note.
      """
  
      SERVICE_ADDRESS = "containeranalysis.googleapis.com:443"
      """The default address of the service."""
  
      # The name of the interface for this client. This is the key used to
      # find the method configuration in the client_config dictionary.
      _INTERFACE_NAME = "google.devtools.containeranalysis.v1.ContainerAnalysis"
  
      @classmethod
      def from_service_account_file(cls, filename, *args, **kwargs):
          """Creates an instance of this client using the provided credentials
          file.
  
          Args:
              filename (str): The path to the service account private key json
                  file.
              args: Additional arguments to pass to the constructor.
              kwargs: Additional arguments to pass to the constructor.
  
          Returns:
              ContainerAnalysisClient: The constructed client.
          """
          credentials = service_account.Credentials.from_service_account_file(filename)
          kwargs["credentials"] = credentials
          return cls(*args, **kwargs)
  
      from_service_account_json = from_service_account_file
  
      @classmethod
      def note_path(cls, project, note):
          """Return a fully-qualified note string."""
          return google.api_core.path_template.expand(
              "projects/{project}/notes/{note}", project=project, note=note
          )
  
      @classmethod
      def occurrence_path(cls, project, occurrence):
          """Return a fully-qualified occurrence string."""
          return google.api_core.path_template.expand(
              "projects/{project}/occurrences/{occurrence}",
              project=project,
              occurrence=occurrence,
          )
  
      def __init__(
          self,
          transport=None,
          channel=None,
          credentials=None,
          client_config=None,
          client_info=None,
          client_options=None,
      ):
          """Constructor.
  
          Args:
              transport (Union[~.ContainerAnalysisGrpcTransport,
                      Callable[[~.Credentials, type], ~.ContainerAnalysisGrpcTransport]): A transport
                  instance, responsible for actually making the API calls.
                  The default transport uses the gRPC protocol.
                  This argument may also be a callable which returns a
                  transport instance. Callables will be sent the credentials
                  as the first argument and the default transport class as
                  the second argument.
              channel (grpc.Channel): DEPRECATED. 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.
                  This argument is mutually exclusive with providing a
                  transport instance to ``transport``; doing so will raise
                  an exception.
              client_config (dict): DEPRECATED. 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.
              client_options (Union[dict, google.api_core.client_options.ClientOptions]):
                  Client options used to set user options on the client. API Endpoint
                  should be set through client_options.
          """
          # Raise deprecation warnings for things we want to go away.
          if client_config is not None:
              warnings.warn(
                  "The `client_config` argument is deprecated.",
                  PendingDeprecationWarning,
                  stacklevel=2,
              )
          else:
              client_config = container_analysis_client_config.config
  
          if channel:
              warnings.warn(
                  "The `channel` argument is deprecated; use " "`transport` instead.",
                  PendingDeprecationWarning,
                  stacklevel=2,
              )
  
          api_endpoint = self.SERVICE_ADDRESS
          if client_options:
              if type(client_options) == dict:
                  client_options = google.api_core.client_options.from_dict(
                      client_options
                  )
              if client_options.api_endpoint:
                  api_endpoint = client_options.api_endpoint
  
          # Instantiate the transport.
          # The transport is responsible for handling serialization and
          # deserialization and actually sending data to the service.
          if transport:
              if callable(transport):
                  self.transport = transport(
                      credentials=credentials,
                      default_class=container_analysis_grpc_transport.ContainerAnalysisGrpcTransport,
                      address=api_endpoint,
                  )
              else:
                  if credentials:
                      raise ValueError(
                          "Received both a transport instance and "
                          "credentials; these are mutually exclusive."
                      )
                  self.transport = transport
          else:
              self.transport = container_analysis_grpc_transport.ContainerAnalysisGrpcTransport(
                  address=api_endpoint, channel=channel, credentials=credentials
              )
  
          if client_info is None:
              client_info = google.api_core.gapic_v1.client_info.ClientInfo(
                  gapic_version=_GAPIC_LIBRARY_VERSION
              )
          else:
              client_info.gapic_version = _GAPIC_LIBRARY_VERSION
          self._client_info = client_info
  
          # 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.)
          self._method_configs = google.api_core.gapic_v1.config.parse_method_configs(
              client_config["interfaces"][self._INTERFACE_NAME]
          )
  
          # Save a dictionary of cached API call functions.
          # These are the actual callables which invoke the proper
          # transport methods, wrapped with `wrap_method` to add retry,
          # timeout, and the like.
          self._inner_api_calls = {}
  
      def get_grafeas_client(self):
          """Returns an equivalent grafeas client.
  
          Returns:
              A :class:`~grafeas.grafeas_v1.GrafeasClient` instance.
          """
          grafeas_transport = grafeas_grpc_transport.GrafeasGrpcTransport(
              self.SERVICE_ADDRESS, self.transport._OAUTH_SCOPES
          )
  
          return grafeas_v1.GrafeasClient(grafeas_transport)
  
      # Service calls
      def set_iam_policy(
          self,
          resource,
          policy,
          retry=google.api_core.gapic_v1.method.DEFAULT,
          timeout=google.api_core.gapic_v1.method.DEFAULT,
          metadata=None,
      ):
          """
          Sets the access control policy on the specified note or occurrence.
          Requires ``containeranalysis.notes.setIamPolicy`` or
          ``containeranalysis.occurrences.setIamPolicy`` permission if the
          resource is a note or an occurrence, respectively.
  
          The resource takes the format ``projects/[PROJECT_ID]/notes/[NOTE_ID]``
          for notes and ``projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`` for
          occurrences.
  
          Example:
              >>> from google.cloud.devtools import containeranalysis_v1
              >>>
              >>> client = containeranalysis_v1.ContainerAnalysisClient()
              >>>
              >>> resource = client.note_path('[PROJECT]', '[NOTE]')
              >>>
              >>> # TODO: Initialize `policy`:
              >>> policy = {}
              >>>
              >>> response = client.set_iam_policy(resource, policy)
  
          Args:
              resource (str): REQUIRED: The resource for which the policy is being specified.
                  See the operation documentation for the appropriate value for this field.
              policy (Union[dict, ~google.cloud.devtools.containeranalysis_v1.types.Policy]): REQUIRED: The complete policy to be applied to the ``resource``. The
                  size of the policy is limited to a few 10s of KB. An empty policy is a
                  valid policy but certain Cloud Platform services (such as Projects)
                  might reject them.
  
                  If a dict is provided, it must be of the same form as the protobuf
                  message :class:`~google.cloud.devtools.containeranalysis_v1.types.Policy`
              retry (Optional[google.api_core.retry.Retry]):  A retry object used
                  to retry requests. If ``None`` is specified, requests will
                  be retried using a default configuration.
              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.
              metadata (Optional[Sequence[Tuple[str, str]]]): Additional metadata
                  that is provided to the method.
  
          Returns:
              A :class:`~google.cloud.devtools.containeranalysis_v1.types.Policy` 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.
          """
          # Wrap the transport method to add retry and timeout logic.
          if "set_iam_policy" not in self._inner_api_calls:
              self._inner_api_calls[
                  "set_iam_policy"
              ] = google.api_core.gapic_v1.method.wrap_method(
                  self.transport.set_iam_policy,
                  default_retry=self._method_configs["SetIamPolicy"].retry,
                  default_timeout=self._method_configs["SetIamPolicy"].timeout,
                  client_info=self._client_info,
              )
  
          request = iam_policy_pb2.SetIamPolicyRequest(resource=resource, policy=policy)
          if metadata is None:
              metadata = []
          metadata = list(metadata)
          try:
              routing_header = [("resource", resource)]
          except AttributeError:
              pass
          else:
              routing_metadata = google.api_core.gapic_v1.routing_header.to_grpc_metadata(
                  routing_header
              )
              metadata.append(routing_metadata)
  
          return self._inner_api_calls["set_iam_policy"](
              request, retry=retry, timeout=timeout, metadata=metadata
          )
  
      def get_iam_policy(
          self,
          resource,
          options_=None,
          retry=google.api_core.gapic_v1.method.DEFAULT,
          timeout=google.api_core.gapic_v1.method.DEFAULT,
          metadata=None,
      ):
          """
          Gets the access control policy for a note or an occurrence resource.
          Requires ``containeranalysis.notes.setIamPolicy`` or
          ``containeranalysis.occurrences.setIamPolicy`` permission if the
          resource is a note or occurrence, respectively.
  
          The resource takes the format ``projects/[PROJECT_ID]/notes/[NOTE_ID]``
          for notes and ``projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`` for
          occurrences.
  
          Example:
              >>> from google.cloud.devtools import containeranalysis_v1
              >>>
              >>> client = containeranalysis_v1.ContainerAnalysisClient()
              >>>
              >>> resource = client.note_path('[PROJECT]', '[NOTE]')
              >>>
              >>> response = client.get_iam_policy(resource)
  
          Args:
              resource (str): REQUIRED: The resource for which the policy is being requested.
                  See the operation documentation for the appropriate value for this field.
              options_ (Union[dict, ~google.cloud.devtools.containeranalysis_v1.types.GetPolicyOptions]): OPTIONAL: A ``GetPolicyOptions`` object for specifying options to
                  ``GetIamPolicy``. This field is only used by Cloud IAM.
  
                  If a dict is provided, it must be of the same form as the protobuf
                  message :class:`~google.cloud.devtools.containeranalysis_v1.types.GetPolicyOptions`
              retry (Optional[google.api_core.retry.Retry]):  A retry object used
                  to retry requests. If ``None`` is specified, requests will
                  be retried using a default configuration.
              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.
              metadata (Optional[Sequence[Tuple[str, str]]]): Additional metadata
                  that is provided to the method.
  
          Returns:
              A :class:`~google.cloud.devtools.containeranalysis_v1.types.Policy` 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.
          """
          # Wrap the transport method to add retry and timeout logic.
          if "get_iam_policy" not in self._inner_api_calls:
              self._inner_api_calls[
                  "get_iam_policy"
              ] = google.api_core.gapic_v1.method.wrap_method(
                  self.transport.get_iam_policy,
                  default_retry=self._method_configs["GetIamPolicy"].retry,
                  default_timeout=self._method_configs["GetIamPolicy"].timeout,
                  client_info=self._client_info,
              )
  
          request = iam_policy_pb2.GetIamPolicyRequest(
              resource=resource, options=options_
          )
          if metadata is None:
              metadata = []
          metadata = list(metadata)
          try:
              routing_header = [("resource", resource)]
          except AttributeError:
              pass
          else:
              routing_metadata = google.api_core.gapic_v1.routing_header.to_grpc_metadata(
                  routing_header
              )
              metadata.append(routing_metadata)
  
          return self._inner_api_calls["get_iam_policy"](
              request, retry=retry, timeout=timeout, metadata=metadata
          )
  
      def test_iam_permissions(
          self,
          resource,
          permissions,
          retry=google.api_core.gapic_v1.method.DEFAULT,
          timeout=google.api_core.gapic_v1.method.DEFAULT,
          metadata=None,
      ):
          """
          Returns the permissions that a caller has on the specified note or
          occurrence. Requires list permission on the project (for example,
          ``containeranalysis.notes.list``).
  
          The resource takes the format ``projects/[PROJECT_ID]/notes/[NOTE_ID]``
          for notes and ``projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`` for
          occurrences.
  
          Example:
              >>> from google.cloud.devtools import containeranalysis_v1
              >>>
              >>> client = containeranalysis_v1.ContainerAnalysisClient()
              >>>
              >>> resource = client.note_path('[PROJECT]', '[NOTE]')
              >>>
              >>> # TODO: Initialize `permissions`:
              >>> permissions = []
              >>>
              >>> response = client.test_iam_permissions(resource, permissions)
  
          Args:
              resource (str): REQUIRED: The resource for which the policy detail is being requested.
                  See the operation documentation for the appropriate value for this field.
              permissions (list[str]): The set of permissions to check for the ``resource``. Permissions with
                  wildcards (such as '*' or 'storage.*') are not allowed. For more
                  information see `IAM
                  Overview <https://cloud.google.com/iam/docs/overview#permissions>`__.
              retry (Optional[google.api_core.retry.Retry]):  A retry object used
                  to retry requests. If ``None`` is specified, requests will
                  be retried using a default configuration.
              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.
              metadata (Optional[Sequence[Tuple[str, str]]]): Additional metadata
                  that is provided to the method.
  
          Returns:
              A :class:`~google.cloud.devtools.containeranalysis_v1.types.TestIamPermissionsResponse` 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.
          """
          # Wrap the transport method to add retry and timeout logic.
          if "test_iam_permissions" not in self._inner_api_calls:
              self._inner_api_calls[
                  "test_iam_permissions"
              ] = google.api_core.gapic_v1.method.wrap_method(
                  self.transport.test_iam_permissions,
                  default_retry=self._method_configs["TestIamPermissions"].retry,
                  default_timeout=self._method_configs["TestIamPermissions"].timeout,
                  client_info=self._client_info,
              )
  
          request = iam_policy_pb2.TestIamPermissionsRequest(
              resource=resource, permissions=permissions
          )
          if metadata is None:
              metadata = []
          metadata = list(metadata)
          try:
              routing_header = [("resource", resource)]
          except AttributeError:
              pass
          else:
              routing_metadata = google.api_core.gapic_v1.routing_header.to_grpc_metadata(
                  routing_header
              )
              metadata.append(routing_metadata)
  
          return self._inner_api_calls["test_iam_permissions"](
              request, retry=retry, timeout=timeout, metadata=metadata
          )
  