google-cloud-alloy_db-v1alpha 0.3.0 → 0.5.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: 0f311c6a99e0394f713abe8f5be10cd3adfb433bd48b78a00a29318e7fb6b6b9
4
- data.tar.gz: 78a0254b8dd2965de249ea876fa594269eedcaa96b82674e43f29775df705da7
3
+ metadata.gz: f9e0ea0617a8f6e34ee8d6c256dbe31a80e6a12c35bd2a57f78ee728d840860e
4
+ data.tar.gz: 9486adfa5df5e9b112b2a36ce605a9f94be8dbfd4bcba3992c59e1c21ed44ac2
5
5
  SHA512:
6
- metadata.gz: cd0e37cb86ee887a1c520d088a045a0667e215804cce0b49f8a817ac4f3542d3ecf438f228564a40fda9ea1b7c59cc39d08603ce6e3c0b5552efb8cca5edb3f2
7
- data.tar.gz: b8be87d3588b5be6a923996d50a9d853abc178335137a4338471f0c5f379cd2947bfc9309ba9cbe1acc28b58a36856a3197664a6abc4cb298f50222983a3d0df
6
+ metadata.gz: 7c2b8b64fa8c1c210594eb7f5918c7705fefb2d4c872e4e486f644e2a2d86f48845e21b35ee853a9584b6d3d7c5faf5483dacbc85ca01c246c3729f8080d37d2
7
+ data.tar.gz: f4f9a559a59bd7de47b53e55c119dc6d2a1f93e2840a713e03e2005abed53152813629c23163f16f0ae13a2d2fa2f3771db3bbe4660d920bd9493c140a80da01
data/AUTHENTICATION.md CHANGED
@@ -1,149 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-alloy_db-v1alpha 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-alloy_db-v1alpha 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 GOOGLE_CLOUD_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/alloy_db/v1alpha"
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::AlloyDB::V1alpha::AlloyDBAdmin::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-alloy_db-v1alpha 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-alloy_db-v1alpha 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-alloy_db-v1alpha
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::AlloyDB::V1alpha::AlloyDBAdmin::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
71
- * `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)
72
41
 
73
- ```ruby
74
- require "google/cloud/alloy_db/v1alpha"
75
-
76
- ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
77
43
 
78
- client = ::Google::Cloud::AlloyDB::V1alpha::AlloyDBAdmin::Client.new
79
- ```
44
+ You can configure a path to a JSON credentials file, either for an individual client object or
45
+ globally, for all client objects. The JSON file can contain credentials created for
46
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
47
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
48
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
80
49
 
81
- ### 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.
82
53
 
83
- The path to the **Credentials JSON** file can be configured instead of storing
84
- it in an environment variable. Either on an individual client initialization:
54
+ To configure a credentials file for an individual client initialization:
85
55
 
86
56
  ```ruby
87
57
  require "google/cloud/alloy_db/v1alpha"
88
58
 
89
59
  client = ::Google::Cloud::AlloyDB::V1alpha::AlloyDBAdmin::Client.new do |config|
90
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
91
61
  end
92
62
  ```
93
63
 
94
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
95
65
 
96
66
  ```ruby
97
67
  require "google/cloud/alloy_db/v1alpha"
98
68
 
99
69
  ::Google::Cloud::AlloyDB::V1alpha::AlloyDBAdmin::Client.configure do |config|
100
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
101
71
  end
102
72
 
103
73
  client = ::Google::Cloud::AlloyDB::V1alpha::AlloyDBAdmin::Client.new
104
74
  ```
105
75
 
106
- ### Cloud SDK
76
+ ### Environment Variables
107
77
 
108
- This option allows for an easy way to authenticate during development. If
109
- credentials are not provided in code or in environment variables, then Cloud SDK
110
- 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.
111
82
 
112
- 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).
113
87
 
114
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
115
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
116
- 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-alloy_db-v1alpha
93
+ checks for credentials are:
117
94
 
118
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
119
- *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
120
97
 
121
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/alloy_db/v1alpha"
122
100
 
123
- Google Cloud requires **Service Account Credentials** to
124
- connect to the APIs. You will use the **JSON key file** to
125
- connect to most services with google-cloud-alloy_db-v1alpha.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
126
102
 
127
- If you are not running this client within
128
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
129
- need a Google Developers service account.
103
+ client = ::Google::Cloud::AlloyDB::V1alpha::AlloyDBAdmin::Client.new
104
+ ```
130
105
 
