google-cloud-dlp 0.15.0 → 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 88badb6241aa666a5444dd0519c11563c3b0f0684b9cccccb6899369a6caa2f2
4
- data.tar.gz: 84458d32f19cde35abda87761b05098b53926fb33ff96755f1d70bcb57898def
3
+ metadata.gz: ff4e97f7cfd251246d4f04ce6bcb59d04b94a91e5445389f3b6cb9af092eb5f4
4
+ data.tar.gz: e8c3752edd2a454612697d51b6c711c071e382ee902f14901db48a19ed33f3b7
5
5
  SHA512:
6
- metadata.gz: a94146a2afef35635bf42a4d1cf919a5f3d21b4ba9f7b93aa4e2a1df99765b95fdb320d07397dc5ab92ddab338d1366e0725cc4577964f590611c18350f56fc8
7
- data.tar.gz: 867efb9002ee72e12b1cb33554e241c57183abfaacf94d7d8d016b453d73e8f9d717604f12a42e080b2639b0786a212409279458974e1552fba71bddb6d4bd54
6
+ metadata.gz: 3933d72a59b33f85ae0f994ee4e70eeacd49261478be5a910f47066158a7c1e17e91aedeafefe72925cac87e179ffef57df18b249a9748dcc7be9fe516e02028
7
+ data.tar.gz: 5ce73b6af9aa586e1994e2f6ded8a7e2308fb18692869234597d03e8b1060dab55ff79fa308a211165a055fccddb717c3158b9bfc2511a26ac14c056c9fa060d
data/.yardopts CHANGED
@@ -8,4 +8,5 @@
8
8
  -
9
9
  README.md
10
10
  AUTHENTICATION.md
