google-cloud-service_management-v1 0.8.0 → 0.10.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (15) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/lib/google/cloud/service_management/v1/service_manager/client.rb +43 -9
  4. data/lib/google/cloud/service_management/v1/service_manager/operations.rb +38 -7
  5. data/lib/google/cloud/service_management/v1/service_manager/rest/client.rb +290 -7
  6. data/lib/google/cloud/service_management/v1/service_manager/rest/operations.rb +108 -8
  7. data/lib/google/cloud/service_management/v1/service_manager/rest/service_stub.rb +14 -2
  8. data/lib/google/cloud/service_management/v1/version.rb +1 -1
  9. data/proto_docs/google/api/backend.rb +1 -0
  10. data/proto_docs/google/api/client.rb +14 -0
  11. data/proto_docs/google/api/endpoint.rb +1 -0
  12. data/proto_docs/google/api/field_behavior.rb +14 -0
  13. data/proto_docs/google/api/metric.rb +1 -0
  14. data/proto_docs/google/api/servicemanagement/v1/servicemanager.rb +1 -0
  15. metadata +7 -7
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: da4704b32c66244172428530bf937444382a3c94c6e3df29c9b19fa1dfd6718c
4
- data.tar.gz: ffb90b2730c16ef81a3fe4930034de3ffb18198e4b3e2f45e75c0bffef5b40b2
3
+ metadata.gz: 53c6b8ecb17b02d85a08bfdce7c7b97a6d7befe9373275793b6186460e91c845
4
+ data.tar.gz: 283f53162c0de54ac05d5cb1cdb042e81e1776d9ffdcd9ace7162285195e8a30
5
5
  SHA512:
6
- metadata.gz: cd55fd60ff7239ace278517b6b992cc5ed66d5827788c3d06335e599c4a418266b1f7d3e7130b6863dae3742bf92c8a9c78b085685ed716aa2e4396997174d04
7
- data.tar.gz: 7ff730f3593c48f7a29c843c458ea538e4995cf7151e6ab172f7f3b3cfa1e59bd575259b124f689afd80c89ebd80c8f79821a5d699df7f81f82395723628c634
6
+ metadata.gz: bf386de05a5297580908f0f093290d639a7d5e2df0d083a1c86c570a7764dd3679f263955b34a49b8fc1a357c623aa9a97097287b8da33669a45616aea0847c3
7
+ data.tar.gz: ad93aa2d3cf7bea4e9923441048214682646ef436feefb05b15ffb33cda1b32d060474735a582a9a2229db1637acdd5937a7374ada30ee09bfb34768b7be5ddf
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-service_management-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-service_management-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 SERVICE_MANAGEMENT_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/service_management/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::ServiceManagement::V1::ServiceManager::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-service_management-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-service_management-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-service_management-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::ServiceManagement::V1::ServiceManager::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `SERVICE_MANAGEMENT_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `SERVICE_MANAGEMENT_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/service_management/v1"
77
-
78
- ENV["SERVICE_MANAGEMENT_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::ServiceManagement::V1::ServiceManager::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/service_management/v1"
90
58
 
91
59
  client = ::Google::Cloud::ServiceManagement::V1::ServiceManager::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/service_management/v1"
100
68
 
101
69
  ::Google::Cloud::ServiceManagement::V1::ServiceManager::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::ServiceManagement::V1::ServiceManager::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-service_management-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/service_management/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-service_management-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::ServiceManagement::V1::ServiceManager::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).
data/lib/google/cloud/service_management/v1/service_manager/client.rb CHANGED
@@ -32,6 +32,9 @@ module Google
32
32
  # API](https://cloud.google.com/service-infrastructure/docs/overview)
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "servicemanagement.$UNIVERSE_DOMAIN$"
37
+
35
38
  # @private
36
39
  attr_reader :service_manager_stub
37
40
 
@@ -92,6 +95,15 @@ module Google
92
95
  @config
93
96
  end
94
97
 
98
+ ##
99
+ # The effective universe domain
100
+ #
101
+ # @return [String]
102
+ #
103
+ def universe_domain
104
+ @service_manager_stub.universe_domain
105
+ end
106
+
95
107
  ##
96
108
  # Create a new ServiceManager client object.
97
109
  #
@@ -125,8 +137,9 @@ module Google
125
137
  credentials = @config.credentials
126
138
  # Use self-signed JWT if the endpoint is unchanged from default,
127
139
  # but only if the default endpoint does not have a region prefix.
128
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
129
- !@config.endpoint.split(".").first.include?("-")
140
+ enable_self_signed_jwt = @config.endpoint.nil? ||
141
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
142
+ !@config.endpoint.split(".").first.include?("-"))
130
143
  credentials ||= Credentials.default scope: @config.scope,
131
144
  enable_self_signed_jwt: enable_self_signed_jwt
132
145
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -139,20 +152,25 @@ module Google
139
152
  config.credentials = credentials
140
153
  config.quota_project = @quota_project_id
