google-cloud-support-v2 0.1.0 → 0.3.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 -99
- data/lib/google/cloud/support/v2/case_attachment_service/client.rb +41 -9
- data/lib/google/cloud/support/v2/case_service/client.rb +41 -9
- data/lib/google/cloud/support/v2/comment_service/client.rb +41 -9
- data/lib/google/cloud/support/v2/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -0
- data/proto_docs/google/api/field_behavior.rb +14 -0
- metadata +5 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a0c85d8db0a0b045993ab3ef52031fe445b8646a22faaea5c47331df4aa3a947
|
|
4
|
+
data.tar.gz: 87371543cc21b704c152f66f3f7d8e752e4e4ec176fd796a638cf4b095209c32
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 5bf556474bfe088b3a9964a02fb448654537aaa4000a5483ad64542bc5b5e1683a59814eb8bcc4e49a551e81b7cfbaa66dfb76fc6917a9e4c544172abc40447a
|
|
7
|
+
data.tar.gz: 9195ca1d03e90aa99a4ebb303cd83729171dc5b1795004f096aee9239b5f2f46c134ffa86aa608cac4b7fbe6fe0bf5b5531c3c9261d69a553d135c118ced66d6
|
data/AUTHENTICATION.md
CHANGED
|
@@ -1,149 +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-support-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-support-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-support-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::Support::V2::CaseAttachmentService::Credentials}):
|
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
|
68
35
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
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)
|
|
72
41
|
|
|
73
|
-
|
|
74
|
-
require "google/cloud/support/v2"
|
|
75
|
-
|
|
76
|
-
ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
|
|
42
|
+
### Configuration
|
|
77
43
|
|
|
78
|
-
client
|
|
79
|
-
|
|
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).
|
|
80
49
|
|
|
81
|
-
|
|
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.
|
|
82
53
|
|
|
83
|
-
|
|
84
|
-
it in an environment variable. Either on an individual client initialization:
|
|
54
|
+
To configure a credentials file for an individual client initialization:
|
|
85
55
|
|
|
86
56
|
```ruby
|
|
87
57
|
require "google/cloud/support/v2"
|
|
88
58
|
|
|
89
59
|
client = ::Google::Cloud::Support::V2::CaseAttachmentService::Client.new do |config|
|
|
90
|
-
config.credentials = "path/to/
|
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
|
91
61
|
end
|
|
92
62
|
```
|
|
93
63
|
|
|
94
|
-
|
|
64
|
+
To configure a credentials file globally for all clients:
|
|
95
65
|
|
|
96
66
|
```ruby
|
|
97
67
|
require "google/cloud/support/v2"
|
|
98
68
|
|
|
99
69
|
::Google::Cloud::Support::V2::CaseAttachmentService::Client.configure do |config|
|
|
100
|
-
config.credentials = "path/to/
|
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
|
101
71
|
end
|
|
102
72
|
|
|
103
73
|
client = ::Google::Cloud::Support::V2::CaseAttachmentService::Client.new
|
|
104
74
|
```
|
|
105
75
|
|
|
106
|
-
###
|
|
76
|
+
### Environment Variables
|
|
107
77
|
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
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.
|
|
111
82
|
|
|
112
|
-
|
|
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).
|
|
113
87
|
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
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-support-v2
|
|
93
|
+
checks for credentials are:
|
|
117
94
|
|
|
118
|
-
|
|
119
|
-
*
|
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
|
120
97
|
|
|
121
|
-
|
|
98
|
+
```ruby
|
|
99
|
+
require "google/cloud/support/v2"
|
|
122
100
|
|
|
123
|
-
|
|
124
|
-
connect to the APIs. You will use the **JSON key file** to
|
|
125
|
-
connect to most services with google-cloud-support-v2.
|
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
|
126
102
|
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
need a Google Developers service account.
|
|
103
|
+
client = ::Google::Cloud::Support::V2::CaseAttachmentService::Client.new
|
|
104
|
+
```
|
|
130
105
|
|
|
131
|
-
|
|
132
|
-
2. Create a new project or click on an existing project.
|
|
133
|
-
3. Activate the menu in the upper left and select **APIs & Services**. From
|
|
134
|
-
here, you will enable the APIs that your application requires.
|
|
106
|
+
### Local ADC file
|
|
135
107
|
|
|
136
|
-
|
|
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.
|
|
137
111
|
|
|
138
|
-
|
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
|
139
113
|
|
|
140
|
-
|
|
141
|
-
"Service account" to be guided through downloading a new JSON key file.
|
|
114
|
+
### Google Cloud Platform environments
|
|
142
115
|
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
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.
|
|
147
120
|
|
|
148
|
-
|
|
149
|
-
|
|
121
|
+
For more information, see
|
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
|
@@ -30,6 +30,9 @@ module Google
|
|
|
30
30
|
# A service to manage file attachment for Google Cloud support cases.
|
|
31
31
|
#
|
|
32
32
|
class Client
|
|
33
|
+
# @private
|
|
34
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudsupport.$UNIVERSE_DOMAIN$"
|
|
35
|
+
|
|
33
36
|
include Paths
|
|
34
37
|
|
|
35
38
|
# @private
|
|
@@ -95,6 +98,15 @@ module Google
|
|
|
95
98
|
@config
|
|
96
99
|
end
|
|
97
100
|
|
|
101
|
+
##
|
|
102
|
+
# The effective universe domain
|
|
103
|
+
#
|
|
104
|
+
# @return [String]
|
|
105
|
+
#
|
|
106
|
+
def universe_domain
|
|
107
|
+
@case_attachment_service_stub.universe_domain
|
|
108
|
+
end
|
|
109
|
+
|
|
98
110
|
##
|
|
99
111
|
# Create a new CaseAttachmentService client object.
|
|
100
112
|
#
|
|
@@ -128,8 +140,9 @@ module Google
|
|
|
128
140
|
credentials = @config.credentials
|
|
129
141
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
130
142
|
# but only if the default endpoint does not have a region prefix.
|
|
131
|
-
enable_self_signed_jwt = @config.endpoint
|
|
132
|
-
|
|
143
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
144
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
145
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
133
146
|
credentials ||= Credentials.default scope: @config.scope,
|
|
134
147
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
135
148
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -140,10 +153,13 @@ module Google
|
|
|
140
153
|
|
|
141
154
|
@case_attachment_service_stub = ::Gapic::ServiceStub.new(
|
|
142
155
|
::Google::Cloud::Support::V2::CaseAttachmentService::Stub,
|
|
143
|
-
credentials:
|
|
144
|
-
endpoint:
|
|
156
|
+
credentials: credentials,
|
|
157
|
+
endpoint: @config.endpoint,
|
|
158
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
159
|
+
universe_domain: @config.universe_domain,
|
|
145
160
|
channel_args: @config.channel_args,
|
|
146
|
-
interceptors: @config.interceptors
|
|
161
|
+
interceptors: @config.interceptors,
|
|
162
|
+
channel_pool_config: @config.channel_pool
|
|
147
163
|
)
|
|
148
164
|
end
|
|
149
165
|
|
|
@@ -277,9 +293,9 @@ module Google
|
|
|
277
293
|
# end
|
|
278
294
|
#
|
|
279
295
|
# @!attribute [rw] endpoint
|
|
280
|
-
#
|
|
281
|
-
#
|
|
282
|
-
# @return [::String]
|
|
296
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
297
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
298
|
+
# @return [::String,nil]
|
|
283
299
|
# @!attribute [rw] credentials
|
|
284
300
|
# Credentials to send with calls. You may provide any of the following types:
|
|
285
301
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -325,13 +341,20 @@ module Google
|
|
|
325
341
|
# @!attribute [rw] quota_project
|
|
326
342
|
# A separate project against which to charge quota.
|
|
327
343
|
# @return [::String]
|
|
344
|
+
# @!attribute [rw] universe_domain
|
|
345
|
+
# The universe domain within which to make requests. This determines the
|
|
346
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
347
|
+
# universe (usually the default "googleapis.com" universe).
|
|
348
|
+
# @return [::String,nil]
|
|
328
349
|
#
|
|
329
350
|
class Configuration
|
|
330
351
|
extend ::Gapic::Config
|
|
331
352
|
|
|
353
|
+
# @private
|
|
354
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
332
355
|
DEFAULT_ENDPOINT = "cloudsupport.googleapis.com"
|
|
333
356
|
|
|
334
|
-
config_attr :endpoint,
|
|
357
|
+
config_attr :endpoint, nil, ::String, nil
|
|
335
358
|
config_attr :credentials, nil do |value|
|
|
336
359
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
337
360
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -346,6 +369,7 @@ module Google
|
|
|
346
369
|
config_attr :metadata, nil, ::Hash, nil
|
|
347
370
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
348
371
|
config_attr :quota_project, nil, ::String, nil
|
|
372
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
349
373
|
|
|
350
374
|
# @private
|
|
351
375
|
def initialize parent_config = nil
|
|
@@ -366,6 +390,14 @@ module Google
|
|
|
366
390
|
end
|
|
367
391
|
end
|
|
368
392
|
|
|
393
|
+
##
|
|
394
|
+
# Configuration for the channel pool
|
|
395
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
|
396
|
+
#
|
|
397
|
+
def channel_pool
|
|
398
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
|
399
|
+
end
|
|
400
|
+
|
|
369
401
|
##
|
|
370
402
|
# Configuration RPC class for the CaseAttachmentService API.
|
|
371
403
|
#
|
|
@@ -30,6 +30,9 @@ module Google
|
|
|
30
30
|
# A service to manage Google Cloud support cases.
|
|
31
31
|
#
|
|
32
32
|
class Client
|
|
33
|
+
# @private
|
|
34
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudsupport.$UNIVERSE_DOMAIN$"
|
|
35
|
+
|
|
33
36
|
include Paths
|
|
34
37
|
|
|
35
38
|
# @private
|
|
@@ -118,6 +121,15 @@ module Google
|
|
|
118
121
|
@config
|
|
119
122
|
end
|
|
120
123
|
|
|
124
|
+
##
|
|
125
|
+
# The effective universe domain
|
|
126
|
+
#
|
|
127
|
+
# @return [String]
|
|
128
|
+
#
|
|
129
|
+
def universe_domain
|
|
130
|
+
@case_service_stub.universe_domain
|
|
131
|
+
end
|
|
132
|
+
|
|
121
133
|
##
|
|
122
134
|
# Create a new CaseService client object.
|
|
123
135
|
#
|
|
@@ -151,8 +163,9 @@ module Google
|
|
|
151
163
|
credentials = @config.credentials
|
|
152
164
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
153
165
|
# but only if the default endpoint does not have a region prefix.
|
|
154
|
-
enable_self_signed_jwt = @config.endpoint
|
|
155
|
-
|
|
166
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
167
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
168
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
156
169
|
credentials ||= Credentials.default scope: @config.scope,
|
|
157
170
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
158
171
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -163,10 +176,13 @@ module Google
|
|
|
163
176
|
|
|
164
177
|
@case_service_stub = ::Gapic::ServiceStub.new(
|
|
165
178
|
::Google::Cloud::Support::V2::CaseService::Stub,
|
|
166
|
-
credentials:
|
|
167
|
-
endpoint:
|
|
179
|
+
credentials: credentials,
|
|
180
|
+
endpoint: @config.endpoint,
|
|
181
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
182
|
+
universe_domain: @config.universe_domain,
|
|
168
183
|
channel_args: @config.channel_args,
|
|
169
|
-
interceptors: @config.interceptors
|
|
184
|
+
interceptors: @config.interceptors,
|
|
185
|
+
channel_pool_config: @config.channel_pool
|
|
170
186
|
)
|
|
171
187
|
end
|
|
172
188
|
|
|
@@ -992,9 +1008,9 @@ module Google
|
|
|
992
1008
|
# end
|
|
993
1009
|
#
|
|
994
1010
|
# @!attribute [rw] endpoint
|
|
995
|
-
#
|
|
996
|
-
#
|
|
997
|
-
# @return [::String]
|
|
1011
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
1012
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
1013
|
+
# @return [::String,nil]
|
|
998
1014
|
# @!attribute [rw] credentials
|
|
999
1015
|
# Credentials to send with calls. You may provide any of the following types:
|
|
1000
1016
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -1040,13 +1056,20 @@ module Google
|
|
|
1040
1056
|
# @!attribute [rw] quota_project
|
|
1041
1057
|
# A separate project against which to charge quota.
|
|
1042
1058
|
# @return [::String]
|
|
1059
|
+
# @!attribute [rw] universe_domain
|
|
1060
|
+
# The universe domain within which to make requests. This determines the
|
|
1061
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
1062
|
+
# universe (usually the default "googleapis.com" universe).
|
|
1063
|
+
# @return [::String,nil]
|
|
1043
1064
|
#
|
|
1044
1065
|
class Configuration
|
|
1045
1066
|
extend ::Gapic::Config
|
|
1046
1067
|
|
|
1068
|
+
# @private
|
|
1069
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
1047
1070
|
DEFAULT_ENDPOINT = "cloudsupport.googleapis.com"
|
|
1048
1071
|
|
|
1049
|
-
config_attr :endpoint,
|
|
1072
|
+
config_attr :endpoint, nil, ::String, nil
|
|
1050
1073
|
config_attr :credentials, nil do |value|
|
|
1051
1074
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
1052
1075
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -1061,6 +1084,7 @@ module Google
|
|
|
1061
1084
|
config_attr :metadata, nil, ::Hash, nil
|
|
1062
1085
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
1063
1086
|
config_attr :quota_project, nil, ::String, nil
|
|
1087
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
1064
1088
|
|
|
1065
1089
|
# @private
|
|
1066
1090
|
def initialize parent_config = nil
|
|
@@ -1081,6 +1105,14 @@ module Google
|
|
|
1081
1105
|
end
|
|
1082
1106
|
end
|
|
1083
1107
|
|
|
1108
|
+
##
|
|
1109
|
+
# Configuration for the channel pool
|
|
1110
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
|
1111
|
+
#
|
|
1112
|
+
def channel_pool
|
|
1113
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
|
1114
|
+
end
|
|
1115
|
+
|
|
1084
1116
|
##
|
|
1085
1117
|
# Configuration RPC class for the CaseService API.
|
|
1086
1118
|
#
|
|
@@ -30,6 +30,9 @@ module Google
|
|
|
30
30
|
# A service to manage comments on cases.
|
|
31
31
|
#
|
|
32
32
|
class Client
|
|
33
|
+
# @private
|
|
34
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudsupport.$UNIVERSE_DOMAIN$"
|
|
35
|
+
|
|
33
36
|
include Paths
|
|
34
37
|
|
|
35
38
|
# @private
|
|
@@ -97,6 +100,15 @@ module Google
|
|
|
97
100
|
@config
|
|
98
101
|
end
|
|
99
102
|
|
|
103
|
+
##
|
|
104
|
+
# The effective universe domain
|
|
105
|
+
#
|
|
106
|
+
# @return [String]
|
|
107
|
+
#
|
|
108
|
+
def universe_domain
|
|
109
|
+
@comment_service_stub.universe_domain
|
|
110
|
+
end
|
|
111
|
+
|
|
100
112
|
##
|
|
101
113
|
# Create a new CommentService client object.
|
|
102
114
|
#
|
|
@@ -130,8 +142,9 @@ module Google
|
|
|
130
142
|
credentials = @config.credentials
|
|
131
143
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
132
144
|
# but only if the default endpoint does not have a region prefix.
|
|
133
|
-
enable_self_signed_jwt = @config.endpoint
|
|
134
|
-
|
|
145
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
146
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
147
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
135
148
|
credentials ||= Credentials.default scope: @config.scope,
|
|
136
149
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
137
150
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -142,10 +155,13 @@ module Google
|
|
|
142
155
|
|
|
143
156
|
@comment_service_stub = ::Gapic::ServiceStub.new(
|
|
144
157
|
::Google::Cloud::Support::V2::CommentService::Stub,
|
|
145
|
-
credentials:
|
|
146
|
-
endpoint:
|
|
158
|
+
credentials: credentials,
|
|
159
|
+
endpoint: @config.endpoint,
|
|
160
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
161
|
+
universe_domain: @config.universe_domain,
|
|
147
162
|
channel_args: @config.channel_args,
|
|
148
|
-
interceptors: @config.interceptors
|
|
163
|
+
interceptors: @config.interceptors,
|
|
164
|
+
channel_pool_config: @config.channel_pool
|
|
149
165
|
)
|
|
150
166
|
end
|
|
151
167
|
|
|
@@ -365,9 +381,9 @@ module Google
|
|
|
365
381
|
# end
|
|
366
382
|
#
|
|
367
383
|
# @!attribute [rw] endpoint
|
|
368
|
-
#
|
|
369
|
-
#
|
|
370
|
-
# @return [::String]
|
|
384
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
385
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
386
|
+
# @return [::String,nil]
|
|
371
387
|
# @!attribute [rw] credentials
|
|
372
388
|
# Credentials to send with calls. You may provide any of the following types:
|
|
373
389
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -413,13 +429,20 @@ module Google
|
|
|
413
429
|
# @!attribute [rw] quota_project
|
|
414
430
|
# A separate project against which to charge quota.
|
|
415
431
|
# @return [::String]
|
|
432
|
+
# @!attribute [rw] universe_domain
|
|
433
|
+
# The universe domain within which to make requests. This determines the
|
|
434
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
435
|
+
# universe (usually the default "googleapis.com" universe).
|
|
436
|
+
# @return [::String,nil]
|
|
416
437
|
#
|
|
417
438
|
class Configuration
|
|
418
439
|
extend ::Gapic::Config
|
|
419
440
|
|
|
441
|
+
# @private
|
|
442
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
420
443
|
DEFAULT_ENDPOINT = "cloudsupport.googleapis.com"
|
|
421
444
|
|
|
422
|
-
config_attr :endpoint,
|
|
445
|
+
config_attr :endpoint, nil, ::String, nil
|
|
423
446
|
config_attr :credentials, nil do |value|
|
|
424
447
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
425
448
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -434,6 +457,7 @@ module Google
|
|
|
434
457
|
config_attr :metadata, nil, ::Hash, nil
|
|
435
458
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
436
459
|
config_attr :quota_project, nil, ::String, nil
|
|
460
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
437
461
|
|
|
438
462
|
# @private
|
|
439
463
|
def initialize parent_config = nil
|
|
@@ -454,6 +478,14 @@ module Google
|
|
|
454
478
|
end
|
|
455
479
|
end
|
|
456
480
|
|
|
481
|
+
##
|
|
482
|
+
# Configuration for the channel pool
|
|
483
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
|
484
|
+
#
|
|
485
|
+
def channel_pool
|
|
486
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
|
487
|
+
end
|
|
488
|
+
|
|
457
489
|
##
|
|
458
490
|
# Configuration RPC class for the CommentService API.
|
|
459
491
|
#
|
|
@@ -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
|
|
@@ -304,6 +305,19 @@ module Google
|
|
|
304
305
|
# seconds: 360 # 6 minutes
|
|
305
306
|
# total_poll_timeout:
|
|
306
307
|
# seconds: 54000 # 90 minutes
|
|
308
|
+
# @!attribute [rw] auto_populated_fields
|
|
309
|
+
# @return [::Array<::String>]
|
|
310
|
+
# List of top-level fields of the request message, that should be
|
|
311
|
+
# automatically populated by the client libraries based on their
|
|
312
|
+
# (google.api.field_info).format. Currently supported format: UUID4.
|
|
313
|
+
#
|
|
314
|
+
# Example of a YAML configuration:
|
|
315
|
+
#
|
|
316
|
+
# publishing:
|
|
317
|
+
# method_settings:
|
|
318
|
+
# - selector: google.example.v1.ExampleService.CreateExample
|
|
319
|
+
# auto_populated_fields:
|
|
320
|
+
# - request_id
|
|
307
321
|
class MethodSettings
|
|
308
322
|
include ::Google::Protobuf::MessageExts
|
|
309
323
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -66,6 +66,20 @@ module Google
|
|
|
66
66
|
# a non-empty value will be returned. The user will not be aware of what
|
|
67
67
|
# non-empty value to expect.
|
|
68
68
|
NON_EMPTY_DEFAULT = 7
|
|
69
|
+
|
|
70
|
+
# Denotes that the field in a resource (a message annotated with
|
|
71
|
+
# google.api.resource) is used in the resource name to uniquely identify the
|
|
72
|
+
# resource. For AIP-compliant APIs, this should only be applied to the
|
|
73
|
+
# `name` field on the resource.
|
|
74
|
+
#
|
|
75
|
+
# This behavior should not be applied to references to other resources within
|
|
76
|
+
# the message.
|
|
77
|
+
#
|
|
78
|
+
# The identifier field of resources often have different field behavior
|
|
79
|
+
# depending on the request it is embedded in (e.g. for Create methods name
|
|
80
|
+
# is optional and unused, while for Update methods it is required). Instead
|
|
81
|
+
# of method-specific annotations, only `IDENTIFIER` is required.
|
|
82
|
+
IDENTIFIER = 8
|
|
69
83
|
end
|
|
70
84
|
end
|
|
71
85
|
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-support-v2
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.3.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:
|
|
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
|
|
@@ -230,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
230
230
|
- !ruby/object:Gem::Version
|
|
231
231
|
version: '0'
|
|
232
232
|
requirements: []
|
|
233
|
-
rubygems_version: 3.
|
|
233
|
+
rubygems_version: 3.5.3
|
|
234
234
|
signing_key:
|
|
235
235
|
specification_version: 4
|
|
236
236
|
summary: Manages Google Cloud technical support cases for Customer Care support offerings.
|