google-cloud-channel-v1 0.22.1 → 0.23.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3b80a4dcdca9f823d4e0b883c1763ac190fc1f13e1c7a703d362a11542eba207
4
- data.tar.gz: 3bf12e8c63942f31368c226fd3d23b952f6f1a72096e0e3dd98b3ca02ca933db
3
+ metadata.gz: df8f72b28d724ede575377cf56eb9cfe7e4415fa423f08b5acc3b548a43c54ed
4
+ data.tar.gz: 581cbc8b6e42a188e158dbd442cea8417924c147a43079b1602573a5e6d3f107
5
5
  SHA512:
6
- metadata.gz: e6098f15c53368da8a68caa30efbc0c04bbb1b7cd1b4e03668fd4cf0bb4fed0180cc5eff56d635ff9ad9654ecabe64f2ea46d1f9331b924c47bed2b28665b2dc
7
- data.tar.gz: 8e1dc2c27e8207c0584376399de949a9f4f6b4d8200c6bd771361fff0bb5b7995d285192281d007f59718b6806c7bc408d4ba231fc9515ac584af7d17293abcc
6
+ metadata.gz: 9ecdab305ea1cae400ed3d48a910ef9362ca7b0412500edf738125054a40436b33002581828084cd7f16d6bbf5e7a15b0be254b7d67daa4ccb0ff44ac556703f
7
+ data.tar.gz: 8fd8e76505f66ae2cb11f7f8514522bc04b24e93e0258cb5295399656c0d9b811fbe27da1c0bce5124ba0486cc2f43f2f7c1305e12311378811b13d4c2185745
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-channel-v1 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
- 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
- 1. [Create a service account and credentials](#creating-a-service-account).
19
- 2. Set the [environment variable](#environment-variables).
9
+ The following example shows how to set up authentication for a local development
10
+ environment with your user credentials.
20
11
 
21
- ```sh
22
- export CHANNEL_CREDENTIALS=path/to/keyfile.json
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
- ```ruby
28
- require "google/cloud/channel/v1"
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
- client = ::Google::Cloud::Channel::V1::CloudChannelReportsService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
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
- 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.
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
- ### Environment Variables
27
+ ## Credential Lookup
56
28
 
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.
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
- The environment variables that google-cloud-channel-v1
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
- * `CHANNEL_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `CHANNEL_KEYFILE` - Path to JSON file, or JSON contents
71
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
- * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
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
- ```ruby
76
- require "google/cloud/channel/v1"
77
-
78
- ENV["CHANNEL_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::Channel::V1::CloudChannelReportsService::Client.new
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
- ### Configuration
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
- The path to the **Credentials JSON** file can be configured instead of storing
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/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
93
61
  end
94
62
  ```
95
63
 
96
- Or globally for all clients:
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/keyfile.json"
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
- ### Cloud SDK
76
+ ### Environment Variables
109
77
 
110
- This option allows for an easy way to authenticate during development. If
111
- credentials are not provided in code or in environment variables, then Cloud SDK
112
- credentials are discovered.
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
- To configure your system for this, simply:
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
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
118
- 3. Write code as if already authenticated.
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
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
121
- *should* only be used during development.
95
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
96
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
122
97
 
123
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/channel/v1"
124
100
 
125
- Google Cloud requires **Service Account Credentials** to
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
- If you are not running this client within
130
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
131
- need a Google Developers service account.
103
+ client = ::Google::Cloud::Channel::V1::CloudChannelReportsService::Client.new
104
+ ```
132
105
 
133
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
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
- *Note: You may need to enable billing in order to use these services.*
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
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
141
113
 
142
- Find the "Create credentials" drop down near the top of the page, and select
143
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
144
115
 
145
- If you want to re-use an existing service account, you can easily generate a
146
- new key file. Just select the account you wish to re-use, click the pencil
147
- tool on the right side to edit the service account, select the **Keys** tab,
148
- and then select **Add Key**.
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
- The key file you download will be used by this library to authenticate API
151
- requests and should be stored in a secure location.
121
+ For more information, see
122
+ [Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
@@ -37,6 +37,9 @@ module Google
37
37
  # instead.
38
38
  #
39
39
  class Client
40
+ # @private
41
+ DEFAULT_ENDPOINT_TEMPLATE = "cloudchannel.$UNIVERSE_DOMAIN$"
42
+
40
43
  include Paths
41
44
 
42
45
  # @private
@@ -99,6 +102,15 @@ module Google
99
102
  @config
100
103
  end
101
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
+
102
114
  ##
103
115
  # Create a new CloudChannelReportsService client object.
104
116
  #
@@ -132,8 +144,9 @@ module Google
132
144
  credentials = @config.credentials
133
145
  # Use self-signed JWT if the endpoint is unchanged from default,
134
146
  # but only if the default endpoint does not have a region prefix.
135
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
136
- !@config.endpoint.split(".").first.include?("-")
147
+ enable_self_signed_jwt = @config.endpoint.nil? ||
148
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
149
+ !@config.endpoint.split(".").first.include?("-"))
137
150
  credentials ||= Credentials.default scope: @config.scope,
138
151
  enable_self_signed_jwt: enable_self_signed_jwt
139
152
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -146,12 +159,15 @@ module Google
146
159
  config.credentials = credentials
147
160
  config.quota_project = @quota_project_id
148
161
  config.endpoint = @config.endpoint
162
+ config.universe_domain = @config.universe_domain
149
163
  end
150
164
 
151
165
  @cloud_channel_reports_service_stub = ::Gapic::ServiceStub.new(
152
166
  ::Google::Cloud::Channel::V1::CloudChannelReportsService::Stub,
153
- credentials: credentials,
154
- endpoint: @config.endpoint,
167
+ credentials: credentials,
168
+ endpoint: @config.endpoint,
169
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
170
+ universe_domain: @config.universe_domain,
155
171
  channel_args: @config.channel_args,
156
172
  interceptors: @config.interceptors,
157
173
  channel_pool_config: @config.channel_pool
@@ -573,9 +589,9 @@ module Google
573
589
  # end
574
590
  #
575
591
  # @!attribute [rw] endpoint
576
- # The hostname or hostname:port of the service endpoint.
577
- # Defaults to `"cloudchannel.googleapis.com"`.
578
- # @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]
579
595
  # @!attribute [rw] credentials
580
596
  # Credentials to send with calls. You may provide any of the following types:
581
597
  # * (`String`) The path to a service account key file in JSON format
@@ -621,13 +637,20 @@ module Google
621
637
  # @!attribute [rw] quota_project
622
638
  # A separate project against which to charge quota.
623
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]
624
645
  #
625
646
  class Configuration
626
647
  extend ::Gapic::Config
627
648
 
649
+ # @private
650
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
628
651
  DEFAULT_ENDPOINT = "cloudchannel.googleapis.com"
629
652
 
630
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
653
+ config_attr :endpoint, nil, ::String, nil
631
654
  config_attr :credentials, nil do |value|
632
655
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
633
656
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -642,6 +665,7 @@ module Google
642
665
  config_attr :metadata, nil, ::Hash, nil
643
666
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
644
667
  config_attr :quota_project, nil, ::String, nil
668
+ config_attr :universe_domain, nil, ::String, nil
645
669
 
646
670
  # @private
647
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: credentials,
94
- endpoint: @config.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
- # The hostname or hostname:port of the service endpoint.
617
- # Defaults to `"cloudchannel.googleapis.com"`.
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, DEFAULT_ENDPOINT, ::String
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
@@ -39,6 +39,9 @@ module Google
39
39
  # instead.
40
40
  #
41
41
  class Client
42
+ # @private
43
+ DEFAULT_ENDPOINT_TEMPLATE = "cloudchannel.$UNIVERSE_DOMAIN$"
44
+
42
45
  include Paths
43
46
 
44
47
  # @private
@@ -49,7 +52,6 @@ module Google
49
52
  #
50
53
  # See {::Google::Cloud::Channel::V1::CloudChannelReportsService::Rest::Client::Configuration}
51
54
  # for a description of the configuration fields.
52
- #
53
55
  # @deprecated This service is deprecated and may be removed in the next major version update.
54
56
  #
55
57
  # @example
@@ -101,6 +103,15 @@ module Google
101
103
  @config
102
104
  end
103
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
+
104
115
  ##
105
116
  # Create a new CloudChannelReportsService REST client object.
106
117
  #
@@ -128,8 +139,9 @@ module Google
128
139
  credentials = @config.credentials
129
140
  # Use self-signed JWT if the endpoint is unchanged from default,
130
141
  # but only if the default endpoint does not have a region prefix.
131
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
132
- !@config.endpoint.split(".").first.include?("-")
142
+ enable_self_signed_jwt = @config.endpoint.nil? ||
143
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
144
+ !@config.endpoint.split(".").first.include?("-"))
133
145
  credentials ||= Credentials.default scope: @config.scope,
134
146
  enable_self_signed_jwt: enable_self_signed_jwt
135
147
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -143,9 +155,15 @@ module Google
143
155
  config.credentials = credentials
144
156
  config.quota_project = @quota_project_id
145
157
  config.endpoint = @config.endpoint
158
+ config.universe_domain = @config.universe_domain
146
159
  end
147
160
 
148
- @cloud_channel_reports_service_stub = ::Google::Cloud::Channel::V1::CloudChannelReportsService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
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
+ )
149
167
  end
150
168
 
151
169
  ##
@@ -536,9 +554,9 @@ module Google
536
554
  # end
537
555
  #
538
556
  # @!attribute [rw] endpoint
539
- # The hostname or hostname:port of the service endpoint.
540
- # Defaults to `"cloudchannel.googleapis.com"`.
541
- # @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]
542
560
  # @!attribute [rw] credentials
543
561
  # Credentials to send with calls. You may provide any of the following types:
544
562
  # * (`String`) The path to a service account key file in JSON format
@@ -575,13 +593,20 @@ module Google
575
593
  # @!attribute [rw] quota_project
576
594
  # A separate project against which to charge quota.
577
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]
578
601
  #