141
154
  config.endpoint = @config.endpoint
155
+ config.universe_domain = @config.universe_domain
142
156
  end
143
157
 
144
158
  @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
145
159
  config.credentials = credentials
146
160
  config.quota_project = @quota_project_id
147
161
  config.endpoint = @config.endpoint
162
+ config.universe_domain = @config.universe_domain
148
163
  end
149
164
 
150
165
  @service_manager_stub = ::Gapic::ServiceStub.new(
151
166
  ::Google::Cloud::ServiceManagement::V1::ServiceManager::Stub,
152
- credentials: credentials,
153
- endpoint: @config.endpoint,
167
+ credentials: credentials,
168
+ endpoint: @config.endpoint,
169
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
170
+ universe_domain: @config.universe_domain,
154
171
  channel_args: @config.channel_args,
155
- interceptors: @config.interceptors
172
+ interceptors: @config.interceptors,
173
+ channel_pool_config: @config.channel_pool
156
174
  )
157
175
  end
158
176
 
@@ -1499,9 +1517,9 @@ module Google
1499
1517
  # end
1500
1518
  #
1501
1519
  # @!attribute [rw] endpoint
1502
- # The hostname or hostname:port of the service endpoint.
1503
- # Defaults to `"servicemanagement.googleapis.com"`.
1504
- # @return [::String]
1520
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1521
+ # nil, indicating to use the default endpoint in the current universe domain.
1522
+ # @return [::String,nil]
1505
1523
  # @!attribute [rw] credentials
1506
1524
  # Credentials to send with calls. You may provide any of the following types:
1507
1525
  # * (`String`) The path to a service account key file in JSON format
@@ -1547,13 +1565,20 @@ module Google
1547
1565
  # @!attribute [rw] quota_project
1548
1566
  # A separate project against which to charge quota.
1549
1567
  # @return [::String]
1568
+ # @!attribute [rw] universe_domain
1569
+ # The universe domain within which to make requests. This determines the
1570
+ # default endpoint URL. The default value of nil uses the environment
1571
+ # universe (usually the default "googleapis.com" universe).
1572
+ # @return [::String,nil]
1550
1573
  #
1551
1574
  class Configuration
1552
1575
  extend ::Gapic::Config
1553
1576
 
1577
+ # @private
1578
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1554
1579
  DEFAULT_ENDPOINT = "servicemanagement.googleapis.com"
1555
1580
 
1556
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1581
+ config_attr :endpoint, nil, ::String, nil
1557
1582
  config_attr :credentials, nil do |value|
1558
1583
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1559
1584
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -1568,6 +1593,7 @@ module Google
1568
1593
  config_attr :metadata, nil, ::Hash, nil
1569
1594
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1570
1595
  config_attr :quota_project, nil, ::String, nil
1596
+ config_attr :universe_domain, nil, ::String, nil
1571
1597
 
1572
1598
  # @private
1573
1599
  def initialize parent_config = nil
@@ -1588,6 +1614,14 @@ module Google
1588
1614
  end
1589
1615
  end
1590
1616
 
1617
+ ##
1618
+ # Configuration for the channel pool
1619
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
1620
+ #
1621
+ def channel_pool
1622
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
1623
+ end
1624
+
1591
1625
  ##
1592
1626
  # Configuration RPC class for the ServiceManager API.
1593
1627
  #
data/lib/google/cloud/service_management/v1/service_manager/operations.rb CHANGED
@@ -26,6 +26,9 @@ module Google
26
26
  module ServiceManager
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "servicemanagement.$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,10 +102,13 @@ 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
- interceptors: @config.interceptors
110
+ interceptors: @config.interceptors,
111
+ channel_pool_config: @config.channel_pool
97
112
  )
98
113
 
99
114
  # Used by an LRO wrapper for some methods of this service
@@ -604,9 +619,9 @@ module Google
604
619
  # end
605
620
  #
606
621
  # @!attribute [rw] endpoint
607
- # The hostname or hostname:port of the service endpoint.
608
- # Defaults to `"servicemanagement.googleapis.com"`.
609
- # @return [::String]
622
+ # A custom service endpoint, as a hostname or hostname:port. The default is
623
+ # nil, indicating to use the default endpoint in the current universe domain.
624
+ # @return [::String,nil]
610
625
  # @!attribute [rw] credentials
611
626
  # Credentials to send with calls. You may provide any of the following types:
612
627
  # * (`String`) The path to a service account key file in JSON format
@@ -652,13 +667,20 @@ module Google
652
667
  # @!attribute [rw] quota_project
653
668
  # A separate project against which to charge quota.
654
669
  # @return [::String]
670
+ # @!attribute [rw] universe_domain
671
+ # The universe domain within which to make requests. This determines the
672
+ # default endpoint URL. The default value of nil uses the environment
673
+ # universe (usually the default "googleapis.com" universe).
674
+ # @return [::String,nil]
655
675
  #
656
676
  class Configuration
657
677
  extend ::Gapic::Config
658
678
 
