Class: Google::Cloud::Dlp::V2::DlpService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/dlp/v2/dlp_service/client.rb

Overview

Client for the DlpService service.

The Cloud Data Loss Prevention (DLP) API is a service that allows clients to detect the presence of Personally Identifiable Information (PII) and other privacy-sensitive data in user-supplied, unstructured data streams, like text blocks or images. The service also includes methods for sensitive data redaction and scheduling of data scans on Google Cloud Platform based data sets.

To learn more about concepts and find how-to guides see https://cloud.google.com/dlp/docs/.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#deidentify_template_path, #dlp_job_path, #inspect_template_path, #job_trigger_path, #location_path, #organization_location_path, #organization_path, #project_path, #stored_info_type_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new DlpService client object.

Examples

To create a new DlpService client with the default configuration:

client = ::Google::Cloud::Dlp::V2::DlpService::Client.new

To create a new DlpService client with a custom configuration:

client = ::Google::Cloud::Dlp::V2::DlpService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the DlpService client.

Yield Parameters:



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 328

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/privacy/dlp/v2/dlp_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  credentials ||= Credentials.default scope: @config.scope
  if credentials.is_a?(String) || credentials.is_a?(Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = credentials.respond_to?(:quota_project_id) ? credentials.quota_project_id : nil

  @dlp_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Dlp::V2::DlpService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the DlpService Client class.

See Configuration for a description of the configuration fields.

Example

To modify the configuration for all DlpService clients:

::Google::Cloud::Dlp::V2::DlpService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 65

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Dlp", "V2"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const&.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.inspect_content.timeout = 300.0
    default_config.rpcs.inspect_content.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.redact_image.timeout = 300.0
    default_config.rpcs.redact_image.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.deidentify_content.timeout = 300.0
    default_config.rpcs.deidentify_content.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.reidentify_content.timeout = 300.0
    default_config.rpcs.reidentify_content.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.list_info_types.timeout = 300.0
    default_config.rpcs.list_info_types.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.create_inspect_template.timeout = 300.0

    default_config.rpcs.update_inspect_template.timeout = 300.0

    default_config.rpcs.get_inspect_template.timeout = 300.0
    default_config.rpcs.get_inspect_template.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.list_inspect_templates.timeout = 300.0
    default_config.rpcs.list_inspect_templates.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.delete_inspect_template.timeout = 300.0
    default_config.rpcs.delete_inspect_template.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.create_deidentify_template.timeout = 300.0

    default_config.rpcs.update_deidentify_template.timeout = 300.0

    default_config.rpcs.get_deidentify_template.timeout = 300.0
    default_config.rpcs.get_deidentify_template.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.list_deidentify_templates.timeout = 300.0
    default_config.rpcs.list_deidentify_templates.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.delete_deidentify_template.timeout = 300.0
    default_config.rpcs.delete_deidentify_template.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.create_job_trigger.timeout = 300.0

    default_config.rpcs.update_job_trigger.timeout = 300.0

    default_config.rpcs.hybrid_inspect_job_trigger.timeout = 300.0
    default_config.rpcs.hybrid_inspect_job_trigger.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.get_job_trigger.timeout = 300.0
    default_config.rpcs.get_job_trigger.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.list_job_triggers.timeout = 300.0
    default_config.rpcs.list_job_triggers.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.delete_job_trigger.timeout = 300.0
    default_config.rpcs.delete_job_trigger.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.activate_job_trigger.timeout = 300.0

    default_config.rpcs.create_dlp_job.timeout = 300.0

    default_config.rpcs.list_dlp_jobs.timeout = 300.0
    default_config.rpcs.list_dlp_jobs.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.get_dlp_job.timeout = 300.0
    default_config.rpcs.get_dlp_job.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.delete_dlp_job.timeout = 300.0
    default_config.rpcs.delete_dlp_job.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.cancel_dlp_job.timeout = 300.0

    default_config.rpcs.create_stored_info_type.timeout = 300.0

    default_config.rpcs.update_stored_info_type.timeout = 300.0

    default_config.rpcs.get_stored_info_type.timeout = 300.0
    default_config.rpcs.get_stored_info_type.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.list_stored_info_types.timeout = 300.0
    default_config.rpcs.list_stored_info_types.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.delete_stored_info_type.timeout = 300.0
    default_config.rpcs.delete_stored_info_type.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.hybrid_inspect_dlp_job.timeout = 300.0
    default_config.rpcs.hybrid_inspect_dlp_job.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.finish_dlp_job.timeout = 300.0
    default_config.rpcs.finish_dlp_job.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#activate_job_trigger(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DlpJob #activate_job_trigger(name: nil) ⇒ ::Google::Cloud::Dlp::V2::DlpJob

Activate a job trigger. Causes the immediate execute of a trigger instead of waiting on the trigger event to occur.

Overloads:

  • #activate_job_trigger(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DlpJob

    Pass arguments to activate_job_trigger via a request object, either of type ActivateJobTriggerRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::ActivateJobTriggerRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #activate_job_trigger(name: nil) ⇒ ::Google::Cloud::Dlp::V2::DlpJob

    Pass arguments to activate_job_trigger via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Resource name of the trigger to activate, for example projects/dlp-test-project/jobTriggers/53234423.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 2077

def activate_job_trigger request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::ActivateJobTriggerRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.activate_job_trigger.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.activate_job_trigger.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.activate_job_trigger.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :activate_job_trigger, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#cancel_dlp_job(request, options = nil) ⇒ ::Google::Protobuf::Empty #cancel_dlp_job(name: nil) ⇒ ::Google::Protobuf::Empty

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.

Overloads:

  • #cancel_dlp_job(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to cancel_dlp_job via a request object, either of type CancelDlpJobRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::CancelDlpJobRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #cancel_dlp_job(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to cancel_dlp_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the DlpJob resource to be cancelled.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 2490

def cancel_dlp_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::CancelDlpJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.cancel_dlp_job.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.cancel_dlp_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.cancel_dlp_job.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :cancel_dlp_job, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#configure {|config| ... } ⇒ Client::Configuration

Configure the DlpService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



303
304
305
306
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 303

def configure
  yield @config if block_given?
  @config
end

#create_deidentify_template(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DeidentifyTemplate #create_deidentify_template(parent: nil, deidentify_template: nil, template_id: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::DeidentifyTemplate

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.

Overloads:

  • #create_deidentify_template(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DeidentifyTemplate

    Pass arguments to create_deidentify_template via a request object, either of type CreateDeidentifyTemplateRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::CreateDeidentifyTemplateRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_deidentify_template(parent: nil, deidentify_template: nil, template_id: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::DeidentifyTemplate

    Pass arguments to create_deidentify_template via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id or projects/my-project-id/locations/{location_id}.

    • deidentify_template (::Google::Cloud::Dlp::V2::DeidentifyTemplate, ::Hash) (defaults to: nil) —

      Required. The DeidentifyTemplate to create.

    • template_id (::String) (defaults to: nil) —

      The template id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: [a-zA-Z\\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.

    • location_id (::String) (defaults to: nil) —

      Deprecated. This field has no effect.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 1223

def create_deidentify_template request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::CreateDeidentifyTemplateRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_deidentify_template.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_deidentify_template.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_deidentify_template.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :create_deidentify_template, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_dlp_job(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DlpJob #create_dlp_job(parent: nil, inspect_job: nil, risk_job: nil, job_id: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::DlpJob

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.

Overloads:

  • #create_dlp_job(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DlpJob

    Pass arguments to create_dlp_job via a request object, either of type CreateDlpJobRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::CreateDlpJobRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_dlp_job(parent: nil, inspect_job: nil, risk_job: nil, job_id: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::DlpJob

    Pass arguments to create_dlp_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent resource name, for example projects/my-project-id or projects/my-project-id/locations/{location_id}.

    • inspect_job (::Google::Cloud::Dlp::V2::InspectJobConfig, ::Hash) (defaults to: nil) —

      Set to control what and how to inspect.

    • risk_job (::Google::Cloud::Dlp::V2::RiskAnalysisJobConfig, ::Hash) (defaults to: nil) —

      Set to choose what metric to calculate.

    • job_id (::String) (defaults to: nil) —

      The job id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: [a-zA-Z\\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.

    • location_id (::String) (defaults to: nil) —

      Deprecated. This field has no effect.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 2161

def create_dlp_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::CreateDlpJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_dlp_job.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_dlp_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_dlp_job.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :create_dlp_job, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_inspect_template(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::InspectTemplate #create_inspect_template(parent: nil, inspect_template: nil, template_id: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::InspectTemplate

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.

Overloads:

  • #create_inspect_template(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::InspectTemplate

    Pass arguments to create_inspect_template via a request object, either of type CreateInspectTemplateRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::CreateInspectTemplateRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_inspect_template(parent: nil, inspect_template: nil, template_id: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::InspectTemplate

    Pass arguments to create_inspect_template via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id or projects/my-project-id/locations/{location-id}.

    • inspect_template (::Google::Cloud::Dlp::V2::InspectTemplate, ::Hash) (defaults to: nil) —

      Required. The InspectTemplate to create.

    • template_id (::String) (defaults to: nil) —

      The template id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: [a-zA-Z\\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.

    • location_id (::String) (defaults to: nil) —

      Deprecated. This field has no effect.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 842

def create_inspect_template request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::CreateInspectTemplateRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_inspect_template.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_inspect_template.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_inspect_template.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :create_inspect_template, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_job_trigger(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::JobTrigger #create_job_trigger(parent: nil, job_trigger: nil, trigger_id: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::JobTrigger

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.

Overloads:

  • #create_job_trigger(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::JobTrigger

    Pass arguments to create_job_trigger via a request object, either of type CreateJobTriggerRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::CreateJobTriggerRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_job_trigger(parent: nil, job_trigger: nil, trigger_id: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::JobTrigger

    Pass arguments to create_job_trigger via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent resource name, for example projects/my-project-id or projects/my-project-id/locations/{location_id}.

    • job_trigger (::Google::Cloud::Dlp::V2::JobTrigger, ::Hash) (defaults to: nil) —

      Required. The JobTrigger to create.

    • trigger_id (::String) (defaults to: nil) —

      The trigger id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: [a-zA-Z\\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.

    • location_id (::String) (defaults to: nil) —

      Deprecated. This field has no effect.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 1609

def create_job_trigger request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::CreateJobTriggerRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_job_trigger.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_job_trigger.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_job_trigger.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :create_job_trigger, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_stored_info_type(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::StoredInfoType #create_stored_info_type(parent: nil, config: nil, stored_info_type_id: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::StoredInfoType

Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.

Overloads:

  • #create_stored_info_type(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::StoredInfoType

    Pass arguments to create_stored_info_type via a request object, either of type CreateStoredInfoTypeRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::CreateStoredInfoTypeRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_stored_info_type(parent: nil, config: nil, stored_info_type_id: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::StoredInfoType

    Pass arguments to create_stored_info_type via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id or projects/my-project-id/locations/{location_id}

    • config (::Google::Cloud::Dlp::V2::StoredInfoTypeConfig, ::Hash) (defaults to: nil) —

      Required. Configuration of the storedInfoType to create.

    • stored_info_type_id (::String) (defaults to: nil) —

      The storedInfoType ID can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: [a-zA-Z\\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.

    • location_id (::String) (defaults to: nil) —

      Deprecated. This field has no effect.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 2568

def create_stored_info_type request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::CreateStoredInfoTypeRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_stored_info_type.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_stored_info_type.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_stored_info_type.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :create_stored_info_type, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#deidentify_content(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DeidentifyContentResponse #deidentify_content(parent: nil, deidentify_config: nil, inspect_config: nil, item: nil, inspect_template_name: nil, deidentify_template_name: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::DeidentifyContentResponse

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.

Overloads:

  • #deidentify_content(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DeidentifyContentResponse

    Pass arguments to deidentify_content via a request object, either of type Google::Cloud::Dlp::V2::DeidentifyContentRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::DeidentifyContentRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #deidentify_content(parent: nil, deidentify_config: nil, inspect_config: nil, item: nil, inspect_template_name: nil, deidentify_template_name: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::DeidentifyContentResponse

    Pass arguments to deidentify_content via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      The parent resource name, for example projects/my-project-id or projects/my-project-id/locations/{location_id}.

    • deidentify_config (::Google::Cloud::Dlp::V2::DeidentifyConfig, ::Hash) (defaults to: nil) —

      Configuration for the de-identification of the content item. Items specified here will override the template referenced by the deidentify_template_name argument.

    • inspect_config (::Google::Cloud::Dlp::V2::InspectConfig, ::Hash) (defaults to: nil) —

      Configuration for the inspector. Items specified here will override the template referenced by the inspect_template_name argument.

    • item (::Google::Cloud::Dlp::V2::ContentItem, ::Hash) (defaults to: nil) —

      The item to de-identify. Will be treated as text.

    • inspect_template_name (::String) (defaults to: nil) —

      Template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

    • deidentify_template_name (::String) (defaults to: nil) —

      Template to use. Any configuration directly specified in deidentify_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

    • location_id (::String) (defaults to: nil) —

      Deprecated. This field has no effect.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 594

def deidentify_content request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::DeidentifyContentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.deidentify_content.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.deidentify_content.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.deidentify_content.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :deidentify_content, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_deidentify_template(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_deidentify_template(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

Overloads:

  • #delete_deidentify_template(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_deidentify_template via a request object, either of type Google::Cloud::Dlp::V2::DeleteDeidentifyTemplateRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::DeleteDeidentifyTemplateRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_deidentify_template(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_deidentify_template via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Resource name of the organization and deidentify template to be deleted, for example organizations/433245324/deidentifyTemplates/432452342 or projects/project-id/deidentifyTemplates/432452342.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 1531

def delete_deidentify_template request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::DeleteDeidentifyTemplateRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_deidentify_template.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_deidentify_template.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_deidentify_template.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :delete_deidentify_template, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_dlp_job(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_dlp_job(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be cancelled if possible. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

Overloads:

  • #delete_dlp_job(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_dlp_job via a request object, either of type Google::Cloud::Dlp::V2::DeleteDlpJobRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::DeleteDlpJobRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_dlp_job(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_dlp_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the DlpJob resource to be deleted.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 2420

def delete_dlp_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::DeleteDlpJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_dlp_job.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_dlp_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_dlp_job.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :delete_dlp_job, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_inspect_template(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_inspect_template(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.

Overloads:

  • #delete_inspect_template(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_inspect_template via a request object, either of type Google::Cloud::Dlp::V2::DeleteInspectTemplateRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::DeleteInspectTemplateRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_inspect_template(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_inspect_template via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Resource name of the organization and inspectTemplate to be deleted, for example organizations/433245324/inspectTemplates/432452342 or projects/project-id/inspectTemplates/432452342.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 1144

def delete_inspect_template request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::DeleteInspectTemplateRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_inspect_template.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_inspect_template.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_inspect_template.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :delete_inspect_template, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_job_trigger(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_job_trigger(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

Overloads:

  • #delete_job_trigger(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_job_trigger via a request object, either of type Google::Cloud::Dlp::V2::DeleteJobTriggerRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::DeleteJobTriggerRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_job_trigger(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_job_trigger via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Resource name of the project and the triggeredJob, for example projects/dlp-test-project/jobTriggers/53234423.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 2009

def delete_job_trigger request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::DeleteJobTriggerRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_job_trigger.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_job_trigger.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_job_trigger.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :delete_job_trigger, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_stored_info_type(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_stored_info_type(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.

Overloads:

  • #delete_stored_info_type(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_stored_info_type via a request object, either of type Google::Cloud::Dlp::V2::DeleteStoredInfoTypeRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::DeleteStoredInfoTypeRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_stored_info_type(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_stored_info_type via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Resource name of the organization and storedInfoType to be deleted, for example organizations/433245324/storedInfoTypes/432452342 or projects/project-id/storedInfoTypes/432452342.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 2878

def delete_stored_info_type request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::DeleteStoredInfoTypeRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_stored_info_type.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_stored_info_type.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_stored_info_type.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :delete_stored_info_type, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#finish_dlp_job(request, options = nil) ⇒ ::Google::Protobuf::Empty #finish_dlp_job(name: nil) ⇒ ::Google::Protobuf::Empty

Finish a running hybrid DlpJob. Triggers the finalization steps and running of any enabled actions that have not yet run. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.

Overloads:

  • #finish_dlp_job(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to finish_dlp_job via a request object, either of type FinishDlpJobRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::FinishDlpJobRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #finish_dlp_job(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to finish_dlp_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the DlpJob resource to be cancelled.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 3022

def finish_dlp_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::FinishDlpJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.finish_dlp_job.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.finish_dlp_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.finish_dlp_job.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :finish_dlp_job, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_deidentify_template(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DeidentifyTemplate #get_deidentify_template(name: nil) ⇒ ::Google::Cloud::Dlp::V2::DeidentifyTemplate

Gets a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

Overloads:

  • #get_deidentify_template(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DeidentifyTemplate

    Pass arguments to get_deidentify_template via a request object, either of type GetDeidentifyTemplateRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::GetDeidentifyTemplateRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_deidentify_template(name: nil) ⇒ ::Google::Cloud::Dlp::V2::DeidentifyTemplate

    Pass arguments to get_deidentify_template via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Resource name of the organization and deidentify template to be read, for example organizations/433245324/deidentifyTemplates/432452342 or projects/project-id/deidentifyTemplates/432452342.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 1368

def get_deidentify_template request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::GetDeidentifyTemplateRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_deidentify_template.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_deidentify_template.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_deidentify_template.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :get_deidentify_template, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_dlp_job(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DlpJob #get_dlp_job(name: nil) ⇒ ::Google::Cloud::Dlp::V2::DlpJob

Gets the latest state of a long-running DlpJob. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

Overloads:

  • #get_dlp_job(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DlpJob

    Pass arguments to get_dlp_job via a request object, either of type GetDlpJobRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::GetDlpJobRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_dlp_job(name: nil) ⇒ ::Google::Cloud::Dlp::V2::DlpJob

    Pass arguments to get_dlp_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the DlpJob resource.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 2350

def get_dlp_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::GetDlpJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_dlp_job.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_dlp_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_dlp_job.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :get_dlp_job, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_inspect_template(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::InspectTemplate #get_inspect_template(name: nil) ⇒ ::Google::Cloud::Dlp::V2::InspectTemplate

Gets an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.

Overloads:

  • #get_inspect_template(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::InspectTemplate

    Pass arguments to get_inspect_template via a request object, either of type GetInspectTemplateRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::GetInspectTemplateRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_inspect_template(name: nil) ⇒ ::Google::Cloud::Dlp::V2::InspectTemplate

    Pass arguments to get_inspect_template via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Resource name of the organization and inspectTemplate to be read, for example organizations/433245324/inspectTemplates/432452342 or projects/project-id/inspectTemplates/432452342.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 984

def get_inspect_template request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::GetInspectTemplateRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_inspect_template.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_inspect_template.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_inspect_template.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :get_inspect_template, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_job_trigger(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::JobTrigger #get_job_trigger(name: nil) ⇒ ::Google::Cloud::Dlp::V2::JobTrigger

Gets a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

Overloads:

  • #get_job_trigger(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::JobTrigger

    Pass arguments to get_job_trigger via a request object, either of type GetJobTriggerRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::GetJobTriggerRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_job_trigger(name: nil) ⇒ ::Google::Cloud::Dlp::V2::JobTrigger

    Pass arguments to get_job_trigger via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Resource name of the project and the triggeredJob, for example projects/dlp-test-project/jobTriggers/53234423.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 1823

def get_job_trigger request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::GetJobTriggerRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_job_trigger.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_job_trigger.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_job_trigger.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :get_job_trigger, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_stored_info_type(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::StoredInfoType #get_stored_info_type(name: nil) ⇒ ::Google::Cloud::Dlp::V2::StoredInfoType

Gets a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.

Overloads:

  • #get_stored_info_type(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::StoredInfoType

    Pass arguments to get_stored_info_type via a request object, either of type GetStoredInfoTypeRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::GetStoredInfoTypeRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_stored_info_type(name: nil) ⇒ ::Google::Cloud::Dlp::V2::StoredInfoType

    Pass arguments to get_stored_info_type via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Resource name of the organization and storedInfoType to be read, for example organizations/433245324/storedInfoTypes/432452342 or projects/project-id/storedInfoTypes/432452342.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 2715

def get_stored_info_type request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::GetStoredInfoTypeRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_stored_info_type.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_stored_info_type.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_stored_info_type.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :get_stored_info_type, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#hybrid_inspect_dlp_job(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::HybridInspectResponse #hybrid_inspect_dlp_job(name: nil, hybrid_item: nil) ⇒ ::Google::Cloud::Dlp::V2::HybridInspectResponse

Inspect hybrid content and store findings to a job. To review the findings inspect the job. Inspection will occur asynchronously. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.

Overloads:

  • #hybrid_inspect_dlp_job(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::HybridInspectResponse

    Pass arguments to hybrid_inspect_dlp_job via a request object, either of type HybridInspectDlpJobRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::HybridInspectDlpJobRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #hybrid_inspect_dlp_job(name: nil, hybrid_item: nil) ⇒ ::Google::Cloud::Dlp::V2::HybridInspectResponse

    Pass arguments to hybrid_inspect_dlp_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Resource name of the job to execute a hybrid inspect on, for example projects/dlp-test-project/dlpJob/53234423.

    • hybrid_item (::Google::Cloud::Dlp::V2::HybridContentItem, ::Hash) (defaults to: nil) —

      The item to inspect.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 2952

def hybrid_inspect_dlp_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::HybridInspectDlpJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.hybrid_inspect_dlp_job.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.hybrid_inspect_dlp_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.hybrid_inspect_dlp_job.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :hybrid_inspect_dlp_job, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#hybrid_inspect_job_trigger(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::HybridInspectResponse #hybrid_inspect_job_trigger(name: nil, hybrid_item: nil) ⇒ ::Google::Cloud::Dlp::V2::HybridInspectResponse

Inspect hybrid content and store findings to a trigger. The inspection will be processed asynchronously. To review the findings monitor the jobs within the trigger. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.

Overloads:

  • #hybrid_inspect_job_trigger(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::HybridInspectResponse

    Pass arguments to hybrid_inspect_job_trigger via a request object, either of type HybridInspectJobTriggerRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::HybridInspectJobTriggerRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #hybrid_inspect_job_trigger(name: nil, hybrid_item: nil) ⇒ ::Google::Cloud::Dlp::V2::HybridInspectResponse

    Pass arguments to hybrid_inspect_job_trigger via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Resource name of the trigger to execute a hybrid inspect on, for example projects/dlp-test-project/jobTriggers/53234423.

    • hybrid_item (::Google::Cloud::Dlp::V2::HybridContentItem, ::Hash) (defaults to: nil) —

      The item to inspect.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 1755

def hybrid_inspect_job_trigger request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::HybridInspectJobTriggerRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.hybrid_inspect_job_trigger.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.hybrid_inspect_job_trigger.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.hybrid_inspect_job_trigger.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :hybrid_inspect_job_trigger, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#inspect_content(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::InspectContentResponse #inspect_content(parent: nil, inspect_config: nil, item: nil, inspect_template_name: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::InspectContentResponse

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,

Overloads:

  • #inspect_content(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::InspectContentResponse

    Pass arguments to inspect_content via a request object, either of type InspectContentRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::InspectContentRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #inspect_content(parent: nil, inspect_config: nil, item: nil, inspect_template_name: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::InspectContentResponse

    Pass arguments to inspect_content via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      The parent resource name, for example projects/my-project-id or projects/my-project-id/locations/{location_id}

    • inspect_config (::Google::Cloud::Dlp::V2::InspectConfig, ::Hash) (defaults to: nil) —

      Configuration for the inspector. What specified here will override the template referenced by the inspect_template_name argument.

    • item (::Google::Cloud::Dlp::V2::ContentItem, ::Hash) (defaults to: nil) —

      The item to inspect.

    • inspect_template_name (::String) (defaults to: nil) —

      Template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

    • location_id (::String) (defaults to: nil) —

      Deprecated. This field has no effect.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 411

def inspect_content request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::InspectContentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.inspect_content.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.inspect_content.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.inspect_content.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :inspect_content, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_deidentify_templates(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::DeidentifyTemplate> #list_deidentify_templates(parent: nil, page_token: nil, page_size: nil, order_by: nil, location_id: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::DeidentifyTemplate>

Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

Overloads:

  • #list_deidentify_templates(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::DeidentifyTemplate>

    Pass arguments to list_deidentify_templates via a request object, either of type ListDeidentifyTemplatesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::ListDeidentifyTemplatesRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_deidentify_templates(parent: nil, page_token: nil, page_size: nil, order_by: nil, location_id: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::DeidentifyTemplate>

    Pass arguments to list_deidentify_templates via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id or projects/my-project-id/locations/{location_id}.

    • page_token (::String) (defaults to: nil) —

      Page token to continue retrieval. Comes from previous call to ListDeidentifyTemplates.

    • page_size (::Integer) (defaults to: nil) —

      Size of the page, can be limited by server. If zero server returns a page of max size 100.

    • order_by (::String) (defaults to: nil) —

      Comma separated list of 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 template was created.
      • update_time: corresponds to time the template was last updated.
      • name: corresponds to template's name.
      • display_name: corresponds to template's display name.
    • location_id (::String) (defaults to: nil) —

      Deprecated. This field has no effect.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 1459

def list_deidentify_templates request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::ListDeidentifyTemplatesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_deidentify_templates.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_deidentify_templates.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_deidentify_templates.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :list_deidentify_templates, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @dlp_service_stub, :list_deidentify_templates, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_dlp_jobs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::DlpJob> #list_dlp_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, type: nil, order_by: nil, location_id: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::DlpJob>

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.

Overloads:

  • #list_dlp_jobs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::DlpJob>

    Pass arguments to list_dlp_jobs via a request object, either of type ListDlpJobsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::ListDlpJobsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_dlp_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, type: nil, order_by: nil, location_id: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::DlpJob>

    Pass arguments to list_dlp_jobs via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent resource name, for example projects/my-project-id or projects/my-project-id/locations/{location_id}.

    • filter (::String) (defaults to: nil) —

      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.
        • 'end_time` - Corresponds to time the job finished.
        • 'start_time` - Corresponds to time the job finished.
      • Supported fields for risk analysis jobs:
        • state - RUNNING|CANCELED|FINISHED|FAILED
        • 'end_time` - Corresponds to time the job finished.
        • 'start_time` - Corresponds to time the job finished.
      • 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)
      • end_time > \"2017-12-12T00:00:00+00:00\"

      The length of this field should be no more than 500 characters.

    • page_size (::Integer) (defaults to: nil) —

      The standard list page size.

    • page_token (::String) (defaults to: nil) —

      The standard list page token.

    • type (::Google::Cloud::Dlp::V2::DlpJobType) (defaults to: nil) —

      The type of job. Defaults to DlpJobType.INSPECT

    • order_by (::String) (defaults to: nil) —

      Comma separated list of 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, end_time asc, create_time desc

      Supported fields are:

      • create_time: corresponds to time the job was created.
      • end_time: corresponds to time the job ended.
      • name: corresponds to job's name.
      • state: corresponds to state
    • location_id (::String) (defaults to: nil) —

      Deprecated. This field has no effect.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 2281

def list_dlp_jobs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::ListDlpJobsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_dlp_jobs.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_dlp_jobs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_dlp_jobs.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :list_dlp_jobs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @dlp_service_stub, :list_dlp_jobs, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_info_types(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::ListInfoTypesResponse #list_info_types(parent: nil, language_code: nil, filter: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::ListInfoTypesResponse

Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/dlp/docs/infotypes-reference to learn more.

Overloads:

  • #list_info_types(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::ListInfoTypesResponse

    Pass arguments to list_info_types via a request object, either of type ListInfoTypesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::ListInfoTypesRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_info_types(parent: nil, language_code: nil, filter: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::ListInfoTypesResponse

    Pass arguments to list_info_types via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      The parent resource name, for example locations/{location_id}

    • language_code (::String) (defaults to: nil) —

      BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned.

    • filter (::String) (defaults to: nil) —

      filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT.

    • location_id (::String) (defaults to: nil) —

      Deprecated. This field has no effect.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 770

def list_info_types request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::ListInfoTypesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_info_types.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_info_types.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_info_types.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :list_info_types, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_inspect_templates(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::InspectTemplate> #list_inspect_templates(parent: nil, page_token: nil, page_size: nil, order_by: nil, location_id: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::InspectTemplate>

Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more.

Overloads:

  • #list_inspect_templates(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::InspectTemplate>

    Pass arguments to list_inspect_templates via a request object, either of type ListInspectTemplatesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::ListInspectTemplatesRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_inspect_templates(parent: nil, page_token: nil, page_size: nil, order_by: nil, location_id: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::InspectTemplate>

    Pass arguments to list_inspect_templates via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id or projects/my-project-id/locations/{location_id}.

    • page_token (::String) (defaults to: nil) —

      Page token to continue retrieval. Comes from previous call to ListInspectTemplates.

    • page_size (::Integer) (defaults to: nil) —

      Size of the page, can be limited by server. If zero server returns a page of max size 100.

    • order_by (::String) (defaults to: nil) —

      Comma separated list of 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 template was created.
      • update_time: corresponds to time the template was last updated.
      • name: corresponds to template's name.
      • display_name: corresponds to template's display name.
    • location_id (::String) (defaults to: nil) —

      Deprecated. This field has no effect.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 1074

def list_inspect_templates request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::ListInspectTemplatesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_inspect_templates.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_inspect_templates.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_inspect_templates.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :list_inspect_templates, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @dlp_service_stub, :list_inspect_templates, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_job_triggers(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::JobTrigger> #list_job_triggers(parent: nil, page_token: nil, page_size: nil, order_by: nil, filter: nil, location_id: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::JobTrigger>

Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

Overloads:

  • #list_job_triggers(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::JobTrigger>

    Pass arguments to list_job_triggers via a request object, either of type ListJobTriggersRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::ListJobTriggersRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_job_triggers(parent: nil, page_token: nil, page_size: nil, order_by: nil, filter: nil, location_id: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::JobTrigger>

    Pass arguments to list_job_triggers via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent resource name, for example projects/my-project-id or projects/my-project-id/locations/{location_id}.

    • page_token (::String) (defaults to: nil) —

      Page token to continue retrieval. Comes from previous call to ListJobTriggers. order_by field must not change for subsequent calls.

    • page_size (::Integer) (defaults to: nil) —

      Size of the page, can be limited by a server.

    • order_by (::String) (defaults to: nil) —

      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 JobTrigger was created.
      • update_time: corresponds to time the JobTrigger was last updated.
      • last_run_time: corresponds to the last time the JobTrigger ran.
      • name: corresponds to JobTrigger's name.
      • display_name: corresponds to JobTrigger's display name.
      • status: corresponds to JobTrigger's status.
    • filter (::String) (defaults to: nil) —

      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:
        • status - HEALTHY|PAUSED|CANCELLED
        • inspected_storage - DATASTORE|CLOUD_STORAGE|BIGQUERY
        • 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored.
        • 'error_count' - Number of errors that have occurred while running.
      • The operator must be = or != for status and inspected_storage.

      Examples:

      • inspected_storage = cloud_storage AND status = HEALTHY
      • inspected_storage = cloud_storage OR inspected_storage = bigquery
      • inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY)
      • last_run_time > \"2017-12-12T00:00:00+00:00\"

      The length of this field should be no more than 500 characters.

    • location_id (::String) (defaults to: nil) —

      Deprecated. This field has no effect.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 1940

def list_job_triggers request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::ListJobTriggersRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_job_triggers.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_job_triggers.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_job_triggers.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :list_job_triggers, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @dlp_service_stub, :list_job_triggers, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_stored_info_types(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::StoredInfoType> #list_stored_info_types(parent: nil, page_token: nil, page_size: nil, order_by: nil, location_id: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::StoredInfoType>

Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.

Overloads:

  • #list_stored_info_types(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::StoredInfoType>

    Pass arguments to list_stored_info_types via a request object, either of type ListStoredInfoTypesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::ListStoredInfoTypesRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_stored_info_types(parent: nil, page_token: nil, page_size: nil, order_by: nil, location_id: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::StoredInfoType>

    Pass arguments to list_stored_info_types via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent resource name, for example projects/my-project-id or organizations/my-org-id or projects/my-project-id/locations/{location_id}.

    • page_token (::String) (defaults to: nil) —

      Page token to continue retrieval. Comes from previous call to ListStoredInfoTypes.

    • page_size (::Integer) (defaults to: nil) —

      Size of the page, can be limited by server. If zero server returns a page of max size 100.

    • order_by (::String) (defaults to: nil) —

      Comma separated list of 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, display_name, create_time desc

      Supported fields are:

      • create_time: corresponds to time the most recent version of the resource was created.
      • state: corresponds to the state of the resource.
      • name: corresponds to resource name.
      • display_name: corresponds to info type's display name.
    • location_id (::String) (defaults to: nil) —

      Deprecated. This field has no effect.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 2807

def list_stored_info_types request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::ListStoredInfoTypesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_stored_info_types.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_stored_info_types.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_stored_info_types.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :list_stored_info_types, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @dlp_service_stub, :list_stored_info_types, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#redact_image(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::RedactImageResponse #redact_image(parent: nil, location_id: nil, inspect_config: nil, image_redaction_configs: nil, include_findings: nil, byte_item: nil) ⇒ ::Google::Cloud::Dlp::V2::RedactImageResponse

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.

Overloads:

  • #redact_image(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::RedactImageResponse

    Pass arguments to redact_image via a request object, either of type RedactImageRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::RedactImageRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #redact_image(parent: nil, location_id: nil, inspect_config: nil, image_redaction_configs: nil, include_findings: nil, byte_item: nil) ⇒ ::Google::Cloud::Dlp::V2::RedactImageResponse

    Pass arguments to redact_image via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      The parent resource name, for example projects/my-project-id or projects/my-project-id/locations/{location_id}.

    • location_id (::String) (defaults to: nil) —

      Deprecated. This field has no effect.

    • inspect_config (::Google::Cloud::Dlp::V2::InspectConfig, ::Hash) (defaults to: nil) —

      Configuration for the inspector.

    • image_redaction_configs (::Array<::Google::Cloud::Dlp::V2::RedactImageRequest::ImageRedactionConfig, ::Hash>) (defaults to: nil) —

      The configuration for specifying what content to redact from images.

    • include_findings (::Boolean) (defaults to: nil) —

      Whether the response should include findings along with the redacted image.

    • byte_item (::Google::Cloud::Dlp::V2::ByteContentItem, ::Hash) (defaults to: nil) —

      The content must be PNG, JPEG, SVG or BMP.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 496

def redact_image request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::RedactImageRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.redact_image.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.redact_image.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.redact_image.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :redact_image, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#reidentify_content(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::ReidentifyContentResponse #reidentify_content(parent: nil, reidentify_config: nil, inspect_config: nil, item: nil, inspect_template_name: nil, reidentify_template_name: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::ReidentifyContentResponse

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.

Overloads:

  • #reidentify_content(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::ReidentifyContentResponse

    Pass arguments to reidentify_content via a request object, either of type ReidentifyContentRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::ReidentifyContentRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #reidentify_content(parent: nil, reidentify_config: nil, inspect_config: nil, item: nil, inspect_template_name: nil, reidentify_template_name: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::ReidentifyContentResponse

    Pass arguments to reidentify_content via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent resource name.

    • reidentify_config (::Google::Cloud::Dlp::V2::DeidentifyConfig, ::Hash) (defaults to: nil) —

      Configuration for the re-identification of the content item. This field shares the same proto message type that is used for de-identification, however its usage here is for the reversal of the previous de-identification. Re-identification is performed by examining the transformations used to de-identify the items and executing the reverse. This requires that only reversible transformations be provided here. The reversible transformations are:

      • CryptoDeterministicConfig
      • CryptoReplaceFfxFpeConfig
    • inspect_config (::Google::Cloud::Dlp::V2::InspectConfig, ::Hash) (defaults to: nil) —

      Configuration for the inspector.

    • item (::Google::Cloud::Dlp::V2::ContentItem, ::Hash) (defaults to: nil) —

      The item to re-identify. Will be treated as text.

    • inspect_template_name (::String) (defaults to: nil) —

      Template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

    • reidentify_template_name (::String) (defaults to: nil) —

      Template to use. References an instance of DeidentifyTemplate. Any configuration directly specified in reidentify_config or inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

    • location_id (::String) (defaults to: nil) —

      Deprecated. This field has no effect.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 693

def reidentify_content request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::ReidentifyContentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.reidentify_content.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.reidentify_content.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.reidentify_content.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :reidentify_content, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_deidentify_template(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DeidentifyTemplate #update_deidentify_template(name: nil, deidentify_template: nil, update_mask: nil) ⇒ ::Google::Cloud::Dlp::V2::DeidentifyTemplate

Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

Overloads:

  • #update_deidentify_template(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DeidentifyTemplate

    Pass arguments to update_deidentify_template via a request object, either of type UpdateDeidentifyTemplateRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::UpdateDeidentifyTemplateRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_deidentify_template(name: nil, deidentify_template: nil, update_mask: nil) ⇒ ::Google::Cloud::Dlp::V2::DeidentifyTemplate

    Pass arguments to update_deidentify_template via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Resource name of organization and deidentify template to be updated, for example organizations/433245324/deidentifyTemplates/432452342 or projects/project-id/deidentifyTemplates/432452342.

    • deidentify_template (::Google::Cloud::Dlp::V2::DeidentifyTemplate, ::Hash) (defaults to: nil) —

      New DeidentifyTemplate value.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Mask to control which fields get updated.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 1298

def update_deidentify_template request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::UpdateDeidentifyTemplateRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_deidentify_template.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_deidentify_template.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_deidentify_template.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :update_deidentify_template, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_inspect_template(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::InspectTemplate #update_inspect_template(name: nil, inspect_template: nil, update_mask: nil) ⇒ ::Google::Cloud::Dlp::V2::InspectTemplate

Updates the InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.

Overloads:

  • #update_inspect_template(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::InspectTemplate

    Pass arguments to update_inspect_template via a request object, either of type UpdateInspectTemplateRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::UpdateInspectTemplateRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_inspect_template(name: nil, inspect_template: nil, update_mask: nil) ⇒ ::Google::Cloud::Dlp::V2::InspectTemplate

    Pass arguments to update_inspect_template via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Resource name of organization and inspectTemplate to be updated, for example organizations/433245324/inspectTemplates/432452342 or projects/project-id/inspectTemplates/432452342.

    • inspect_template (::Google::Cloud::Dlp::V2::InspectTemplate, ::Hash) (defaults to: nil) —

      New InspectTemplate value.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Mask to control which fields get updated.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 915

def update_inspect_template request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::UpdateInspectTemplateRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_inspect_template.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_inspect_template.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_inspect_template.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :update_inspect_template, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_job_trigger(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::JobTrigger #update_job_trigger(name: nil, job_trigger: nil, update_mask: nil) ⇒ ::Google::Cloud::Dlp::V2::JobTrigger

Updates a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

Overloads:

  • #update_job_trigger(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::JobTrigger

    Pass arguments to update_job_trigger via a request object, either of type UpdateJobTriggerRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::UpdateJobTriggerRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_job_trigger(name: nil, job_trigger: nil, update_mask: nil) ⇒ ::Google::Cloud::Dlp::V2::JobTrigger

    Pass arguments to update_job_trigger via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Resource name of the project and the triggeredJob, for example projects/dlp-test-project/jobTriggers/53234423.

    • job_trigger (::Google::Cloud::Dlp::V2::JobTrigger, ::Hash) (defaults to: nil) —

      New JobTrigger value.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Mask to control which fields get updated.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 1681

def update_job_trigger request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::UpdateJobTriggerRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_job_trigger.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_job_trigger.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_job_trigger.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :update_job_trigger, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_stored_info_type(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::StoredInfoType #update_stored_info_type(name: nil, config: nil, update_mask: nil) ⇒ ::Google::Cloud::Dlp::V2::StoredInfoType

Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.

Overloads:

  • #update_stored_info_type(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::StoredInfoType

    Pass arguments to update_stored_info_type via a request object, either of type UpdateStoredInfoTypeRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dlp::V2::UpdateStoredInfoTypeRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_stored_info_type(name: nil, config: nil, update_mask: nil) ⇒ ::Google::Cloud::Dlp::V2::StoredInfoType

    Pass arguments to update_stored_info_type via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Resource name of organization and storedInfoType to be updated, for example organizations/433245324/storedInfoTypes/432452342 or projects/project-id/storedInfoTypes/432452342.

    • config (::Google::Cloud::Dlp::V2::StoredInfoTypeConfig, ::Hash) (defaults to: nil) —

      Updated configuration for the storedInfoType. If not provided, a new version of the storedInfoType will be created with the existing configuration.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Mask to control which fields get updated.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
 
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 2645

def update_stored_info_type request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::UpdateStoredInfoTypeRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_stored_info_type.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dlp::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_stored_info_type.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_stored_info_type.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.call_rpc :update_stored_info_type, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end