579
602
  class Configuration
580
603
  extend ::Gapic::Config
581
604
 
605
+ # @private
606
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
582
607
  DEFAULT_ENDPOINT = "cloudchannel.googleapis.com"
583
608
 
584
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
609
+ config_attr :endpoint, nil, ::String, nil
585
610
  config_attr :credentials, nil do |value|
586
611
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
587
612
  allowed.any? { |klass| klass === value }
@@ -593,6 +618,7 @@ module Google
593
618
  config_attr :metadata, nil, ::Hash, nil
594
619
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
595
620
  config_attr :quota_project, nil, ::String, nil
621
+ config_attr :universe_domain, nil, ::String, nil
596
622
 
597
623
  # @private
598
624
  def initialize parent_config = nil
@@ -26,6 +26,9 @@ module Google
26
26
  module Rest
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
  #
@@ -84,8 +96,10 @@ module Google
84
96
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
85
97
 
86
98
  @operations_stub = OperationsServiceStub.new(
87
- endpoint: @config.endpoint,
88
- credentials: credentials
99
+ endpoint: @config.endpoint,
100
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
101
+ universe_domain: @config.universe_domain,
102
+ credentials: credentials
89
103
  )
90
104
 
91
105
  # Used by an LRO wrapper for some methods of this service
@@ -478,9 +492,9 @@ module Google
478
492
  # end