679
+ # @private
680
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
659
681
  DEFAULT_ENDPOINT = "servicemanagement.googleapis.com"
660
682
 
661
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
683
+ config_attr :endpoint, nil, ::String, nil
662
684
  config_attr :credentials, nil do |value|
663
685
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
664
686
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -673,6 +695,7 @@ module Google
673
695
  config_attr :metadata, nil, ::Hash, nil
674
696
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
675
697
  config_attr :quota_project, nil, ::String, nil
698
+ config_attr :universe_domain, nil, ::String, nil
676
699
 
677
700
  # @private
678
701
  def initialize parent_config = nil
@@ -693,6 +716,14 @@ module Google
693
716
  end
694
717
  end
695
718
 
719
+ ##
720
+ # Configuration for the channel pool
721
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
722
+ #
723
+ def channel_pool
724
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
725
+ end
726
+
696
727
  ##
697
728
  # Configuration RPC class for the Operations API.
698
729
  #
data/lib/google/cloud/service_management/v1/service_manager/rest/client.rb CHANGED
@@ -34,6 +34,9 @@ module Google
34
34
  # API](https://cloud.google.com/service-infrastructure/docs/overview)
35
35
  #
36
36
  class Client
37
+ # @private
38
+ DEFAULT_ENDPOINT_TEMPLATE = "servicemanagement.$UNIVERSE_DOMAIN$"
39
+
37
40
  # @private
38
41
  attr_reader :service_manager_stub
39
42
 
@@ -94,6 +97,15 @@ module Google
94
97
  @config
95
98
  end
96
99
 
100
+ ##
101
+ # The effective universe domain
102
+ #
103
+ # @return [String]
104
+ #
105
+ def universe_domain
106
+ @service_manager_stub.universe_domain
107
+ end
108
+
97
109
  ##
98
110
  # Create a new ServiceManager REST client object.
99
111
  #
@@ -121,8 +133,9 @@ module Google
121
133
  credentials = @config.credentials
122
134
  # Use self-signed JWT if the endpoint is unchanged from default,
123
135
  # but only if the default endpoint does not have a region prefix.
124
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
125
- !@config.endpoint.split(".").first.include?("-")
136
+ enable_self_signed_jwt = @config.endpoint.nil? ||
137
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
138
+ !@config.endpoint.split(".").first.include?("-"))
126
139
  credentials ||= Credentials.default scope: @config.scope,
127
140
  enable_self_signed_jwt: enable_self_signed_jwt
128
141
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -136,16 +149,23 @@ module Google
136
149
  config.credentials = credentials
137
150
  config.quota_project = @quota_project_id
138
151
  config.endpoint = @config.endpoint
152
+ config.universe_domain = @config.universe_domain
139
153
  end
140
154
 
141
155
  @iam_policy_client = Google::Iam::V1::IAMPolicy::Rest::Client.new do |config|
142
156
  config.credentials = credentials
143
157
  config.quota_project = @quota_project_id
144
158
  config.endpoint = @config.endpoint
159
+ config.universe_domain = @config.universe_domain
145
160
  config.bindings_override = @config.bindings_override
146
161
  end
147
162
 
148
- @service_manager_stub = ::Google::Cloud::ServiceManagement::V1::ServiceManager::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
163
+ @service_manager_stub = ::Google::Cloud::ServiceManagement::V1::ServiceManager::Rest::ServiceStub.new(
164
+ endpoint: @config.endpoint,
165
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
166
+ universe_domain: @config.universe_domain,
167
+ credentials: credentials
168
+ )
149
169
  end
150
170
 
151
171
  ##
@@ -207,6 +227,26 @@ module Google
207
227
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::ServiceManagement::V1::ManagedService>]
208
228
  #
209
229
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
230
+ #
231
+ # @example Basic example
232
+ # require "google/cloud/service_management/v1"
233
+ #
234
+ # # Create a client object. The client can be reused for multiple calls.
235
+ # client = Google::Cloud::ServiceManagement::V1::ServiceManager::Rest::Client.new
236
+ #
237
+ # # Create a request. To set request fields, pass in keyword arguments.
238
+ # request = Google::Cloud::ServiceManagement::V1::ListServicesRequest.new
239
+ #
240
+ # # Call the list_services method.
241
+ # result = client.list_services request
242
+ #
243
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
244
+ # # over elements, and API calls will be issued to fetch pages as needed.
245
+ # result.each do |item|
246
+ # # Each element is of type ::Google::Cloud::ServiceManagement::V1::ManagedService.
247
+ # p item
248
+ # end
249
+ #
210
250
  def list_services request, options = nil
211
251
  raise ::ArgumentError, "request must be provided" if request.nil?
212
252
 
@@ -272,6 +312,22 @@ module Google
272
312
  # @return [::Google::Cloud::ServiceManagement::V1::ManagedService]
273
313
  #
