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

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

Overview

REST 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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#deidentify_template_path, #discovery_config_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 REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Dlp::V2::DlpService::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the DlpService client.

Yield Parameters:



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 279

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

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

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end

  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @dlp_service_stub = ::Google::Cloud::Dlp::V2::DlpService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials
  )

  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @dlp_service_stub.endpoint
    config.universe_domain = @dlp_service_stub.universe_domain
  end
end

Instance Attribute Details

#location_client ⇒ Google::Cloud::Location::Locations::Rest::Client (readonly)

Get the associated client for mix-in of the Locations.

Returns:

  • (Google::Cloud::Location::Locations::Rest::Client) 


322
323
324
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 322

def location_client
  @location_client
end

Class Method Details

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

Configure the DlpService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all DlpService clients
::Google::Cloud::Dlp::V2::DlpService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 70

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: [14, 4]
    }

    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: [14, 4]
    }

    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: [14, 4]
    }

    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: [14, 4]
    }

    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: [14, 4]
    }

    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: [14, 4]
    }

    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: [14, 4]
    }

    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: [14, 4]
    }

    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: [14, 4]
    }

    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: [14, 4]
    }

    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: [14, 4]
    }

    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.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: [14, 4]
    }

    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: [14, 4]
    }

    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: [14, 4]
    }

    default_config.rpcs.activate_job_trigger.timeout = 300.0

    default_config.rpcs.create_discovery_config.timeout = 300.0

    default_config.rpcs.update_discovery_config.timeout = 300.0

    default_config.rpcs.get_discovery_config.timeout = 300.0
    default_config.rpcs.get_discovery_config.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.list_discovery_configs.timeout = 300.0
    default_config.rpcs.list_discovery_configs.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.delete_discovery_config.timeout = 300.0
    default_config.rpcs.delete_discovery_config.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    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: [14, 4]
    }

    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: [14, 4]
    }

    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: [14, 4]
    }

    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: [14, 4]
    }

    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: [14, 4]
    }

    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: [14, 4]
    }

    default_config.rpcs.hybrid_inspect_dlp_job.timeout = 300.0

    default_config.rpcs.finish_dlp_job.timeout = 300.0

    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.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::ActivateJobTriggerRequest.new

# Call the activate_job_trigger method.
result = client.activate_job_trigger request

# The returned object is of type Google::Cloud::Dlp::V2::DlpJob.
p result

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
2526
2527
2528
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 2495

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
  call_metadata = @config.rpcs.activate_job_trigger.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @dlp_service_stub.activate_job_trigger request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::CancelDlpJobRequest.new

# Call the cancel_dlp_job method.
result = client.cancel_dlp_job request

# The returned object is of type Google::Protobuf::Empty.
p result

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 3447

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
  call_metadata = @config.rpcs.cancel_dlp_job.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @dlp_service_stub.cancel_dlp_job request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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:



249
250
251
252
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 249

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 reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::CreateDeidentifyTemplateRequest.new

# Call the create_deidentify_template method.
result = client.create_deidentify_template request

# The returned object is of type Google::Cloud::Dlp::V2::DeidentifyTemplate.
p result

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. Parent resource name.

      The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

      • Projects scope, location specified:
        projects/PROJECT_ID/locations/LOCATION_ID
      • Projects scope, no location specified (defaults to global):
        projects/PROJECT_ID
      • Organizations scope, location specified:
        organizations/ORG_ID/locations/LOCATION_ID
      • Organizations scope, no location specified (defaults to global):
        organizations/ORG_ID

      The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

      parent=projects/example-project/locations/europe-west3
    • 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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1456
1457
1458
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
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 1456

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
  call_metadata = @config.rpcs.create_deidentify_template.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

#create_discovery_config(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DiscoveryConfig #create_discovery_config(parent: nil, discovery_config: nil, config_id: nil) ⇒ ::Google::Cloud::Dlp::V2::DiscoveryConfig

Creates a config for discovery to scan and profile storage.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::CreateDiscoveryConfigRequest.new

# Call the create_discovery_config method.
result = client.create_discovery_config request

