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

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

Overview

Client for the DlpService service.

Sensitive Data Protection provides access to a powerful sensitive data inspection, classification, and de-identification platform that works on text, images, and Google Cloud storage repositories. To learn more about concepts and find how-to guides see https://cloud.google.com/sensitive-data-protection/docs/.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#column_data_profile_path, #connection_path, #deidentify_template_path, #discovery_config_path, #dlp_job_path, #file_store_data_profile_path, #inspect_template_path, #job_trigger_path, #location_path, #organization_location_path, #organization_path, #project_data_profile_path, #project_path, #stored_info_type_path, #table_data_profile_path

Constructor Details

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

Create a new DlpService client object.

Examples:


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

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

Yields:

  • (config)

    Configure the DlpService client.

Yield Parameters:



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 321

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

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

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

  # Create credentials
  credentials = @config.credentials
  # 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 = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Dlp::V2::DlpService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool
  )

  @location_client = Google::Cloud::Location::Locations::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_clientGoogle::Cloud::Location::Locations::Client (readonly)

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

Returns:

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


373
374
375
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 373

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::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config)

    Configure the Client client.

Yield Parameters:

Returns:



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

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.list_project_data_profiles.timeout = 300.0
    default_config.rpcs.list_project_data_profiles.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

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

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

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

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

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

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

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

    default_config.rpcs.get_column_data_profile.timeout = 300.0
    default_config.rpcs.get_column_data_profile.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::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:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
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
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 2737

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

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

Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/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::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:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 3789

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

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

Configure the DlpService Client instance.

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

See Configuration for a description of the configuration fields.

Yields:

  • (config)

    Configure the Client client.

Yield Parameters:

Returns:



291
292
293
294
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 291

def configure
  yield @config if block_given?
  @config
end

#create_connection(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::Connection #create_connection(parent: nil, connection: nil) ⇒ ::Google::Cloud::Dlp::V2::Connection

Create a Connection to an external data source.

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::Client.new

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

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

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

Overloads:

  • #create_connection(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::Connection

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

    Parameters:

    • request (::Google::Cloud::Dlp::V2::CreateConnectionRequest, ::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_connection(parent: nil, connection: nil) ⇒ ::Google::Cloud::Dlp::V2::Connection

    Pass arguments to create_connection 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):

      • Projects scope: projects/{project_id}/locations/{location_id}
      • Organizations scope: organizations/{org_id}/locations/{location_id}
    • connection (::Google::Cloud::Dlp::V2::Connection, ::Hash) (defaults to: nil)

      Required. The connection resource.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 5700

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

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

  # 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
   = @config.rpcs.create_connection..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

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

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

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

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

#create_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/sensitive-data-protection/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::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:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 1596

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

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

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

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

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