274
314
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
315
+ #
316
+ # @example Basic example
317
+ # require "google/cloud/service_management/v1"
318
+ #
319
+ # # Create a client object. The client can be reused for multiple calls.
320
+ # client = Google::Cloud::ServiceManagement::V1::ServiceManager::Rest::Client.new
321
+ #
322
+ # # Create a request. To set request fields, pass in keyword arguments.
323
+ # request = Google::Cloud::ServiceManagement::V1::GetServiceRequest.new
324
+ #
325
+ # # Call the get_service method.
326
+ # result = client.get_service request
327
+ #
328
+ # # The returned object is of type Google::Cloud::ServiceManagement::V1::ManagedService.
329
+ # p result
330
+ #
275
331
  def get_service request, options = nil
276
332
  raise ::ArgumentError, "request must be provided" if request.nil?
277
333
 
@@ -344,6 +400,29 @@ module Google
344
400
  # @return [::Gapic::Operation]
345
401
  #
346
402
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
403
+ #
404
+ # @example Basic example
405
+ # require "google/cloud/service_management/v1"
406
+ #
407
+ # # Create a client object. The client can be reused for multiple calls.
408
+ # client = Google::Cloud::ServiceManagement::V1::ServiceManager::Rest::Client.new
409
+ #
410
+ # # Create a request. To set request fields, pass in keyword arguments.
411
+ # request = Google::Cloud::ServiceManagement::V1::CreateServiceRequest.new
412
+ #
413
+ # # Call the create_service method.
414
+ # result = client.create_service request
415
+ #
416
+ # # The returned object is of type Gapic::Operation. You can use it to
417
+ # # check the status of an operation, cancel it, or wait for results.
418
+ # # Here is how to wait for a response.
419
+ # result.wait_until_done! timeout: 60
420
+ # if result.response?
421
+ # p result.response
422
+ # else
423
+ # puts "No response received."
424
+ # end
425
+ #
347
426
  def create_service request, options = nil
348
427
  raise ::ArgumentError, "request must be provided" if request.nil?
349
428
 
@@ -416,6 +495,29 @@ module Google
416
495
  # @return [::Gapic::Operation]
417
496
  #
418
497
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
498
+ #
499
+ # @example Basic example
500
+ # require "google/cloud/service_management/v1"
501
+ #
502
+ # # Create a client object. The client can be reused for multiple calls.
503
+ # client = Google::Cloud::ServiceManagement::V1::ServiceManager::Rest::Client.new
504
+ #
505
+ # # Create a request. To set request fields, pass in keyword arguments.
506
+ # request = Google::Cloud::ServiceManagement::V1::DeleteServiceRequest.new
507
+ #
508
+ # # Call the delete_service method.
509
+ # result = client.delete_service request
510
+ #
511
+ # # The returned object is of type Gapic::Operation. You can use it to
512
+ # # check the status of an operation, cancel it, or wait for results.
513
+ # # Here is how to wait for a response.
514
+ # result.wait_until_done! timeout: 60
515
+ # if result.response?
516
+ # p result.response
517
+ # else
518
+ # puts "No response received."
519
+ # end
520
+ #
419
521
  def delete_service request, options = nil
420
522
  raise ::ArgumentError, "request must be provided" if request.nil?
421
523
 
@@ -486,6 +588,29 @@ module Google
486
588
  # @return [::Gapic::Operation]
487
589
  #
488
590
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
591
+ #
592
+ # @example Basic example
593
+ # require "google/cloud/service_management/v1"
594
+ #
595
+ # # Create a client object. The client can be reused for multiple calls.
596
+ # client = Google::Cloud::ServiceManagement::V1::ServiceManager::Rest::Client.new
597
+ #
598
+ # # Create a request. To set request fields, pass in keyword arguments.
599
+ # request = Google::Cloud::ServiceManagement::V1::UndeleteServiceRequest.new
600
+ #
601
+ # # Call the undelete_service method.
602
+ # result = client.undelete_service request
603
+ #
604
+ # # The returned object is of type Gapic::Operation. You can use it to
605
+ # # check the status of an operation, cancel it, or wait for results.
606
+ # # Here is how to wait for a response.
607
+ # result.wait_until_done! timeout: 60
608
+ # if result.response?
609
+ # p result.response
610
+ # else
611
+ # puts "No response received."
612
+ # end
613
+ #
489
614
  def undelete_service request, options = nil
490
615
  raise ::ArgumentError, "request must be provided" if request.nil?
491
616
 
@@ -557,6 +682,26 @@ module Google
557
682
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Api::Service>]
558
683
  #
559
684
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
685
+ #
686
+ # @example Basic example
687
+ # require "google/cloud/service_management/v1"
688
+ #
689
+ # # Create a client object. The client can be reused for multiple calls.
690
+ # client = Google::Cloud::ServiceManagement::V1::ServiceManager::Rest::Client.new
691
+ #
692
+ # # Create a request. To set request fields, pass in keyword arguments.
693
+ # request = Google::Cloud::ServiceManagement::V1::ListServiceConfigsRequest.new
694
+ #
695
+ # # Call the list_service_configs method.
696
+ # result = client.list_service_configs request
697
+ #
698
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
699
+ # # over elements, and API calls will be issued to fetch pages as needed.
700
+ # result.each do |item|
701
+ # # Each element is of type ::Google::Api::Service.
702
+ # p item
703
+ # end
704
+ #
560
705
  def list_service_configs request, options = nil