# The returned object is of type Google::Cloud::Dlp::V2::DiscoveryConfig.
p result

Overloads:

  • #create_discovery_config(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DiscoveryConfig

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

    Parameters:

    • request (::Google::Cloud::Dlp::V2::CreateDiscoveryConfigRequest, ::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_discovery_config(parent: nil, discovery_config: nil, config_id: nil) ⇒ ::Google::Cloud::Dlp::V2::DiscoveryConfig

    Pass arguments to create_discovery_config 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. Parent resource name.

      The format of this value is as follows: projects/PROJECT_ID/locations/LOCATION_ID

      The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

      parent=projects/example-project/locations/europe-west3
    • discovery_config (::Google::Cloud::Dlp::V2::DiscoveryConfig, ::Hash) (defaults to: nil) —

      Required. The DiscoveryConfig to create.

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

      The config 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.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 2589

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

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

  # 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
  call_metadata = @config.rpcs.create_discovery_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_discovery_config.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_discovery_config.retry_policy

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

  @dlp_service_stub.create_discovery_config request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::CreateDlpJobRequest.new

# Call the create_dlp_job method.
result = client.create_dlp_job request

# The returned object is of type Google::Cloud::Dlp::V2::DlpJob.
p result

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. Parent resource name.

      The format of this value varies depending on whether you have specified a processing location:

      • Projects scope, location specified:
        projects/PROJECT_ID/locations/LOCATION_ID
      • Projects scope, no location specified (defaults to global):
        projects/PROJECT_ID

      The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

      parent=projects/example-project/locations/europe-west3
    • inspect_job (::Google::Cloud::Dlp::V2::InspectJobConfig, ::Hash) (defaults to: nil) —

      An inspection job scans a storage repository for InfoTypes.

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

      A risk analysis job calculates re-identification risk metrics for a BigQuery table.

    • 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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 3052

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
  call_metadata = @config.rpcs.create_dlp_job.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @dlp_service_stub.create_dlp_job request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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 reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::CreateInspectTemplateRequest.new

# Call the create_inspect_template method.
result = client.create_inspect_template request

# The returned object is of type Google::Cloud::Dlp::V2::InspectTemplate.
p result

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. Parent resource name.

      The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

      • Projects scope, location specified:
        projects/PROJECT_ID/locations/LOCATION_ID
      • Projects scope, no location specified (defaults to global):
        projects/PROJECT_ID
      • Organizations scope, location specified:
        organizations/ORG_ID/locations/LOCATION_ID
      • Organizations scope, no location specified (defaults to global):
        organizations/ORG_ID

      The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

      parent=projects/example-project/locations/europe-west3
    • 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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



975
976
977
978
979
980
981
982
983
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
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 975

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
  call_metadata = @config.rpcs.create_inspect_template.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @dlp_service_stub.create_inspect_template request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::CreateJobTriggerRequest.new

# Call the create_job_trigger method.
result = client.create_job_trigger request

# The returned object is of type Google::Cloud::Dlp::V2::JobTrigger.
p result

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. Parent resource name.

      The format of this value varies depending on whether you have specified a processing location:

      • Projects scope, location specified:
        projects/PROJECT_ID/locations/LOCATION_ID
      • Projects scope, no location specified (defaults to global):
        projects/PROJECT_ID

      The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

      parent=projects/example-project/locations/europe-west3
    • 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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1938
1939
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
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 1938

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
  call_metadata = @config.rpcs.create_job_trigger.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @dlp_service_stub.create_job_trigger request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::CreateStoredInfoTypeRequest.new

# Call the create_stored_info_type method.
result = client.create_stored_info_type request

# The returned object is of type Google::Cloud::Dlp::V2::StoredInfoType.
p result

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. Parent resource name.

      The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

      • Projects scope, location specified:
        projects/PROJECT_ID/locations/LOCATION_ID
      • Projects scope, no location specified (defaults to global):
        projects/PROJECT_ID
      • Organizations scope, location specified:
        organizations/ORG_ID/locations/LOCATION_ID
      • Organizations scope, no location specified (defaults to global):
        organizations/ORG_ID

      The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

      parent=projects/example-project/locations/europe-west3
    • 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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 3555

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
  call_metadata = @config.rpcs.create_stored_info_type.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @dlp_service_stub.create_stored_info_type request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::DeidentifyContentRequest.new

# Call the deidentify_content method.
result = client.deidentify_content request

# The returned object is of type Google::Cloud::Dlp::V2::DeidentifyContentResponse.
p result

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) —

      Parent resource name.

      The format of this value varies depending on whether you have specified a processing location:

      • Projects scope, location specified:
        projects/PROJECT_ID/locations/LOCATION_ID
      • Projects scope, no location specified (defaults to global):
        projects/PROJECT_ID

      The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

      parent=projects/example-project/locations/europe-west3
    • 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.

      This value must be of type Table if your deidentify_config is a RecordTransformations object.

    • 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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 647

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
  call_metadata = @config.rpcs.deidentify_content.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @dlp_service_stub.deidentify_content request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::DeleteDeidentifyTemplateRequest.new