131
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
132
- 2. Create a new project or click on an existing project.
133
- 3. Activate the menu in the upper left and select **APIs & Services**. From
134
- here, you will enable the APIs that your application requires.
106
+ ### Local ADC file
135
107
 
136
- *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.
137
111
 
138
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
139
113
 
140
- Find the "Create credentials" drop down near the top of the page, and select
141
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
142
115
 
143
- If you want to re-use an existing service account, you can easily generate a
144
- new key file. Just select the account you wish to re-use, click the pencil
145
- tool on the right side to edit the service account, select the **Keys** tab,
146
- 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.
147
120
 
148
- The key file you download will be used by this library to authenticate API
149
- 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).
@@ -32,6 +32,9 @@ module Google
32
32
  # Service describing handlers for resources
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "alloydb.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -123,6 +126,11 @@ module Google
123
126
  initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
124
127
  }
125
128
 
129
+ default_config.rpcs.list_databases.timeout = 60.0
130
+ default_config.rpcs.list_databases.retry_policy = {
131
+ initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
132
+ }
133
+
126
134
  default_config
127
135
  end
128
136
  yield @configure if block_given?
@@ -149,6 +157,15 @@ module Google
149
157
  @config
150
158
  end
151
159
 
160
+ ##
161
+ # The effective universe domain
162
+ #
163
+ # @return [String]
164
+ #
165
+ def universe_domain
166
+ @alloy_db_admin_stub.universe_domain
167
+ end
168
+
152
169
  ##
153
170
  # Create a new AlloyDBAdmin client object.
154
171
  #
@@ -182,8 +199,9 @@ module Google
182
199
  credentials = @config.credentials
183
200
  # Use self-signed JWT if the endpoint is unchanged from default,
184
201
  # but only if the default endpoint does not have a region prefix.
185
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
186
- !@config.endpoint.split(".").first.include?("-")
202
+ enable_self_signed_jwt = @config.endpoint.nil? ||
203
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
204
+ !@config.endpoint.split(".").first.include?("-"))
187
205
  credentials ||= Credentials.default scope: @config.scope,
188
206
  enable_self_signed_jwt: enable_self_signed_jwt
189
207
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -196,24 +214,29 @@ module Google
196
214
  config.credentials = credentials
197
215
  config.quota_project = @quota_project_id
198
216
  config.endpoint = @config.endpoint
217
+ config.universe_domain = @config.universe_domain
199
218
  end
200
219
 
201
220
  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
202
221
  config.credentials = credentials
203
222
  config.quota_project = @quota_project_id
204
223
  config.endpoint = @config.endpoint
224
+ config.universe_domain = @config.universe_domain
205
225
  end
206
226
 
207
227
  @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
208
228
  config.credentials = credentials
209
229
  config.quota_project = @quota_project_id
210
230
  config.endpoint = @config.endpoint
231
+ config.universe_domain = @config.universe_domain
211
232
  end
212
233
 