561
706
  raise ::ArgumentError, "request must be provided" if request.nil?
562
707
 
@@ -630,6 +775,22 @@ module Google
630
775
  # @return [::Google::Api::Service]
631
776
  #
632
777
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
778
+ #
779
+ # @example Basic example
780
+ # require "google/cloud/service_management/v1"
781
+ #
782
+ # # Create a client object. The client can be reused for multiple calls.
783
+ # client = Google::Cloud::ServiceManagement::V1::ServiceManager::Rest::Client.new
784
+ #
785
+ # # Create a request. To set request fields, pass in keyword arguments.
786
+ # request = Google::Cloud::ServiceManagement::V1::GetServiceConfigRequest.new
787
+ #
788
+ # # Call the get_service_config method.
789
+ # result = client.get_service_config request
790
+ #
791
+ # # The returned object is of type Google::Api::Service.
792
+ # p result
793
+ #
633
794
  def get_service_config request, options = nil
634
795
  raise ::ArgumentError, "request must be provided" if request.nil?
635
796
 
@@ -703,6 +864,22 @@ module Google
703
864
  # @return [::Google::Api::Service]
704
865
  #
705
866
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
867
+ #
868
+ # @example Basic example
869
+ # require "google/cloud/service_management/v1"
870
+ #
871
+ # # Create a client object. The client can be reused for multiple calls.
872
+ # client = Google::Cloud::ServiceManagement::V1::ServiceManager::Rest::Client.new
873
+ #
874
+ # # Create a request. To set request fields, pass in keyword arguments.
875
+ # request = Google::Cloud::ServiceManagement::V1::CreateServiceConfigRequest.new
876
+ #
877
+ # # Call the create_service_config method.
878
+ # result = client.create_service_config request
879
+ #
880
+ # # The returned object is of type Google::Api::Service.
881
+ # p result
882
+ #
706
883
  def create_service_config request, options = nil
707
884
  raise ::ArgumentError, "request must be provided" if request.nil?
708
885
 
@@ -786,6 +963,29 @@ module Google
786
963
  # @return [::Gapic::Operation]
787
964
  #
788
965
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
966
+ #
967
+ # @example Basic example
968
+ # require "google/cloud/service_management/v1"
969
+ #
970
+ # # Create a client object. The client can be reused for multiple calls.
971
+ # client = Google::Cloud::ServiceManagement::V1::ServiceManager::Rest::Client.new
972
+ #
973
+ # # Create a request. To set request fields, pass in keyword arguments.
974
+ # request = Google::Cloud::ServiceManagement::V1::SubmitConfigSourceRequest.new
975
+ #
976
+ # # Call the submit_config_source method.
977
+ # result = client.submit_config_source request
978
+ #
979
+ # # The returned object is of type Gapic::Operation. You can use it to
980
+ # # check the status of an operation, cancel it, or wait for results.
981
+ # # Here is how to wait for a response.
982
+ # result.wait_until_done! timeout: 60
983
+ # if result.response?
984
+ # p result.response
985
+ # else
986
+ # puts "No response received."
987
+ # end
988
+ #
789
989
  def submit_config_source request, options = nil
790
990
  raise ::ArgumentError, "request must be provided" if request.nil?
791
991
 
@@ -868,6 +1068,26 @@ module Google
868
1068
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::ServiceManagement::V1::Rollout>]
869
1069
  #
870
1070
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1071
+ #
1072
+ # @example Basic example
1073
+ # require "google/cloud/service_management/v1"
1074
+ #
1075
+ # # Create a client object. The client can be reused for multiple calls.
1076
+ # client = Google::Cloud::ServiceManagement::V1::ServiceManager::Rest::Client.new
1077
+ #
1078
+ # # Create a request. To set request fields, pass in keyword arguments.
1079
+ # request = Google::Cloud::ServiceManagement::V1::ListServiceRolloutsRequest.new
1080
+ #
1081
+ # # Call the list_service_rollouts method.
1082
+ # result = client.list_service_rollouts request
1083
+ #
1084
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1085
+ # # over elements, and API calls will be issued to fetch pages as needed.
1086
+ # result.each do |item|
1087
+ # # Each element is of type ::Google::Cloud::ServiceManagement::V1::Rollout.
1088
+ # p item
1089
+ # end
1090
+ #
871
1091
  def list_service_rollouts request, options = nil
872
1092
  raise ::ArgumentError, "request must be provided" if request.nil?
873
1093
 
@@ -936,6 +1156,22 @@ module Google
936
1156
  # @return [::Google::Cloud::ServiceManagement::V1::Rollout]
937
1157
  #