479
493
  #
480
494
  # @!attribute [rw] endpoint
481
- # The hostname or hostname:port of the service endpoint.
482
- # Defaults to `"cloudchannel.googleapis.com"`.
483
- # @return [::String]
495
+ # A custom service endpoint, as a hostname or hostname:port. The default is
496
+ # nil, indicating to use the default endpoint in the current universe domain.
497
+ # @return [::String,nil]
484
498
  # @!attribute [rw] credentials
485
499
  # Credentials to send with calls. You may provide any of the following types:
486
500
  # * (`String`) The path to a service account key file in JSON format
@@ -517,13 +531,20 @@ module Google
517
531
  # @!attribute [rw] quota_project
518
532
  # A separate project against which to charge quota.
519
533
  # @return [::String]
534
+ # @!attribute [rw] universe_domain
535
+ # The universe domain within which to make requests. This determines the
536
+ # default endpoint URL. The default value of nil uses the environment
537
+ # universe (usually the default "googleapis.com" universe).
538
+ # @return [::String,nil]
520
539
  #
521
540
  class Configuration
522
541
  extend ::Gapic::Config
523
542
 
543
+ # @private
544
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
524
545
  DEFAULT_ENDPOINT = "cloudchannel.googleapis.com"
525
546
 
526
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
547
+ config_attr :endpoint, nil, ::String, nil
527
548
  config_attr :credentials, nil do |value|