213
234
  @alloy_db_admin_stub = ::Gapic::ServiceStub.new(
214
235
  ::Google::Cloud::AlloyDB::V1alpha::AlloyDBAdmin::Stub,
215
- credentials: credentials,
216
- endpoint: @config.endpoint,
236
+ credentials: credentials,
237
+ endpoint: @config.endpoint,
238
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
239
+ universe_domain: @config.universe_domain,
217
240
  channel_args: @config.channel_args,
218
241
  interceptors: @config.interceptors,
219
242
  channel_pool_config: @config.channel_pool
@@ -2935,7 +2958,8 @@ module Google
2935
2958
  # The request ID must be a valid UUID with the exception that zero UUID is
2936
2959
  # not supported (00000000-0000-0000-0000-000000000000).
2937
2960
  # @param pem_csr [::String]
2938
- # Optional. A pem-encoded X.509 certificate signing request (CSR).
2961
+ # Optional. A pem-encoded X.509 certificate signing request (CSR). It is
2962
+ # recommended to use public_key instead.
2939
2963
  # @param cert_duration [::Google::Protobuf::Duration, ::Hash]
2940
2964
  # Optional. An optional hint to the endpoint to generate the client
2941
2965
  # certificate with the requested duration. The duration can be from 1 hour to
@@ -3617,6 +3641,108 @@ module Google
3617
3641
  raise ::Google::Cloud::Error.from_error(e)
3618
3642
  end
3619
3643
 
3644
+ ##
3645
+ # Lists Databases in a given project and location.
3646
+ #
3647
+ # @overload list_databases(request, options = nil)
3648
+ # Pass arguments to `list_databases` via a request object, either of type
3649
+ # {::Google::Cloud::AlloyDB::V1alpha::ListDatabasesRequest} or an equivalent Hash.
3650
+ #
3651
+ # @param request [::Google::Cloud::AlloyDB::V1alpha::ListDatabasesRequest, ::Hash]
3652
+ # A request object representing the call parameters. Required. To specify no
3653
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
3654
+ # @param options [::Gapic::CallOptions, ::Hash]
3655
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
3656
+ #
3657
+ # @overload list_databases(parent: nil, page_size: nil, page_token: nil, filter: nil)
3658
+ # Pass arguments to `list_databases` via keyword arguments. Note that at
3659
+ # least one keyword argument is required. To specify no parameters, or to keep all
3660
+ # the default parameter values, pass an empty Hash as a request object (see above).
3661
+ #
3662
+ # @param parent [::String]
3663
+ # Required. Parent value for ListDatabasesRequest.
3664
+ # @param page_size [::Integer]
3665
+ # Optional. The maximum number of databases to return. The service may return
3666
+ # fewer than this value. If unspecified, an appropriate number of databases
3667
+ # will be returned. The max value will be 2000, values above max will be
3668
+ # coerced to max.
3669
+ # @param page_token [::String]
3670
+ # Optional. A page token, received from a previous `ListDatabases` call.
3671
+ # This should be provided to retrieve the subsequent page.
3672
+ # This field is currently not supported, its value will be ignored if passed.
3673
+ # @param filter [::String]
3674
+ # Optional. Filtering results.
3675
+ # This field is currently not supported, its value will be ignored if passed.
3676
+ #
3677
+ # @yield [response, operation] Access the result along with the RPC operation
3678
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1alpha::Database>]
3679
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
3680
+ #
3681
+ # @return [::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1alpha::Database>]
3682
+ #
3683
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
3684
+ #
3685
+ # @example Basic example
3686
+ # require "google/cloud/alloy_db/v1alpha"
3687
+ #
3688
+ # # Create a client object. The client can be reused for multiple calls.
3689
+ # client = Google::Cloud::AlloyDB::V1alpha::AlloyDBAdmin::Client.new
3690
+ #
3691
+ # # Create a request. To set request fields, pass in keyword arguments.
3692
+ # request = Google::Cloud::AlloyDB::V1alpha::ListDatabasesRequest.new
3693
+ #
3694
+ # # Call the list_databases method.
3695
+ # result = client.list_databases request
3696
+ #
3697
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
3698
+ # # over elements, and API calls will be issued to fetch pages as needed.
3699
+ # result.each do |item|
3700
+ # # Each element is of type ::Google::Cloud::AlloyDB::V1alpha::Database.
3701
+ # p item
3702
+ # end
3703
+ #
3704
+ def list_databases request, options = nil
3705
+ raise ::ArgumentError, "request must be provided" if request.nil?
3706
+
3707
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1alpha::ListDatabasesRequest
3708
+
3709
+ # Converts hash and nil to an options object
3710
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
3711
+
3712
+ # Customize the options with defaults
3713
+ metadata = @config.rpcs.list_databases.metadata.to_h
3714
+
3715
+ # Set x-goog-api-client and x-goog-user-project headers
3716
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
3717
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
3718
+ gapic_version: ::Google::Cloud::AlloyDB::V1alpha::VERSION
3719
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
3720
+
3721
+ header_params = {}
3722
+ if request.parent
3723
+ header_params["parent"] = request.parent
3724
+ end
3725
+
3726
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
3727
+ metadata[:"x-goog-request-params"] ||= request_params_header
3728
+
3729
+ options.apply_defaults timeout: @config.rpcs.list_databases.timeout,
3730
+ metadata: metadata,
3731
+ retry_policy: @config.rpcs.list_databases.retry_policy
3732
+
3733
+ options.apply_defaults timeout: @config.timeout,
3734
+ metadata: @config.metadata,
3735
+ retry_policy: @config.retry_policy
3736
+
3737
+ @alloy_db_admin_stub.call_rpc :list_databases, request, options: options do |response, operation|
3738
+ response = ::Gapic::PagedEnumerable.new @alloy_db_admin_stub, :list_databases, request, response, operation, options
3739
+ yield response, operation if block_given?
3740
+ return response
3741
+ end
3742
+ rescue ::GRPC::BadStatus => e
3743
+ raise ::Google::Cloud::Error.from_error(e)
3744
+ end
3745
+
3620
3746
  ##
