google-cloud-profiler-v2 0.8.0 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +72 -101
- data/lib/google/cloud/profiler/v2/export_service/client.rb +31 -8
- data/lib/google/cloud/profiler/v2/export_service/rest/client.rb +33 -7
- data/lib/google/cloud/profiler/v2/export_service/rest/service_stub.rb +14 -2
- data/lib/google/cloud/profiler/v2/profiler_service/client.rb +31 -8
- data/lib/google/cloud/profiler/v2/profiler_service/rest/client.rb +33 -7
- data/lib/google/cloud/profiler/v2/profiler_service/rest/service_stub.rb +14 -2
- data/lib/google/cloud/profiler/v2/version.rb +1 -1
- data/proto_docs/google/api/client.rb +1 -0
- metadata +4 -4
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 193ce430138a0f2d042583b2239319485a41c43804e7a6d2fa2222916820020e
|
|
4
|
+
data.tar.gz: b9e00c8c4371988f5dabbe1ffb68d4e17b2107b54f43d79dce1fef09281bd5fb
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 00ecc4741781f55a64b346a684fbbd8ceb6679021ec0ad6b7a466b14755b91d2ae420dc29c326aef6c0383c824c24b7d4e687ef7d26cd93740a41a31244f02df
|
|
7
|
+
data.tar.gz: c1f45648dc0092d490b302d76fcfd4634f465aeb1b48344cabc18ff222e9b699358942f049031d044d44f3cf7d5704aabfe890c90aedc5fb2211ce04e7762646
|
data/AUTHENTICATION.md
CHANGED
|
@@ -1,151 +1,122 @@
|
|
|
1
1
|
# Authentication
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
[
|
|
5
|
-
|
|
6
|
-
[Google Cloud Platform environments](#google-cloud-platform-environments) the
|
|
7
|
-
credentials will be discovered automatically. When running on other
|
|
8
|
-
environments, the Service Account credentials can be specified by providing the
|
|
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.
|
|
3
|
+
The recommended way to authenticate to the google-cloud-profiler-v2 library is to use
|
|
4
|
+
[Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
|
|
5
|
+
To review all of your authentication options, see [Credentials lookup](#credential-lookup).
|
|
15
6
|
|
|
16
7
|
## Quickstart
|
|
17
8
|
|
|
18
|
-
|
|
19
|
-
|
|
9
|
+
The following example shows how to set up authentication for a local development
|
|
10
|
+
environment with your user credentials.
|
|
20
11
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
3. Initialize the client.
|
|
12
|
+
**NOTE:** This method is _not_ recommended for running in production. User credentials
|
|
13
|
+
should be used only during development.
|
|
26
14
|
|
|
27
|
-
|
|
28
|
-
|
|
15
|
+
1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
|
|
16
|
+
2. Set up a local ADC file with your user credentials:
|
|
29
17
|
|
|
30
|
-
|
|
18
|
+
```sh
|
|
19
|
+
gcloud auth application-default login
|
|
31
20
|
```
|
|
32
21
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
The google-cloud-profiler-v2 library aims to make authentication
|
|
36
|
-
as simple as possible, and provides several mechanisms to configure your system
|
|
37
|
-
without requiring **Service Account Credentials** directly in code.
|
|
38
|
-
|
|
39
|
-
**Credentials** are discovered in the following order:
|
|
40
|
-
|
|
41
|
-
1. Specify credentials in method arguments
|
|
42
|
-
2. Specify credentials in configuration
|
|
43
|
-
3. Discover credentials path in environment variables
|
|
44
|
-
4. Discover credentials JSON in environment variables
|
|
45
|
-
5. Discover credentials file in the Cloud SDK's path
|
|
46
|
-
6. Discover GCP credentials
|
|
47
|
-
|
|
48
|
-
### Google Cloud Platform environments
|
|
22
|
+
3. Write code as if already authenticated.
|
|
49
23
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
|
|
53
|
-
Code should be written as if already authenticated.
|
|
24
|
+
For more information about setting up authentication for a local development environment, see
|
|
25
|
+
[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
|
|
54
26
|
|
|
55
|
-
|
|
27
|
+
## Credential Lookup
|
|
56
28
|
|
|
57
|
-
The
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
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.
|
|
29
|
+
The google-cloud-profiler-v2 library provides several mechanisms to configure your system.
|
|
30
|
+
Generally, using Application Default Credentials to facilitate automatic
|
|
31
|
+
credentials discovery is the easist method. But if you need to explicitly specify
|
|
32
|
+
credentials, there are several methods available to you.
|
|
64
33
|
|
|
65
|
-
|
|
66
|
-
checks for credentials are configured on the service Credentials class (such as
|
|
67
|
-
{::Google::Cloud::Profiler::V2::ProfilerService::Credentials}):
|
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
|
68
35
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
36
|
+
1. Credentials specified in method arguments
|
|
37
|
+
2. Credentials specified in configuration
|
|
38
|
+
3. Credentials pointed to or included in environment variables
|
|
39
|
+
4. Credentials found in local ADC file
|
|
40
|
+
5. Credentials returned by the metadata server for the attached service account (GCP)
|
|
74
41
|
|
|
75
|
-
|
|
76
|
-
require "google/cloud/profiler/v2"
|
|
77
|
-
|
|
78
|
-
ENV["PROFILER_CREDENTIALS"] = "path/to/keyfile.json"
|
|
42
|
+
### Configuration
|
|
79
43
|
|
|
80
|
-
client
|
|
81
|
-
|
|
44
|
+
You can configure a path to a JSON credentials file, either for an individual client object or
|
|
45
|
+
globally, for all client objects. The JSON file can contain credentials created for
|
|
46
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
|
47
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
|
48
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
|
82
49
|
|
|
83
|
-
|
|
50
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
|
51
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
|
52
|
+
whenever possible.
|
|
84
53
|
|
|
85
|
-
|
|
86
|
-
it in an environment variable. Either on an individual client initialization:
|
|
54
|
+
To configure a credentials file for an individual client initialization:
|
|
87
55
|
|
|
88
56
|
```ruby
|
|
89
57
|
require "google/cloud/profiler/v2"
|
|
90
58
|
|
|
91
59
|
client = ::Google::Cloud::Profiler::V2::ProfilerService::Client.new do |config|
|
|
92
|
-
config.credentials = "path/to/
|
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
|
93
61
|
end
|
|
94
62
|
```
|
|
95
63
|
|
|
96
|
-
|
|
64
|
+
To configure a credentials file globally for all clients:
|
|
97
65
|
|
|
98
66
|
```ruby
|
|
99
67
|
require "google/cloud/profiler/v2"
|
|
100
68
|
|
|
101
69
|
::Google::Cloud::Profiler::V2::ProfilerService::Client.configure do |config|
|
|
102
|
-
config.credentials = "path/to/
|
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
|
103
71
|
end
|
|
104
72
|
|
|
105
73
|
client = ::Google::Cloud::Profiler::V2::ProfilerService::Client.new
|
|
106
74
|
```
|
|
107
75
|
|
|
108
|
-
###
|
|
76
|
+
### Environment Variables
|
|
109
77
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
78
|
+
You can also use an environment variable to provide a JSON credentials file.
|
|
79
|
+
The environment variable can contain a path to the credentials file or, for
|
|
80
|
+
environments such as Docker containers where writing files is not encouraged,
|
|
81
|
+
you can include the credentials file itself.
|
|
113
82
|
|
|
114
|
-
|
|
83
|
+
The JSON file can contain credentials created for
|
|
84
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
|
85
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
|
86
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
|
115
87
|
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
88
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
|
89
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
|
90
|
+
whenever possible.
|
|
91
|
+
|
|
92
|
+
The environment variables that google-cloud-profiler-v2
|
|
93
|
+
checks for credentials are:
|
|
119
94
|
|
|
120
|
-
|
|
121
|
-
*
|
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
|
122
97
|
|
|
123
|
-
|
|
98
|
+
```ruby
|
|
99
|
+
require "google/cloud/profiler/v2"
|
|
124
100
|
|
|
125
|
-
|
|
126
|
-
connect to the APIs. You will use the **JSON key file** to
|
|
127
|
-
connect to most services with google-cloud-profiler-v2.
|
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
|
128
102
|
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
need a Google Developers service account.
|
|
103
|
+
client = ::Google::Cloud::Profiler::V2::ProfilerService::Client.new
|
|
104
|
+
```
|
|
132
105
|
|
|
133
|
-
|
|
134
|
-
2. Create a new project or click on an existing project.
|
|
135
|
-
3. Activate the menu in the upper left and select **APIs & Services**. From
|
|
136
|
-
here, you will enable the APIs that your application requires.
|
|
106
|
+
### Local ADC file
|
|
137
107
|
|
|
138
|
-
|
|
108
|
+
You can set up a local ADC file with your user credentials for authentication during
|
|
109
|
+
development. If credentials are not provided in code or in environment variables,
|
|
110
|
+
then the local ADC credentials are discovered.
|
|
139
111
|
|
|
140
|
-
|
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
|
141
113
|
|
|
142
|
-
|
|
143
|
-
"Service account" to be guided through downloading a new JSON key file.
|
|
114
|
+
### Google Cloud Platform environments
|
|
144
115
|
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
116
|
+
When running on Google Cloud Platform (GCP), including Google Compute Engine
|
|
117
|
+
(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
|
|
118
|
+
Functions (GCF) and Cloud Run, credentials are retrieved from the attached
|
|
119
|
+
service account automatically. Code should be written as if already authenticated.
|
|
149
120
|
|
|
150
|
-
|
|
151
|
-
|
|
121
|
+
For more information, see
|
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
|
@@ -31,6 +31,9 @@ module Google
|
|
|
31
31
|
# out of Google Cloud.
|
|
32
32
|
#
|
|
33
33
|
class Client
|
|
34
|
+
# @private
|
|
35
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudprofiler.$UNIVERSE_DOMAIN$"
|
|
36
|
+
|
|
34
37
|
include Paths
|
|
35
38
|
|
|
36
39
|
# @private
|
|
@@ -96,6 +99,15 @@ module Google
|
|
|
96
99
|
@config
|
|
97
100
|
end
|
|
98
101
|
|
|
102
|
+
##
|
|
103
|
+
# The effective universe domain
|
|
104
|
+
#
|
|
105
|
+
# @return [String]
|
|
106
|
+
#
|
|
107
|
+
def universe_domain
|
|
108
|
+
@export_service_stub.universe_domain
|
|
109
|
+
end
|
|
110
|
+
|
|
99
111
|
##
|
|
100
112
|
# Create a new ExportService client object.
|
|
101
113
|
#
|
|
@@ -129,8 +141,9 @@ module Google
|
|
|
129
141
|
credentials = @config.credentials
|
|
130
142
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
131
143
|
# but only if the default endpoint does not have a region prefix.
|
|
132
|
-
enable_self_signed_jwt = @config.endpoint
|
|
133
|
-
|
|
144
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
145
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
146
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
134
147
|
credentials ||= Credentials.default scope: @config.scope,
|
|
135
148
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
136
149
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -141,8 +154,10 @@ module Google
|
|
|
141
154
|
|
|
142
155
|
@export_service_stub = ::Gapic::ServiceStub.new(
|
|
143
156
|
::Google::Cloud::Profiler::V2::ExportService::Stub,
|
|
144
|
-
credentials:
|
|
145
|
-
endpoint:
|
|
157
|
+
credentials: credentials,
|
|
158
|
+
endpoint: @config.endpoint,
|
|
159
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
160
|
+
universe_domain: @config.universe_domain,
|
|
146
161
|
channel_args: @config.channel_args,
|
|
147
162
|
interceptors: @config.interceptors,
|
|
148
163
|
channel_pool_config: @config.channel_pool
|
|
@@ -281,9 +296,9 @@ module Google
|
|
|
281
296
|
# end
|
|
282
297
|
#
|
|
283
298
|
# @!attribute [rw] endpoint
|
|
284
|
-
#
|
|
285
|
-
#
|
|
286
|
-
# @return [::String]
|
|
299
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
300
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
301
|
+
# @return [::String,nil]
|
|
287
302
|
# @!attribute [rw] credentials
|
|
288
303
|
# Credentials to send with calls. You may provide any of the following types:
|
|
289
304
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -329,13 +344,20 @@ module Google
|
|
|
329
344
|
# @!attribute [rw] quota_project
|
|
330
345
|
# A separate project against which to charge quota.
|
|
331
346
|
# @return [::String]
|
|
347
|
+
# @!attribute [rw] universe_domain
|
|
348
|
+
# The universe domain within which to make requests. This determines the
|
|
349
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
350
|
+
# universe (usually the default "googleapis.com" universe).
|
|
351
|
+
# @return [::String,nil]
|
|
332
352
|
#
|
|
333
353
|
class Configuration
|
|
334
354
|
extend ::Gapic::Config
|
|
335
355
|
|
|
356
|
+
# @private
|
|
357
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
336
358
|
DEFAULT_ENDPOINT = "cloudprofiler.googleapis.com"
|
|
337
359
|
|
|
338
|
-
config_attr :endpoint,
|
|
360
|
+
config_attr :endpoint, nil, ::String, nil
|
|
339
361
|
config_attr :credentials, nil do |value|
|
|
340
362
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
341
363
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -350,6 +372,7 @@ module Google
|
|
|
350
372
|
config_attr :metadata, nil, ::Hash, nil
|
|
351
373
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
352
374
|
config_attr :quota_project, nil, ::String, nil
|
|
375
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
353
376
|
|
|
354
377
|
# @private
|
|
355
378
|
def initialize parent_config = nil
|
|
@@ -33,6 +33,9 @@ module Google
|
|
|
33
33
|
# out of Google Cloud.
|
|
34
34
|
#
|
|
35
35
|
class Client
|
|
36
|
+
# @private
|
|
37
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudprofiler.$UNIVERSE_DOMAIN$"
|
|
38
|
+
|
|
36
39
|
include Paths
|
|
37
40
|
|
|
38
41
|
# @private
|
|
@@ -98,6 +101,15 @@ module Google
|
|
|
98
101
|
@config
|
|
99
102
|
end
|
|
100
103
|
|
|
104
|
+
##
|
|
105
|
+
# The effective universe domain
|
|
106
|
+
#
|
|
107
|
+
# @return [String]
|
|
108
|
+
#
|
|
109
|
+
def universe_domain
|
|
110
|
+
@export_service_stub.universe_domain
|
|
111
|
+
end
|
|
112
|
+
|
|
101
113
|
##
|
|
102
114
|
# Create a new ExportService REST client object.
|
|
103
115
|
#
|
|
@@ -125,8 +137,9 @@ module Google
|
|
|
125
137
|
credentials = @config.credentials
|
|
126
138
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
127
139
|
# but only if the default endpoint does not have a region prefix.
|
|
128
|
-
enable_self_signed_jwt = @config.endpoint
|
|
129
|
-
|
|
140
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
141
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
142
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
130
143
|
credentials ||= Credentials.default scope: @config.scope,
|
|
131
144
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
132
145
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -136,7 +149,12 @@ module Google
|
|
|
136
149
|
@quota_project_id = @config.quota_project
|
|
137
150
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
|
138
151
|
|
|
139
|
-
@export_service_stub = ::Google::Cloud::Profiler::V2::ExportService::Rest::ServiceStub.new
|
|
152
|
+
@export_service_stub = ::Google::Cloud::Profiler::V2::ExportService::Rest::ServiceStub.new(
|
|
153
|
+
endpoint: @config.endpoint,
|
|
154
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
155
|
+
universe_domain: @config.universe_domain,
|
|
156
|
+
credentials: credentials
|
|
157
|
+
)
|
|
140
158
|
end
|
|
141
159
|
|
|
142
160
|
# Service calls
|
|
@@ -264,9 +282,9 @@ module Google
|
|
|
264
282
|
# end
|
|
265
283
|
#
|
|
266
284
|
# @!attribute [rw] endpoint
|
|
267
|
-
#
|
|
268
|
-
#
|
|
269
|
-
# @return [::String]
|
|
285
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
286
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
287
|
+
# @return [::String,nil]
|
|
270
288
|
# @!attribute [rw] credentials
|
|
271
289
|
# Credentials to send with calls. You may provide any of the following types:
|
|
272
290
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -303,13 +321,20 @@ module Google
|
|
|
303
321
|
# @!attribute [rw] quota_project
|
|
304
322
|
# A separate project against which to charge quota.
|
|
305
323
|
# @return [::String]
|
|
324
|
+
# @!attribute [rw] universe_domain
|
|
325
|
+
# The universe domain within which to make requests. This determines the
|
|
326
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
327
|
+
# universe (usually the default "googleapis.com" universe).
|
|
328
|
+
# @return [::String,nil]
|
|
306
329
|
#
|
|
307
330
|
class Configuration
|
|
308
331
|
extend ::Gapic::Config
|
|
309
332
|
|
|
333
|
+
# @private
|
|
334
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
310
335
|
DEFAULT_ENDPOINT = "cloudprofiler.googleapis.com"
|
|
311
336
|
|
|
312
|
-
config_attr :endpoint,
|
|
337
|
+
config_attr :endpoint, nil, ::String, nil
|
|
313
338
|
config_attr :credentials, nil do |value|
|
|
314
339
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
315
340
|
allowed.any? { |klass| klass === value }
|
|
@@ -321,6 +346,7 @@ module Google
|
|
|
321
346
|
config_attr :metadata, nil, ::Hash, nil
|
|
322
347
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
323
348
|
config_attr :quota_project, nil, ::String, nil
|
|
349
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
324
350
|
|
|
325
351
|
# @private
|
|
326
352
|
def initialize parent_config = nil
|
|
@@ -30,16 +30,28 @@ module Google
|
|
|
30
30
|
# including transcoding, making the REST call, and deserialing the response.
|
|
31
31
|
#
|
|
32
32
|
class ServiceStub
|
|
33
|
-
def initialize endpoint:, credentials:
|
|
33
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
34
34
|
# These require statements are intentionally placed here to initialize
|
|
35
35
|
# the REST modules only when it's required.
|
|
36
36
|
require "gapic/rest"
|
|
37
37
|
|
|
38
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
38
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
39
|
+
endpoint_template: endpoint_template,
|
|
40
|
+
universe_domain: universe_domain,
|
|
41
|
+
credentials: credentials,
|
|
39
42
|
numeric_enums: true,
|
|
40
43
|
raise_faraday_errors: false
|
|
41
44
|
end
|
|
42
45
|
|
|
46
|
+
##
|
|
47
|
+
# The effective universe domain
|
|
48
|
+
#
|
|
49
|
+
# @return [String]
|
|
50
|
+
#
|
|
51
|
+
def universe_domain
|
|
52
|
+
@client_stub.universe_domain
|
|
53
|
+
end
|
|
54
|
+
|
|
43
55
|
##
|
|
44
56
|
# Baseline implementation for the list_profiles REST call
|
|
45
57
|
#
|
|
@@ -35,6 +35,9 @@ module Google
|
|
|
35
35
|
# * Profiles can be created in either online or offline mode, see below.
|
|
36
36
|
#
|
|
37
37
|
class Client
|
|
38
|
+
# @private
|
|
39
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudprofiler.$UNIVERSE_DOMAIN$"
|
|
40
|
+
|
|
38
41
|
include Paths
|
|
39
42
|
|
|
40
43
|
# @private
|
|
@@ -106,6 +109,15 @@ module Google
|
|
|
106
109
|
@config
|
|
107
110
|
end
|
|
108
111
|
|
|
112
|
+
##
|
|
113
|
+
# The effective universe domain
|
|
114
|
+
#
|
|
115
|
+
# @return [String]
|
|
116
|
+
#
|
|
117
|
+
def universe_domain
|
|
118
|
+
@profiler_service_stub.universe_domain
|
|
119
|
+
end
|
|
120
|
+
|
|
109
121
|
##
|
|
110
122
|
# Create a new ProfilerService client object.
|
|
111
123
|
#
|
|
@@ -139,8 +151,9 @@ module Google
|
|
|
139
151
|
credentials = @config.credentials
|
|
140
152
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
141
153
|
# but only if the default endpoint does not have a region prefix.
|
|
142
|
-
enable_self_signed_jwt = @config.endpoint
|
|
143
|
-
|
|
154
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
155
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
156
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
144
157
|
credentials ||= Credentials.default scope: @config.scope,
|
|
145
158
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
146
159
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -151,8 +164,10 @@ module Google
|
|
|
151
164
|
|
|
152
165
|
@profiler_service_stub = ::Gapic::ServiceStub.new(
|
|
153
166
|
::Google::Cloud::Profiler::V2::ProfilerService::Stub,
|
|
154
|
-
credentials:
|
|
155
|
-
endpoint:
|
|
167
|
+
credentials: credentials,
|
|
168
|
+
endpoint: @config.endpoint,
|
|
169
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
170
|
+
universe_domain: @config.universe_domain,
|
|
156
171
|
channel_args: @config.channel_args,
|
|
157
172
|
interceptors: @config.interceptors,
|
|
158
173
|
channel_pool_config: @config.channel_pool
|
|
@@ -474,9 +489,9 @@ module Google
|
|
|
474
489
|
# end
|
|
475
490
|
#
|
|
476
491
|
# @!attribute [rw] endpoint
|
|
477
|
-
#
|
|
478
|
-
#
|
|
479
|
-
# @return [::String]
|
|
492
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
493
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
494
|
+
# @return [::String,nil]
|
|
480
495
|
# @!attribute [rw] credentials
|
|
481
496
|
# Credentials to send with calls. You may provide any of the following types:
|
|
482
497
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -522,13 +537,20 @@ module Google
|
|
|
522
537
|
# @!attribute [rw] quota_project
|
|
523
538
|
# A separate project against which to charge quota.
|
|
524
539
|
# @return [::String]
|
|
540
|
+
# @!attribute [rw] universe_domain
|
|
541
|
+
# The universe domain within which to make requests. This determines the
|
|
542
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
543
|
+
# universe (usually the default "googleapis.com" universe).
|
|
544
|
+
# @return [::String,nil]
|
|
525
545
|
#
|
|
526
546
|
class Configuration
|
|
527
547
|
extend ::Gapic::Config
|
|
528
548
|
|
|
549
|
+
# @private
|
|
550
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
529
551
|
DEFAULT_ENDPOINT = "cloudprofiler.googleapis.com"
|
|
530
552
|
|
|
531
|
-
config_attr :endpoint,
|
|
553
|
+
config_attr :endpoint, nil, ::String, nil
|
|
532
554
|
config_attr :credentials, nil do |value|
|
|
533
555
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
534
556
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -543,6 +565,7 @@ module Google
|
|
|
543
565
|
config_attr :metadata, nil, ::Hash, nil
|
|
544
566
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
545
567
|
config_attr :quota_project, nil, ::String, nil
|
|
568
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
546
569
|
|
|
547
570
|
# @private
|
|
548
571
|
def initialize parent_config = nil
|
|
@@ -37,6 +37,9 @@ module Google
|
|
|
37
37
|
# * Profiles can be created in either online or offline mode, see below.
|
|
38
38
|
#
|
|
39
39
|
class Client
|
|
40
|
+
# @private
|
|
41
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudprofiler.$UNIVERSE_DOMAIN$"
|
|
42
|
+
|
|
40
43
|
include Paths
|
|
41
44
|
|
|
42
45
|
# @private
|
|
@@ -108,6 +111,15 @@ module Google
|
|
|
108
111
|
@config
|
|
109
112
|
end
|
|
110
113
|
|
|
114
|
+
##
|
|
115
|
+
# The effective universe domain
|
|
116
|
+
#
|
|
117
|
+
# @return [String]
|
|
118
|
+
#
|
|
119
|
+
def universe_domain
|
|
120
|
+
@profiler_service_stub.universe_domain
|
|
121
|
+
end
|
|
122
|
+
|
|
111
123
|
##
|
|
112
124
|
# Create a new ProfilerService REST client object.
|
|
113
125
|
#
|
|
@@ -135,8 +147,9 @@ module Google
|
|
|
135
147
|
credentials = @config.credentials
|
|
136
148
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
137
149
|
# but only if the default endpoint does not have a region prefix.
|
|
138
|
-
enable_self_signed_jwt = @config.endpoint
|
|
139
|
-
|
|
150
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
151
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
152
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
140
153
|
credentials ||= Credentials.default scope: @config.scope,
|
|
141
154
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
142
155
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -146,7 +159,12 @@ module Google
|
|
|
146
159
|
@quota_project_id = @config.quota_project
|
|
147
160
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
|
148
161
|
|
|
149
|
-
@profiler_service_stub = ::Google::Cloud::Profiler::V2::ProfilerService::Rest::ServiceStub.new
|
|
162
|
+
@profiler_service_stub = ::Google::Cloud::Profiler::V2::ProfilerService::Rest::ServiceStub.new(
|
|
163
|
+
endpoint: @config.endpoint,
|
|
164
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
165
|
+
universe_domain: @config.universe_domain,
|
|
166
|
+
credentials: credentials
|
|
167
|
+
)
|
|
150
168
|
end
|
|
151
169
|
|
|
152
170
|
# Service calls
|
|
@@ -443,9 +461,9 @@ module Google
|
|
|
443
461
|
# end
|
|
444
462
|
#
|
|
445
463
|
# @!attribute [rw] endpoint
|
|
446
|
-
#
|
|
447
|
-
#
|
|
448
|
-
# @return [::String]
|
|
464
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
465
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
466
|
+
# @return [::String,nil]
|
|
449
467
|
# @!attribute [rw] credentials
|
|
450
468
|
# Credentials to send with calls. You may provide any of the following types:
|
|
451
469
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -482,13 +500,20 @@ module Google
|
|
|
482
500
|
# @!attribute [rw] quota_project
|
|
483
501
|
# A separate project against which to charge quota.
|
|
484
502
|
# @return [::String]
|
|
503
|
+
# @!attribute [rw] universe_domain
|
|
504
|
+
# The universe domain within which to make requests. This determines the
|
|
505
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
506
|
+
# universe (usually the default "googleapis.com" universe).
|
|
507
|
+
# @return [::String,nil]
|
|
485
508
|
#
|
|
486
509
|
class Configuration
|
|
487
510
|
extend ::Gapic::Config
|
|
488
511
|
|
|
512
|
+
# @private
|
|
513
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
489
514
|
DEFAULT_ENDPOINT = "cloudprofiler.googleapis.com"
|
|
490
515
|
|
|
491
|
-
config_attr :endpoint,
|
|
516
|
+
config_attr :endpoint, nil, ::String, nil
|
|
492
517
|
config_attr :credentials, nil do |value|
|
|
493
518
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
494
519
|
allowed.any? { |klass| klass === value }
|
|
@@ -500,6 +525,7 @@ module Google
|
|
|
500
525
|
config_attr :metadata, nil, ::Hash, nil
|
|
501
526
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
502
527
|
config_attr :quota_project, nil, ::String, nil
|
|
528
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
503
529
|
|
|
504
530
|
# @private
|
|
505
531
|
def initialize parent_config = nil
|
|
@@ -30,16 +30,28 @@ module Google
|
|
|
30
30
|
# including transcoding, making the REST call, and deserialing the response.
|
|
31
31
|
#
|
|
32
32
|
class ServiceStub
|
|
33
|
-
def initialize endpoint:, credentials:
|
|
33
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
34
34
|
# These require statements are intentionally placed here to initialize
|
|
35
35
|
# the REST modules only when it's required.
|
|
36
36
|
require "gapic/rest"
|
|
37
37
|
|
|
38
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
38
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
39
|
+
endpoint_template: endpoint_template,
|
|
40
|
+
universe_domain: universe_domain,
|
|
41
|
+
credentials: credentials,
|
|
39
42
|
numeric_enums: true,
|
|
40
43
|
raise_faraday_errors: false
|
|
41
44
|
end
|
|
42
45
|
|
|
46
|
+
##
|
|
47
|
+
# The effective universe domain
|
|
48
|
+
#
|
|
49
|
+
# @return [String]
|
|
50
|
+
#
|
|
51
|
+
def universe_domain
|
|
52
|
+
@client_stub.universe_domain
|
|
53
|
+
end
|
|
54
|
+
|
|
43
55
|
##
|
|
44
56
|
# Baseline implementation for the create_profile REST call
|
|
45
57
|
#
|
|
@@ -21,6 +21,7 @@ module Google
|
|
|
21
21
|
module Api
|
|
22
22
|
# Required information for every language.
|
|
23
23
|
# @!attribute [rw] reference_docs_uri
|
|
24
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
24
25
|
# @return [::String]
|
|
25
26
|
# Link to automatically generated reference documentation. Example:
|
|
26
27
|
# https://cloud.google.com/nodejs/docs/reference/asset/latest
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-profiler-v2
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.9.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2024-01-
|
|
11
|
+
date: 2024-01-11 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: gapic-common
|
|
@@ -16,7 +16,7 @@ dependencies:
|
|
|
16
16
|
requirements:
|
|
17
17
|
- - ">="
|
|
18
18
|
- !ruby/object:Gem::Version
|
|
19
|
-
version: 0.
|
|
19
|
+
version: 0.21.1
|
|
20
20
|
- - "<"
|
|
21
21
|
- !ruby/object:Gem::Version
|
|
22
22
|
version: 2.a
|
|
@@ -26,7 +26,7 @@ dependencies:
|
|
|
26
26
|
requirements:
|
|
27
27
|
- - ">="
|
|
28
28
|
- !ruby/object:Gem::Version
|
|
29
|
-
version: 0.
|
|
29
|
+
version: 0.21.1
|
|
30
30
|
- - "<"
|
|
31
31
|
- !ruby/object:Gem::Version
|
|
32
32
|
version: 2.a
|