528
549
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
529
550
  allowed.any? { |klass| klass === value }
@@ -535,6 +556,7 @@ module Google
535
556
  config_attr :metadata, nil, ::Hash, nil
536
557
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
537
558
  config_attr :quota_project, nil, ::String, nil
559
+ config_attr :universe_domain, nil, ::String, nil
538
560
 
539
561
  # @private
540
562
  def initialize parent_config = nil
@@ -617,12 +639,15 @@ module Google
617
639
  # Service stub contains baseline method implementations
618
640
  # including transcoding, making the REST call, and deserialing the response.
619
641
  class OperationsServiceStub
620
- def initialize endpoint:, credentials:
642
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
621
643
  # These require statements are intentionally placed here to initialize
622
644
  # the REST modules only when it's required.
623
645
  require "gapic/rest"
624
646
 
625
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials
647
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
648
+ endpoint_template: endpoint_template,
649
+ universe_domain: universe_domain,
650
+ credentials: credentials
626
651
  end
627
652
 
628
653
  ##
@@ -29,17 +29,30 @@ module Google
29
29
  # Service stub contains baseline method implementations
30
30
  # including transcoding, making the REST call, and deserialing the response.
31
31
  #
32
+ # @deprecated This service is deprecated and may be removed in the next major version update.
32
33
  class ServiceStub
33
- def initialize endpoint:, credentials:
34
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
34
35
  # These require statements are intentionally placed here to initialize
35
36
  # the REST modules only when it's required.
36
37
  require "gapic/rest"
37
38
 
38
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
39
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
40
+ endpoint_template: endpoint_template,
41
+ universe_domain: universe_domain,
42
+ credentials: credentials,
39
43
  numeric_enums: true,
40
44
  raise_faraday_errors: false
41
45
  end
42
46
 
47
+ ##
48
+ # The effective universe domain
49
+ #
50
+ # @return [String]
51
+ #
52
+ def universe_domain
53
+ @client_stub.universe_domain
54
+ end
55
+
43
56
  ##
44
57
  # Baseline implementation for the run_report_job REST call
45
58
  #
@@ -42,6 +42,8 @@ module Google
42
42
  # BigQuery](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery)
43
43
  # instead.
44
44
  #
45
+ # @deprecated This service is deprecated and may be removed in the next major version update.
46
+ #
45
47
  # @example Load this service and instantiate a gRPC client
46
48
  #
47
49
  # require "google/cloud/channel/v1/cloud_channel_reports_service"
@@ -49,6 +49,9 @@ module Google
49
49
  # resellers in a channel.
50
50
  #
51
51
  class Client
52
+ # @private
53
+ DEFAULT_ENDPOINT_TEMPLATE = "cloudchannel.$UNIVERSE_DOMAIN$"
54
+
52
55
  include Paths
53
56
 
54
57
  # @private
@@ -136,6 +139,15 @@ module Google
136
139
  @config
137
140
  end
138
141
 
142
+ ##
143
+ # The effective universe domain
144
+ #
145
+ # @return [String]
146
+ #
147
+ def universe_domain
148
+ @cloud_channel_service_stub.universe_domain
149
+ end
150
+
139
151
  ##
140
152
  # Create a new CloudChannelService client object.
141
153
  #
@@ -169,8 +181,9 @@ module Google
169
181
  credentials = @config.credentials
170
182
  # Use self-signed JWT if the endpoint is unchanged from default,
171
183
  # but only if the default endpoint does not have a region prefix.
172
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
173
- !@config.endpoint.split(".").first.include?("-")
184
+ enable_self_signed_jwt = @config.endpoint.nil? ||
185
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
186
+ !@config.endpoint.split(".").first.include?("-"))
174
187
  credentials ||= Credentials.default scope: @config.scope,
175
188
  enable_self_signed_jwt: enable_self_signed_jwt
176
189
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -183,12 +196,15 @@ module Google
183
196
  config.credentials = credentials
184
197
  config.quota_project = @quota_project_id
185
198
  config.endpoint = @config.endpoint
199
+ config.universe_domain = @config.universe_domain
186
200
  end
187
201
 