# Call the delete_deidentify_template method.
result = client.delete_deidentify_template request

# The returned object is of type Google::Protobuf::Empty.
p result

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
1859
1860
1861
1862
1863
1864
1865
1866
1867
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 1834

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
  call_metadata = @config.rpcs.delete_deidentify_template.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

Deletes a discovery configuration.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::DeleteDiscoveryConfigRequest.new

# Call the delete_discovery_config method.
result = client.delete_discovery_config request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Dlp::V2::DeleteDiscoveryConfigRequest, ::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_discovery_config(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_discovery_config 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 config, for example projects/dlp-test-project/discoveryConfigs/53234423.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 2941

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

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

  # 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
  call_metadata = @config.rpcs.delete_discovery_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_discovery_config.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_discovery_config.retry_policy

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

  @dlp_service_stub.delete_discovery_config request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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 canceled if possible. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::DeleteDlpJobRequest.new

# Call the delete_dlp_job method.
result = client.delete_dlp_job request

# The returned object is of type Google::Protobuf::Empty.
p result

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 3365

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
  call_metadata = @config.rpcs.delete_dlp_job.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @dlp_service_stub.delete_dlp_job request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::DeleteInspectTemplateRequest.new

# Call the delete_inspect_template method.
result = client.delete_inspect_template request

# The returned object is of type Google::Protobuf::Empty.
p result

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 1347

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
  call_metadata = @config.rpcs.delete_inspect_template.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @dlp_service_stub.delete_inspect_template request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::DeleteJobTriggerRequest.new

# Call the delete_job_trigger method.
result = client.delete_job_trigger request

# The returned object is of type Google::Protobuf::Empty.
p result

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2415
2416
2417
2418
2419
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
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 2415

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
  call_metadata = @config.rpcs.delete_job_trigger.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @dlp_service_stub.delete_job_trigger request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::DeleteStoredInfoTypeRequest.new

# Call the delete_stored_info_type method.
result = client.delete_stored_info_type request

# The returned object is of type Google::Protobuf::Empty.
p result

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 3931

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
  call_metadata = @config.rpcs.delete_stored_info_type.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @dlp_service_stub.delete_stored_info_type request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::FinishDlpJobRequest.new

# Call the finish_dlp_job method.
result = client.finish_dlp_job request

# The returned object is of type Google::Protobuf::Empty.
p result

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 4093

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
  call_metadata = @config.rpcs.finish_dlp_job.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @dlp_service_stub.finish_dlp_job request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::GetDeidentifyTemplateRequest.new

# Call the get_deidentify_template method.
result = client.get_deidentify_template request

# The returned object is of type Google::Cloud::Dlp::V2::DeidentifyTemplate.
p result

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 1625

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
  call_metadata = @config.rpcs.get_deidentify_template.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

#get_discovery_config(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DiscoveryConfig #get_discovery_config(name: nil) ⇒ ::Google::Cloud::Dlp::V2::DiscoveryConfig

Gets a discovery configuration.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::GetDiscoveryConfigRequest.new

# Call the get_discovery_config method.
result = client.get_discovery_config request

# The returned object is of type Google::Cloud::Dlp::V2::DiscoveryConfig.
p result

Overloads:

  • #get_discovery_config(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DiscoveryConfig

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

    Parameters:

    • request (::Google::Cloud::Dlp::V2::GetDiscoveryConfigRequest, ::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_discovery_config(name: nil) ⇒ ::Google::Cloud::Dlp::V2::DiscoveryConfig

    Pass arguments to get_discovery_config 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 configuration, for example projects/dlp-test-project/discoveryConfigs/53234423.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 2751

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

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

  # 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
  call_metadata = @config.rpcs.get_discovery_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_discovery_config.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_discovery_config.retry_policy

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

  @dlp_service_stub.get_discovery_config request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::GetDlpJobRequest.new

# Call the get_dlp_job method.
result = client.get_dlp_job request

# The returned object is of type Google::Cloud::Dlp::V2::DlpJob.
p result

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 3283

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
  call_metadata = @config.rpcs.get_dlp_job.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @dlp_service_stub.get_dlp_job request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::GetInspectTemplateRequest.new

# Call the get_inspect_template method.
result = client.get_inspect_template request

# The returned object is of type Google::Cloud::Dlp::V2::InspectTemplate.
p result

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1141
1142
1143
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
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 1141

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
  call_metadata = @config.rpcs.get_inspect_template.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @dlp_service_stub.get_inspect_template request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::GetJobTriggerRequest.new

# Call the get_job_trigger method.
result = client.get_job_trigger request

# The returned object is of type Google::Cloud::Dlp::V2::JobTrigger.
p result

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 2185

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
  call_metadata = @config.rpcs.get_job_trigger.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @dlp_service_stub.get_job_trigger request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::GetStoredInfoTypeRequest.new

# Call the get_stored_info_type method.
result = client.get_stored_info_type request

# The returned object is of type Google::Cloud::Dlp::V2::StoredInfoType.
p result

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 3726

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
  call_metadata = @config.rpcs.get_stored_info_type.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @dlp_service_stub.get_stored_info_type request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::HybridInspectDlpJobRequest.new

# Call the hybrid_inspect_dlp_job method.
result = client.hybrid_inspect_dlp_job request

# The returned object is of type Google::Cloud::Dlp::V2::HybridInspectResponse.
p result

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 4014

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
  call_metadata = @config.rpcs.hybrid_inspect_dlp_job.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @dlp_service_stub.hybrid_inspect_dlp_job request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::HybridInspectJobTriggerRequest.new

# Call the hybrid_inspect_job_trigger method.
result = client.hybrid_inspect_job_trigger request

# The returned object is of type Google::Cloud::Dlp::V2::HybridInspectResponse.
p result

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 2105

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
  call_metadata = @config.rpcs.hybrid_inspect_job_trigger.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @dlp_service_stub.hybrid_inspect_job_trigger request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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,

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::InspectContentRequest.new

# Call the inspect_content method.
result = client.inspect_content request

# The returned object is of type Google::Cloud::Dlp::V2::InspectContentResponse.
p result

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) —

      Parent resource name.

      The format of this value varies depending on whether you have specified a processing location:

      • Projects scope, location specified:
        projects/PROJECT_ID/locations/LOCATION_ID
      • Projects scope, no location specified (defaults to global):
        projects/PROJECT_ID

      The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

      parent=projects/example-project/locations/europe-west3
    • 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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



405
406
407
408
409
410
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
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 405

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
  call_metadata = @config.rpcs.inspect_content.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

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

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::ListDeidentifyTemplatesRequest.new

# Call the list_deidentify_templates method.
result = client.list_deidentify_templates request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dlp::V2::DeidentifyTemplate.
  p item
end

Overloads:

  • #list_deidentify_templates(request, options = nil) ⇒ ::Gapic::Rest::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::Rest::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. Parent resource name.

      The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

      • Projects scope, location specified:
        projects/PROJECT_ID/locations/LOCATION_ID
      • Projects scope, no location specified (defaults to global):
        projects/PROJECT_ID
      • Organizations scope, location specified:
        organizations/ORG_ID/locations/LOCATION_ID
      • Organizations scope, no location specified (defaults to global):
        organizations/ORG_ID

      The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

      parent=projects/example-project/locations/europe-west3
    • page_token (::String) (defaults to: nil) —

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

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

      Size of the page. This value can be limited by the 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. The 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 the time the template was created.
      • update_time: corresponds to the time the template was last updated.
      • name: corresponds to the template's name.
      • display_name: corresponds to the template's display name.
    • location_id (::String) (defaults to: nil) —

      Deprecated. This field has no effect.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1750
1751
1752
1753
1754
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
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 1750

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
  call_metadata = @config.rpcs.list_deidentify_templates.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @dlp_service_stub.list_deidentify_templates request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dlp_service_stub, :list_deidentify_templates, "deidentify_templates", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_discovery_configs(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DiscoveryConfig> #list_discovery_configs(parent: nil, page_token: nil, page_size: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DiscoveryConfig>

Lists discovery configurations.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::ListDiscoveryConfigsRequest.new

# Call the list_discovery_configs method.
result = client.list_discovery_configs request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dlp::V2::DiscoveryConfig.
  p item
end

Overloads:

  • #list_discovery_configs(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DiscoveryConfig>

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

    Parameters:

    • request (::Google::Cloud::Dlp::V2::ListDiscoveryConfigsRequest, ::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_discovery_configs(parent: nil, page_token: nil, page_size: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DiscoveryConfig>

    Pass arguments to list_discovery_configs 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. Parent resource name.

      The format of this value is as follows: projects/PROJECT_ID/locations/LOCATION_ID

      The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

      parent=projects/example-project/locations/europe-west3
    • page_token (::String) (defaults to: nil) —

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

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

      Size of the page. This value can be limited by a server.

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

      Comma separated list of config fields to order by, followed by asc or desc postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant.

      Example: name asc,update_time, create_time desc

      Supported fields are:

      • last_run_time: corresponds to the last time the DiscoveryConfig ran.
      • name: corresponds to the DiscoveryConfig's name.
      • status: corresponds to DiscoveryConfig's status.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 2861

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

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

  # 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
  call_metadata = @config.rpcs.list_discovery_configs.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_discovery_configs.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_discovery_configs.retry_policy

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

  @dlp_service_stub.list_discovery_configs request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dlp_service_stub, :list_discovery_configs, "discovery_configs", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_dlp_jobs(request, options = nil) ⇒ ::Gapic::Rest::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::Rest::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.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::ListDlpJobsRequest.new

# Call the list_dlp_jobs method.
result = client.list_dlp_jobs request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dlp::V2::DlpJob.
  p item
end

Overloads:

  • #list_dlp_jobs(request, options = nil) ⇒ ::Gapic::Rest::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::Rest::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. Parent resource name.

      The format of this value varies depending on whether you have specified a processing location:

      • Projects scope, location specified:
        projects/PROJECT_ID/locations/LOCATION_ID
      • Projects scope, no location specified (defaults to global):
        projects/PROJECT_ID

      The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

      parent=projects/example-project/locations/europe-west3
    • 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 name of the trigger that created the job.
        • 'end_time` - Corresponds to the time the job finished.
        • 'start_time` - Corresponds to the time the job finished.
      • Supported fields for risk analysis jobs:
        • state - RUNNING|CANCELED|FINISHED|FAILED
        • 'end_time` - Corresponds to the time the job finished.
        • 'start_time` - Corresponds to the 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. The 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 the time the job was created.
      • end_time: corresponds to the time the job ended.
      • name: corresponds to the job's name.
      • state: corresponds to state
    • location_id (::String) (defaults to: nil) —

      Deprecated. This field has no effect.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 3202

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
  call_metadata = @config.rpcs.list_dlp_jobs.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @dlp_service_stub.list_dlp_jobs request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dlp_service_stub, :list_dlp_jobs, "jobs", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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 DLP API supports. See https://cloud.google.com/dlp/docs/infotypes-reference to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::ListInfoTypesRequest.new

# Call the list_info_types method.
result = client.list_info_types request

# The returned object is of type Google::Cloud::Dlp::V2::ListInfoTypesResponse.
p result

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.

      The format of this value is as follows:

      locations/<var>LOCATION_ID</var>
    • 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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 867

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
  call_metadata = @config.rpcs.list_info_types.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

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

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::ListInspectTemplatesRequest.new

# Call the list_inspect_templates method.
result = client.list_inspect_templates request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dlp::V2::InspectTemplate.
  p item
end

Overloads:

  • #list_inspect_templates(request, options = nil) ⇒ ::Gapic::Rest::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::Rest::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. Parent resource name.

      The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

      • Projects scope, location specified:
        projects/PROJECT_ID/locations/LOCATION_ID
      • Projects scope, no location specified (defaults to global):
        projects/PROJECT_ID
      • Organizations scope, location specified:
        organizations/ORG_ID/locations/LOCATION_ID
      • Organizations scope, no location specified (defaults to global):
        organizations/ORG_ID

      The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

      parent=projects/example-project/locations/europe-west3
    • page_token (::String) (defaults to: nil) —

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

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

      Size of the page. This value can be limited by the 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. The 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 the time the template was created.
      • update_time: corresponds to the time the template was last updated.
      • name: corresponds to the template's name.
      • display_name: corresponds to the template's display name.
    • location_id (::String) (defaults to: nil) —

      Deprecated. This field has no effect.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 1265

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
  call_metadata = @config.rpcs.list_inspect_templates.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @dlp_service_stub.list_inspect_templates request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dlp_service_stub, :list_inspect_templates, "inspect_templates", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

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

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::ListJobTriggersRequest.new

# Call the list_job_triggers method.
result = client.list_job_triggers request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dlp::V2::JobTrigger.
  p item
end

Overloads:

  • #list_job_triggers(request, options = nil) ⇒ ::Gapic::Rest::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, type: nil, location_id: nil) ⇒ ::Gapic::Rest::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. Parent resource name.

      The format of this value varies depending on whether you have specified a processing location:

      • Projects scope, location specified:
        projects/PROJECT_ID/locations/LOCATION_ID
      • Projects scope, no location specified (defaults to global):
        projects/PROJECT_ID

      The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

      parent=projects/example-project/locations/europe-west3
    • page_token (::String) (defaults to: nil) —

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

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

      Size of the page. This value 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. The 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 the time the JobTrigger was created.
      • update_time: corresponds to the time the JobTrigger was last updated.
      • last_run_time: corresponds to the last time the JobTrigger ran.
      • name: corresponds to the JobTrigger's name.
      • display_name: corresponds to the 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 triggers:
        • 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.

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

      The type of jobs. Will use DlpJobType.INSPECT if not set.

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

      Deprecated. This field has no effect.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 2334

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
  call_metadata = @config.rpcs.list_job_triggers.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @dlp_service_stub.list_job_triggers request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dlp_service_stub, :list_job_triggers, "job_triggers", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_stored_info_types(request, options = nil) ⇒ ::Gapic::Rest::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::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::StoredInfoType>

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

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::ListStoredInfoTypesRequest.new

# Call the list_stored_info_types method.
result = client.list_stored_info_types request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dlp::V2::StoredInfoType.
  p item
end

Overloads:

  • #list_stored_info_types(request, options = nil) ⇒ ::Gapic::Rest::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::Rest::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. Parent resource name.

      The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:

      • Projects scope, location specified:
        projects/PROJECT_ID/locations/LOCATION_ID
      • Projects scope, no location specified (defaults to global):
        projects/PROJECT_ID

      The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

      parent=projects/example-project/locations/europe-west3
    • page_token (::String) (defaults to: nil) —

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

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

      Size of the page. This value can be limited by the 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. The 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 the 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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 3848

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
  call_metadata = @config.rpcs.list_stored_info_types.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @dlp_service_stub.list_stored_info_types request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dlp_service_stub, :list_stored_info_types, "stored_info_types", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::RedactImageRequest.new

# Call the redact_image method.
result = client.redact_image request

# The returned object is of type Google::Cloud::Dlp::V2::RedactImageResponse.
p result

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) —

      Parent resource name.

      The format of this value varies depending on whether you have specified a processing location:

      • Projects scope, location specified:
        projects/PROJECT_ID/locations/LOCATION_ID
      • Projects scope, no location specified (defaults to global):
        projects/PROJECT_ID

      The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

      parent=projects/example-project/locations/europe-west3
    • 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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 516

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
  call_metadata = @config.rpcs.redact_image.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @dlp_service_stub.redact_image request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::ReidentifyContentRequest.new

# Call the reidentify_content method.
result = client.reidentify_content request

# The returned object is of type Google::Cloud::Dlp::V2::ReidentifyContentResponse.
p result

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. Parent resource name.

      The format of this value varies depending on whether you have specified a processing location:

      • Projects scope, location specified:
        projects/PROJECT_ID/locations/LOCATION_ID
      • Projects scope, no location specified (defaults to global):
        projects/PROJECT_ID

      The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

      parent=projects/example-project/locations/europe-west3
    • 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. The DeidentifyTemplate used must include only reversible transformations. 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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
800
801
802
803
804
805
806
807
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 774

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
  call_metadata = @config.rpcs.reidentify_content.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


259
260
261
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 259

def universe_domain
  @dlp_service_stub.universe_domain
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.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::UpdateDeidentifyTemplateRequest.new

# Call the update_deidentify_template method.
result = client.update_deidentify_template request

# The returned object is of type Google::Cloud::Dlp::V2::DeidentifyTemplate.
p result

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 1543

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
  call_metadata = @config.rpcs.update_deidentify_template.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_deidentify_template.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_deidentify_template.retry_policy

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

  @dlp_service_stub.update_deidentify_template request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_discovery_config(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DiscoveryConfig #update_discovery_config(name: nil, discovery_config: nil, update_mask: nil) ⇒ ::Google::Cloud::Dlp::V2::DiscoveryConfig

Updates a discovery configuration.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::UpdateDiscoveryConfigRequest.new

# Call the update_discovery_config method.
result = client.update_discovery_config request

# The returned object is of type Google::Cloud::Dlp::V2::DiscoveryConfig.
p result

Overloads:

  • #update_discovery_config(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DiscoveryConfig

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

    Parameters:

    • request (::Google::Cloud::Dlp::V2::UpdateDiscoveryConfigRequest, ::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_discovery_config(name: nil, discovery_config: nil, update_mask: nil) ⇒ ::Google::Cloud::Dlp::V2::DiscoveryConfig

    Pass arguments to update_discovery_config 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 configuration, for example projects/dlp-test-project/discoveryConfigs/53234423.

    • discovery_config (::Google::Cloud::Dlp::V2::DiscoveryConfig, ::Hash) (defaults to: nil) —

      Required. New DiscoveryConfig value.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Mask to control which fields get updated.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 2672

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

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

  # 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
  call_metadata = @config.rpcs.update_discovery_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_discovery_config.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_discovery_config.retry_policy

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

  @dlp_service_stub.update_discovery_config request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::UpdateInspectTemplateRequest.new

# Call the update_inspect_template method.
result = client.update_inspect_template request

# The returned object is of type Google::Cloud::Dlp::V2::InspectTemplate.
p result

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 1060

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
  call_metadata = @config.rpcs.update_inspect_template.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_inspect_template.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_inspect_template.retry_policy

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

  @dlp_service_stub.update_inspect_template request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::UpdateJobTriggerRequest.new

# Call the update_job_trigger method.
result = client.update_job_trigger request

# The returned object is of type Google::Cloud::Dlp::V2::JobTrigger.
p result

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 2022

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
  call_metadata = @config.rpcs.update_job_trigger.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_job_trigger.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_job_trigger.retry_policy

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

  @dlp_service_stub.update_job_trigger request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::UpdateStoredInfoTypeRequest.new

# Call the update_stored_info_type method.
result = client.update_stored_info_type request

# The returned object is of type Google::Cloud::Dlp::V2::StoredInfoType.
p result

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
 
# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 3644

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
  call_metadata = @config.rpcs.update_stored_info_type.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_stored_info_type.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_stored_info_type.retry_policy

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

  @dlp_service_stub.update_stored_info_type request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end