#create_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::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 varies depending on the scope of the request (project or organization):

      • Projects scope: projects/{project_id}/locations/{location_id}
      • Organizations scope: organizations/{org_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:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 2844

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

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

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

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

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

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

Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/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::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:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
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
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 3350

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

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

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

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

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

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

Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/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::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:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 1066

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

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

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

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

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

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

Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/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::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:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 2124

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

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

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

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

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

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

Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/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::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:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 3906

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

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

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

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

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

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

De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/sensitive-data-protection/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::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:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 719

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

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

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

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

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

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

Delete a Connection.

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::Client.new

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

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

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

Overloads:

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

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

    Parameters:

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

    Pass arguments to delete_connection 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 Connection to be deleted, in the format: projects/{project}/locations/{location}/connections/{connection}.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 6075

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

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

  # 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
   = @config.rpcs.delete_connection..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

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

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

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

#delete_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::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:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 3228

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

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

Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/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::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:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 3696

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

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

Delete a FileStoreDataProfile. Will not prevent the profile from being regenerated if the resource is still included in 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::Client.new

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

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

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

Overloads:

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

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

    Parameters:

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

    Pass arguments to delete_file_store_data_profile 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 file store data profile.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 5165

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

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

  # 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
   = @config.rpcs.delete_file_store_data_profile..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

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

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

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 1478

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

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

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

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 2649

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

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

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

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 4318

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

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

Delete a TableDataProfile. Will not prevent the profile from being regenerated if the table is still included in 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::Client.new

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

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

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

Overloads:

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

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

    Parameters:

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

    Pass arguments to delete_table_data_profile 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 table data profile.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 5426

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

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

  # 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
   = @config.rpcs.delete_table_data_profile..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

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

Finish a running hybrid DlpJob. Triggers the finalization steps and running of any enabled actions that have not yet run.

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::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 finished.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 5604

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

#get_column_data_profile(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::ColumnDataProfile #get_column_data_profile(name: nil) ⇒ ::Google::Cloud::Dlp::V2::ColumnDataProfile

Gets a column data profile.

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::Client.new

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

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

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

Overloads:

  • #get_column_data_profile(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::ColumnDataProfile

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

    Parameters:

    • request (::Google::Cloud::Dlp::V2::GetColumnDataProfileRequest, ::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_column_data_profile(name: nil) ⇒ ::Google::Cloud::Dlp::V2::ColumnDataProfile

    Pass arguments to get_column_data_profile 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, for example organizations/12345/locations/us/columnDataProfiles/53234423.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 5339

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

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

  # 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
   = @config.rpcs.get_column_data_profile..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

#get_connection(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::Connection #get_connection(name: nil) ⇒ ::Google::Cloud::Dlp::V2::Connection

Get a Connection by name.

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::Client.new

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

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

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

Overloads:

  • #get_connection(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::Connection

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

    Parameters:

    • request (::Google::Cloud::Dlp::V2::GetConnectionRequest, ::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_connection(name: nil) ⇒ ::Google::Cloud::Dlp::V2::Connection

    Pass arguments to get_connection 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 in the format: projects/{project}/locations/{location}/connections/{connection}.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 5787

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

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

  # 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
   = @config.rpcs.get_connection..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

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

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

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 1783

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

#get_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::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:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

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

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

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 3603

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

#get_file_store_data_profile(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::FileStoreDataProfile #get_file_store_data_profile(name: nil) ⇒ ::Google::Cloud::Dlp::V2::FileStoreDataProfile

Gets a file store data profile.

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::Client.new

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

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

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

Overloads:

  • #get_file_store_data_profile(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::FileStoreDataProfile

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

    Parameters:

    • request (::Google::Cloud::Dlp::V2::GetFileStoreDataProfileRequest, ::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_file_store_data_profile(name: nil) ⇒ ::Google::Cloud::Dlp::V2::FileStoreDataProfile

    Pass arguments to get_file_store_data_profile 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, for example organizations/12345/locations/us/fileStoreDataProfiles/53234423.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 5078

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

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

  # 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
   = @config.rpcs.get_file_store_data_profile..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

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

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

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
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
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 1252

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

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

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

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
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
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 2399

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

#get_project_data_profile(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::ProjectDataProfile #get_project_data_profile(name: nil) ⇒ ::Google::Cloud::Dlp::V2::ProjectDataProfile

Gets a project data profile.

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::Client.new

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

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

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

Overloads:

  • #get_project_data_profile(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::ProjectDataProfile

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

    Parameters:

    • request (::Google::Cloud::Dlp::V2::GetProjectDataProfileRequest, ::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_project_data_profile(name: nil) ⇒ ::Google::Cloud::Dlp::V2::ProjectDataProfile

    Pass arguments to get_project_data_profile 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, for example organizations/12345/locations/us/projectDataProfiles/53234423.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 4838

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

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

  # 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
   = @config.rpcs.get_project_data_profile..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

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

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

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
4127
4128
4129
4130
4131
4132
4133
4134
4135
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 4095

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

#get_table_data_profile(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::TableDataProfile #get_table_data_profile(name: nil) ⇒ ::Google::Cloud::Dlp::V2::TableDataProfile

Gets a table data profile.

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::Client.new

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

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

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

Overloads:

  • #get_table_data_profile(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::TableDataProfile

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

    Parameters:

    • request (::Google::Cloud::Dlp::V2::GetTableDataProfileRequest, ::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_table_data_profile(name: nil) ⇒ ::Google::Cloud::Dlp::V2::TableDataProfile

    Pass arguments to get_table_data_profile 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, for example organizations/12345/locations/us/tableDataProfiles/53234423.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 5252

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

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

  # 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
   = @config.rpcs.get_table_data_profile..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

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

Inspect hybrid content and store findings to a job. To review the findings, inspect the job. Inspection will occur asynchronously.

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

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 5517

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

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

Inspect hybrid content and store findings to a trigger. The inspection will be processed asynchronously. To review the findings monitor the jobs within the trigger.

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

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 2309

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

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

Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size.

When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

For how to guides, see https://cloud.google.com/sensitive-data-protection/docs/inspecting-images and https://cloud.google.com/sensitive-data-protection/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::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:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 459

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

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

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

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

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

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

Lists column data profiles for an organization.

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::Client.new

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

# Call the list_column_data_profiles method.
result = client.list_column_data_profiles 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::ColumnDataProfile.
  p item
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Dlp::V2::ListColumnDataProfilesRequest, ::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_column_data_profiles(parent: nil, page_token: nil, page_size: nil, order_by: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::ColumnDataProfile>

    Pass arguments to list_column_data_profiles 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. Resource name of the organization or project, for example organizations/433245324/locations/europe or projects/project-id/locations/asia.

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

      Page token to continue retrieval.

    • 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. Only one order field at a time is allowed.

      Examples:

      • project_id asc
      • table_id
      • sensitivity_level desc

      Supported fields are:

      • project_id: The Google Cloud project ID.
      • dataset_id: The ID of a BigQuery dataset.
      • table_id: The ID of a BigQuery table.
      • sensitivity_level: How sensitive the data in a column is, at most.
      • data_risk_level: How much risk is associated with this data.
      • profile_last_generated: When the profile was last updated in epoch seconds.
    • 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:
        • table_data_profile_name - The name of the related table data profile.
        • project_id - The Google Cloud project ID. (REQUIRED)
        • dataset_id - The BigQuery dataset ID. (REQUIRED)
        • table_id - The BigQuery table ID. (REQUIRED)
        • field_id - The ID of the BigQuery field.
        • info_type - The infotype detected in the resource.
        • sensitivity_level - HIGH|MEDIUM|LOW
        • data_risk_level: How much risk is associated with this data.
        • status_code - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
      • The operator must be = for project_id, dataset_id, and table_id. Other filters also support !=.

      Examples:

      • project_id = 12345 AND status_code = 1
      • project_id = 12345 AND sensitivity_level = HIGH
      • project_id = 12345 AND info_type = STREET_ADDRESS

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

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 4750

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

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

  # 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
   = @config.rpcs.list_column_data_profiles..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

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

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

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

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

#list_connections(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::Connection> #list_connections(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::Connection>

Lists Connections in a parent. Use SearchConnections to see all connections within an organization.

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::Client.new

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

# Call the list_connections method.
result = client.list_connections 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::Connection.
  p item
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Dlp::V2::ListConnectionsRequest, ::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_connections(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::Connection>

    Pass arguments to list_connections 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. Resource name of the organization or project, for example, organizations/433245324/locations/europe or projects/project-id/locations/asia.

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

      Optional. Number of results per page, max 1000.

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

      Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request.

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

      Optional. Supported field/value: state - MISSING|AVAILABLE|ERROR

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 5887

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

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

  # 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
   = @config.rpcs.list_connections..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

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

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

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

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

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

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::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::PagedEnumerable<::Google::Cloud::Dlp::V2::DeidentifyTemplate>

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. 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:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 1917

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

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

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

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

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

#list_discovery_configs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::DiscoveryConfig> #list_discovery_configs(parent: nil, page_token: nil, page_size: nil, order_by: nil) ⇒ ::Gapic::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::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::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::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:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 3140

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

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

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

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

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

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

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::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::PagedEnumerable<::Google::Cloud::Dlp::V2::DlpJob>

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. 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:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 3511

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

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

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

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

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

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

Lists file store data profiles for an organization.

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::Client.new

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

# Call the list_file_store_data_profiles method.
result = client.list_file_store_data_profiles 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::FileStoreDataProfile.
  p item
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Dlp::V2::ListFileStoreDataProfilesRequest, ::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_file_store_data_profiles(parent: nil, page_token: nil, page_size: nil, order_by: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::FileStoreDataProfile>

    Pass arguments to list_file_store_data_profiles 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. Resource name of the organization or project, for example organizations/433245324/locations/europe or projects/project-id/locations/asia.

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

      Optional. Page token to continue retrieval.

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

      Optional. 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)

      Optional. 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. Only one order field at a time is allowed.

      Examples:

      • project_id asc
      • name
      • sensitivity_level desc

      Supported fields are:

      • project_id: The Google Cloud project ID.
      • sensitivity_level: How sensitive the data in a table is, at most.
      • data_risk_level: How much risk is associated with this data.
      • profile_last_generated: When the profile was last updated in epoch seconds.
      • last_modified: The last time the resource was modified.
      • resource_visibility: Visibility restriction for this resource.
      • name: The name of the profile.
      • create_time: The time the file store was first created.
    • filter (::String) (defaults to: nil)

      Optional. Allows filtering.

      Supported syntax:

      • Filter expressions are made up of one or more restrictions.
      • Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND.
      • A restriction has the form of {field} {operator} {value}.
      • Supported fields/values:
        • project_id - The Google Cloud project ID.
        • account_id - The AWS account ID.
        • file_store_path - The path like "gs://bucket".
        • data_source_type - The profile's data source type, like "google/storage/bucket".
        • data_storage_location - The location where the file store's data is stored, like "us-central1".
        • sensitivity_level - HIGH|MODERATE|LOW
        • data_risk_level - HIGH|MODERATE|LOW
        • resource_visibility: PUBLIC|RESTRICTED
        • status_code - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
      • The operator must be = or !=.

      Examples:

      • project_id = 12345 AND status_code = 1
      • project_id = 12345 AND sensitivity_level = HIGH
      • project_id = 12345 AND resource_visibility = PUBLIC
      • file_store_path = "gs://mybucket"

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

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 4990

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

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

  # 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
   = @config.rpcs.list_file_store_data_profiles..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

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

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

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

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

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

Returns a list of the sensitive information types that DLP API supports. See https://cloud.google.com/sensitive-data-protection/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::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/{location_id}`
      
    • language_code (::String) (defaults to: nil)

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

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

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

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

      Deprecated. This field has no effect.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 956

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

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::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::PagedEnumerable<::Google::Cloud::Dlp::V2::InspectTemplate>

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. 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:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 1386

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

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

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

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

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

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

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

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 2558

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

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

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

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

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

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

Lists project data profiles for an organization.

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::Client.new

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

# Call the list_project_data_profiles method.
result = client.list_project_data_profiles 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::ProjectDataProfile.
  p item
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Dlp::V2::ListProjectDataProfilesRequest, ::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_project_data_profiles(parent: nil, page_token: nil, page_size: nil, order_by: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::ProjectDataProfile>

    Pass arguments to list_project_data_profiles 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. organizations/{org_id}/locations/{loc_id}

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

      Page token to continue retrieval.

    • 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. Only one order field at a time is allowed.

      Examples:

      • project_id
      • sensitivity_level desc

      Supported fields are:

      • project_id: Google Cloud project ID
      • sensitivity_level: How sensitive the data in a project is, at most.
      • data_risk_level: How much risk is associated with this data.
      • profile_last_generated: When the profile was last updated in epoch seconds.
    • 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:
      • The operator must be = or !=.

      Examples:

      • project_id = 12345 AND status_code = 1
      • project_id = 12345 AND sensitivity_level = HIGH

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

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 4452

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

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

  # 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
   = @config.rpcs.list_project_data_profiles..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

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

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

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

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

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

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::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::PagedEnumerable<::Google::Cloud::Dlp::V2::StoredInfoType>

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. 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:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 4226

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

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

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

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

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

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

Lists table data profiles for an organization.

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::Client.new

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

# Call the list_table_data_profiles method.
result = client.list_table_data_profiles 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::TableDataProfile.
  p item
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Dlp::V2::ListTableDataProfilesRequest, ::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_table_data_profiles(parent: nil, page_token: nil, page_size: nil, order_by: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::TableDataProfile>

    Pass arguments to list_table_data_profiles 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. Resource name of the organization or project, for example organizations/433245324/locations/europe or projects/project-id/locations/asia.

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

      Page token to continue retrieval.

    • 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. Only one order field at a time is allowed.

      Examples:

      • project_id asc
      • table_id
      • sensitivity_level desc

      Supported fields are:

      • project_id: The Google Cloud project ID.
      • dataset_id: The ID of a BigQuery dataset.
      • table_id: The ID of a BigQuery table.
      • sensitivity_level: How sensitive the data in a table is, at most.
      • data_risk_level: How much risk is associated with this data.
      • profile_last_generated: When the profile was last updated in epoch seconds.
      • last_modified: The last time the resource was modified.
      • resource_visibility: Visibility restriction for this resource.
      • row_count: Number of rows in this resource.
    • 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:
      • The operator must be = or !=.

      Examples:

      • project_id = 12345 AND status_code = 1
      • project_id = 12345 AND sensitivity_level = HIGH
      • project_id = 12345 AND resource_visibility = PUBLIC

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

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 4600

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

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

  # 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
   = @config.rpcs.list_table_data_profiles..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

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

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

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

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

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

Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/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::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:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 579

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

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

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

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

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

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

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

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



854
855
856
857
858
859
860
861
862
863
864
865
866
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
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 854

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

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

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

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

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

#search_connections(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::Connection> #search_connections(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::Connection>

Searches for Connections in a parent.

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::Client.new

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

# Call the search_connections method.
result = client.search_connections 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::Connection.
  p item
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Dlp::V2::SearchConnectionsRequest, ::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.

  • #search_connections(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::Connection>

    Pass arguments to search_connections 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. Resource name of the organization or project with a wildcard location, for example, organizations/433245324/locations/- or projects/project-id/locations/-.

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

      Optional. Number of results per page, max 1000.

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

      Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request.

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

      Optional. Supported field/value: - state - MISSING|AVAILABLE|ERROR

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 5987

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

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

  # 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
   = @config.rpcs.search_connections..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

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

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

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

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

#universe_domainString

The effective universe domain

Returns:

  • (String)


301
302
303
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 301

def universe_domain
  @dlp_service_stub.universe_domain
end

#update_connection(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::Connection #update_connection(name: nil, connection: nil, update_mask: nil) ⇒ ::Google::Cloud::Dlp::V2::Connection

Update a Connection.

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::Client.new

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

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

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

Overloads:

  • #update_connection(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::Connection

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

    Parameters:

    • request (::Google::Cloud::Dlp::V2::UpdateConnectionRequest, ::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_connection(name: nil, connection: nil, update_mask: nil) ⇒ ::Google::Cloud::Dlp::V2::Connection

    Pass arguments to update_connection 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 in the format: projects/{project}/locations/{location}/connections/{connection}.

    • connection (::Google::Cloud::Dlp::V2::Connection, ::Hash) (defaults to: nil)

      Required. The connection with new values for the relevant fields.

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

      Optional. Mask to control which fields get updated.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 6166

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

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

  # 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
   = @config.rpcs.update_connection..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

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

Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/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::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:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 1692

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

#update_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::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:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2935
2936
2937
2938
2939
2940
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
2975
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 2935

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

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

Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/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::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:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 1161

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

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

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

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 2218

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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

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

Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/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::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:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
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
# File 'lib/google/cloud/dlp/v2/dlp_service/client.rb', line 4004

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"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
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

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