188
202
  @cloud_channel_service_stub = ::Gapic::ServiceStub.new(
189
203
  ::Google::Cloud::Channel::V1::CloudChannelService::Stub,
190
- credentials: credentials,
191
- endpoint: @config.endpoint,
204
+ credentials: credentials,
205
+ endpoint: @config.endpoint,
206
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
207
+ universe_domain: @config.universe_domain,
192
208
  channel_args: @config.channel_args,
193
209
  interceptors: @config.interceptors,
194
210
  channel_pool_config: @config.channel_pool
@@ -6025,9 +6041,9 @@ module Google
6025
6041
  # end
6026
6042
  #
6027
6043
  # @!attribute [rw] endpoint
6028
- # The hostname or hostname:port of the service endpoint.
6029
- # Defaults to `"cloudchannel.googleapis.com"`.
6030
- # @return [::String]
6044
+ # A custom service endpoint, as a hostname or hostname:port. The default is
6045
+ # nil, indicating to use the default endpoint in the current universe domain.
6046
+ # @return [::String,nil]
6031
6047
  # @!attribute [rw] credentials
6032
6048
  # Credentials to send with calls. You may provide any of the following types:
6033
6049
  # * (`String`) The path to a service account key file in JSON format
@@ -6073,13 +6089,20 @@ module Google
6073
6089
  # @!attribute [rw] quota_project
6074
6090
  # A separate project against which to charge quota.
6075
6091
  # @return [::String]
6092
+ # @!attribute [rw] universe_domain
6093
+ # The universe domain within which to make requests. This determines the
6094
+ # default endpoint URL. The default value of nil uses the environment
6095
+ # universe (usually the default "googleapis.com" universe).
6096
+ # @return [::String,nil]
6076
6097
  #
6077
6098
  class Configuration
6078
6099
  extend ::Gapic::Config
6079
6100
 
6101
+ # @private
6102
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
6080
6103
  DEFAULT_ENDPOINT = "cloudchannel.googleapis.com"
6081
6104
 
6082
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
6105
+ config_attr :endpoint, nil, ::String, nil
6083
6106
  config_attr :credentials, nil do |value|
6084
6107
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
6085
6108
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -6094,6 +6117,7 @@ module Google
6094
6117
  config_attr :metadata, nil, ::Hash, nil
6095
6118
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
6096
6119
  config_attr :quota_project, nil, ::String, nil
6120
+ config_attr :universe_domain, nil, ::String, nil
6097
6121
 
6098
6122
  # @private
6099
6123
  def initialize parent_config = nil
@@ -26,6 +26,9 @@ module Google
26
26
  module CloudChannelService
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: credentials,
94
- endpoint: @config.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
- # The hostname or hostname:port of the service endpoint.
617
- # Defaults to `"cloudchannel.googleapis.com"`.
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, DEFAULT_ENDPOINT, ::String
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
@@ -51,6 +51,9 @@ module Google
51
51
  # resellers in a channel.
52
52
  #
53
53
  class Client
54
+ # @private
55
+ DEFAULT_ENDPOINT_TEMPLATE = "cloudchannel.$UNIVERSE_DOMAIN$"
56
+
54
57
  include Paths
55
58
 
56
59
  # @private
@@ -138,6 +141,15 @@ module Google
138
141
  @config
139
142
  end
140
143
 
144
+ ##
145
+ # The effective universe domain
146
+ #
147
+ # @return [String]
148
+ #
149
+ def universe_domain
150
+ @cloud_channel_service_stub.universe_domain
151
+ end
152
+
141
153
  ##
142
154
  # Create a new CloudChannelService REST client object.
143
155
  #
@@ -165,8 +177,9 @@ module Google
165
177
  credentials = @config.credentials
166
178
  # Use self-signed JWT if the endpoint is unchanged from default,
167
179
  # but only if the default endpoint does not have a region prefix.
168
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
169
- !@config.endpoint.split(".").first.include?("-")
180
+ enable_self_signed_jwt = @config.endpoint.nil? ||
181
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
182
+ !@config.endpoint.split(".").first.include?("-"))
170
183
  credentials ||= Credentials.default scope: @config.scope,
171
184
  enable_self_signed_jwt: enable_self_signed_jwt
172
185
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -180,9 +193,15 @@ module Google
180
193
  config.credentials = credentials
181
194
  config.quota_project = @quota_project_id