938
1158
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1159
+ #
1160
+ # @example Basic example
1161
+ # require "google/cloud/service_management/v1"
1162
+ #
1163
+ # # Create a client object. The client can be reused for multiple calls.
1164
+ # client = Google::Cloud::ServiceManagement::V1::ServiceManager::Rest::Client.new
1165
+ #
1166
+ # # Create a request. To set request fields, pass in keyword arguments.
1167
+ # request = Google::Cloud::ServiceManagement::V1::GetServiceRolloutRequest.new
1168
+ #
1169
+ # # Call the get_service_rollout method.
1170
+ # result = client.get_service_rollout request
1171
+ #
1172
+ # # The returned object is of type Google::Cloud::ServiceManagement::V1::Rollout.
1173
+ # p result
1174
+ #
939
1175
  def get_service_rollout request, options = nil
940
1176
  raise ::ArgumentError, "request must be provided" if request.nil?
941
1177
 
@@ -1015,6 +1251,29 @@ module Google
1015
1251
  # @return [::Gapic::Operation]
1016
1252
  #
1017
1253
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1254
+ #
1255
+ # @example Basic example
1256
+ # require "google/cloud/service_management/v1"
1257
+ #
1258
+ # # Create a client object. The client can be reused for multiple calls.
1259
+ # client = Google::Cloud::ServiceManagement::V1::ServiceManager::Rest::Client.new
1260
+ #
1261
+ # # Create a request. To set request fields, pass in keyword arguments.
1262
+ # request = Google::Cloud::ServiceManagement::V1::CreateServiceRolloutRequest.new
1263
+ #
1264
+ # # Call the create_service_rollout method.
1265
+ # result = client.create_service_rollout request
1266
+ #
1267
+ # # The returned object is of type Gapic::Operation. You can use it to
1268
+ # # check the status of an operation, cancel it, or wait for results.
1269
+ # # Here is how to wait for a response.
1270
+ # result.wait_until_done! timeout: 60
1271
+ # if result.response?
1272
+ # p result.response
1273
+ # else
1274
+ # puts "No response received."
1275
+ # end
1276
+ #
1018
1277
  def create_service_rollout request, options = nil
1019
1278
  raise ::ArgumentError, "request must be provided" if request.nil?
1020
1279
 
@@ -1098,6 +1357,22 @@ module Google
1098
1357
  # @return [::Google::Cloud::ServiceManagement::V1::GenerateConfigReportResponse]
1099
1358
  #
1100
1359
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1360
+ #
1361
+ # @example Basic example
1362
+ # require "google/cloud/service_management/v1"
1363
+ #
1364
+ # # Create a client object. The client can be reused for multiple calls.
1365
+ # client = Google::Cloud::ServiceManagement::V1::ServiceManager::Rest::Client.new
1366
+ #
1367
+ # # Create a request. To set request fields, pass in keyword arguments.
1368
+ # request = Google::Cloud::ServiceManagement::V1::GenerateConfigReportRequest.new
1369
+ #
1370
+ # # Call the generate_config_report method.
1371
+ # result = client.generate_config_report request
1372
+ #
1373
+ # # The returned object is of type Google::Cloud::ServiceManagement::V1::GenerateConfigReportResponse.
1374
+ # p result
1375
+ #
1101
1376
  def generate_config_report request, options = nil
1102
1377
  raise ::ArgumentError, "request must be provided" if request.nil?
1103
1378
 
@@ -1163,9 +1438,9 @@ module Google
1163
1438
  # end
1164
1439
  #
1165
1440
  # @!attribute [rw] endpoint
1166
- # The hostname or hostname:port of the service endpoint.
1167
- # Defaults to `"servicemanagement.googleapis.com"`.
1168
- # @return [::String]
1441
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1442
+ # nil, indicating to use the default endpoint in the current universe domain.
1443
+ # @return [::String,nil]
1169
1444
  # @!attribute [rw] credentials
1170
1445
  # Credentials to send with calls. You may provide any of the following types:
1171
1446
  # * (`String`) The path to a service account key file in JSON format
@@ -1202,13 +1477,20 @@ module Google
1202
1477
  # @!attribute [rw] quota_project
1203
1478
  # A separate project against which to charge quota.
1204
1479
  # @return [::String]
1480
+ # @!attribute [rw] universe_domain
1481
+ # The universe domain within which to make requests. This determines the
1482
+ # default endpoint URL. The default value of nil uses the environment
1483
+ # universe (usually the default "googleapis.com" universe).
1484
+ # @return [::String,nil]
1205
1485
  #
1206
1486
  class Configuration
1207
1487
  extend ::Gapic::Config
1208
1488
 
1489
+ # @private
1490
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1209
1491
  DEFAULT_ENDPOINT = "servicemanagement.googleapis.com"
1210
1492
 
1211
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1493
+ config_attr :endpoint, nil, ::String, nil
1212
1494
  config_attr :credentials, nil do |value|
1213
1495
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1214
1496
  allowed.any? { |klass| klass === value }