11
- LICENSE
11
+ MIGRATING.md
12
+ LICENSE.md
@@ -1,16 +1,17 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-dlp library uses [Service
4
- Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
5
- credentials to connect to Google Cloud services. When running within [Google
6
- Cloud Platform environments](#google-cloud-platform-environments)
7
- the credentials will be discovered automatically. When running on other
3
+ In general, the google-cloud-dlp library uses
4
+ [Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
5
+ credentials to connect to Google Cloud services. When running within
6
+ [Google Cloud Platform environments](#google-cloud-platform-environments) the
7
+ credentials will be discovered automatically. When running on other
8
8
  environments, the Service Account credentials can be specified by providing the
9
- path to the [JSON
10
- keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys) for
11
- the account (or the JSON itself) in [environment
12
- variables](#environment-variables). Additionally, Cloud SDK credentials can also
13
- be discovered automatically, but this is only recommended during development.
9
+ path to the
10
+ [JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
11
+ for the account (or the JSON itself) in
12
+ [environment variables](#environment-variables). Additionally, Cloud SDK
13
+ credentials can also be discovered automatically, but this is only recommended
14
+ during development.
14
15
 
15
16
  ## Quickstart
16
17
 
@@ -18,7 +19,7 @@ be discovered automatically, but this is only recommended during development.
18
19
  2. Set the [environment variable](#environment-variables).
19
20
 
20
21
  ```sh
21
- export DLP_CREDENTIALS=/path/to/json`
22
+ export DLP_CREDENTIALS=path/to/keyfile.json
22
23
  ```
23
24
 
24
25
  3. Initialize the client.
@@ -26,23 +27,14 @@ export DLP_CREDENTIALS=/path/to/json`
26
27
  ```ruby
27
28
  require "google/cloud/dlp"
28
29
 
29
- client = Google::Cloud::Dlp.new
30
+ client = Google::Cloud::Dlp.dlp_service
30
31
  ```
31
32
 
32
- ## Project and Credential Lookup
33
+ ## Credential Lookup
33
34
 
34
35
  The google-cloud-dlp library aims to make authentication
35
36
  as simple as possible, and provides several mechanisms to configure your system
36
- without providing **Project ID** and **Service Account Credentials** directly in
37
- code.
38
-
39
- **Project ID** is discovered in the following order:
40
-
41
- 1. Specify project ID in method arguments
42
- 2. Specify project ID in configuration
43
- 3. Discover project ID in environment variables
44
- 4. Discover GCP project ID
45
- 5. Discover project ID in credentials JSON
37
+ without requiring **Service Account Credentials** directly in code.
46
38
 
47
39
  **Credentials** are discovered in the following order:
48
40
 
@@ -55,28 +47,24 @@ code.
55
47
 
56
48
  ### Google Cloud Platform environments
57
49
 
58
- When running on Google Cloud Platform (GCP), including Google Compute Engine (GCE),
59
- Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud Functions
60
- (GCF) and Cloud Run, the **Project ID** and **Credentials** and are discovered
61
- automatically. Code should be written as if already authenticated.
50
+ When running on Google Cloud Platform (GCP), including Google Compute Engine
51
+ (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
52
+ Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
53
+ Code should be written as if already authenticated.
62
54
 
63
55
  ### Environment Variables
64
56
 
65
- The **Project ID** and **Credentials JSON** can be placed in environment
66
- variables instead of declaring them directly in code. Each service has its own
67
- environment variable, allowing for different service accounts to be used for
68
- different services. (See the READMEs for the individual service gems for
69
- details.) The path to the **Credentials JSON** file can be stored in the
70
- environment variable, or the **Credentials JSON** itself can be stored for
71
- environments such as Docker containers where writing files is difficult or not
72
- encouraged.
73
-
74
- The environment variables that google-cloud-dlp checks for project ID are:
75
-
76
- 1. `DLP_PROJECT`
77
- 2. `GOOGLE_CLOUD_PROJECT`
57
+ The **Credentials JSON** can be placed in environment variables instead of
58
+ declaring them directly in code. Each service has its own environment variable,
59
+ allowing for different service accounts to be used for different services. (See
60
+ the READMEs for the individual service gems for details.) The path to the
61
+ **Credentials JSON** file can be stored in the environment variable, or the
62
+ **Credentials JSON** itself can be stored for environments such as Docker
63
+ containers where writing files is difficult or not encouraged.
78
64
 
79
- The environment variables that google-cloud-dlp checks for credentials are configured on {Google::Cloud::Dlp::V2::Credentials}:
65
+ The environment variables that google-cloud-dlp
66
+ checks for credentials are configured on the service Credentials class (such as
67
+ `::Google::Cloud::Dlp::V2::DlpService::Credentials`):
80
68
 
81
69
  1. `DLP_CREDENTIALS` - Path to JSON file, or JSON contents
82
70
  2. `DLP_KEYFILE` - Path to JSON file, or JSON contents
@@ -87,25 +75,34 @@ The environment variables that google-cloud-dlp checks for credentials are confi
87
75
  ```ruby
88
76
  require "google/cloud/dlp"
89
77
 
90
- ENV["DLP_PROJECT"] = "my-project-id"
91
78
  ENV["DLP_CREDENTIALS"] = "path/to/keyfile.json"
92
79
 
93
- client = Google::Cloud::Dlp.new
80
+ client = Google::Cloud::Dlp.dlp_service
94
81
  ```
95
82
 
96
83
  ### Configuration
97
84
 
98
- The **Project ID** and **Credentials JSON** can be configured instead of placing them in environment variables or providing them as arguments.
85
+ The **Credentials JSON** can be configured instead of placing them in
86
+ environment variables. Either on an individual client initialization:
87
+
88
+ ```ruby
89
+ require "google/cloud/dlp"
90
+
91
+ client = Google::Cloud::Dlp.dlp_service do |config|
92
+ config.credentials = "path/to/keyfile.json"
93
+ end
94
+ ```
95
+
96
+ Or configured globally for all clients:
99
97
 
100
98
  ```ruby
101
99
  require "google/cloud/dlp"
102
100
 
103
101
  Google::Cloud::Dlp.configure do |config|
104
- config.project_id = "my-project-id"
105
102
  config.credentials = "path/to/keyfile.json"
106
103
  end
107
104
 
108
- client = Google::Cloud::Dlp.new
105
+ client = Google::Cloud::Dlp.dlp_service
109
106
  ```
110
107
 
111
108
  ### Cloud SDK
@@ -134,24 +131,24 @@ To configure your system for this, simply:
134
131
 
135
132
  ## Creating a Service Account
136
133
 
137
- Google Cloud requires a **Project ID** and **Service Account Credentials** to
138
- connect to the APIs. You will use the **Project ID** and **JSON key file** to
134
+ Google Cloud requires **Service Account Credentials** to
135
+ connect to the APIs. You will use the **JSON key file** to
139
136
  connect to most services with google-cloud-dlp.
140
137
 
141
- If you are not running this client within [Google Cloud Platform
142
- environments](#google-cloud-platform-environments), you need a Google
143
- Developers service account.
138
+ If you are not running this client within
139
+ [Google Cloud Platform environments](#google-cloud-platform-environments), you
140
+ need a Google Developers service account.
144
141
 
145
142
  1. Visit the [Google Developers Console][dev-console].
146
- 1. Create a new project or click on an existing project.
147
- 1. Activate the slide-out navigation tray and select **API Manager**. From
143
+ 2. Create a new project or click on an existing project.
144
+ 3. Activate the slide-out navigation tray and select **API Manager**. From
148
145
  here, you will enable the APIs that your application requires.
149
146
 
150
147
  ![Enable the APIs that your application requires][enable-apis]
151
148
 
152
149
  *Note: You may need to enable billing in order to use these services.*
153
150
 
154
- 1. Select **Credentials** from the side navigation.
151
+ 4. Select **Credentials** from the side navigation.
155
152
 
156
153
  You should see a screen like one of the following.
157
154
 
@@ -170,8 +167,3 @@ Developers service account.
170
167
 
171
168
  The key file you download will be used by this library to authenticate API
172
169
  requests and should be stored in a secure location.
173
-
174
- ## Troubleshooting
175
-
176
- If you're having trouble authenticating you can ask for help by following the
177
- {file:TROUBLESHOOTING.md Troubleshooting Guide}.
@@ -0,0 +1,203 @@
1
+ Apache License
2
+ ==============
3
+
4
+ * Version 2.0, January 2004
5
+ * https://www.apache.org/licenses/
6
+
7
+ ### TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
8
+
9
+ 1. **Definitions.**
10
+
11
+ "License" shall mean the terms and conditions for use, reproduction,
12
+ and distribution as defined by Sections 1 through 9 of this document.
13
+
14
+ "Licensor" shall mean the copyright owner or entity authorized by
15
+ the copyright owner that is granting the License.
16
+
17
+ "Legal Entity" shall mean the union of the acting entity and all
18
+ other entities that control, are controlled by, or are under common
19
+ control with that entity. For the purposes of this definition,
20
+ "control" means (i) the power, direct or indirect, to cause the
21
+ direction or management of such entity, whether by contract or
22
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
23
+ outstanding shares, or (iii) beneficial ownership of such entity.
24
+
25
+ "You" (or "Your") shall mean an individual or Legal Entity
26
+ exercising permissions granted by this License.
27
+
28
+ "Source" form shall mean the preferred form for making modifications,
29
+ including but not limited to software source code, documentation
30
+ source, and configuration files.
31
+
32
+ "Object" form shall mean any form resulting from mechanical
33
+ transformation or translation of a Source form, including but
34
+ not limited to compiled object code, generated documentation,
35
+ and conversions to other media types.
36
+
37
+ "Work" shall mean the work of authorship, whether in Source or
38
+ Object form, made available under the License, as indicated by a
39
+ copyright notice that is included in or attached to the work
40
+ (an example is provided in the Appendix below).
41
+
42
+ "Derivative Works" shall mean any work, whether in Source or Object
43
+ form, that is based on (or derived from) the Work and for which the
44
+ editorial revisions, annotations, elaborations, or other modifications
45
+ represent, as a whole, an original work of authorship. For the purposes
46
+ of this License, Derivative Works shall not include works that remain
47
+ separable from, or merely link (or bind by name) to the interfaces of,
48
+ the Work and Derivative Works thereof.
49
+
50
+ "Contribution" shall mean any work of authorship, including
51
+ the original version of the Work and any modifications or additions
52
+ to that Work or Derivative Works thereof, that is intentionally
53
+ submitted to Licensor for inclusion in the Work by the copyright owner
54
+ or by an individual or Legal Entity authorized to submit on behalf of
55
+ the copyright owner. For the purposes of this definition, "submitted"
56
+ means any form of electronic, verbal, or written communication sent
57
+ to the Licensor or its representatives, including but not limited to
58
+ communication on electronic mailing lists, source code control systems,
59
+ and issue tracking systems that are managed by, or on behalf of, the
60
+ Licensor for the purpose of discussing and improving the Work, but
61
+ excluding communication that is conspicuously marked or otherwise
62
+ designated in writing by the copyright owner as "Not a Contribution."
63
+
64
+ "Contributor" shall mean Licensor and any individual or Legal Entity
65
+ on behalf of whom a Contribution has been received by Licensor and
66
+ subsequently incorporated within the Work.
67
+
68
+ 2. **Grant of Copyright License.** Subject to the terms and conditions of
69
+ this License, each Contributor hereby grants to You a perpetual,
70
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
71
+ copyright license to reproduce, prepare Derivative Works of,
72
+ publicly display, publicly perform, sublicense, and distribute the
73
+ Work and such Derivative Works in Source or Object form.
74
+
75
+ 3. **Grant of Patent License.** Subject to the terms and conditions of
76
+ this License, each Contributor hereby grants to You a perpetual,
77
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
78
+ (except as stated in this section) patent license to make, have made,
79
+ use, offer to sell, sell, import, and otherwise transfer the Work,
80
+ where such license applies only to those patent claims licensable
81
+ by such Contributor that are necessarily infringed by their
82
+ Contribution(s) alone or by combination of their Contribution(s)
83
+ with the Work to which such Contribution(s) was submitted. If You
84
+ institute patent litigation against any entity (including a
85
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
86
+ or a Contribution incorporated within the Work constitutes direct
87
+ or contributory patent infringement, then any patent licenses
88
+ granted to You under this License for that Work shall terminate
89
+ as of the date such litigation is filed.
90
+
91
+ 4. **Redistribution.** You may reproduce and distribute copies of the
92
+ Work or Derivative Works thereof in any medium, with or without
93
+ modifications, and in Source or Object form, provided that You
94
+ meet the following conditions:
95
+
96
+ * **(a)** You must give any other recipients of the Work or
97
+ Derivative Works a copy of this License; and
98
+
99
+ * **(b)** You must cause any modified files to carry prominent notices
100
+ stating that You changed the files; and
101
+
102
+ * **(c)** You must retain, in the Source form of any Derivative Works
103
+ that You distribute, all copyright, patent, trademark, and
104
+ attribution notices from the Source form of the Work,
105
+ excluding those notices that do not pertain to any part of
106
+ the Derivative Works; and
107
+
108
+ * **(d)** If the Work includes a "NOTICE" text file as part of its
109
+ distribution, then any Derivative Works that You distribute must
110
+ include a readable copy of the attribution notices contained
111
+ within such NOTICE file, excluding those notices that do not
112
+ pertain to any part of the Derivative Works, in at least one
113
+ of the following places: within a NOTICE text file distributed
114
+ as part of the Derivative Works; within the Source form or
115
+ documentation, if provided along with the Derivative Works; or,
116
+ within a display generated by the Derivative Works, if and
117
+ wherever such third-party notices normally appear. The contents
118
+ of the NOTICE file are for informational purposes only and
119
+ do not modify the License. You may add Your own attribution
120
+ notices within Derivative Works that You distribute, alongside
121
+ or as an addendum to the NOTICE text from the Work, provided
122
+ that such additional attribution notices cannot be construed
123
+ as modifying the License.
124
+
125
+ You may add Your own copyright statement to Your modifications and
126
+ may provide additional or different license terms and conditions
127
+ for use, reproduction, or distribution of Your modifications, or
128
+ for any such Derivative Works as a whole, provided Your use,
129
+ reproduction, and distribution of the Work otherwise complies with
130
+ the conditions stated in this License.
131
+
132
+ 5. **Submission of Contributions.** Unless You explicitly state otherwise,
133
+ any Contribution intentionally submitted for inclusion in the Work
134
+ by You to the Licensor shall be under the terms and conditions of
135
+ this License, without any additional terms or conditions.
136
+ Notwithstanding the above, nothing herein shall supersede or modify
137
+ the terms of any separate license agreement you may have executed
138
+ with Licensor regarding such Contributions.
139
+
140
+ 6. **Trademarks.** This License does not grant permission to use the trade
141
+ names, trademarks, service marks, or product names of the Licensor,
142
+ except as required for reasonable and customary use in describing the
143
+ origin of the Work and reproducing the content of the NOTICE file.
144
+
145
+ 7. **Disclaimer of Warranty.** Unless required by applicable law or
146
+ agreed to in writing, Licensor provides the Work (and each
147
+ Contributor provides its Contributions) on an "AS IS" BASIS,
148
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
149
+ implied, including, without limitation, any warranties or conditions
150
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
151
+ PARTICULAR PURPOSE. You are solely responsible for determining the
152
+ appropriateness of using or redistributing the Work and assume any
153
+ risks associated with Your exercise of permissions under this License.
154
+
155
+ 8. **Limitation of Liability.** In no event and under no legal theory,
156
+ whether in tort (including negligence), contract, or otherwise,
157
+ unless required by applicable law (such as deliberate and grossly
158
+ negligent acts) or agreed to in writing, shall any Contributor be
159
+ liable to You for damages, including any direct, indirect, special,
160
+ incidental, or consequential damages of any character arising as a
161
+ result of this License or out of the use or inability to use the
162
+ Work (including but not limited to damages for loss of goodwill,
163
+ work stoppage, computer failure or malfunction, or any and all
164
+ other commercial damages or losses), even if such Contributor
165
+ has been advised of the possibility of such damages.
166
+
167
+ 9. **Accepting Warranty or Additional Liability.** While redistributing
168
+ the Work or Derivative Works thereof, You may choose to offer,
169
+ and charge a fee for, acceptance of support, warranty, indemnity,
170
+ or other liability obligations and/or rights consistent with this
171
+ License. However, in accepting such obligations, You may act only
172
+ on Your own behalf and on Your sole responsibility, not on behalf
173
+ of any other Contributor, and only if You agree to indemnify,
174
+ defend, and hold each Contributor harmless for any liability
175
+ incurred by, or claims asserted against, such Contributor by reason
176
+ of your accepting any such warranty or additional liability.
177
+
178
+ _END OF TERMS AND CONDITIONS_
179
+
180
+ ### APPENDIX: How to apply the Apache License to your work.
181
+
182
+ To apply the Apache License to your work, attach the following
183
+ boilerplate notice, with the fields enclosed by brackets "`[]`"
184
+ replaced with your own identifying information. (Don't include
185
+ the brackets!) The text should be enclosed in the appropriate
186
+ comment syntax for the file format. We also recommend that a
187
+ file or class name and description of purpose be included on the
188
+ same "printed page" as the copyright notice for easier
189
+ identification within third-party archives.
190
+
191
+ Copyright [yyyy] [name of copyright owner]
192
+
193
+ Licensed under the Apache License, Version 2.0 (the "License");
194
+ you may not use this file except in compliance with the License.
195
+ You may obtain a copy of the License at
196
+
197
+ https://www.apache.org/licenses/LICENSE-2.0
198
+
199
+ Unless required by applicable law or agreed to in writing, software
200
+ distributed under the License is distributed on an "AS IS" BASIS,
201
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
202
+ See the License for the specific language governing permissions and
203
+ limitations under the License.
@@ -0,0 +1,303 @@
1
+ ## Migrating to google-cloud-dlp 1.0
2
+
3
+ The 1.0 release of the google-cloud-dlp client is a significant upgrade
4
+ based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-ruby),
5
+ and includes substantial interface changes. Existing code written for earlier
6
+ versions of this library will likely require updates to use this version.
7
+ This document describes the changes that have been made, and what you need to
8
+ do to update your usage.
9
+
10
+ To summarize:
11
+
12
+ * The library has been broken out into two libraries. The new gem
13
+ `google-cloud-dlp-v2` contains the actual client classes for version
14
+ V2 of the DLP service, and the gem `google-cloud-dlp` now
15
+ simply provides a convenience wrapper. See
16
+ [Library Structure](#library-structure) for more info.
17
+ * The library uses a new configuration mechanism giving you closer control
18
+ over endpoint address, network timeouts, and retry. See
19
+ [Client Configuration](#client-configuration) for more info. Furthermore,
20
+ when creating a client object, you can customize its configuration in a
21
+ block rather than passing arguments to the constructor. See
22
+ [Creating Clients](#creating-clients) for more info.
23
+ * Previously, positional arguments were used to indicate required arguments.
24
+ Now, all method arguments are keyword arguments, with documentation that
25
+ specifies whether they are required or optional. Additionally, you can pass
26
+ a proto request object instead of separate arguments. See
27
+ [Passing Arguments](#passing-arguments) for more info.
28
+ * Previously, some client classes included class methods for constructing
29
+ resource paths. These paths are now instance methods on the client objects,
30
+ and are also available in a separate paths module. See
31
+ [Resource Path Helpers](#resource-path-helpers) for more info.
32
+ * Some classes have moved into different namespaces. See
33
+ [Class Namespaces](#class-namespaces) for more info.
34
+
35
+ ### Library Structure
36
+
37
+ Older 0.x releases of the `google-cloud-dlp` gem were all-in-one gems
38
+ that included potentially multiple clients for multiple versions of the
39
+ DLP service. The `Google::Cloud::Dlp.new` factory method would
40
+ return you an instance of a `Google::Cloud::Dlp::V2::DlpServiceClient`
41
+ object for the V2 version of the service.
42
+
43
+ With the 1.0 release, the `google-cloud-dlp` gem still provides factory
44
+ methods for obtaining clients. (The method signatures will have changed. See
45
+ [Creating Clients](#creating-clients) for details.) However, the actual client
46
+ classes have been moved into separate gems, one per service version. Currently,
47
+ DLP has one version, V2. The
48
+ `Google::Cloud::Dlp::V2::DlpService::Client` class, along with its
49
+ helpers and data types, is now part of the `google-cloud-dlp-v2` gem.
50
+ If an additional version of the DLP service is released, an additional gem
51
+ may be provided for its client classes.
52
+
53
+ For normal usage, you can continue to install the `google-cloud-dlp` gem
54
+ (which will bring in the versioned client gems as dependencies) and continue to
55
+ use factory methods to create clients. However, you may alternatively choose to
56
+ install only one of the versioned gems. For example, if you know you will only
57
+ use `V2` of the service, you can install `google-cloud-dlp-v2` by
58
+ itself, and construct instances of the
59
+ `Google::Cloud::Dlp::V2::DlpService::Client` client class directly.
60
+
61
+ ### Client Configuration
62
+
63
+ In older releases, if you wanted to customize performance parameters or
64
+ low-level behavior of the client (such as credentials, timeouts, or
65
+ instrumentation), you would pass a variety of keyword arguments to the client
66
+ constructor. It was also extremely difficult to customize the default settings.
67
+
68
+ With the 1.0 release, a configuration interface provides control over these
69
+ parameters, including defaults for all instances of a client, and settings for
70
+ each specific client instance. For example, to set default credentials and
71
+ timeout for all DLP V2 clients:
72
+
73
+ ```
74
+ Google::Cloud::Dlp::V2::DlpService::Client.configure do |config|
75
+ config.credentials = "/path/to/credentials.json"
76
+ config.timeout = 10.0
77
+ end
78
+ ```
79
+
80
+ Individual RPCs can also be configured independently. For example, to set the
81
+ timeout for the `redact_image` call:
82
+
83
+ ```
84
+ Google::Cloud::Dlp::V2::DlpService::Client.configure do |config|
85
+ config.rpcs.redact_image.timeout = 20.0
86
+ end
87
+ ```
88
+
89
+ Defaults for certain configurations can be set for all DLP versions and
90
+ services globally:
91
+
92
+ ```
93
+ Google::Cloud::Dlp.configure do |config|
94
+ config.credentials = "/path/to/credentials.json"
95
+ config.timeout = 10.0
96
+ end
97
+ ```
98
+
99
+ Finally, you can override the configuration for each client instance. See the
100
+ next section on [Creating Clients](#creating-clients) for details.
101
+
102
+ ### Creating Clients
103
+
104
+ In older releases, to create a client object, you would use the
105
+ `Google::Cloud::Dlp.new` class method. Keyword arguments were available to
106
+ select a service version and to configure parameters such as credentials and
107
+ timeouts.
108
+
109
+ With the 1.0 release, use the `Google::Cloud::Dlp.dlp_service` class
110
+ method to create a client object. You may select a service version using the
111
+ `:version` keyword argument. However, other configuration parameters should be
112
+ set in a configuration block when you create the client.
113
+
114
+ Old:
115
+ ```
116
+ client = Google::Cloud::Dlp.new credentials: "/path/to/credentials.json"
117
+ ```
118
+
119
+ New:
120
+ ```
121
+ client = Google::Cloud::Dlp.dlp_service do |config|
122
+ config.credentials = "/path/to/credentials.json"
123
+ end
124
+ ```
125
+
126
+ The configuration block is optional. If you do not provide it, or you do not
127
+ set some configuration parameters, then the default configuration is used. See
128
+ [Client Configuration](#client-configuration).
129
+
130
+ ### Passing Arguments
131
+
132
+ In older releases, required arguments would be passed as positional method
133
+ arguments, while most optional arguments would be passed as keyword arguments.
134
+
135
+ With the 1.0 release, all RPC arguments are passed as keyword arguments,
136
+ regardless of whether they are required or optional. For example:
137
+
138
+ Old:
139
+ ```
140
+ client = Google::Cloud::Dlp.new
141
+
142
+ parent = "projects/my-project"
143
+
144
+ # Parent is a positional argument, while page_size is a keyword argument.
145
+ response = client.list_inspect_templates parent, page_size: 10
146
+ ```
147
+
148
+ New:
149
+ ```
150
+ client = Google::Cloud::Dlp.dlp_service
151
+
152
+ parent = "projects/my-project"
153
+
154
+ # Parent and page_size are both keyword arguments
155
+ response = client.list_inspect_templates parent: parent, page_size: 10
156
+ ```
157
+
158
+ In the 1.0 release, it is also possible to pass a request object, either
159
+ as a hash or as a protocol buffer.
160
+
161
+ New:
162
+ ```
163
+ client = Google::Cloud::Dlp.dlp_service
164
+
165
+ request = Google::Cloud::Dlp::V2::ListInspectTemplatesRequest.new(
166
+ parent: "projects/my-project",
167
+ page_size: 10
168
+ )
169
+
170
+ # Pass a request object as a positional argument:
171
+ response = client.list_inspect_templates request
172
+ ```
173
+
174
+ Finally, in older releases, to provide call options, you would pass a
175
+ `Google::Gax::CallOptions` object with the `:options` keyword argument. In the
176
+ 1.0 release, pass call options using a _second set_ of keyword arguments.
177
+
178
+ Old:
179
+ ```
180
+ client = Google::Cloud::Dlp.new
181
+
182
+ parent = "projects/my-project"
183
+
184
+ options = Google::Gax::CallOptions.new timeout: 10.0
185
+
186
+ response = client.list_inspect_templates parent, page_size: 10, options: options
187
+ ```
188
+
189
+ New:
190
+ ```
191
+ client = Google::Cloud::Dlp.dlp_service
192
+
193
+ parent = "projects/my-project"
194
+
195
+ # Use a hash to wrap the normal call arguments (or pass a request object), and
196
+ # then add further keyword arguments for the call options.
197
+ response = client.list_inspect_templates(
198
+ { parent: parent, page_size: 10 },
199
+ timeout: 10.0
200
+ )
201
+ ```
202
+
203
+ ### Resource Path Helpers
204
+
205
+ The client library includes helper methods for generating the resource path
206
+ strings passed to many calls. These helpers have changed in two ways:
207
+
208
+ * In older releases, they are _class_ methods on the client class. In the 1.0
209
+ release, they are _instance_ methods on the client. They are also available
210
+ on a separate paths module that you can include elsewhere for convenience.
211
+ * In older releases, arguments to a resource path helper are passed as
212
+ _positional_ arguments. In the 1.0 release, they are passed as named _keyword_
213
+ arguments. Some helpers also support different sets of arguments, each set
214
+ corresponding to a different type of path.
215
+
216
+ Following is an example involving using a resource path helper.
217
+
218
+ Old:
219
+ ```
220
+ client = Google::Cloud::Dlp.new
221
+
222
+ # Call the helper on the client class
223
+ name = Google::Cloud::Dlp::V2::DlpServiceClient.project_inspect_template_path(
224
+ "my-project", "my-template"
225
+ )
226
+
227
+ response = client.get_inspect_template name
228
+ ```
229
+
230
+ New:
231
+ ```
232
+ client = Google::Cloud::Dlp.dlp_service
233
+
234
+ # Call the helper on the client instance, and use keyword arguments
235
+ name = client.inspect_template_path project: "my-project",
236
+ inspect_template: "my-template"
237
+
238
+ response = client.get_inspect_template name: name
239
+ ```
240
+
241
+ Because IDs are passed as keyword arguments, some closely related paths
242
+ have been combined. For example, `project_inspect_template_path` and
243
+ `organization_inspect_template_path` used to be separate helpers, one that took
244
+ a project as the parent, and another that took an organization as the parent.
245
+ In the 1.0 client, use `inspect_template_path` for both cases, and pass either
246
+ the `project:` or `organization:` keyword argument.
247
+
248
+ Old:
249
+ ```
250
+ name1 = Google::Cloud::Dlp::V2::DlpServiceClient.project_inspect_template_path(
251
+ "my-project", "my-template"
252
+ )
253
+ name2 = Google::Cloud::Dlp::V2::DlpServiceClient.organization_inspect_template_path(
254
+ "my-org", "my-template"
255
+ )
256
+ ```
257
+
258
+ New:
259
+ ```
260
+ client = Google::Cloud::Dlp.dlp_service
261
+ name1 = client.inspect_template_path project: "my-project",
262
+ inspect_template: "my-template"
263
+ name2 = client.inspect_template_path organization: "my-org",
264
+ inspect_template: "my-template"
265
+ ```
266
+
267
+ Finally, in the 1.0 client, you can also use the paths module as a convenience module.
268
+
269
+ New:
270
+ ```
271
+ # Bring the session_path method into the current class
272
+ include Google::Cloud::Dlp::V2::DlpService::Paths
273
+
274
+ def foo
275
+ client = Google::Cloud::Dlp.dlp_service
276
+
277
+ # Call the included helper method
278
+ name = inspect_template_path organization: "my-org",
279
+ inspect_template: "my-template"
280
+
281
+ response = client.get_inspect_template name: name
282
+
283
+ # Do something with response...
284
+ end
285
+ ```
286
+
287
+ ### Class Namespaces
288
+
289
+ In older releases, the client object was of classes with names like:
290
+ `Google::Cloud::Dlp::V2::DlpServiceClient`.
291
+ In the 1.0 release, the client object is of a different class:
292
+ `Google::Cloud::Dlp::V2::DlpService::Client`.
293
+ Note that most users will use the factory methods such as
294
+ `Google::Cloud::Dlp.dlp_service` to create instances of the client object,
295
+ so you may not need to reference the actual class directly.
296
+ See [Creating Clients](#creating-clients).
297
+
298
+ In older releases, the credentials object was of class
299
+ `Google::Cloud::Dlp::V2::Credentials`.
300
+ In the 1.0 release, each service has its own credentials class, e.g.
301
+ `Google::Cloud::Dlp::V2::DlpService::Credentials`.
302
+ Again, most users will not need to reference this class directly.
303
+ See [Client Configuration](#client-configuration).