182
195
  config.endpoint = @config.endpoint
196
+ config.universe_domain = @config.universe_domain
183
197
  end
184
198
 
185
- @cloud_channel_service_stub = ::Google::Cloud::Channel::V1::CloudChannelService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
199
+ @cloud_channel_service_stub = ::Google::Cloud::Channel::V1::CloudChannelService::Rest::ServiceStub.new(
200
+ endpoint: @config.endpoint,
201
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
202
+ universe_domain: @config.universe_domain,
203
+ credentials: credentials
204
+ )
186
205
  end
187
206
 
188
207
  ##
@@ -5681,9 +5700,9 @@ module Google
5681
5700
  # end
5682
5701
  #
5683
5702
  # @!attribute [rw] endpoint
5684
- # The hostname or hostname:port of the service endpoint.
5685
- # Defaults to `"cloudchannel.googleapis.com"`.
5686
- # @return [::String]
5703
+ # A custom service endpoint, as a hostname or hostname:port. The default is
5704
+ # nil, indicating to use the default endpoint in the current universe domain.
5705
+ # @return [::String,nil]
5687
5706
  # @!attribute [rw] credentials
5688
5707
  # Credentials to send with calls. You may provide any of the following types:
5689
5708
  # * (`String`) The path to a service account key file in JSON format
@@ -5720,13 +5739,20 @@ module Google
5720
5739
  # @!attribute [rw] quota_project
5721
5740
  # A separate project against which to charge quota.
5722
5741
  # @return [::String]
5742
+ # @!attribute [rw] universe_domain
5743
+ # The universe domain within which to make requests. This determines the
5744
+ # default endpoint URL. The default value of nil uses the environment
5745
+ # universe (usually the default "googleapis.com" universe).
5746
+ # @return [::String,nil]
5723
5747
  #
5724
5748
  class Configuration
5725
5749
  extend ::Gapic::Config
5726
5750
 
5751
+ # @private
5752
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
5727
5753
  DEFAULT_ENDPOINT = "cloudchannel.googleapis.com"
5728
5754
 
5729
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
5755
+ config_attr :endpoint, nil, ::String, nil
5730
5756
  config_attr :credentials, nil do |value|
5731
5757
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
5732
5758
  allowed.any? { |klass| klass === value }
@@ -5738,6 +5764,7 @@ module Google
5738
5764
  config_attr :metadata, nil, ::Hash, nil
5739
5765
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
5740
5766
  config_attr :quota_project, nil, ::String, nil
5767
+ config_attr :universe_domain, nil, ::String, nil
5741
5768
 
5742
5769
  # @private
5743
5770
  def initialize parent_config = nil
@@ -26,6 +26,9 @@ module Google
26
26
  module Rest
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
  #
@@ -84,8 +96,10 @@ module Google
84
96
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
85
97
 
86
98
  @operations_stub = OperationsServiceStub.new(
87
- endpoint: @config.endpoint,
88
- credentials: credentials
99
+ endpoint: @config.endpoint,
100
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
101
+ universe_domain: @config.universe_domain,
102
+ credentials: credentials
89
103
  )
90
104
 
91
105
  # Used by an LRO wrapper for some methods of this service
@@ -478,9 +492,9 @@ module Google
478
492
  # end
479
493
  #
480
494
  # @!attribute [rw] endpoint
481
- # The hostname or hostname:port of the service endpoint.
482
- # Defaults to `"cloudchannel.googleapis.com"`.
483
- # @return [::String]
495
+ # A custom service endpoint, as a hostname or hostname:port. The default is
496
+ # nil, indicating to use the default endpoint in the current universe domain.
497
+ # @return [::String,nil]
484
498
  # @!attribute [rw] credentials
485
499
  # Credentials to send with calls. You may provide any of the following types:
486
500
  # * (`String`) The path to a service account key file in JSON format
@@ -517,13 +531,20 @@ module Google
517
531
  # @!attribute [rw] quota_project
518
532
  # A separate project against which to charge quota.
519
533
  # @return [::String]
534
+ # @!attribute [rw] universe_domain
535
+ # The universe domain within which to make requests. This determines the
536
+ # default endpoint URL. The default value of nil uses the environment
537
+ # universe (usually the default "googleapis.com" universe).
538
+ # @return [::String,nil]
520
539
  #