@@ -1220,6 +1502,7 @@ module Google
1220
1502
  config_attr :metadata, nil, ::Hash, nil
1221
1503
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1222
1504
  config_attr :quota_project, nil, ::String, nil
1505
+ config_attr :universe_domain, nil, ::String, nil
1223
1506
 
1224
1507
  # @private
1225
1508
  # Overrides for http bindings for the RPCs of this service
data/lib/google/cloud/service_management/v1/service_manager/rest/operations.rb CHANGED
@@ -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 = "servicemanagement.$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
@@ -136,6 +150,26 @@ module Google
136
150
  # @return [::Gapic::Operation]
137
151
  #
138
152
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
153
+ #
154
+ # @example Basic example
155
+ # require "google/longrunning"
156
+ #
157
+ # # Create a client object. The client can be reused for multiple calls.
158
+ # client = Google::Longrunning::Operations::Rest::Client.new
159
+ #
160
+ # # Create a request. To set request fields, pass in keyword arguments.
161
+ # request = Google::Longrunning::ListOperationsRequest.new
162
+ #
163
+ # # Call the list_operations method.
164
+ # result = client.list_operations request
165
+ #
166
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
167
+ # # over elements, and API calls will be issued to fetch pages as needed.
168
+ # result.each do |item|
169
+ # # Each element is of type ::Google::Longrunning::Operation.
170
+ # p item
171
+ # end
172
+ #
139
173
  def list_operations request, options = nil
140
174
  raise ::ArgumentError, "request must be provided" if request.nil?
141
175
 
@@ -201,6 +235,29 @@ module Google
201
235
  # @return [::Gapic::Operation]
202
236
  #
203
237
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
238
+ #
239
+ # @example Basic example
240
+ # require "google/longrunning"
241
+ #
242
+ # # Create a client object. The client can be reused for multiple calls.
243
+ # client = Google::Longrunning::Operations::Rest::Client.new
244
+ #
245
+ # # Create a request. To set request fields, pass in keyword arguments.
246
+ # request = Google::Longrunning::GetOperationRequest.new
247
+ #
248
+ # # Call the get_operation method.
249
+ # result = client.get_operation request
250
+ #
251
+ # # The returned object is of type Gapic::Operation. You can use it to
252
+ # # check the status of an operation, cancel it, or wait for results.
253
+ # # Here is how to wait for a response.
254
+ # result.wait_until_done! timeout: 60
255
+ # if result.response?
256
+ # p result.response
257
+ # else
258
+ # puts "No response received."
259
+ # end
260
+ #
204
261
  def get_operation request, options = nil
205
262
  raise ::ArgumentError, "request must be provided" if request.nil?
206
263
 
@@ -267,6 +324,22 @@ module Google
267
324
  # @return [::Google::Protobuf::Empty]
268
325
  #
269
326
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
327
+ #
328
+ # @example Basic example
329
+ # require "google/longrunning"
330
+ #
331
+ # # Create a client object. The client can be reused for multiple calls.
332
+ # client = Google::Longrunning::Operations::Rest::Client.new
333
+ #
334
+ # # Create a request. To set request fields, pass in keyword arguments.
335
+ # request = Google::Longrunning::DeleteOperationRequest.new
336
+ #
337
+ # # Call the delete_operation method.
338
+ # result = client.delete_operation request
339
+ #
340
+ # # The returned object is of type Google::Protobuf::Empty.
341
+ # p result
342
+ #
270
343
  def delete_operation request, options = nil
271
344
  raise ::ArgumentError, "request must be provided" if request.nil?
272
345
 
@@ -338,6 +411,22 @@ module Google
338
411
  # @return [::Google::Protobuf::Empty]
339
412
  #
340
413
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
414
+ #
415
+ # @example Basic example
416
+ # require "google/longrunning"
417
+ #
418
+ # # Create a client object. The client can be reused for multiple calls.
419
+ # client = Google::Longrunning::Operations::Rest::Client.new
420
+ #
421
+ # # Create a request. To set request fields, pass in keyword arguments.
422
+ # request = Google::Longrunning::CancelOperationRequest.new
423
+ #
424
+ # # Call the cancel_operation method.
425
+ # result = client.cancel_operation request
426
+ #
427
+ # # The returned object is of type Google::Protobuf::Empty.
428
+ # p result
429
+ #
341
430
  def cancel_operation request, options = nil
342
431
  raise ::ArgumentError, "request must be provided" if request.nil?
343
432
 
@@ -403,9 +492,9 @@ module Google
403
492
  # end
404
493
  #
405
494
  # @!attribute [rw] endpoint
406
- # The hostname or hostname:port of the service endpoint.
407
- # Defaults to `"servicemanagement.googleapis.com"`.
408
- # @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]
409
498
  # @!attribute [rw] credentials
410
499
  # Credentials to send with calls. You may provide any of the following types:
411
500
  # * (`String`) The path to a service account key file in JSON format
