# Copyright 2017 Google Inc.
#
# 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
#
#     http://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.


# NOTE: This class is auto generated by the swagger code generator program.
# https://github.com/swagger-api/swagger-codegen.git
# Do not edit the class manually.

defmodule GoogleApi.DLP.V2beta1.Api.Inspect do
  @moduledoc """
  API calls for all endpoints tagged `Inspect`.
  """

  alias GoogleApi.DLP.V2beta1.Connection
  import GoogleApi.DLP.V2beta1.RequestBuilder


  @doc """
  Cancels an operation. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation.

  ## Parameters

  - connection (GoogleApi.DLP.V2beta1.Connection): Connection to server
  - name (String): The name of the operation resource to be cancelled.
  - opts (KeywordList): [optional] Optional parameters
    - :upload_protocol (String): Upload protocol for media (e.g. \"raw\", \"multipart\").
    - :pretty_print (Boolean): Returns response with indentations and line breaks.
    - :upload_type (String): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
    - :fields (String): Selector specifying which fields to include in a partial response.
    - :__/xgafv (String): V1 error format.
    - :callback (String): JSONP
    - :alt (String): Data format for response.
    - :access_token (String): OAuth access token.
    - :key (String): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    - :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    - :pp (Boolean): Pretty-print response.
    - :bearer_token (String): OAuth bearer token.
    - :oauth_token (String): OAuth 2.0 token for the current user.
    - :body (GoogleLongrunningCancelOperationRequest): 

  ## Returns

  {:ok, %GoogleApi.DLP.V2beta1.Model.GoogleProtobufEmpty{}} on success
  {:error, info} on failure
  """
  @spec dlp_inspect_operations_cancel(Tesla.Env.client, String.t, keyword()) :: {:ok, GoogleApi.DLP.V2beta1.Model.GoogleProtobufEmpty.t} | {:error, Tesla.Env.t}
  def dlp_inspect_operations_cancel(connection, name, opts \\ []) do
    optional_params = %{
      :"upload_protocol" => :query,
      :"prettyPrint" => :query,
      :"uploadType" => :query,
      :"fields" => :query,
      :"$.xgafv" => :query,
      :"callback" => :query,
      :"alt" => :query,
      :"access_token" => :query,
      :"key" => :query,
      :"quotaUser" => :query,
      :"pp" => :query,
      :"bearer_token" => :query,
      :"oauth_token" => :query,
      :"body" => :body
    }
    %{}
    |> method(:post)
    |> url("/v2beta1/{+name}:cancel", %{
         "name" => URI.encode_www_form(name)
       })
    |> add_optional_params(optional_params, opts)
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%GoogleApi.DLP.V2beta1.Model.GoogleProtobufEmpty{})
  end

  @doc """
  Schedules a job scanning content in a Google Cloud Platform data repository.

  ## Parameters

  - connection (GoogleApi.DLP.V2beta1.Connection): Connection to server
  - opts (KeywordList): [optional] Optional parameters
    - :upload_protocol (String): Upload protocol for media (e.g. \"raw\", \"multipart\").
    - :pretty_print (Boolean): Returns response with indentations and line breaks.
    - :upload_type (String): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
    - :fields (String): Selector specifying which fields to include in a partial response.
    - :__/xgafv (String): V1 error format.
    - :callback (String): JSONP
    - :alt (String): Data format for response.
    - :access_token (String): OAuth access token.
    - :key (String): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    - :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    - :pp (Boolean): Pretty-print response.
    - :bearer_token (String): OAuth bearer token.
    - :oauth_token (String): OAuth 2.0 token for the current user.
    - :body (GooglePrivacyDlpV2beta1CreateInspectOperationRequest): 

  ## Returns

  {:ok, %GoogleApi.DLP.V2beta1.Model.GoogleLongrunningOperation{}} on success
  {:error, info} on failure
  """
  @spec dlp_inspect_operations_create(Tesla.Env.client, keyword()) :: {:ok, GoogleApi.DLP.V2beta1.Model.GoogleLongrunningOperation.t} | {:error, Tesla.Env.t}
  def dlp_inspect_operations_create(connection, opts \\ []) do
    optional_params = %{
      :"upload_protocol" => :query,
      :"prettyPrint" => :query,
      :"uploadType" => :query,
      :"fields" => :query,
      :"$.xgafv" => :query,
      :"callback" => :query,
      :"alt" => :query,
      :"access_token" => :query,
      :"key" => :query,
      :"quotaUser" => :query,
      :"pp" => :query,
      :"bearer_token" => :query,
      :"oauth_token" => :query,
      :"body" => :body
    }
    %{}
    |> method(:post)
    |> url("/v2beta1/inspect/operations")
    |> add_optional_params(optional_params, opts)
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%GoogleApi.DLP.V2beta1.Model.GoogleLongrunningOperation{})
  end

  @doc """
  This method is not supported and the server returns `UNIMPLEMENTED`.

  ## Parameters

  - connection (GoogleApi.DLP.V2beta1.Connection): Connection to server
  - name (String): The name of the operation resource to be deleted.
  - opts (KeywordList): [optional] Optional parameters
    - :upload_protocol (String): Upload protocol for media (e.g. \"raw\", \"multipart\").
    - :pretty_print (Boolean): Returns response with indentations and line breaks.
    - :upload_type (String): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
    - :fields (String): Selector specifying which fields to include in a partial response.
    - :__/xgafv (String): V1 error format.
    - :callback (String): JSONP
    - :alt (String): Data format for response.
    - :access_token (String): OAuth access token.
    - :key (String): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    - :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    - :pp (Boolean): Pretty-print response.
    - :bearer_token (String): OAuth bearer token.
    - :oauth_token (String): OAuth 2.0 token for the current user.

  ## Returns

  {:ok, %GoogleApi.DLP.V2beta1.Model.GoogleProtobufEmpty{}} on success
  {:error, info} on failure
  """
  @spec dlp_inspect_operations_delete(Tesla.Env.client, String.t, keyword()) :: {:ok, GoogleApi.DLP.V2beta1.Model.GoogleProtobufEmpty.t} | {:error, Tesla.Env.t}
  def dlp_inspect_operations_delete(connection, name, opts \\ []) do
    optional_params = %{
      :"upload_protocol" => :query,
      :"prettyPrint" => :query,
      :"uploadType" => :query,
      :"fields" => :query,
      :"$.xgafv" => :query,
      :"callback" => :query,
      :"alt" => :query,
      :"access_token" => :query,
      :"key" => :query,
      :"quotaUser" => :query,
      :"pp" => :query,
      :"bearer_token" => :query,
      :"oauth_token" => :query
    }
    %{}
    |> method(:delete)
    |> url("/v2beta1/{+name}", %{
         "name" => URI.encode_www_form(name)
       })
    |> add_optional_params(optional_params, opts)
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%GoogleApi.DLP.V2beta1.Model.GoogleProtobufEmpty{})
  end

  @doc """
  Fetch the list of long running operations.

  ## Parameters

  - connection (GoogleApi.DLP.V2beta1.Connection): Connection to server
  - name (String): The name of the operation's parent resource.
  - opts (KeywordList): [optional] Optional parameters
    - :upload_protocol (String): Upload protocol for media (e.g. \"raw\", \"multipart\").
    - :pretty_print (Boolean): Returns response with indentations and line breaks.
    - :upload_type (String): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
    - :fields (String): Selector specifying which fields to include in a partial response.
    - :__/xgafv (String): V1 error format.
    - :callback (String): JSONP
    - :alt (String): Data format for response.
    - :access_token (String): OAuth access token.
    - :key (String): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    - :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    - :pp (Boolean): Pretty-print response.
    - :bearer_token (String): OAuth bearer token.
    - :oauth_token (String): OAuth 2.0 token for the current user.
    - :page_token (String): The standard list page token.
    - :page_size (Integer): The list page size. The max allowed value is 256 and default is 100.
    - :filter (String): This parameter supports filtering by done, ie done=true or done=false.

  ## Returns

  {:ok, %GoogleApi.DLP.V2beta1.Model.GoogleLongrunningListOperationsResponse{}} on success
  {:error, info} on failure
  """
  @spec dlp_inspect_operations_list(Tesla.Env.client, String.t, keyword()) :: {:ok, GoogleApi.DLP.V2beta1.Model.GoogleLongrunningListOperationsResponse.t} | {:error, Tesla.Env.t}
  def dlp_inspect_operations_list(connection, name, opts \\ []) do
    optional_params = %{
      :"upload_protocol" => :query,
      :"prettyPrint" => :query,
      :"uploadType" => :query,
      :"fields" => :query,
      :"$.xgafv" => :query,
      :"callback" => :query,
      :"alt" => :query,
      :"access_token" => :query,
      :"key" => :query,
      :"quotaUser" => :query,
      :"pp" => :query,
      :"bearer_token" => :query,
      :"oauth_token" => :query,
      :"pageToken" => :query,
      :"pageSize" => :query,
      :"filter" => :query
    }
    %{}
    |> method(:get)
    |> url("/v2beta1/{+name}", %{
         "name" => URI.encode_www_form(name)
       })
    |> add_optional_params(optional_params, opts)
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%GoogleApi.DLP.V2beta1.Model.GoogleLongrunningListOperationsResponse{})
  end

  @doc """
  Returns list of results for given inspect operation result set id.

  ## Parameters

  - connection (GoogleApi.DLP.V2beta1.Connection): Connection to server
  - name (String): Identifier of the results set returned as metadata of the longrunning operation created by a call to CreateInspectOperation. Should be in the format of `inspect/results/{id}`.
  - opts (KeywordList): [optional] Optional parameters
    - :upload_protocol (String): Upload protocol for media (e.g. \"raw\", \"multipart\").
    - :pretty_print (Boolean): Returns response with indentations and line breaks.
    - :upload_type (String): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
    - :fields (String): Selector specifying which fields to include in a partial response.
    - :__/xgafv (String): V1 error format.
    - :callback (String): JSONP
    - :alt (String): Data format for response.
    - :access_token (String): OAuth access token.
    - :key (String): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    - :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    - :pp (Boolean): Pretty-print response.
    - :bearer_token (String): OAuth bearer token.
    - :oauth_token (String): OAuth 2.0 token for the current user.
    - :page_size (Integer): Maximum number of results to return. If 0, the implementation selects a reasonable value.
    - :filter (String): Restricts findings to items that match. Supports info_type and likelihood. <p>Examples:<br/> <li>info_type=EMAIL_ADDRESS <li>info_type=PHONE_NUMBER,EMAIL_ADDRESS <li>likelihood=VERY_LIKELY <li>likelihood=VERY_LIKELY,LIKELY <li>info_type=EMAIL_ADDRESS,likelihood=VERY_LIKELY,LIKELY
    - :page_token (String): The value returned by the last `ListInspectFindingsResponse`; indicates that this is a continuation of a prior `ListInspectFindings` call, and that the system should return the next page of data.

  ## Returns

  {:ok, %GoogleApi.DLP.V2beta1.Model.GooglePrivacyDlpV2beta1ListInspectFindingsResponse{}} on success
  {:error, info} on failure
  """
  @spec dlp_inspect_results_findings_list(Tesla.Env.client, String.t, keyword()) :: {:ok, GoogleApi.DLP.V2beta1.Model.GooglePrivacyDlpV2beta1ListInspectFindingsResponse.t} | {:error, Tesla.Env.t}
  def dlp_inspect_results_findings_list(connection, name, opts \\ []) do
    optional_params = %{
      :"upload_protocol" => :query,
      :"prettyPrint" => :query,
      :"uploadType" => :query,
      :"fields" => :query,
      :"$.xgafv" => :query,
      :"callback" => :query,
      :"alt" => :query,
      :"access_token" => :query,
      :"key" => :query,
      :"quotaUser" => :query,
      :"pp" => :query,
      :"bearer_token" => :query,
      :"oauth_token" => :query,
      :"pageSize" => :query,
      :"filter" => :query,
      :"pageToken" => :query
    }
    %{}
    |> method(:get)
    |> url("/v2beta1/{+name}/findings", %{
         "name" => URI.encode_www_form(name)
       })
    |> add_optional_params(optional_params, opts)
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%GoogleApi.DLP.V2beta1.Model.GooglePrivacyDlpV2beta1ListInspectFindingsResponse{})
  end
end