521
540
  class Configuration
522
541
  extend ::Gapic::Config
523
542
 
543
+ # @private
544
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
524
545
  DEFAULT_ENDPOINT = "cloudchannel.googleapis.com"
525
546
 
526
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
547
+ config_attr :endpoint, nil, ::String, nil
527
548
  config_attr :credentials, nil do |value|
528
549
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
529
550
  allowed.any? { |klass| klass === value }
@@ -535,6 +556,7 @@ module Google
535
556
  config_attr :metadata, nil, ::Hash, nil
536
557
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
537
558
  config_attr :quota_project, nil, ::String, nil
559
+ config_attr :universe_domain, nil, ::String, nil
538
560
 
539
561
  # @private
540
562
  def initialize parent_config = nil
@@ -617,12 +639,15 @@ module Google
617
639
  # Service stub contains baseline method implementations
618
640
  # including transcoding, making the REST call, and deserialing the response.
619
641
  class OperationsServiceStub
620
- def initialize endpoint:, credentials:
642
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
621
643
  # These require statements are intentionally placed here to initialize
622
644
  # the REST modules only when it's required.
623
645
  require "gapic/rest"
624
646
 
625
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials
647
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
648
+ endpoint_template: endpoint_template,
649
+ universe_domain: universe_domain,
650
+ credentials: credentials
626
651
  end
627
652
 
628
653
  ##
@@ -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, credentials: credentials,
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_customers REST call
45
57
  #
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Channel
23
23
  module V1
24
- VERSION = "0.22.1"
24
+ VERSION = "0.23.0"
25
25
  end
26
26
  end
27
27
  end
@@ -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
@@ -23,6 +23,7 @@ module Google
23
23
  module V1
24
24
  # Request message for
25
25
  # {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#run_report_job CloudChannelReportsService.RunReportJob}.
26
+ # @deprecated This message is deprecated and may be removed in the next major version update.
26
27
  # @!attribute [rw] name
27
28
  # @return [::String]
28
29
  # Required. The report's resource name. Specifies the account and report used
@@ -58,6 +59,7 @@ module Google
58
59
 
59
60
  # Response message for
60
61
  # {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#run_report_job CloudChannelReportsService.RunReportJob}.
62
+ # @deprecated This message is deprecated and may be removed in the next major version update.
61
63
  # @!attribute [rw] report_job
62
64
  # @return [::Google::Cloud::Channel::V1::ReportJob]
63
65
  # Pass `report_job.name` to
@@ -75,6 +77,7 @@ module Google
75
77
 
76
78
  # Request message for
77
79
  # {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#fetch_report_results CloudChannelReportsService.FetchReportResults}.
80
+ # @deprecated This message is deprecated and may be removed in the next major version update.
78
81
  # @!attribute [rw] report_job
79
82
  # @return [::String]
80
83
  # Required. The report job created by
@@ -109,6 +112,7 @@ module Google
109
112
  # Response message for
110
113
  # {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#fetch_report_results CloudChannelReportsService.FetchReportResults}.
111
114
  # Contains a tabular representation of the report results.
115
+ # @deprecated This message is deprecated and may be removed in the next major version update.
112
116
  # @!attribute [rw] report_metadata
113
117
  # @return [::Google::Cloud::Channel::V1::ReportResultsMetadata]
114
118
  # The metadata for the report results (display name, columns, row count, and
@@ -129,6 +133,7 @@ module Google
129
133
 
130
134
  # Request message for
131
135
  # {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#list_reports CloudChannelReportsService.ListReports}.
136
+ # @deprecated This message is deprecated and may be removed in the next major version update.
132
137
  # @!attribute [rw] parent
133
138
  # @return [::String]
134
139
  # Required. The resource name of the partner account to list available
@@ -159,6 +164,7 @@ module Google
159
164
 
160
165
  # Response message for
161
166
  # {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#list_reports CloudChannelReportsService.ListReports}.
167
+ # @deprecated This message is deprecated and may be removed in the next major version update.
162
168
  # @!attribute [rw] reports
163
169
  # @return [::Array<::Google::Cloud::Channel::V1::Report>]
164
170
  # The reports available to the partner.
@@ -175,6 +181,7 @@ module Google
175
181
  # The result of a [RunReportJob][] operation. Contains the name to use in