@@ -442,13 +531,20 @@ module Google
442
531
  # @!attribute [rw] quota_project
443
532
  # A separate project against which to charge quota.
444
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]
445
539
  #
446
540
  class Configuration
447
541
  extend ::Gapic::Config
448
542
 
543
+ # @private
544
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
449
545
  DEFAULT_ENDPOINT = "servicemanagement.googleapis.com"
450
546
 
451
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
547
+ config_attr :endpoint, nil, ::String, nil
452
548
  config_attr :credentials, nil do |value|
453
549
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
454
550
  allowed.any? { |klass| klass === value }
@@ -460,6 +556,7 @@ module Google
460
556
  config_attr :metadata, nil, ::Hash, nil
461
557
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
462
558
  config_attr :quota_project, nil, ::String, nil
559
+ config_attr :universe_domain, nil, ::String, nil
463
560
 
464
561
  # @private
465
562
  def initialize parent_config = nil
@@ -542,12 +639,15 @@ module Google
542
639
  # Service stub contains baseline method implementations
543
640
  # including transcoding, making the REST call, and deserialing the response.
544
641
  class OperationsServiceStub
545
- def initialize endpoint:, credentials:
642
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
546
643
  # These require statements are intentionally placed here to initialize
547
644
  # the REST modules only when it's required.
548
645
  require "gapic/rest"
549
646
 
550
- @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
551
651
  end
552
652
 
553
653
  ##
data/lib/google/cloud/service_management/v1/service_manager/rest/service_stub.rb CHANGED
@@ -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_services REST call
45
57
  #
data/lib/google/cloud/service_management/v1/version.rb CHANGED
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module ServiceManagement
23
23
  module V1
24
- VERSION = "0.8.0"
24
+ VERSION = "0.10.0"
25
25
  end
26
26
  end
27
27
  end
data/proto_docs/google/api/backend.rb CHANGED
@@ -64,6 +64,7 @@ module Google
64
64
  # The number of seconds to wait for a response from a request. The default
65
65
  # varies based on the request protocol and deployment environment.
66
66
  # @!attribute [rw] min_deadline
67
+ # @deprecated This field is deprecated and may be removed in the next major version update.
67
68
  # @return [::Float]
68
69
  # Deprecated, do not use.
69
70
  # @!attribute [rw] operation_deadline
data/proto_docs/google/api/client.rb CHANGED
@@ -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
data/proto_docs/google/api/endpoint.rb CHANGED
@@ -44,6 +44,7 @@ module Google
44
44
  # @return [::String]
45
45
  # The canonical name of this endpoint.
46
46
  # @!attribute [rw] aliases
47
+ # @deprecated This field is deprecated and may be removed in the next major version update.
47
48
  # @return [::Array<::String>]
48
49
  # Unimplemented. Dot not use.
49
50
  #
data/proto_docs/google/api/field_behavior.rb CHANGED
@@ -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
data/proto_docs/google/api/metric.rb CHANGED
@@ -184,6 +184,7 @@ module Google
184
184
 
185
185
  # Additional annotations that can be used to guide the usage of a metric.
186
186
  # @!attribute [rw] launch_stage
187
+ # @deprecated This field is deprecated and may be removed in the next major version update.
187
188
  # @return [::Google::Api::LaunchStage]
188
189
  # Deprecated. Must use the
189
190
  # {::Google::Api::MetricDescriptor#launch_stage MetricDescriptor.launch_stage}
data/proto_docs/google/api/servicemanagement/v1/servicemanager.rb CHANGED
@@ -34,6 +34,7 @@ module Google
34
34
  # Token identifying which result to start with; returned by a previous list
35
35
  # call.
36
36
  # @!attribute [rw] consumer_id
37
+ # @deprecated This field is deprecated and may be removed in the next major version update.
37
38
  # @return [::String]
38
39
  # Include services consumed by the specified consumer.
39
40
  #
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-service_management-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.8.0
4
+ version: 0.10.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: 2023-07-26 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.19.1
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.19.1
29
+ version: 0.21.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -50,7 +50,7 @@ dependencies:
50
50
  requirements:
51
51
  - - ">="
52
52
  - !ruby/object:Gem::Version
53
- version: '0.4'
53
+ version: '0.7'
54
54
  - - "<"
55
55
  - !ruby/object:Gem::Version
56
56
  version: 2.a
@@ -60,7 +60,7 @@ dependencies:
60
60
  requirements:
61
61
  - - ">="
62
62
  - !ruby/object:Gem::Version
63
- version: '0.4'
63
+ version: '0.7'
64
64
  - - "<"
65
65
  - !ruby/object:Gem::Version
66
66
  version: 2.a
@@ -265,7 +265,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
265
265
  - !ruby/object:Gem::Version
266
266
  version: '0'
267
267
  requirements: []
268
- rubygems_version: 3.4.2
268
+ rubygems_version: 3.5.3
269
269
  signing_key:
270
270
  specification_version: 4
271
271
  summary: Google Service Management allows service producers to publish their services