google-cloud-private_catalog-v1beta1 0.4.1 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +72 -101
- data/lib/google/cloud/private_catalog/v1beta1/private_catalog/client.rb +41 -9
- data/lib/google/cloud/private_catalog/v1beta1/private_catalog/rest/client.rb +93 -7
- data/lib/google/cloud/private_catalog/v1beta1/private_catalog/rest/service_stub.rb +14 -2
- data/lib/google/cloud/private_catalog/v1beta1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -0
- data/proto_docs/google/api/field_behavior.rb +14 -0
- data/proto_docs/google/cloud/privatecatalog/v1beta1/private_catalog.rb +2 -0
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d5bbc257fbce39668768acaf838dd8e90f1a1a31089f84edba7c4b428a5e5d4e
|
4
|
+
data.tar.gz: aa0cd50f9e32e9d5db25de9e0103f31a8487b697980df0708bb99347e80ffe4f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7c773b8f8190ca2ba8589ed327ce4c98d59cc9126c9e80a5d8cae7faa8b84a0412cb93ae0e142f5516d72727da0c55f2dbfc0ab39daaac769251485b742a5092
|
7
|
+
data.tar.gz: cb70ec10f2573e5f9e30584660f4edca143f3116ecf305c2aefcbf03c6896eba5dce817d3da929aa3168c2b4bc4ad99c30a98d87fa2c5ba7da618fe725155617
|
data/AUTHENTICATION.md
CHANGED
@@ -1,151 +1,122 @@
|
|
1
1
|
# Authentication
|
2
2
|
|
3
|
-
|
4
|
-
[
|
5
|
-
|
6
|
-
[Google Cloud Platform environments](#google-cloud-platform-environments) the
|
7
|
-
credentials will be discovered automatically. When running on other
|
8
|
-
environments, the Service Account credentials can be specified by providing the
|
9
|
-
path to the
|
10
|
-
[JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
|
11
|
-
for the account (or the JSON itself) in
|
12
|
-
[environment variables](#environment-variables). Additionally, Cloud SDK
|
13
|
-
credentials can also be discovered automatically, but this is only recommended
|
14
|
-
during development.
|
3
|
+
The recommended way to authenticate to the google-cloud-private_catalog-v1beta1 library is to use
|
4
|
+
[Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
|
5
|
+
To review all of your authentication options, see [Credentials lookup](#credential-lookup).
|
15
6
|
|
16
7
|
## Quickstart
|
17
8
|
|
18
|
-
|
19
|
-
|
9
|
+
The following example shows how to set up authentication for a local development
|
10
|
+
environment with your user credentials.
|
20
11
|
|
21
|
-
|
22
|
-
|
23
|
-
```
|
24
|
-
|
25
|
-
3. Initialize the client.
|
12
|
+
**NOTE:** This method is _not_ recommended for running in production. User credentials
|
13
|
+
should be used only during development.
|
26
14
|
|
27
|
-
|
28
|
-
|
15
|
+
1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
|
16
|
+
2. Set up a local ADC file with your user credentials:
|
29
17
|
|
30
|
-
|
18
|
+
```sh
|
19
|
+
gcloud auth application-default login
|
31
20
|
```
|
32
21
|
|
33
|
-
|
34
|
-
|
35
|
-
The google-cloud-private_catalog-v1beta1 library aims to make authentication
|
36
|
-
as simple as possible, and provides several mechanisms to configure your system
|
37
|
-
without requiring **Service Account Credentials** directly in code.
|
38
|
-
|
39
|
-
**Credentials** are discovered in the following order:
|
40
|
-
|
41
|
-
1. Specify credentials in method arguments
|
42
|
-
2. Specify credentials in configuration
|
43
|
-
3. Discover credentials path in environment variables
|
44
|
-
4. Discover credentials JSON in environment variables
|
45
|
-
5. Discover credentials file in the Cloud SDK's path
|
46
|
-
6. Discover GCP credentials
|
47
|
-
|
48
|
-
### Google Cloud Platform environments
|
22
|
+
3. Write code as if already authenticated.
|
49
23
|
|
50
|
-
|
51
|
-
|
52
|
-
Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
|
53
|
-
Code should be written as if already authenticated.
|
24
|
+
For more information about setting up authentication for a local development environment, see
|
25
|
+
[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
|
54
26
|
|
55
|
-
|
27
|
+
## Credential Lookup
|
56
28
|
|
57
|
-
The
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
**Credentials JSON** file can be stored in the environment variable, or the
|
62
|
-
**Credentials JSON** itself can be stored for environments such as Docker
|
63
|
-
containers where writing files is difficult or not encouraged.
|
29
|
+
The google-cloud-private_catalog-v1beta1 library provides several mechanisms to configure your system.
|
30
|
+
Generally, using Application Default Credentials to facilitate automatic
|
31
|
+
credentials discovery is the easist method. But if you need to explicitly specify
|
32
|
+
credentials, there are several methods available to you.
|
64
33
|
|
65
|
-
|
66
|
-
checks for credentials are configured on the service Credentials class (such as
|
67
|
-
{::Google::Cloud::PrivateCatalog::V1beta1::PrivateCatalog::Credentials}):
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
68
35
|
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
36
|
+
1. Credentials specified in method arguments
|
37
|
+
2. Credentials specified in configuration
|
38
|
+
3. Credentials pointed to or included in environment variables
|
39
|
+
4. Credentials found in local ADC file
|
40
|
+
5. Credentials returned by the metadata server for the attached service account (GCP)
|
74
41
|
|
75
|
-
|
76
|
-
require "google/cloud/private_catalog/v1beta1"
|
77
|
-
|
78
|
-
ENV["PRIVATE_CATALOG_CREDENTIALS"] = "path/to/keyfile.json"
|
42
|
+
### Configuration
|
79
43
|
|
80
|
-
client
|
81
|
-
|
44
|
+
You can configure a path to a JSON credentials file, either for an individual client object or
|
45
|
+
globally, for all client objects. The JSON file can contain credentials created for
|
46
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
47
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
48
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
82
49
|
|
83
|
-
|
50
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
51
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
52
|
+
whenever possible.
|
84
53
|
|
85
|
-
|
86
|
-
it in an environment variable. Either on an individual client initialization:
|
54
|
+
To configure a credentials file for an individual client initialization:
|
87
55
|
|
88
56
|
```ruby
|
89
57
|
require "google/cloud/private_catalog/v1beta1"
|
90
58
|
|
91
59
|
client = ::Google::Cloud::PrivateCatalog::V1beta1::PrivateCatalog::Client.new do |config|
|
92
|
-
config.credentials = "path/to/
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
93
61
|
end
|
94
62
|
```
|
95
63
|
|
96
|
-
|
64
|
+
To configure a credentials file globally for all clients:
|
97
65
|
|
98
66
|
```ruby
|
99
67
|
require "google/cloud/private_catalog/v1beta1"
|
100
68
|
|
101
69
|
::Google::Cloud::PrivateCatalog::V1beta1::PrivateCatalog::Client.configure do |config|
|
102
|
-
config.credentials = "path/to/
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
103
71
|
end
|
104
72
|
|
105
73
|
client = ::Google::Cloud::PrivateCatalog::V1beta1::PrivateCatalog::Client.new
|
106
74
|
```
|
107
75
|
|
108
|
-
###
|
76
|
+
### Environment Variables
|
109
77
|
|
110
|
-
|
111
|
-
|
112
|
-
|
78
|
+
You can also use an environment variable to provide a JSON credentials file.
|
79
|
+
The environment variable can contain a path to the credentials file or, for
|
80
|
+
environments such as Docker containers where writing files is not encouraged,
|
81
|
+
you can include the credentials file itself.
|
113
82
|
|
114
|
-
|
83
|
+
The JSON file can contain credentials created for
|
84
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
85
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
86
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
115
87
|
|
116
|
-
|
117
|
-
|
118
|
-
|
88
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
89
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
90
|
+
whenever possible.
|
91
|
+
|
92
|
+
The environment variables that google-cloud-private_catalog-v1beta1
|
93
|
+
checks for credentials are:
|
119
94
|
|
120
|
-
|
121
|
-
*
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
122
97
|
|
123
|
-
|
98
|
+
```ruby
|
99
|
+
require "google/cloud/private_catalog/v1beta1"
|
124
100
|
|
125
|
-
|
126
|
-
connect to the APIs. You will use the **JSON key file** to
|
127
|
-
connect to most services with google-cloud-private_catalog-v1beta1.
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
128
102
|
|
129
|
-
|
130
|
-
|
131
|
-
need a Google Developers service account.
|
103
|
+
client = ::Google::Cloud::PrivateCatalog::V1beta1::PrivateCatalog::Client.new
|
104
|
+
```
|
132
105
|
|
133
|
-
|
134
|
-
2. Create a new project or click on an existing project.
|
135
|
-
3. Activate the menu in the upper left and select **APIs & Services**. From
|
136
|
-
here, you will enable the APIs that your application requires.
|
106
|
+
### Local ADC file
|
137
107
|
|
138
|
-
|
108
|
+
You can set up a local ADC file with your user credentials for authentication during
|
109
|
+
development. If credentials are not provided in code or in environment variables,
|
110
|
+
then the local ADC credentials are discovered.
|
139
111
|
|
140
|
-
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
141
113
|
|
142
|
-
|
143
|
-
"Service account" to be guided through downloading a new JSON key file.
|
114
|
+
### Google Cloud Platform environments
|
144
115
|
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
|
116
|
+
When running on Google Cloud Platform (GCP), including Google Compute Engine
|
117
|
+
(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
|
118
|
+
Functions (GCF) and Cloud Run, credentials are retrieved from the attached
|
119
|
+
service account automatically. Code should be written as if already authenticated.
|
149
120
|
|
150
|
-
|
151
|
-
|
121
|
+
For more information, see
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
@@ -50,6 +50,9 @@ module Google
|
|
50
50
|
# [google.cloud.privatecatalogproducer.v1beta.Version][].
|
51
51
|
#
|
52
52
|
class Client
|
53
|
+
# @private
|
54
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudprivatecatalog.$UNIVERSE_DOMAIN$"
|
55
|
+
|
53
56
|
# @private
|
54
57
|
attr_reader :private_catalog_stub
|
55
58
|
|
@@ -108,6 +111,15 @@ module Google
|
|
108
111
|
@config
|
109
112
|
end
|
110
113
|
|
114
|
+
##
|
115
|
+
# The effective universe domain
|
116
|
+
#
|
117
|
+
# @return [String]
|
118
|
+
#
|
119
|
+
def universe_domain
|
120
|
+
@private_catalog_stub.universe_domain
|
121
|
+
end
|
122
|
+
|
111
123
|
##
|
112
124
|
# Create a new PrivateCatalog client object.
|
113
125
|
#
|
@@ -141,8 +153,9 @@ module Google
|
|
141
153
|
credentials = @config.credentials
|
142
154
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
143
155
|
# but only if the default endpoint does not have a region prefix.
|
144
|
-
enable_self_signed_jwt = @config.endpoint
|
145
|
-
|
156
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
157
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
158
|
+
!@config.endpoint.split(".").first.include?("-"))
|
146
159
|
credentials ||= Credentials.default scope: @config.scope,
|
147
160
|
enable_self_signed_jwt: enable_self_signed_jwt
|
148
161
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
@@ -153,10 +166,13 @@ module Google
|
|
153
166
|
|
154
167
|
@private_catalog_stub = ::Gapic::ServiceStub.new(
|
155
168
|
::Google::Cloud::PrivateCatalog::V1beta1::PrivateCatalog::Stub,
|
156
|
-
credentials:
|
157
|
-
endpoint:
|
169
|
+
credentials: credentials,
|
170
|
+
endpoint: @config.endpoint,
|
171
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
172
|
+
universe_domain: @config.universe_domain,
|
158
173
|
channel_args: @config.channel_args,
|
159
|
-
interceptors: @config.interceptors
|
174
|
+
interceptors: @config.interceptors,
|
175
|
+
channel_pool_config: @config.channel_pool
|
160
176
|
)
|
161
177
|
end
|
162
178
|
|
@@ -506,9 +522,9 @@ module Google
|
|
506
522
|
# end
|
507
523
|
#
|
508
524
|
# @!attribute [rw] endpoint
|
509
|
-
#
|
510
|
-
#
|
511
|
-
# @return [::String]
|
525
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
526
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
527
|
+
# @return [::String,nil]
|
512
528
|
# @!attribute [rw] credentials
|
513
529
|
# Credentials to send with calls. You may provide any of the following types:
|
514
530
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -554,13 +570,20 @@ module Google
|
|
554
570
|
# @!attribute [rw] quota_project
|
555
571
|
# A separate project against which to charge quota.
|
556
572
|
# @return [::String]
|
573
|
+
# @!attribute [rw] universe_domain
|
574
|
+
# The universe domain within which to make requests. This determines the
|
575
|
+
# default endpoint URL. The default value of nil uses the environment
|
576
|
+
# universe (usually the default "googleapis.com" universe).
|
577
|
+
# @return [::String,nil]
|
557
578
|
#
|
558
579
|
class Configuration
|
559
580
|
extend ::Gapic::Config
|
560
581
|
|
582
|
+
# @private
|
583
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
561
584
|
DEFAULT_ENDPOINT = "cloudprivatecatalog.googleapis.com"
|
562
585
|
|
563
|
-
config_attr :endpoint,
|
586
|
+
config_attr :endpoint, nil, ::String, nil
|
564
587
|
config_attr :credentials, nil do |value|
|
565
588
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
566
589
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
@@ -575,6 +598,7 @@ module Google
|
|
575
598
|
config_attr :metadata, nil, ::Hash, nil
|
576
599
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
577
600
|
config_attr :quota_project, nil, ::String, nil
|
601
|
+
config_attr :universe_domain, nil, ::String, nil
|
578
602
|
|
579
603
|
# @private
|
580
604
|
def initialize parent_config = nil
|
@@ -595,6 +619,14 @@ module Google
|
|
595
619
|
end
|
596
620
|
end
|
597
621
|
|
622
|
+
##
|
623
|
+
# Configuration for the channel pool
|
624
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
625
|
+
#
|
626
|
+
def channel_pool
|
627
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
628
|
+
end
|
629
|
+
|
598
630
|
##
|
599
631
|
# Configuration RPC class for the PrivateCatalog API.
|
600
632
|
#
|
@@ -52,6 +52,9 @@ module Google
|
|
52
52
|
# [google.cloud.privatecatalogproducer.v1beta.Version][].
|
53
53
|
#
|
54
54
|
class Client
|
55
|
+
# @private
|
56
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudprivatecatalog.$UNIVERSE_DOMAIN$"
|
57
|
+
|
55
58
|
# @private
|
56
59
|
attr_reader :private_catalog_stub
|
57
60
|
|
@@ -110,6 +113,15 @@ module Google
|
|
110
113
|
@config
|
111
114
|
end
|
112
115
|
|
116
|
+
##
|
117
|
+
# The effective universe domain
|
118
|
+
#
|
119
|
+
# @return [String]
|
120
|
+
#
|
121
|
+
def universe_domain
|
122
|
+
@private_catalog_stub.universe_domain
|
123
|
+
end
|
124
|
+
|
113
125
|
##
|
114
126
|
# Create a new PrivateCatalog REST client object.
|
115
127
|
#
|
@@ -137,8 +149,9 @@ module Google
|
|
137
149
|
credentials = @config.credentials
|
138
150
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
139
151
|
# but only if the default endpoint does not have a region prefix.
|
140
|
-
enable_self_signed_jwt = @config.endpoint
|
141
|
-
|
152
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
153
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
154
|
+
!@config.endpoint.split(".").first.include?("-"))
|
142
155
|
credentials ||= Credentials.default scope: @config.scope,
|
143
156
|
enable_self_signed_jwt: enable_self_signed_jwt
|
144
157
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
@@ -148,7 +161,12 @@ module Google
|
|
148
161
|
@quota_project_id = @config.quota_project
|
149
162
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
150
163
|
|
151
|
-
@private_catalog_stub = ::Google::Cloud::PrivateCatalog::V1beta1::PrivateCatalog::Rest::ServiceStub.new
|
164
|
+
@private_catalog_stub = ::Google::Cloud::PrivateCatalog::V1beta1::PrivateCatalog::Rest::ServiceStub.new(
|
165
|
+
endpoint: @config.endpoint,
|
166
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
167
|
+
universe_domain: @config.universe_domain,
|
168
|
+
credentials: credentials
|
169
|
+
)
|
152
170
|
end
|
153
171
|
|
154
172
|
# Service calls
|
@@ -194,6 +212,26 @@ module Google
|
|
194
212
|
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::PrivateCatalog::V1beta1::Catalog>]
|
195
213
|
#
|
196
214
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
215
|
+
#
|
216
|
+
# @example Basic example
|
217
|
+
# require "google/cloud/private_catalog/v1beta1"
|
218
|
+
#
|
219
|
+
# # Create a client object. The client can be reused for multiple calls.
|
220
|
+
# client = Google::Cloud::PrivateCatalog::V1beta1::PrivateCatalog::Rest::Client.new
|
221
|
+
#
|
222
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
223
|
+
# request = Google::Cloud::PrivateCatalog::V1beta1::SearchCatalogsRequest.new
|
224
|
+
#
|
225
|
+
# # Call the search_catalogs method.
|
226
|
+
# result = client.search_catalogs request
|
227
|
+
#
|
228
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
229
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
230
|
+
# result.each do |item|
|
231
|
+
# # Each element is of type ::Google::Cloud::PrivateCatalog::V1beta1::Catalog.
|
232
|
+
# p item
|
233
|
+
# end
|
234
|
+
#
|
197
235
|
def search_catalogs request, options = nil
|
198
236
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
199
237
|
|
@@ -272,6 +310,26 @@ module Google
|
|
272
310
|
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::PrivateCatalog::V1beta1::Product>]
|
273
311
|
#
|
274
312
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
313
|
+
#
|
314
|
+
# @example Basic example
|
315
|
+
# require "google/cloud/private_catalog/v1beta1"
|
316
|
+
#
|
317
|
+
# # Create a client object. The client can be reused for multiple calls.
|
318
|
+
# client = Google::Cloud::PrivateCatalog::V1beta1::PrivateCatalog::Rest::Client.new
|
319
|
+
#
|
320
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
321
|
+
# request = Google::Cloud::PrivateCatalog::V1beta1::SearchProductsRequest.new
|
322
|
+
#
|
323
|
+
# # Call the search_products method.
|
324
|
+
# result = client.search_products request
|
325
|
+
#
|
326
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
327
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
328
|
+
# result.each do |item|
|
329
|
+
# # Each element is of type ::Google::Cloud::PrivateCatalog::V1beta1::Product.
|
330
|
+
# p item
|
331
|
+
# end
|
332
|
+
#
|
275
333
|
def search_products request, options = nil
|
276
334
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
277
335
|
|
@@ -350,6 +408,26 @@ module Google
|
|
350
408
|
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::PrivateCatalog::V1beta1::Version>]
|
351
409
|
#
|
352
410
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
411
|
+
#
|
412
|
+
# @example Basic example
|
413
|
+
# require "google/cloud/private_catalog/v1beta1"
|
414
|
+
#
|
415
|
+
# # Create a client object. The client can be reused for multiple calls.
|
416
|
+
# client = Google::Cloud::PrivateCatalog::V1beta1::PrivateCatalog::Rest::Client.new
|
417
|
+
#
|
418
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
419
|
+
# request = Google::Cloud::PrivateCatalog::V1beta1::SearchVersionsRequest.new
|
420
|
+
#
|
421
|
+
# # Call the search_versions method.
|
422
|
+
# result = client.search_versions request
|
423
|
+
#
|
424
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
425
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
426
|
+
# result.each do |item|
|
427
|
+
# # Each element is of type ::Google::Cloud::PrivateCatalog::V1beta1::Version.
|
428
|
+
# p item
|
429
|
+
# end
|
430
|
+
#
|
353
431
|
def search_versions request, options = nil
|
354
432
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
355
433
|
|
@@ -416,9 +494,9 @@ module Google
|
|
416
494
|
# end
|
417
495
|
#
|
418
496
|
# @!attribute [rw] endpoint
|
419
|
-
#
|
420
|
-
#
|
421
|
-
# @return [::String]
|
497
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
498
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
499
|
+
# @return [::String,nil]
|
422
500
|
# @!attribute [rw] credentials
|
423
501
|
# Credentials to send with calls. You may provide any of the following types:
|
424
502
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -455,13 +533,20 @@ module Google
|
|
455
533
|
# @!attribute [rw] quota_project
|
456
534
|
# A separate project against which to charge quota.
|
457
535
|
# @return [::String]
|
536
|
+
# @!attribute [rw] universe_domain
|
537
|
+
# The universe domain within which to make requests. This determines the
|
538
|
+
# default endpoint URL. The default value of nil uses the environment
|
539
|
+
# universe (usually the default "googleapis.com" universe).
|
540
|
+
# @return [::String,nil]
|
458
541
|
#
|
459
542
|
class Configuration
|
460
543
|
extend ::Gapic::Config
|
461
544
|
|
545
|
+
# @private
|
546
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
462
547
|
DEFAULT_ENDPOINT = "cloudprivatecatalog.googleapis.com"
|
463
548
|
|
464
|
-
config_attr :endpoint,
|
549
|
+
config_attr :endpoint, nil, ::String, nil
|
465
550
|
config_attr :credentials, nil do |value|
|
466
551
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
467
552
|
allowed.any? { |klass| klass === value }
|
@@ -473,6 +558,7 @@ module Google
|
|
473
558
|
config_attr :metadata, nil, ::Hash, nil
|
474
559
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
475
560
|
config_attr :quota_project, nil, ::String, nil
|
561
|
+
config_attr :universe_domain, nil, ::String, nil
|
476
562
|
|
477
563
|
# @private
|
478
564
|
def initialize parent_config = nil
|
@@ -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,
|
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 search_catalogs REST call
|
45
57
|
#
|
@@ -21,6 +21,7 @@ module Google
|
|
21
21
|
module Api
|
22
22
|
# Required information for every language.
|
23
23
|
# @!attribute [rw] reference_docs_uri
|
24
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
24
25
|
# @return [::String]
|
25
26
|
# Link to automatically generated reference documentation. Example:
|
26
27
|
# https://cloud.google.com/nodejs/docs/reference/asset/latest
|
@@ -304,6 +305,19 @@ module Google
|
|
304
305
|
# seconds: 360 # 6 minutes
|
305
306
|
# total_poll_timeout:
|
306
307
|
# seconds: 54000 # 90 minutes
|
308
|
+
# @!attribute [rw] auto_populated_fields
|
309
|
+
# @return [::Array<::String>]
|
310
|
+
# List of top-level fields of the request message, that should be
|
311
|
+
# automatically populated by the client libraries based on their
|
312
|
+
# (google.api.field_info).format. Currently supported format: UUID4.
|
313
|
+
#
|
314
|
+
# Example of a YAML configuration:
|
315
|
+
#
|
316
|
+
# publishing:
|
317
|
+
# method_settings:
|
318
|
+
# - selector: google.example.v1.ExampleService.CreateExample
|
319
|
+
# auto_populated_fields:
|
320
|
+
# - request_id
|
307
321
|
class MethodSettings
|
308
322
|
include ::Google::Protobuf::MessageExts
|
309
323
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -66,6 +66,20 @@ module Google
|
|
66
66
|
# a non-empty value will be returned. The user will not be aware of what
|
67
67
|
# non-empty value to expect.
|
68
68
|
NON_EMPTY_DEFAULT = 7
|
69
|
+
|
70
|
+
# Denotes that the field in a resource (a message annotated with
|
71
|
+
# google.api.resource) is used in the resource name to uniquely identify the
|
72
|
+
# resource. For AIP-compliant APIs, this should only be applied to the
|
73
|
+
# `name` field on the resource.
|
74
|
+
#
|
75
|
+
# This behavior should not be applied to references to other resources within
|
76
|
+
# the message.
|
77
|
+
#
|
78
|
+
# The identifier field of resources often have different field behavior
|
79
|
+
# depending on the request it is embedded in (e.g. for Create methods name
|
80
|
+
# is optional and unused, while for Update methods it is required). Instead
|
81
|
+
# of method-specific annotations, only `IDENTIFIER` is required.
|
82
|
+
IDENTIFIER = 8
|
69
83
|
end
|
70
84
|
end
|
71
85
|
end
|
@@ -373,6 +373,7 @@ module Google
|
|
373
373
|
# @return [::String]
|
374
374
|
# Output only. The asset resource name if an asset is hosted by Private Catalog.
|
375
375
|
# @!attribute [r] gcs_path
|
376
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
376
377
|
# @return [::String]
|
377
378
|
# Output only. The cloud storage object path.
|
378
379
|
# @!attribute [r] git_source
|
@@ -388,6 +389,7 @@ module Google
|
|
388
389
|
# @return [::Google::Protobuf::Timestamp]
|
389
390
|
# Output only. The last update timestamp of the asset reference.
|
390
391
|
# @!attribute [rw] version
|
392
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
391
393
|
# @return [::String]
|
392
394
|
# The version of the source used for this asset reference.
|
393
395
|
class AssetReference
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-private_catalog-v1beta1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.6.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2024-01-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -16,7 +16,7 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - ">="
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: 0.
|
19
|
+
version: 0.21.1
|
20
20
|
- - "<"
|
21
21
|
- !ruby/object:Gem::Version
|
22
22
|
version: 2.a
|
@@ -26,7 +26,7 @@ dependencies:
|
|
26
26
|
requirements:
|
27
27
|
- - ">="
|
28
28
|
- !ruby/object:Gem::Version
|
29
|
-
version: 0.
|
29
|
+
version: 0.21.1
|
30
30
|
- - "<"
|
31
31
|
- !ruby/object:Gem::Version
|
32
32
|
version: 2.a
|
@@ -215,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
215
215
|
- !ruby/object:Gem::Version
|
216
216
|
version: '0'
|
217
217
|
requirements: []
|
218
|
-
rubygems_version: 3.
|
218
|
+
rubygems_version: 3.5.3
|
219
219
|
signing_key:
|
220
220
|
specification_version: 4
|
221
221
|
summary: Enable cloud users to discover private catalogs and products in their organizations.
|