Packages
google_api_dlp
0.1.0
0.54.0
0.53.0
0.52.3
0.52.2
0.52.1
0.52.0
0.51.0
0.50.2
0.50.1
0.50.0
0.49.1
0.49.0
0.48.0
0.47.0
0.46.0
0.45.0
0.44.4
0.44.3
0.44.2
0.44.1
0.44.0
0.43.0
0.42.0
0.41.3
0.41.2
0.41.1
0.41.0
0.40.3
0.40.2
0.40.1
0.40.0
0.39.2
0.39.1
0.39.0
0.38.2
0.38.1
0.38.0
0.37.4
0.37.3
0.37.2
0.37.1
0.37.0
0.36.1
0.36.0
0.35.1
0.35.0
0.34.2
0.34.1
0.34.0
0.33.0
0.32.0
0.31.0
0.30.0
0.29.0
0.28.0
0.27.0
0.26.0
0.25.0
0.24.0
0.23.0
0.22.0
0.21.0
0.20.0
0.19.0
0.18.0
0.17.0
0.16.0
0.15.0
0.14.0
0.13.0
0.12.0
0.11.0
0.10.1
0.9.0
0.3.0
0.1.0
0.0.1
Sensitive Data Protection (DLP) client library. Discover and protect your sensitive data. A fully managed service designed to help you discover, classify, and protect your valuable data assets with ease.
Current section
Files
Jump to
Current section
Files
lib/google_api/dlp/v2/api/projects.ex
# 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.V2.Api.Projects do
@moduledoc """
API calls for all endpoints tagged `Projects`.
"""
alias GoogleApi.DLP.V2.Connection
alias GoogleApi.Gax.{Request, Response}
@doc """
De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/dlp/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.
## Parameters
- connection (GoogleApi.DLP.V2.Connection): Connection to server
- parent (String.t): The parent resource name, for example projects/my-project-id.
- opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :$.xgafv (String.t): V1 error format.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :callback (String.t): JSONP
- :alt (String.t): Data format for response.
- :key (String.t): 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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. \"raw\", \"multipart\").
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :body (GooglePrivacyDlpV2DeidentifyContentRequest):
## Returns
{:ok, %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2DeidentifyContentResponse{}} on success
{:error, info} on failure
"""
@spec dlp_projects_content_deidentify(Tesla.Env.client(), String.t(), keyword()) ::
{:ok, GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2DeidentifyContentResponse.t()}
| {:error, Tesla.Env.t()}
def dlp_projects_content_deidentify(connection, parent, opts \\ []) do
optional_params = %{
:uploadType => :query,
:fields => :query,
:"$.xgafv" => :query,
:oauth_token => :query,
:callback => :query,
:alt => :query,
:key => :query,
:access_token => :query,
:upload_protocol => :query,
:prettyPrint => :query,
:quotaUser => :query,
:body => :body
}
request =
Request.new()
|> Request.method(:post)
|> Request.url("/v2/{+parent}/content:deidentify", %{
"parent" => URI.encode_www_form(parent)
})
|> Request.add_optional_params(optional_params, opts)
connection
|> Connection.execute(request)
|> Response.decode(
struct: %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2DeidentifyContentResponse{}
)
end
@doc """
Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://cloud.google.com/dlp/docs/inspecting-images and https://cloud.google.com/dlp/docs/inspecting-text,
## Parameters
- connection (GoogleApi.DLP.V2.Connection): Connection to server
- parent (String.t): The parent resource name, for example projects/my-project-id.
- opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :$.xgafv (String.t): V1 error format.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :callback (String.t): JSONP
- :alt (String.t): Data format for response.
- :key (String.t): 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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. \"raw\", \"multipart\").
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :body (GooglePrivacyDlpV2InspectContentRequest):
## Returns
{:ok, %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2InspectContentResponse{}} on success
{:error, info} on failure
"""
@spec dlp_projects_content_inspect(Tesla.Env.client(), String.t(), keyword()) ::
{:ok, GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2InspectContentResponse.t()}
| {:error, Tesla.Env.t()}
def dlp_projects_content_inspect(connection, parent, opts \\ []) do
optional_params = %{
:uploadType => :query,
:fields => :query,
:"$.xgafv" => :query,
:oauth_token => :query,
:callback => :query,
:alt => :query,
:key => :query,
:access_token => :query,
:upload_protocol => :query,
:prettyPrint => :query,
:quotaUser => :query,
:body => :body
}
request =
Request.new()
|> Request.method(:post)
|> Request.url("/v2/{+parent}/content:inspect", %{
"parent" => URI.encode_www_form(parent)
})
|> Request.add_optional_params(optional_params, opts)
connection
|> Connection.execute(request)
|> Response.decode(struct: %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2InspectContentResponse{})
end
@doc """
Re-identifies content that has been de-identified. See https://cloud.google.com/dlp/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.
## Parameters
- connection (GoogleApi.DLP.V2.Connection): Connection to server
- parent (String.t): The parent resource name.
- opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :$.xgafv (String.t): V1 error format.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :callback (String.t): JSONP
- :alt (String.t): Data format for response.
- :key (String.t): 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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. \"raw\", \"multipart\").
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :body (GooglePrivacyDlpV2ReidentifyContentRequest):
## Returns
{:ok, %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2ReidentifyContentResponse{}} on success
{:error, info} on failure
"""
@spec dlp_projects_content_reidentify(Tesla.Env.client(), String.t(), keyword()) ::
{:ok, GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2ReidentifyContentResponse.t()}
| {:error, Tesla.Env.t()}
def dlp_projects_content_reidentify(connection, parent, opts \\ []) do
optional_params = %{
:uploadType => :query,
:fields => :query,
:"$.xgafv" => :query,
:oauth_token => :query,
:callback => :query,
:alt => :query,
:key => :query,
:access_token => :query,
:upload_protocol => :query,
:prettyPrint => :query,
:quotaUser => :query,
:body => :body
}
request =
Request.new()
|> Request.method(:post)
|> Request.url("/v2/{+parent}/content:reidentify", %{
"parent" => URI.encode_www_form(parent)
})
|> Request.add_optional_params(optional_params, opts)
connection
|> Connection.execute(request)
|> Response.decode(
struct: %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2ReidentifyContentResponse{}
)
end
@doc """
Creates a DeidentifyTemplate for re-using frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.
## Parameters
- connection (GoogleApi.DLP.V2.Connection): Connection to server
- parent (String.t): The parent resource name, for example projects/my-project-id or organizations/my-org-id.
- opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :$.xgafv (String.t): V1 error format.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :callback (String.t): JSONP
- :alt (String.t): Data format for response.
- :key (String.t): 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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. \"raw\", \"multipart\").
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :body (GooglePrivacyDlpV2CreateDeidentifyTemplateRequest):
## Returns
{:ok, %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2DeidentifyTemplate{}} on success
{:error, info} on failure
"""
@spec dlp_projects_deidentify_templates_create(Tesla.Env.client(), String.t(), keyword()) ::
{:ok, GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2DeidentifyTemplate.t()}
| {:error, Tesla.Env.t()}
def dlp_projects_deidentify_templates_create(connection, parent, opts \\ []) do
optional_params = %{
:uploadType => :query,
:fields => :query,
:"$.xgafv" => :query,
:oauth_token => :query,
:callback => :query,
:alt => :query,
:key => :query,
:access_token => :query,
:upload_protocol => :query,
:prettyPrint => :query,
:quotaUser => :query,
:body => :body
}
request =
Request.new()
|> Request.method(:post)
|> Request.url("/v2/{+parent}/deidentifyTemplates", %{
"parent" => URI.encode_www_form(parent)
})
|> Request.add_optional_params(optional_params, opts)
connection
|> Connection.execute(request)
|> Response.decode(struct: %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2DeidentifyTemplate{})
end
@doc """
Deletes a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.
## Parameters
- connection (GoogleApi.DLP.V2.Connection): Connection to server
- name (String.t): Resource name of the organization and deidentify template to be deleted, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.
- opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :$.xgafv (String.t): V1 error format.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :callback (String.t): JSONP
- :alt (String.t): Data format for response.
- :key (String.t): 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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. \"raw\", \"multipart\").
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
## Returns
{:ok, %GoogleApi.DLP.V2.Model.GoogleProtobufEmpty{}} on success
{:error, info} on failure
"""
@spec dlp_projects_deidentify_templates_delete(Tesla.Env.client(), String.t(), keyword()) ::
{:ok, GoogleApi.DLP.V2.Model.GoogleProtobufEmpty.t()} | {:error, Tesla.Env.t()}
def dlp_projects_deidentify_templates_delete(connection, name, opts \\ []) do
optional_params = %{
:uploadType => :query,
:fields => :query,
:"$.xgafv" => :query,
:oauth_token => :query,
:callback => :query,
:alt => :query,
:key => :query,
:access_token => :query,
:upload_protocol => :query,
:prettyPrint => :query,
:quotaUser => :query
}
request =
Request.new()
|> Request.method(:delete)
|> Request.url("/v2/{+name}", %{
"name" => URI.encode_www_form(name)
})
|> Request.add_optional_params(optional_params, opts)
connection
|> Connection.execute(request)
|> Response.decode(struct: %GoogleApi.DLP.V2.Model.GoogleProtobufEmpty{})
end
@doc """
Gets a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.
## Parameters
- connection (GoogleApi.DLP.V2.Connection): Connection to server
- name (String.t): Resource name of the organization and deidentify template to be read, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.
- opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :$.xgafv (String.t): V1 error format.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :callback (String.t): JSONP
- :alt (String.t): Data format for response.
- :key (String.t): 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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. \"raw\", \"multipart\").
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
## Returns
{:ok, %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2DeidentifyTemplate{}} on success
{:error, info} on failure
"""
@spec dlp_projects_deidentify_templates_get(Tesla.Env.client(), String.t(), keyword()) ::
{:ok, GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2DeidentifyTemplate.t()}
| {:error, Tesla.Env.t()}
def dlp_projects_deidentify_templates_get(connection, name, opts \\ []) do
optional_params = %{
:uploadType => :query,
:fields => :query,
:"$.xgafv" => :query,
:oauth_token => :query,
:callback => :query,
:alt => :query,
:key => :query,
:access_token => :query,
:upload_protocol => :query,
:prettyPrint => :query,
:quotaUser => :query
}
request =
Request.new()
|> Request.method(:get)
|> Request.url("/v2/{+name}", %{
"name" => URI.encode_www_form(name)
})
|> Request.add_optional_params(optional_params, opts)
connection
|> Connection.execute(request)
|> Response.decode(struct: %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2DeidentifyTemplate{})
end
@doc """
Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.
## Parameters
- connection (GoogleApi.DLP.V2.Connection): Connection to server
- parent (String.t): The parent resource name, for example projects/my-project-id or organizations/my-org-id.
- opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :$.xgafv (String.t): V1 error format.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :callback (String.t): JSONP
- :alt (String.t): Data format for response.
- :key (String.t): 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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. \"raw\", \"multipart\").
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :pageToken (String.t): Optional page token to continue retrieval. Comes from previous call to `ListDeidentifyTemplates`.
- :pageSize (integer()): Optional size of the page, can be limited by server. If zero server returns a page of max size 100.
## Returns
{:ok, %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2ListDeidentifyTemplatesResponse{}} on success
{:error, info} on failure
"""
@spec dlp_projects_deidentify_templates_list(Tesla.Env.client(), String.t(), keyword()) ::
{:ok, GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2ListDeidentifyTemplatesResponse.t()}
| {:error, Tesla.Env.t()}
def dlp_projects_deidentify_templates_list(connection, parent, opts \\ []) do
optional_params = %{
:uploadType => :query,
:fields => :query,
:"$.xgafv" => :query,
:oauth_token => :query,
:callback => :query,
:alt => :query,
:key => :query,
:access_token => :query,
:upload_protocol => :query,
:prettyPrint => :query,
:quotaUser => :query,
:pageToken => :query,
:pageSize => :query
}
request =
Request.new()
|> Request.method(:get)
|> Request.url("/v2/{+parent}/deidentifyTemplates", %{
"parent" => URI.encode_www_form(parent)
})
|> Request.add_optional_params(optional_params, opts)
connection
|> Connection.execute(request)
|> Response.decode(
struct: %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2ListDeidentifyTemplatesResponse{}
)
end
@doc """
Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.
## Parameters
- connection (GoogleApi.DLP.V2.Connection): Connection to server
- name (String.t): Resource name of organization and deidentify template to be updated, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.
- opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :$.xgafv (String.t): V1 error format.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :callback (String.t): JSONP
- :alt (String.t): Data format for response.
- :key (String.t): 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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. \"raw\", \"multipart\").
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :body (GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest):
## Returns
{:ok, %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2DeidentifyTemplate{}} on success
{:error, info} on failure
"""
@spec dlp_projects_deidentify_templates_patch(Tesla.Env.client(), String.t(), keyword()) ::
{:ok, GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2DeidentifyTemplate.t()}
| {:error, Tesla.Env.t()}
def dlp_projects_deidentify_templates_patch(connection, name, opts \\ []) do
optional_params = %{
:uploadType => :query,
:fields => :query,
:"$.xgafv" => :query,
:oauth_token => :query,
:callback => :query,
:alt => :query,
:key => :query,
:access_token => :query,
:upload_protocol => :query,
:prettyPrint => :query,
:quotaUser => :query,
:body => :body
}
request =
Request.new()
|> Request.method(:patch)
|> Request.url("/v2/{+name}", %{
"name" => URI.encode_www_form(name)
})
|> Request.add_optional_params(optional_params, opts)
connection
|> Connection.execute(request)
|> Response.decode(struct: %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2DeidentifyTemplate{})
end
@doc """
Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.
## Parameters
- connection (GoogleApi.DLP.V2.Connection): Connection to server
- name (String.t): The name of the DlpJob resource to be cancelled.
- opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :$.xgafv (String.t): V1 error format.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :callback (String.t): JSONP
- :alt (String.t): Data format for response.
- :key (String.t): 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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. \"raw\", \"multipart\").
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :body (GooglePrivacyDlpV2CancelDlpJobRequest):
## Returns
{:ok, %GoogleApi.DLP.V2.Model.GoogleProtobufEmpty{}} on success
{:error, info} on failure
"""
@spec dlp_projects_dlp_jobs_cancel(Tesla.Env.client(), String.t(), keyword()) ::
{:ok, GoogleApi.DLP.V2.Model.GoogleProtobufEmpty.t()} | {:error, Tesla.Env.t()}
def dlp_projects_dlp_jobs_cancel(connection, name, opts \\ []) do
optional_params = %{
:uploadType => :query,
:fields => :query,
:"$.xgafv" => :query,
:oauth_token => :query,
:callback => :query,
:alt => :query,
:key => :query,
:access_token => :query,
:upload_protocol => :query,
:prettyPrint => :query,
:quotaUser => :query,
:body => :body
}
request =
Request.new()
|> Request.method(:post)
|> Request.url("/v2/{+name}:cancel", %{
"name" => URI.encode_www_form(name)
})
|> Request.add_optional_params(optional_params, opts)
connection
|> Connection.execute(request)
|> Response.decode(struct: %GoogleApi.DLP.V2.Model.GoogleProtobufEmpty{})
end
@doc """
Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.
## Parameters
- connection (GoogleApi.DLP.V2.Connection): Connection to server
- parent (String.t): The parent resource name, for example projects/my-project-id.
- opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :$.xgafv (String.t): V1 error format.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :callback (String.t): JSONP
- :alt (String.t): Data format for response.
- :key (String.t): 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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. \"raw\", \"multipart\").
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :body (GooglePrivacyDlpV2CreateDlpJobRequest):
## Returns
{:ok, %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2DlpJob{}} on success
{:error, info} on failure
"""
@spec dlp_projects_dlp_jobs_create(Tesla.Env.client(), String.t(), keyword()) ::
{:ok, GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2DlpJob.t()} | {:error, Tesla.Env.t()}
def dlp_projects_dlp_jobs_create(connection, parent, opts \\ []) do
optional_params = %{
:uploadType => :query,
:fields => :query,
:"$.xgafv" => :query,
:oauth_token => :query,
:callback => :query,
:alt => :query,
:key => :query,
:access_token => :query,
:upload_protocol => :query,
:prettyPrint => :query,
:quotaUser => :query,
:body => :body
}
request =
Request.new()
|> Request.method(:post)
|> Request.url("/v2/{+parent}/dlpJobs", %{
"parent" => URI.encode_www_form(parent)
})
|> Request.add_optional_params(optional_params, opts)
connection
|> Connection.execute(request)
|> Response.decode(struct: %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2DlpJob{})
end
@doc """
Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.
## Parameters
- connection (GoogleApi.DLP.V2.Connection): Connection to server
- parent (String.t): The parent resource name, for example projects/my-project-id.
- opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :$.xgafv (String.t): V1 error format.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :callback (String.t): JSONP
- :alt (String.t): Data format for response.
- :key (String.t): 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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. \"raw\", \"multipart\").
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :pageSize (integer()): The standard list page size.
- :type (String.t): The type of job. Defaults to `DlpJobType.INSPECT`
- :filter (String.t): Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `<field> <operator> <value>`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) The length of this field should be no more than 500 characters.
- :pageToken (String.t): The standard list page token.
## Returns
{:ok, %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2ListDlpJobsResponse{}} on success
{:error, info} on failure
"""
@spec dlp_projects_dlp_jobs_list(Tesla.Env.client(), String.t(), keyword()) ::
{:ok, GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2ListDlpJobsResponse.t()}
| {:error, Tesla.Env.t()}
def dlp_projects_dlp_jobs_list(connection, parent, opts \\ []) do
optional_params = %{
:uploadType => :query,
:fields => :query,
:"$.xgafv" => :query,
:oauth_token => :query,
:callback => :query,
:alt => :query,
:key => :query,
:access_token => :query,
:upload_protocol => :query,
:prettyPrint => :query,
:quotaUser => :query,
:pageSize => :query,
:type => :query,
:filter => :query,
:pageToken => :query
}
request =
Request.new()
|> Request.method(:get)
|> Request.url("/v2/{+parent}/dlpJobs", %{
"parent" => URI.encode_www_form(parent)
})
|> Request.add_optional_params(optional_params, opts)
connection
|> Connection.execute(request)
|> Response.decode(struct: %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2ListDlpJobsResponse{})
end
@doc """
Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/dlp/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.
## Parameters
- connection (GoogleApi.DLP.V2.Connection): Connection to server
- parent (String.t): The parent resource name, for example projects/my-project-id.
- opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :$.xgafv (String.t): V1 error format.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :callback (String.t): JSONP
- :alt (String.t): Data format for response.
- :key (String.t): 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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. \"raw\", \"multipart\").
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :body (GooglePrivacyDlpV2RedactImageRequest):
## Returns
{:ok, %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2RedactImageResponse{}} on success
{:error, info} on failure
"""
@spec dlp_projects_image_redact(Tesla.Env.client(), String.t(), keyword()) ::
{:ok, GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2RedactImageResponse.t()}
| {:error, Tesla.Env.t()}
def dlp_projects_image_redact(connection, parent, opts \\ []) do
optional_params = %{
:uploadType => :query,
:fields => :query,
:"$.xgafv" => :query,
:oauth_token => :query,
:callback => :query,
:alt => :query,
:key => :query,
:access_token => :query,
:upload_protocol => :query,
:prettyPrint => :query,
:quotaUser => :query,
:body => :body
}
request =
Request.new()
|> Request.method(:post)
|> Request.url("/v2/{+parent}/image:redact", %{
"parent" => URI.encode_www_form(parent)
})
|> Request.add_optional_params(optional_params, opts)
connection
|> Connection.execute(request)
|> Response.decode(struct: %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2RedactImageResponse{})
end
@doc """
Creates an InspectTemplate for re-using frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates to learn more.
## Parameters
- connection (GoogleApi.DLP.V2.Connection): Connection to server
- parent (String.t): The parent resource name, for example projects/my-project-id or organizations/my-org-id.
- opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :$.xgafv (String.t): V1 error format.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :callback (String.t): JSONP
- :alt (String.t): Data format for response.
- :key (String.t): 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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. \"raw\", \"multipart\").
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :body (GooglePrivacyDlpV2CreateInspectTemplateRequest):
## Returns
{:ok, %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2InspectTemplate{}} on success
{:error, info} on failure
"""
@spec dlp_projects_inspect_templates_create(Tesla.Env.client(), String.t(), keyword()) ::
{:ok, GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2InspectTemplate.t()}
| {:error, Tesla.Env.t()}
def dlp_projects_inspect_templates_create(connection, parent, opts \\ []) do
optional_params = %{
:uploadType => :query,
:fields => :query,
:"$.xgafv" => :query,
:oauth_token => :query,
:callback => :query,
:alt => :query,
:key => :query,
:access_token => :query,
:upload_protocol => :query,
:prettyPrint => :query,
:quotaUser => :query,
:body => :body
}
request =
Request.new()
|> Request.method(:post)
|> Request.url("/v2/{+parent}/inspectTemplates", %{
"parent" => URI.encode_www_form(parent)
})
|> Request.add_optional_params(optional_params, opts)
connection
|> Connection.execute(request)
|> Response.decode(struct: %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2InspectTemplate{})
end
@doc """
Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more.
## Parameters
- connection (GoogleApi.DLP.V2.Connection): Connection to server
- parent (String.t): The parent resource name, for example projects/my-project-id or organizations/my-org-id.
- opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :$.xgafv (String.t): V1 error format.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :callback (String.t): JSONP
- :alt (String.t): Data format for response.
- :key (String.t): 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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. \"raw\", \"multipart\").
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :pageToken (String.t): Optional page token to continue retrieval. Comes from previous call to `ListInspectTemplates`.
- :pageSize (integer()): Optional size of the page, can be limited by server. If zero server returns a page of max size 100.
## Returns
{:ok, %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2ListInspectTemplatesResponse{}} on success
{:error, info} on failure
"""
@spec dlp_projects_inspect_templates_list(Tesla.Env.client(), String.t(), keyword()) ::
{:ok, GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2ListInspectTemplatesResponse.t()}
| {:error, Tesla.Env.t()}
def dlp_projects_inspect_templates_list(connection, parent, opts \\ []) do
optional_params = %{
:uploadType => :query,
:fields => :query,
:"$.xgafv" => :query,
:oauth_token => :query,
:callback => :query,
:alt => :query,
:key => :query,
:access_token => :query,
:upload_protocol => :query,
:prettyPrint => :query,
:quotaUser => :query,
:pageToken => :query,
:pageSize => :query
}
request =
Request.new()
|> Request.method(:get)
|> Request.url("/v2/{+parent}/inspectTemplates", %{
"parent" => URI.encode_www_form(parent)
})
|> Request.add_optional_params(optional_params, opts)
connection
|> Connection.execute(request)
|> Response.decode(
struct: %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2ListInspectTemplatesResponse{}
)
end
@doc """
Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
## Parameters
- connection (GoogleApi.DLP.V2.Connection): Connection to server
- parent (String.t): The parent resource name, for example projects/my-project-id.
- opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :$.xgafv (String.t): V1 error format.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :callback (String.t): JSONP
- :alt (String.t): Data format for response.
- :key (String.t): 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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. \"raw\", \"multipart\").
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :body (GooglePrivacyDlpV2CreateJobTriggerRequest):
## Returns
{:ok, %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2JobTrigger{}} on success
{:error, info} on failure
"""
@spec dlp_projects_job_triggers_create(Tesla.Env.client(), String.t(), keyword()) ::
{:ok, GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2JobTrigger.t()} | {:error, Tesla.Env.t()}
def dlp_projects_job_triggers_create(connection, parent, opts \\ []) do
optional_params = %{
:uploadType => :query,
:fields => :query,
:"$.xgafv" => :query,
:oauth_token => :query,
:callback => :query,
:alt => :query,
:key => :query,
:access_token => :query,
:upload_protocol => :query,
:prettyPrint => :query,
:quotaUser => :query,
:body => :body
}
request =
Request.new()
|> Request.method(:post)
|> Request.url("/v2/{+parent}/jobTriggers", %{
"parent" => URI.encode_www_form(parent)
})
|> Request.add_optional_params(optional_params, opts)
connection
|> Connection.execute(request)
|> Response.decode(struct: %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2JobTrigger{})
end
@doc """
Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
## Parameters
- connection (GoogleApi.DLP.V2.Connection): Connection to server
- parent (String.t): The parent resource name, for example `projects/my-project-id`.
- opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :$.xgafv (String.t): V1 error format.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :callback (String.t): JSONP
- :alt (String.t): Data format for response.
- :key (String.t): 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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. \"raw\", \"multipart\").
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :pageSize (integer()): Optional size of the page, can be limited by a server.
- :pageToken (String.t): Optional page token to continue retrieval. Comes from previous call to ListJobTriggers. `order_by` field must not change for subsequent calls.
- :orderBy (String.t): Optional comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the triggeredJob was created. - `update_time`: corresponds to time the triggeredJob was last updated. - `name`: corresponds to JobTrigger's name.
## Returns
{:ok, %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2ListJobTriggersResponse{}} on success
{:error, info} on failure
"""
@spec dlp_projects_job_triggers_list(Tesla.Env.client(), String.t(), keyword()) ::
{:ok, GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2ListJobTriggersResponse.t()}
| {:error, Tesla.Env.t()}
def dlp_projects_job_triggers_list(connection, parent, opts \\ []) do
optional_params = %{
:uploadType => :query,
:fields => :query,
:"$.xgafv" => :query,
:oauth_token => :query,
:callback => :query,
:alt => :query,
:key => :query,
:access_token => :query,
:upload_protocol => :query,
:prettyPrint => :query,
:quotaUser => :query,
:pageSize => :query,
:pageToken => :query,
:orderBy => :query
}
request =
Request.new()
|> Request.method(:get)
|> Request.url("/v2/{+parent}/jobTriggers", %{
"parent" => URI.encode_www_form(parent)
})
|> Request.add_optional_params(optional_params, opts)
connection
|> Connection.execute(request)
|> Response.decode(
struct: %GoogleApi.DLP.V2.Model.GooglePrivacyDlpV2ListJobTriggersResponse{}
)
end
end