3621
3747
  # Configuration class for the AlloyDBAdmin API.
3622
3748
  #
@@ -3647,9 +3773,9 @@ module Google
3647
3773
  # end
3648
3774
  #
3649
3775
  # @!attribute [rw] endpoint
3650
- # The hostname or hostname:port of the service endpoint.
3651
- # Defaults to `"alloydb.googleapis.com"`.
3652
- # @return [::String]
3776
+ # A custom service endpoint, as a hostname or hostname:port. The default is
3777
+ # nil, indicating to use the default endpoint in the current universe domain.
3778
+ # @return [::String,nil]
3653
3779
  # @!attribute [rw] credentials
3654
3780
  # Credentials to send with calls. You may provide any of the following types:
3655
3781
  # * (`String`) The path to a service account key file in JSON format
@@ -3695,13 +3821,20 @@ module Google
3695
3821
  # @!attribute [rw] quota_project
3696
3822
  # A separate project against which to charge quota.
3697
3823
  # @return [::String]
3824
+ # @!attribute [rw] universe_domain
3825
+ # The universe domain within which to make requests. This determines the
3826
+ # default endpoint URL. The default value of nil uses the environment
3827
+ # universe (usually the default "googleapis.com" universe).
3828
+ # @return [::String,nil]
3698
3829
  #
3699
3830
  class Configuration
3700
3831
  extend ::Gapic::Config
3701
3832
 
3833
+ # @private
3834
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
3702
3835
  DEFAULT_ENDPOINT = "alloydb.googleapis.com"
3703
3836
 
3704
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
3837
+ config_attr :endpoint, nil, ::String, nil
3705
3838
  config_attr :credentials, nil do |value|
3706
3839
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
3707
3840
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -3716,6 +3849,7 @@ module Google
3716
3849
  config_attr :metadata, nil, ::Hash, nil
3717
3850
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
3718
3851
  config_attr :quota_project, nil, ::String, nil
3852
+ config_attr :universe_domain, nil, ::String, nil
3719
3853
 
3720
3854
  # @private
3721
3855
  def initialize parent_config = nil
@@ -3917,6 +4051,11 @@ module Google
3917
4051
  # @return [::Gapic::Config::Method]
3918
4052
  #
3919
4053
  attr_reader :delete_user
4054
+ ##
4055
+ # RPC-specific configuration for `list_databases`
4056
+ # @return [::Gapic::Config::Method]
4057
+ #
4058
+ attr_reader :list_databases
3920
4059
 
3921
4060
  # @private
3922
4061
  def initialize parent_rpcs = nil
@@ -3982,6 +4121,8 @@ module Google
3982
4121
  @update_user = ::Gapic::Config::Method.new update_user_config
3983
4122
  delete_user_config = parent_rpcs.delete_user if parent_rpcs.respond_to? :delete_user
3984
4123
  @delete_user = ::Gapic::Config::Method.new delete_user_config
4124
+ list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
4125
+ @list_databases = ::Gapic::Config::Method.new list_databases_config
3985
4126
 
3986
4127
  yield self if block_given?
3987
4128
  end
@@ -26,6 +26,9 @@ module Google
26
26
  module AlloyDBAdmin
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "alloydb.$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 `"alloydb.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 = "alloydb.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
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module AlloyDB
23
23
  module V1alpha
24
- VERSION = "0.3.0"
24
+ VERSION = "0.5.0"
25
25
  end
26
26
  end
27
27
  end