google-cloud-channel-v1 0.22.0 → 0.23.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +72 -101
- data/lib/google/cloud/channel/v1/cloud_channel_reports_service/client.rb +57 -8
- data/lib/google/cloud/channel/v1/cloud_channel_reports_service/operations.rb +28 -6
- data/lib/google/cloud/channel/v1/cloud_channel_reports_service/rest/client.rb +52 -7
- data/lib/google/cloud/channel/v1/cloud_channel_reports_service/rest/operations.rb +33 -8
- data/lib/google/cloud/channel/v1/cloud_channel_reports_service/rest/service_stub.rb +15 -2
- data/lib/google/cloud/channel/v1/cloud_channel_reports_service/rest.rb +5 -0
- data/lib/google/cloud/channel/v1/cloud_channel_reports_service.rb +7 -0
- data/lib/google/cloud/channel/v1/cloud_channel_service/client.rb +32 -8
- data/lib/google/cloud/channel/v1/cloud_channel_service/operations.rb +28 -6
- data/lib/google/cloud/channel/v1/cloud_channel_service/rest/client.rb +34 -7
- data/lib/google/cloud/channel/v1/cloud_channel_service/rest/operations.rb +33 -8
- data/lib/google/cloud/channel/v1/cloud_channel_service/rest/service_stub.rb +14 -2
- data/lib/google/cloud/channel/v1/reports_service_pb.rb +1 -1
- data/lib/google/cloud/channel/v1/reports_service_services_pb.rb +17 -0
- data/lib/google/cloud/channel/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -0
- data/proto_docs/google/cloud/channel/v1/reports_service.rb +14 -0
- data/proto_docs/google/cloud/channel/v1/repricing.rb +2 -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: df8f72b28d724ede575377cf56eb9cfe7e4415fa423f08b5acc3b548a43c54ed
|
4
|
+
data.tar.gz: 581cbc8b6e42a188e158dbd442cea8417924c147a43079b1602573a5e6d3f107
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9ecdab305ea1cae400ed3d48a910ef9362ca7b0412500edf738125054a40436b33002581828084cd7f16d6bbf5e7a15b0be254b7d67daa4ccb0ff44ac556703f
|
7
|
+
data.tar.gz: 8fd8e76505f66ae2cb11f7f8514522bc04b24e93e0258cb5295399656c0d9b811fbe27da1c0bce5124ba0486cc2f43f2f7c1305e12311378811b13d4c2185745
|
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-channel-v1 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-channel-v1 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-channel-v1 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::Channel::V1::CloudChannelReportsService::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/channel/v1"
|
77
|
-
|
78
|
-
ENV["CHANNEL_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/channel/v1"
|
90
58
|
|
91
59
|
client = ::Google::Cloud::Channel::V1::CloudChannelReportsService::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/channel/v1"
|
100
68
|
|
101
69
|
::Google::Cloud::Channel::V1::CloudChannelReportsService::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::Channel::V1::CloudChannelReportsService::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-channel-v1
|
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/channel/v1"
|
124
100
|
|
125
|
-
|
126
|
-
connect to the APIs. You will use the **JSON key file** to
|
127
|
-
connect to most services with google-cloud-channel-v1.
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
128
102
|
|
129
|
-
|
130
|
-
|
131
|
-
need a Google Developers service account.
|
103
|
+
client = ::Google::Cloud::Channel::V1::CloudChannelReportsService::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,7 +31,15 @@ module Google
|
|
31
31
|
# distributors retrieve and combine a variety of data in Cloud Channel for
|
32
32
|
# multiple products (Google Cloud, Google Voice, and Google Workspace.)
|
33
33
|
#
|
34
|
+
# Deprecated: This service is being deprecated. Please use [Export Channel
|
35
|
+
# Services data to
|
36
|
+
# BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery)
|
37
|
+
# instead.
|
38
|
+
#
|
34
39
|
class Client
|
40
|
+
# @private
|
41
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudchannel.$UNIVERSE_DOMAIN$"
|
42
|
+
|
35
43
|
include Paths
|
36
44
|
|
37
45
|
# @private
|
@@ -43,6 +51,8 @@ module Google
|
|
43
51
|
# See {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client::Configuration}
|
44
52
|
# for a description of the configuration fields.
|
45
53
|
#
|
54
|
+
# @deprecated This service is deprecated and may be removed in the next major version update.
|
55
|
+
#
|
46
56
|
# @example
|
47
57
|
#
|
48
58
|
# # Modify the configuration for all CloudChannelReportsService clients
|
@@ -92,6 +102,15 @@ module Google
|
|
92
102
|
@config
|
93
103
|
end
|
94
104
|
|
105
|
+
##
|
106
|
+
# The effective universe domain
|
107
|
+
#
|
108
|
+
# @return [String]
|
109
|
+
#
|
110
|
+
def universe_domain
|
111
|
+
@cloud_channel_reports_service_stub.universe_domain
|
112
|
+
end
|
113
|
+
|
95
114
|
##
|
96
115
|
# Create a new CloudChannelReportsService client object.
|
97
116
|
#
|
@@ -125,8 +144,9 @@ module Google
|
|
125
144
|
credentials = @config.credentials
|
126
145
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
127
146
|
# but only if the default endpoint does not have a region prefix.
|
128
|
-
enable_self_signed_jwt = @config.endpoint
|
129
|
-
|
147
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
148
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
149
|
+
!@config.endpoint.split(".").first.include?("-"))
|
130
150
|
credentials ||= Credentials.default scope: @config.scope,
|
131
151
|
enable_self_signed_jwt: enable_self_signed_jwt
|
132
152
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
@@ -139,12 +159,15 @@ module Google
|
|
139
159
|
config.credentials = credentials
|
140
160
|
config.quota_project = @quota_project_id
|
141
161
|
config.endpoint = @config.endpoint
|
162
|
+
config.universe_domain = @config.universe_domain
|
142
163
|
end
|
143
164
|
|
144
165
|
@cloud_channel_reports_service_stub = ::Gapic::ServiceStub.new(
|
145
166
|
::Google::Cloud::Channel::V1::CloudChannelReportsService::Stub,
|
146
|
-
credentials:
|
147
|
-
endpoint:
|
167
|
+
credentials: credentials,
|
168
|
+
endpoint: @config.endpoint,
|
169
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
170
|
+
universe_domain: @config.universe_domain,
|
148
171
|
channel_args: @config.channel_args,
|
149
172
|
interceptors: @config.interceptors,
|
150
173
|
channel_pool_config: @config.channel_pool
|
@@ -187,6 +210,12 @@ module Google
|
|
187
210
|
# with the
|
188
211
|
# {::Google::Cloud::Channel::V1::RunReportJobResponse#report_job RunReportJobResponse.report_job}.
|
189
212
|
#
|
213
|
+
# Deprecated: Please use [Export Channel Services data to
|
214
|
+
# BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery)
|
215
|
+
# instead.
|
216
|
+
#
|
217
|
+
# @deprecated This method is deprecated and may be removed in the next major version update.
|
218
|
+
#
|
190
219
|
# @overload run_report_job(request, options = nil)
|
191
220
|
# Pass arguments to `run_report_job` via a request object, either of type
|
192
221
|
# {::Google::Cloud::Channel::V1::RunReportJobRequest} or an equivalent Hash.
|
@@ -303,6 +332,12 @@ module Google
|
|
303
332
|
# Retrieves data generated by
|
304
333
|
# {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#run_report_job CloudChannelReportsService.RunReportJob}.
|
305
334
|
#
|
335
|
+
# Deprecated: Please use [Export Channel Services data to
|
336
|
+
# BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery)
|
337
|
+
# instead.
|
338
|
+
#
|
339
|
+
# @deprecated This method is deprecated and may be removed in the next major version update.
|
340
|
+
#
|
306
341
|
# @overload fetch_report_results(request, options = nil)
|
307
342
|
# Pass arguments to `fetch_report_results` via a request object, either of type
|
308
343
|
# {::Google::Cloud::Channel::V1::FetchReportResultsRequest} or an equivalent Hash.
|
@@ -414,6 +449,12 @@ module Google
|
|
414
449
|
# Lists the reports that RunReportJob can run. These reports include an ID,
|
415
450
|
# a description, and the list of columns that will be in the result.
|
416
451
|
#
|
452
|
+
# Deprecated: Please use [Export Channel Services data to
|
453
|
+
# BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery)
|
454
|
+
# instead.
|
455
|
+
#
|
456
|
+
# @deprecated This method is deprecated and may be removed in the next major version update.
|
457
|
+
#
|
417
458
|
# @overload list_reports(request, options = nil)
|
418
459
|
# Pass arguments to `list_reports` via a request object, either of type
|
419
460
|
# {::Google::Cloud::Channel::V1::ListReportsRequest} or an equivalent Hash.
|
@@ -548,9 +589,9 @@ module Google
|
|
548
589
|
# end
|
549
590
|
#
|
550
591
|
# @!attribute [rw] endpoint
|
551
|
-
#
|
552
|
-
#
|
553
|
-
# @return [::String]
|
592
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
593
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
594
|
+
# @return [::String,nil]
|
554
595
|
# @!attribute [rw] credentials
|
555
596
|
# Credentials to send with calls. You may provide any of the following types:
|
556
597
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -596,13 +637,20 @@ module Google
|
|
596
637
|
# @!attribute [rw] quota_project
|
597
638
|
# A separate project against which to charge quota.
|
598
639
|
# @return [::String]
|
640
|
+
# @!attribute [rw] universe_domain
|
641
|
+
# The universe domain within which to make requests. This determines the
|
642
|
+
# default endpoint URL. The default value of nil uses the environment
|
643
|
+
# universe (usually the default "googleapis.com" universe).
|
644
|
+
# @return [::String,nil]
|
599
645
|
#
|
600
646
|
class Configuration
|
601
647
|
extend ::Gapic::Config
|
602
648
|
|
649
|
+
# @private
|
650
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
603
651
|
DEFAULT_ENDPOINT = "cloudchannel.googleapis.com"
|
604
652
|
|
605
|
-
config_attr :endpoint,
|
653
|
+
config_attr :endpoint, nil, ::String, nil
|
606
654
|
config_attr :credentials, nil do |value|
|
607
655
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
608
656
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
@@ -617,6 +665,7 @@ module Google
|
|
617
665
|
config_attr :metadata, nil, ::Hash, nil
|
618
666
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
619
667
|
config_attr :quota_project, nil, ::String, nil
|
668
|
+
config_attr :universe_domain, nil, ::String, nil
|
620
669
|
|
621
670
|
# @private
|
622
671
|
def initialize parent_config = nil
|
@@ -26,6 +26,9 @@ module Google
|
|
26
26
|
module CloudChannelReportsService
|
27
27
|
# Service that implements Longrunning Operations API.
|
28
28
|
class Operations
|
29
|
+
# @private
|
30
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudchannel.$UNIVERSE_DOMAIN$"
|
31
|
+
|
29
32
|
# @private
|
30
33
|
attr_reader :operations_stub
|
31
34
|
|
@@ -60,6 +63,15 @@ module Google
|
|
60
63
|
@config
|
61
64
|
end
|
62
65
|
|
66
|
+
##
|
67
|
+
# The effective universe domain
|
68
|
+
#
|
69
|
+
# @return [String]
|
70
|
+
#
|
71
|
+
def universe_domain
|
72
|
+
@operations_stub.universe_domain
|
73
|
+
end
|
74
|
+
|
63
75
|
##
|
64
76
|
# Create a new Operations client object.
|
65
77
|
#
|
@@ -90,8 +102,10 @@ module Google
|
|
90
102
|
|
91
103
|
@operations_stub = ::Gapic::ServiceStub.new(
|
92
104
|
::Google::Longrunning::Operations::Stub,
|
93
|
-
credentials:
|
94
|
-
endpoint:
|
105
|
+
credentials: credentials,
|
106
|
+
endpoint: @config.endpoint,
|
107
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
108
|
+
universe_domain: @config.universe_domain,
|
95
109
|
channel_args: @config.channel_args,
|
96
110
|
interceptors: @config.interceptors,
|
97
111
|
channel_pool_config: @config.channel_pool
|
@@ -613,9 +627,9 @@ module Google
|
|
613
627
|
# end
|
614
628
|
#
|
615
629
|
# @!attribute [rw] endpoint
|
616
|
-
#
|
617
|
-
#
|
618
|
-
# @return [::String]
|
630
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
631
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
632
|
+
# @return [::String,nil]
|
619
633
|
# @!attribute [rw] credentials
|
620
634
|
# Credentials to send with calls. You may provide any of the following types:
|
621
635
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -661,13 +675,20 @@ module Google
|
|
661
675
|
# @!attribute [rw] quota_project
|
662
676
|
# A separate project against which to charge quota.
|
663
677
|
# @return [::String]
|
678
|
+
# @!attribute [rw] universe_domain
|
679
|
+
# The universe domain within which to make requests. This determines the
|
680
|
+
# default endpoint URL. The default value of nil uses the environment
|
681
|
+
# universe (usually the default "googleapis.com" universe).
|
682
|
+
# @return [::String,nil]
|
664
683
|
#
|
665
684
|
class Configuration
|
666
685
|
extend ::Gapic::Config
|
667
686
|
|
687
|
+
# @private
|
688
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
668
689
|
DEFAULT_ENDPOINT = "cloudchannel.googleapis.com"
|
669
690
|
|
670
|
-
config_attr :endpoint,
|
691
|
+
config_attr :endpoint, nil, ::String, nil
|
671
692
|
config_attr :credentials, nil do |value|
|
672
693
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
673
694
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
@@ -682,6 +703,7 @@ module Google
|
|
682
703
|
config_attr :metadata, nil, ::Hash, nil
|
683
704
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
684
705
|
config_attr :quota_project, nil, ::String, nil
|
706
|
+
config_attr :universe_domain, nil, ::String, nil
|
685
707
|
|
686
708
|
# @private
|
687
709
|
def initialize parent_config = nil
|
@@ -33,7 +33,15 @@ module Google
|
|
33
33
|
# distributors retrieve and combine a variety of data in Cloud Channel for
|
34
34
|
# multiple products (Google Cloud, Google Voice, and Google Workspace.)
|
35
35
|
#
|
36
|
+
# Deprecated: This service is being deprecated. Please use [Export Channel
|
37
|
+
# Services data to
|
38
|
+
# BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery)
|
39
|
+
# instead.
|
40
|
+
#
|
36
41
|
class Client
|
42
|
+
# @private
|
43
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudchannel.$UNIVERSE_DOMAIN$"
|
44
|
+
|
37
45
|
include Paths
|
38
46
|
|
39
47
|
# @private
|
@@ -44,6 +52,7 @@ module Google
|
|
44
52
|
#
|
45
53
|
# See {::Google::Cloud::Channel::V1::CloudChannelReportsService::Rest::Client::Configuration}
|
46
54
|
# for a description of the configuration fields.
|
55
|
+
# @deprecated This service is deprecated and may be removed in the next major version update.
|
47
56
|
#
|
48
57
|
# @example
|
49
58
|
#
|
@@ -94,6 +103,15 @@ module Google
|
|
94
103
|
@config
|
95
104
|
end
|
96
105
|
|
106
|
+
##
|
107
|
+
# The effective universe domain
|
108
|
+
#
|
109
|
+
# @return [String]
|
110
|
+
#
|
111
|
+
def universe_domain
|
112
|
+
@cloud_channel_reports_service_stub.universe_domain
|
113
|
+
end
|
114
|
+
|
97
115
|
##
|
98
116
|
# Create a new CloudChannelReportsService REST client object.
|
99
117
|
#
|
@@ -121,8 +139,9 @@ module Google
|
|
121
139
|
credentials = @config.credentials
|
122
140
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
123
141
|
# but only if the default endpoint does not have a region prefix.
|
124
|
-
enable_self_signed_jwt = @config.endpoint
|
125
|
-
|
142
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
143
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
144
|
+
!@config.endpoint.split(".").first.include?("-"))
|
126
145
|
credentials ||= Credentials.default scope: @config.scope,
|
127
146
|
enable_self_signed_jwt: enable_self_signed_jwt
|
128
147
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
@@ -136,9 +155,15 @@ module Google
|
|
136
155
|
config.credentials = credentials
|
137
156
|
config.quota_project = @quota_project_id
|
138
157
|
config.endpoint = @config.endpoint
|
158
|
+
config.universe_domain = @config.universe_domain
|
139
159
|
end
|
140
160
|
|
141
|
-
@cloud_channel_reports_service_stub = ::Google::Cloud::Channel::V1::CloudChannelReportsService::Rest::ServiceStub.new
|
161
|
+
@cloud_channel_reports_service_stub = ::Google::Cloud::Channel::V1::CloudChannelReportsService::Rest::ServiceStub.new(
|
162
|
+
endpoint: @config.endpoint,
|
163
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
164
|
+
universe_domain: @config.universe_domain,
|
165
|
+
credentials: credentials
|
166
|
+
)
|
142
167
|
end
|
143
168
|
|
144
169
|
##
|
@@ -177,6 +202,10 @@ module Google
|
|
177
202
|
# with the
|
178
203
|
# {::Google::Cloud::Channel::V1::RunReportJobResponse#report_job RunReportJobResponse.report_job}.
|
179
204
|
#
|
205
|
+
# Deprecated: Please use [Export Channel Services data to
|
206
|
+
# BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery)
|
207
|
+
# instead.
|
208
|
+
#
|
180
209
|
# @overload run_report_job(request, options = nil)
|
181
210
|
# Pass arguments to `run_report_job` via a request object, either of type
|
182
211
|
# {::Google::Cloud::Channel::V1::RunReportJobRequest} or an equivalent Hash.
|
@@ -286,6 +315,10 @@ module Google
|
|
286
315
|
# Retrieves data generated by
|
287
316
|
# {::Google::Cloud::Channel::V1::CloudChannelReportsService::Rest::Client#run_report_job CloudChannelReportsService.RunReportJob}.
|
288
317
|
#
|
318
|
+
# Deprecated: Please use [Export Channel Services data to
|
319
|
+
# BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery)
|
320
|
+
# instead.
|
321
|
+
#
|
289
322
|
# @overload fetch_report_results(request, options = nil)
|
290
323
|
# Pass arguments to `fetch_report_results` via a request object, either of type
|
291
324
|
# {::Google::Cloud::Channel::V1::FetchReportResultsRequest} or an equivalent Hash.
|
@@ -390,6 +423,10 @@ module Google
|
|
390
423
|
# Lists the reports that RunReportJob can run. These reports include an ID,
|
391
424
|
# a description, and the list of columns that will be in the result.
|
392
425
|
#
|
426
|
+
# Deprecated: Please use [Export Channel Services data to
|
427
|
+
# BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery)
|
428
|
+
# instead.
|
429
|
+
#
|
393
430
|
# @overload list_reports(request, options = nil)
|
394
431
|
# Pass arguments to `list_reports` via a request object, either of type
|
395
432
|
# {::Google::Cloud::Channel::V1::ListReportsRequest} or an equivalent Hash.
|
@@ -517,9 +554,9 @@ module Google
|
|
517
554
|
# end
|
518
555
|
#
|
519
556
|
# @!attribute [rw] endpoint
|
520
|
-
#
|
521
|
-
#
|
522
|
-
# @return [::String]
|
557
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
558
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
559
|
+
# @return [::String,nil]
|
523
560
|
# @!attribute [rw] credentials
|
524
561
|
# Credentials to send with calls. You may provide any of the following types:
|
525
562
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -556,13 +593,20 @@ module Google
|
|
556
593
|
# @!attribute [rw] quota_project
|
557
594
|
# A separate project against which to charge quota.
|
558
595
|
# @return [::String]
|
596
|
+
# @!attribute [rw] universe_domain
|
597
|
+
# The universe domain within which to make requests. This determines the
|
598
|
+
# default endpoint URL. The default value of nil uses the environment
|
599
|
+
# universe (usually the default "googleapis.com" universe).
|
600
|
+
# @return [::String,nil]
|
559
601
|
#
|
560
602
|
class Configuration
|
561
603
|
extend ::Gapic::Config
|
562
604
|
|
605
|
+
# @private
|
606
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
563
607
|
DEFAULT_ENDPOINT = "cloudchannel.googleapis.com"
|
564
608
|
|
565
|
-
config_attr :endpoint,
|
609
|
+
config_attr :endpoint, nil, ::String, nil
|
566
610
|
config_attr :credentials, nil do |value|
|
567
611
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
568
612
|
allowed.any? { |klass| klass === value }
|
@@ -574,6 +618,7 @@ module Google
|
|
574
618
|
config_attr :metadata, nil, ::Hash, nil
|
575
619
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
576
620
|
config_attr :quota_project, nil, ::String, nil
|
621
|
+
config_attr :universe_domain, nil, ::String, nil
|
577
622
|
|
578
623
|
# @private
|
579
624
|
def initialize parent_config = nil
|