176
182
  # {::Google::Cloud::Channel::V1::FetchReportResultsRequest#report_job FetchReportResultsRequest.report_job}
177
183
  # and the status of the operation.
184
+ # @deprecated This message is deprecated and may be removed in the next major version update.
178
185
  # @!attribute [rw] name
179
186
  # @return [::String]
180
187
  # Required. The resource name of a report job.
@@ -192,6 +199,7 @@ module Google
192
199
  # {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#run_report_job CloudChannelReportsService.RunReportJob}
193
200
  # and
194
201
  # {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#fetch_report_results CloudChannelReportsService.FetchReportResults}.
202
+ # @deprecated This message is deprecated and may be removed in the next major version update.
195
203
  # @!attribute [rw] report
196
204
  # @return [::Google::Cloud::Channel::V1::Report]
197
205
  # Details of the completed report.
@@ -216,6 +224,7 @@ module Google
216
224
 
217
225
  # The definition of a report column. Specifies the data properties
218
226
  # in the corresponding position of the report rows.
227
+ # @deprecated This message is deprecated and may be removed in the next major version update.
219
228
  # @!attribute [rw] column_id
220
229
  # @return [::String]
221
230
  # The unique name of the column (for example, customer_domain,
@@ -260,6 +269,7 @@ module Google
260
269
  end
261
270
 
262
271
  # A representation of usage or invoice date ranges.
272
+ # @deprecated This message is deprecated and may be removed in the next major version update.
263
273
  # @!attribute [rw] usage_start_date_time
264
274
  # @return [::Google::Type::DateTime]
265
275
  # The earliest usage date time (inclusive).
@@ -294,6 +304,7 @@ module Google
294
304
  end
295
305
 
296
306
  # A row of report values.
307
+ # @deprecated This message is deprecated and may be removed in the next major version update.
297
308
  # @!attribute [rw] values
298
309
  # @return [::Array<::Google::Cloud::Channel::V1::ReportValue>]
299
310
  # The list of values in the row.
@@ -307,6 +318,7 @@ module Google
307
318
  end
308
319
 
309
320
  # A single report value.
321
+ # @deprecated This message is deprecated and may be removed in the next major version update.
310
322
  # @!attribute [rw] string_value
311
323
  # @return [::String]
312
324
  # A value of type `string`.
@@ -334,6 +346,7 @@ module Google
334
346
  end
335
347
 
336
348
  # Status of a report generation process.
349
+ # @deprecated This message is deprecated and may be removed in the next major version update.
337
350
  # @!attribute [rw] state
338
351
  # @return [::Google::Cloud::Channel::V1::ReportStatus::State]
339
352
  # The current state of the report generation process.
@@ -369,6 +382,7 @@ module Google
369
382
  # The ID and description of a report that was used to generate report data.
370
383
  # For example, "Google Cloud Daily Spend", "Google Workspace License Activity",
371
384
  # etc.
385
+ # @deprecated This message is deprecated and may be removed in the next major version update.
372
386
  # @!attribute [rw] name
373
387
  # @return [::String]
374
388
  # Required. The report's resource name. Specifies the account and report used
@@ -82,6 +82,7 @@ module Google
82
82
  # and
83
83
  # {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig ChannelPartnerRepricingConfig}.
84
84
  # @!attribute [rw] channel_partner_granularity
85
+ # @deprecated This field is deprecated and may be removed in the next major version update.
85
86
  # @return [::Google::Cloud::Channel::V1::RepricingConfig::ChannelPartnerGranularity]
86
87
  # Applies the repricing configuration at the channel partner level.
87
88
  # Only
@@ -127,6 +128,7 @@ module Google
127
128
  # Deprecated: This is no longer supported. Use
128
129
  # {::Google::Cloud::Channel::V1::RepricingConfig::EntitlementGranularity RepricingConfig.EntitlementGranularity}
129
130
  # instead.
131
+ # @deprecated This message is deprecated and may be removed in the next major version update.
130
132
  class ChannelPartnerGranularity
131
133
  include ::Google::Protobuf::MessageExts
132
134
  extend ::Google::Protobuf::MessageExts::ClassMethods
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-channel-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.22.1
4
+ version: 0.23.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-03 00:00:00.000000000 Z
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.20.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.20.0
29
+ version: 0.21.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a