google-cloud-api_keys-v2 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 +4 -4
- data/AUTHENTICATION.md +72 -99
- data/lib/google/api/apikeys/v2/apikeys_pb.rb +2 -1
- data/lib/google/cloud/api_keys/v2/api_keys/client.rb +42 -9
- data/lib/google/cloud/api_keys/v2/api_keys/operations.rb +38 -7
- data/lib/google/cloud/api_keys/v2/api_keys/rest/client.rb +194 -7
- data/lib/google/cloud/api_keys/v2/api_keys/rest/operations.rb +108 -8
- data/lib/google/cloud/api_keys/v2/api_keys/rest/service_stub.rb +14 -2
- data/lib/google/cloud/api_keys/v2/version.rb +1 -1
- data/proto_docs/google/api/apikeys/v2/resources.rb +6 -6
- data/proto_docs/google/api/client.rb +14 -0
- data/proto_docs/google/api/field_behavior.rb +14 -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: b27ce0856b0e280cc7da391203d352c1c5be7758897bb361a2182591d9eb7b48
|
|
4
|
+
data.tar.gz: 34ca6e9d5ea13762f086a5b7974c6a0dba89bb9cf1eaff2fa77b2e7887b528ae
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ba7c5df07d253c9b13706868525e78c3f9cf4a6a9143d38726f466522ed7ce2f4fcfd52bad2cedf3a81ea4fab9fedc819917f25b45161b42467a55433730a182
|
|
7
|
+
data.tar.gz: d82bc8fc930deed9fc8d949c73532ead7f7f66980edea46842f1ecb3daabaeea924e93f1db18fd94c34170da6473a69c629878d7a348189dbab6441514af637d
|
data/AUTHENTICATION.md
CHANGED
|
@@ -1,149 +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-api_keys-v2 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-api_keys-v2 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-api_keys-v2 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::ApiKeys::V2::ApiKeys::Credentials}):
|
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
|
68
35
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
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
|
-
|
|
74
|
-
require "google/cloud/api_keys/v2"
|
|
75
|
-
|
|
76
|
-
ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
|
|
42
|
+
### Configuration
|
|
77
43
|
|
|
78
|
-
client
|
|
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
|
-
|
|
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
|
-
|
|
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/api_keys/v2"
|
|
88
58
|
|
|
89
59
|
client = ::Google::Cloud::ApiKeys::V2::ApiKeys::Client.new do |config|
|
|
90
|
-
config.credentials = "path/to/
|
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
|
91
61
|
end
|
|
92
62
|
```
|
|
93
63
|
|
|
94
|
-
|
|
64
|
+
To configure a credentials file globally for all clients:
|
|
95
65
|
|
|
96
66
|
```ruby
|
|
97
67
|
require "google/cloud/api_keys/v2"
|
|
98
68
|
|
|
99
69
|
::Google::Cloud::ApiKeys::V2::ApiKeys::Client.configure do |config|
|
|
100
|
-
config.credentials = "path/to/
|
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
|
101
71
|
end
|
|
102
72
|
|
|
103
73
|
client = ::Google::Cloud::ApiKeys::V2::ApiKeys::Client.new
|
|
104
74
|
```
|
|
105
75
|
|
|
106
|
-
###
|
|
76
|
+
### Environment Variables
|
|
107
77
|
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
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
|
-
|
|
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
|
-
|
|
115
|
-
|
|
116
|
-
|
|
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-api_keys-v2
|
|
93
|
+
checks for credentials are:
|
|
117
94
|
|
|
118
|
-
|
|
119
|
-
*
|
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
|
120
97
|
|
|
121
|
-
|
|
98
|
+
```ruby
|
|
99
|
+
require "google/cloud/api_keys/v2"
|
|
122
100
|
|
|
123
|
-
|
|
124
|
-
connect to the APIs. You will use the **JSON key file** to
|
|
125
|
-
connect to most services with google-cloud-api_keys-v2.
|
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
|
126
102
|
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
need a Google Developers service account.
|
|
103
|
+
client = ::Google::Cloud::ApiKeys::V2::ApiKeys::Client.new
|
|
104
|
+
```
|
|
130
105
|
|
|
131
|
-
|
|
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
|
-
|
|
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
|
-
|
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
|
139
113
|
|
|
140
|
-
|
|
141
|
-
"Service account" to be guided through downloading a new JSON key file.
|
|
114
|
+
### Google Cloud Platform environments
|
|
142
115
|
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
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
|
-
|
|
149
|
-
|
|
121
|
+
For more information, see
|
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
|
@@ -10,10 +10,11 @@ require 'google/api/client_pb'
|
|
|
10
10
|
require 'google/api/field_behavior_pb'
|
|
11
11
|
require 'google/api/resource_pb'
|
|
12
12
|
require 'google/longrunning/operations_pb'
|
|
13
|
+
require 'google/protobuf/empty_pb'
|
|
13
14
|
require 'google/protobuf/field_mask_pb'
|
|
14
15
|
|
|
15
16
|
|
|
16
|
-
descriptor_data = "\n#google/api/apikeys/v2/apikeys.proto\x12\x15google.api.apikeys.v2\x1a\x1cgoogle/api/annotations.proto\x1a%google/api/apikeys/v2/resources.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a#google/longrunning/operations.proto\x1a google/protobuf/field_mask.proto\"\x84\x01\n\x10\x43reateKeyRequest\x12\x32\n\x06parent\x18\x01 \x01(\tB\"\xe0\x41\x02\xfa\x41\x1c\x12\x1a\x61pikeys.googleapis.com/Key\x12,\n\x03key\x18\x02 \x01(\x0b\x32\x1a.google.api.apikeys.v2.KeyB\x03\xe0\x41\x02\x12\x0e\n\x06key_id\x18\x03 \x01(\t\"\x91\x01\n\x0fListKeysRequest\x12\x32\n\x06parent\x18\x01 \x01(\tB\"\xe0\x41\x02\xfa\x41\x1c\x12\x1a\x61pikeys.googleapis.com/Key\x12\x16\n\tpage_size\x18\x02 \x01(\x05\x42\x03\xe0\x41\x01\x12\x17\n\npage_token\x18\x03 \x01(\tB\x03\xe0\x41\x01\x12\x19\n\x0cshow_deleted\x18\x06 \x01(\x08\x42\x03\xe0\x41\x01\"U\n\x10ListKeysResponse\x12(\n\x04keys\x18\x01 \x03(\x0b\x32\x1a.google.api.apikeys.v2.Key\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\"A\n\rGetKeyRequest\x12\x30\n\x04name\x18\x01 \x01(\tB\"\xe0\x41\x02\xfa\x41\x1c\n\x1a\x61pikeys.googleapis.com/Key\"G\n\x13GetKeyStringRequest\x12\x30\n\x04name\x18\x01 \x01(\tB\"\xe0\x41\x02\xfa\x41\x1c\n\x1a\x61pikeys.googleapis.com/Key\"*\n\x14GetKeyStringResponse\x12\x12\n\nkey_string\x18\x01 \x01(\t\"q\n\x10UpdateKeyRequest\x12,\n\x03key\x18\x01 \x01(\x0b\x32\x1a.google.api.apikeys.v2.KeyB\x03\xe0\x41\x02\x12/\n\x0bupdate_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMask\"W\n\x10\x44\x65leteKeyRequest\x12\x30\n\x04name\x18\x01 \x01(\tB\"\xe0\x41\x02\xfa\x41\x1c\n\x1a\x61pikeys.googleapis.com/Key\x12\x11\n\x04\x65tag\x18\x02 \x01(\tB\x03\xe0\x41\x01\"F\n\x12UndeleteKeyRequest\x12\x30\n\x04name\x18\x01 \x01(\tB\"\xe0\x41\x02\xfa\x41\x1c\n\x1a\x61pikeys.googleapis.com/Key\"+\n\x10LookupKeyRequest\x12\x17\n\nkey_string\x18\x01 \x01(\tB\x03\xe0\x41\x02\"1\n\x11LookupKeyResponse\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12\x0c\n\x04name\x18\x02 \x01(\t2\xbe\x0b\n\x07\x41piKeys\x12\xbd\x01\n\tCreateKey\x12\'.google.api.apikeys.v2.CreateKeyRequest\x1a\x1d.google.longrunning.Operation\"h\x82\xd3\xe4\x93\x02/\"(/v2/{parent=projects/*/locations/*}/keys:\x03key\xda\x41\x11parent,key,key_id\xca\x41\x1c\n\x03Key\x12\x15google.protobuf.Empty\x12\x96\x01\n\x08ListKeys\x12&.google.api.apikeys.v2.ListKeysRequest\x1a\'.google.api.apikeys.v2.ListKeysResponse\"9\x82\xd3\xe4\x93\x02*\x12(/v2/{parent=projects/*/locations/*}/keys\xda\x41\x06parent\x12\x83\x01\n\x06GetKey\x12$.google.api.apikeys.v2.GetKeyRequest\x1a\x1a.google.api.apikeys.v2.Key\"7\x82\xd3\xe4\x93\x02*\x12(/v2/{name=projects/*/locations/*/keys/*}\xda\x41\x04name\x12\xaa\x01\n\x0cGetKeyString\x12*.google.api.apikeys.v2.GetKeyStringRequest\x1a+.google.api.apikeys.v2.GetKeyStringResponse\"A\x82\xd3\xe4\x93\x02\x34\x12\x32/v2/{name=projects/*/locations/*/keys/*}/keyString\xda\x41\x04name\x12\xbf\x01\n\tUpdateKey\x12\'.google.api.apikeys.v2.UpdateKeyRequest\x1a\x1d.google.longrunning.Operation\"j\x82\xd3\xe4\x93\x02\x33\x32,/v2/{key.name=projects/*/locations/*/keys/*}:\x03key\xda\x41\x0fkey,update_mask\xca\x41\x1c\n\x03Key\x12\x15google.protobuf.Empty\x12\xab\x01\n\tDeleteKey\x12\'.google.api.apikeys.v2.DeleteKeyRequest\x1a\x1d.google.longrunning.Operation\"V\x82\xd3\xe4\x93\x02**(/v2/{name=projects/*/locations/*/keys/*}\xda\x41\x04name\xca\x41\x1c\n\x03Key\x12\x15google.protobuf.Empty\x12\xb4\x01\n\x0bUndeleteKey\x12).google.api.apikeys.v2.UndeleteKeyRequest\x1a\x1d.google.longrunning.Operation\"[\x82\xd3\xe4\x93\x02\x36\"1/v2/{name=projects/*/locations/*/keys/*}:undelete:\x01*\xca\x41\x1c\n\x03Key\x12\x15google.protobuf.Empty\x12z\n\tLookupKey\x12\'.google.api.apikeys.v2.LookupKeyRequest\x1a(.google.api.apikeys.v2.LookupKeyResponse\"\x1a\x82\xd3\xe4\x93\x02\x14\x12\x12/v2/keys:lookupKey\x1a\x83\x01\xca\x41\x16\x61pikeys.googleapis.com\xd2\x41ghttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/cloud-platform.read-onlyB\xb3\x01\n\x19\x63om.google.api.apikeys.v2B\x0c\x41piKeysProtoP\x01Z5cloud.google.com/go/apikeys/apiv2/apikeyspb;apikeyspb\xaa\x02\x17Google.Cloud.ApiKeys.V2\xca\x02\x17Google\\Cloud\\ApiKeys\\V2\xea\x02\x1aGoogle::Cloud::ApiKeys::V2b\x06proto3"
|
|
17
|
+
descriptor_data = "\n#google/api/apikeys/v2/apikeys.proto\x12\x15google.api.apikeys.v2\x1a\x1cgoogle/api/annotations.proto\x1a%google/api/apikeys/v2/resources.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a#google/longrunning/operations.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a google/protobuf/field_mask.proto\"\x84\x01\n\x10\x43reateKeyRequest\x12\x32\n\x06parent\x18\x01 \x01(\tB\"\xe0\x41\x02\xfa\x41\x1c\x12\x1a\x61pikeys.googleapis.com/Key\x12,\n\x03key\x18\x02 \x01(\x0b\x32\x1a.google.api.apikeys.v2.KeyB\x03\xe0\x41\x02\x12\x0e\n\x06key_id\x18\x03 \x01(\t\"\x91\x01\n\x0fListKeysRequest\x12\x32\n\x06parent\x18\x01 \x01(\tB\"\xe0\x41\x02\xfa\x41\x1c\x12\x1a\x61pikeys.googleapis.com/Key\x12\x16\n\tpage_size\x18\x02 \x01(\x05\x42\x03\xe0\x41\x01\x12\x17\n\npage_token\x18\x03 \x01(\tB\x03\xe0\x41\x01\x12\x19\n\x0cshow_deleted\x18\x06 \x01(\x08\x42\x03\xe0\x41\x01\"U\n\x10ListKeysResponse\x12(\n\x04keys\x18\x01 \x03(\x0b\x32\x1a.google.api.apikeys.v2.Key\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\"A\n\rGetKeyRequest\x12\x30\n\x04name\x18\x01 \x01(\tB\"\xe0\x41\x02\xfa\x41\x1c\n\x1a\x61pikeys.googleapis.com/Key\"G\n\x13GetKeyStringRequest\x12\x30\n\x04name\x18\x01 \x01(\tB\"\xe0\x41\x02\xfa\x41\x1c\n\x1a\x61pikeys.googleapis.com/Key\"*\n\x14GetKeyStringResponse\x12\x12\n\nkey_string\x18\x01 \x01(\t\"q\n\x10UpdateKeyRequest\x12,\n\x03key\x18\x01 \x01(\x0b\x32\x1a.google.api.apikeys.v2.KeyB\x03\xe0\x41\x02\x12/\n\x0bupdate_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMask\"W\n\x10\x44\x65leteKeyRequest\x12\x30\n\x04name\x18\x01 \x01(\tB\"\xe0\x41\x02\xfa\x41\x1c\n\x1a\x61pikeys.googleapis.com/Key\x12\x11\n\x04\x65tag\x18\x02 \x01(\tB\x03\xe0\x41\x01\"F\n\x12UndeleteKeyRequest\x12\x30\n\x04name\x18\x01 \x01(\tB\"\xe0\x41\x02\xfa\x41\x1c\n\x1a\x61pikeys.googleapis.com/Key\"+\n\x10LookupKeyRequest\x12\x17\n\nkey_string\x18\x01 \x01(\tB\x03\xe0\x41\x02\"1\n\x11LookupKeyResponse\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12\x0c\n\x04name\x18\x02 \x01(\t2\xbe\x0b\n\x07\x41piKeys\x12\xbd\x01\n\tCreateKey\x12\'.google.api.apikeys.v2.CreateKeyRequest\x1a\x1d.google.longrunning.Operation\"h\x82\xd3\xe4\x93\x02/\"(/v2/{parent=projects/*/locations/*}/keys:\x03key\xda\x41\x11parent,key,key_id\xca\x41\x1c\n\x03Key\x12\x15google.protobuf.Empty\x12\x96\x01\n\x08ListKeys\x12&.google.api.apikeys.v2.ListKeysRequest\x1a\'.google.api.apikeys.v2.ListKeysResponse\"9\x82\xd3\xe4\x93\x02*\x12(/v2/{parent=projects/*/locations/*}/keys\xda\x41\x06parent\x12\x83\x01\n\x06GetKey\x12$.google.api.apikeys.v2.GetKeyRequest\x1a\x1a.google.api.apikeys.v2.Key\"7\x82\xd3\xe4\x93\x02*\x12(/v2/{name=projects/*/locations/*/keys/*}\xda\x41\x04name\x12\xaa\x01\n\x0cGetKeyString\x12*.google.api.apikeys.v2.GetKeyStringRequest\x1a+.google.api.apikeys.v2.GetKeyStringResponse\"A\x82\xd3\xe4\x93\x02\x34\x12\x32/v2/{name=projects/*/locations/*/keys/*}/keyString\xda\x41\x04name\x12\xbf\x01\n\tUpdateKey\x12\'.google.api.apikeys.v2.UpdateKeyRequest\x1a\x1d.google.longrunning.Operation\"j\x82\xd3\xe4\x93\x02\x33\x32,/v2/{key.name=projects/*/locations/*/keys/*}:\x03key\xda\x41\x0fkey,update_mask\xca\x41\x1c\n\x03Key\x12\x15google.protobuf.Empty\x12\xab\x01\n\tDeleteKey\x12\'.google.api.apikeys.v2.DeleteKeyRequest\x1a\x1d.google.longrunning.Operation\"V\x82\xd3\xe4\x93\x02**(/v2/{name=projects/*/locations/*/keys/*}\xda\x41\x04name\xca\x41\x1c\n\x03Key\x12\x15google.protobuf.Empty\x12\xb4\x01\n\x0bUndeleteKey\x12).google.api.apikeys.v2.UndeleteKeyRequest\x1a\x1d.google.longrunning.Operation\"[\x82\xd3\xe4\x93\x02\x36\"1/v2/{name=projects/*/locations/*/keys/*}:undelete:\x01*\xca\x41\x1c\n\x03Key\x12\x15google.protobuf.Empty\x12z\n\tLookupKey\x12\'.google.api.apikeys.v2.LookupKeyRequest\x1a(.google.api.apikeys.v2.LookupKeyResponse\"\x1a\x82\xd3\xe4\x93\x02\x14\x12\x12/v2/keys:lookupKey\x1a\x83\x01\xca\x41\x16\x61pikeys.googleapis.com\xd2\x41ghttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/cloud-platform.read-onlyB\xb3\x01\n\x19\x63om.google.api.apikeys.v2B\x0c\x41piKeysProtoP\x01Z5cloud.google.com/go/apikeys/apiv2/apikeyspb;apikeyspb\xaa\x02\x17Google.Cloud.ApiKeys.V2\xca\x02\x17Google\\Cloud\\ApiKeys\\V2\xea\x02\x1aGoogle::Cloud::ApiKeys::V2b\x06proto3"
|
|
17
18
|
|
|
18
19
|
pool = Google::Protobuf::DescriptorPool.generated_pool
|
|
19
20
|
|
|
@@ -30,6 +30,9 @@ module Google
|
|
|
30
30
|
# Manages the API keys associated with projects.
|
|
31
31
|
#
|
|
32
32
|
class Client
|
|
33
|
+
# @private
|
|
34
|
+
DEFAULT_ENDPOINT_TEMPLATE = "apikeys.$UNIVERSE_DOMAIN$"
|
|
35
|
+
|
|
33
36
|
include Paths
|
|
34
37
|
|
|
35
38
|
# @private
|
|
@@ -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
|
+
@api_keys_stub.universe_domain
|
|
105
|
+
end
|
|
106
|
+
|
|
95
107
|
##
|
|
96
108
|
# Create a new ApiKeys 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
|
|
129
|
-
|
|
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,14 +152,18 @@ 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
|
@api_keys_stub = ::Gapic::ServiceStub.new(
|
|
145
159
|
::Google::Cloud::ApiKeys::V2::ApiKeys::Stub,
|
|
146
|
-
credentials:
|
|
147
|
-
endpoint:
|
|
160
|
+
credentials: credentials,
|
|
161
|
+
endpoint: @config.endpoint,
|
|
162
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
163
|
+
universe_domain: @config.universe_domain,
|
|
148
164
|
channel_args: @config.channel_args,
|
|
149
|
-
interceptors: @config.interceptors
|
|
165
|
+
interceptors: @config.interceptors,
|
|
166
|
+
channel_pool_config: @config.channel_pool
|
|
150
167
|
)
|
|
151
168
|
end
|
|
152
169
|
|
|
@@ -961,9 +978,9 @@ module Google
|
|
|
961
978
|
# end
|
|
962
979
|
#
|
|
963
980
|
# @!attribute [rw] endpoint
|
|
964
|
-
#
|
|
965
|
-
#
|
|
966
|
-
# @return [::String]
|
|
981
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
982
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
983
|
+
# @return [::String,nil]
|
|
967
984
|
# @!attribute [rw] credentials
|
|
968
985
|
# Credentials to send with calls. You may provide any of the following types:
|
|
969
986
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -1009,13 +1026,20 @@ module Google
|
|
|
1009
1026
|
# @!attribute [rw] quota_project
|
|
1010
1027
|
# A separate project against which to charge quota.
|
|
1011
1028
|
# @return [::String]
|
|
1029
|
+
# @!attribute [rw] universe_domain
|
|
1030
|
+
# The universe domain within which to make requests. This determines the
|
|
1031
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
1032
|
+
# universe (usually the default "googleapis.com" universe).
|
|
1033
|
+
# @return [::String,nil]
|
|
1012
1034
|
#
|
|
1013
1035
|
class Configuration
|
|
1014
1036
|
extend ::Gapic::Config
|
|
1015
1037
|
|
|
1038
|
+
# @private
|
|
1039
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
1016
1040
|
DEFAULT_ENDPOINT = "apikeys.googleapis.com"
|
|
1017
1041
|
|
|
1018
|
-
config_attr :endpoint,
|
|
1042
|
+
config_attr :endpoint, nil, ::String, nil
|
|
1019
1043
|
config_attr :credentials, nil do |value|
|
|
1020
1044
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
1021
1045
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -1030,6 +1054,7 @@ module Google
|
|
|
1030
1054
|
config_attr :metadata, nil, ::Hash, nil
|
|
1031
1055
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
1032
1056
|
config_attr :quota_project, nil, ::String, nil
|
|
1057
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
1033
1058
|
|
|
1034
1059
|
# @private
|
|
1035
1060
|
def initialize parent_config = nil
|
|
@@ -1050,6 +1075,14 @@ module Google
|
|
|
1050
1075
|
end
|
|
1051
1076
|
end
|
|
1052
1077
|
|
|
1078
|
+
##
|
|
1079
|
+
# Configuration for the channel pool
|
|
1080
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
|
1081
|
+
#
|
|
1082
|
+
def channel_pool
|
|
1083
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
|
1084
|
+
end
|
|
1085
|
+
|
|
1053
1086
|
##
|
|
1054
1087
|
# Configuration RPC class for the ApiKeys API.
|
|
1055
1088
|
#
|
|
@@ -26,6 +26,9 @@ module Google
|
|
|
26
26
|
module ApiKeys
|
|
27
27
|
# Service that implements Longrunning Operations API.
|
|
28
28
|
class Operations
|
|
29
|
+
# @private
|
|
30
|
+
DEFAULT_ENDPOINT_TEMPLATE = "apikeys.$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:
|
|
94
|
-
endpoint:
|
|
105
|
+
credentials: credentials,
|
|
106
|
+
endpoint: @config.endpoint,
|
|
107
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
108
|
+
universe_domain: @config.universe_domain,
|
|
95
109
|
channel_args: @config.channel_args,
|
|
96
|
-
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
|
|
@@ -612,9 +627,9 @@ module Google
|
|
|
612
627
|
# end
|
|
613
628
|
#
|
|
614
629
|
# @!attribute [rw] endpoint
|
|
615
|
-
#
|
|
616
|
-
#
|
|
617
|
-
# @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]
|
|
618
633
|
# @!attribute [rw] credentials
|
|
619
634
|
# Credentials to send with calls. You may provide any of the following types:
|
|
620
635
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -660,13 +675,20 @@ module Google
|
|
|
660
675
|
# @!attribute [rw] quota_project
|
|
661
676
|
# A separate project against which to charge quota.
|
|
662
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]
|
|
663
683
|
#
|
|
664
684
|
class Configuration
|
|
665
685
|
extend ::Gapic::Config
|
|
666
686
|
|
|
687
|
+
# @private
|
|
688
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
667
689
|
DEFAULT_ENDPOINT = "apikeys.googleapis.com"
|
|
668
690
|
|
|
669
|
-
config_attr :endpoint,
|
|
691
|
+
config_attr :endpoint, nil, ::String, nil
|
|
670
692
|
config_attr :credentials, nil do |value|
|
|
671
693
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
672
694
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -681,6 +703,7 @@ module Google
|
|
|
681
703
|
config_attr :metadata, nil, ::Hash, nil
|
|
682
704
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
683
705
|
config_attr :quota_project, nil, ::String, nil
|
|
706
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
684
707
|
|
|
685
708
|
# @private
|
|
686
709
|
def initialize parent_config = nil
|
|
@@ -701,6 +724,14 @@ module Google
|
|
|
701
724
|
end
|
|
702
725
|
end
|
|
703
726
|
|
|
727
|
+
##
|
|
728
|
+
# Configuration for the channel pool
|
|
729
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
|
730
|
+
#
|
|
731
|
+
def channel_pool
|
|
732
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
|
733
|
+
end
|
|
734
|
+
|
|
704
735
|
##
|
|
705
736
|
# Configuration RPC class for the Operations API.
|
|
706
737
|
#
|
|
@@ -32,6 +32,9 @@ module Google
|
|
|
32
32
|
# Manages the API keys associated with projects.
|
|
33
33
|
#
|
|
34
34
|
class Client
|
|
35
|
+
# @private
|
|
36
|
+
DEFAULT_ENDPOINT_TEMPLATE = "apikeys.$UNIVERSE_DOMAIN$"
|
|
37
|
+
|
|
35
38
|
include Paths
|
|
36
39
|
|
|
37
40
|
# @private
|
|
@@ -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
|
+
@api_keys_stub.universe_domain
|
|
107
|
+
end
|
|
108
|
+
|
|
97
109
|
##
|
|
98
110
|
# Create a new ApiKeys 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
|
|
125
|
-
|
|
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,9 +149,15 @@ 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
|
-
@api_keys_stub = ::Google::Cloud::ApiKeys::V2::ApiKeys::Rest::ServiceStub.new
|
|
155
|
+
@api_keys_stub = ::Google::Cloud::ApiKeys::V2::ApiKeys::Rest::ServiceStub.new(
|
|
156
|
+
endpoint: @config.endpoint,
|
|
157
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
158
|
+
universe_domain: @config.universe_domain,
|
|
159
|
+
credentials: credentials
|
|
160
|
+
)
|
|
142
161
|
end
|
|
143
162
|
|
|
144
163
|
##
|
|
@@ -194,6 +213,29 @@ module Google
|
|
|
194
213
|
# @return [::Gapic::Operation]
|
|
195
214
|
#
|
|
196
215
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
216
|
+
#
|
|
217
|
+
# @example Basic example
|
|
218
|
+
# require "google/cloud/api_keys/v2"
|
|
219
|
+
#
|
|
220
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
221
|
+
# client = Google::Cloud::ApiKeys::V2::ApiKeys::Rest::Client.new
|
|
222
|
+
#
|
|
223
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
224
|
+
# request = Google::Cloud::ApiKeys::V2::CreateKeyRequest.new
|
|
225
|
+
#
|
|
226
|
+
# # Call the create_key method.
|
|
227
|
+
# result = client.create_key request
|
|
228
|
+
#
|
|
229
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
230
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
231
|
+
# # Here is how to wait for a response.
|
|
232
|
+
# result.wait_until_done! timeout: 60
|
|
233
|
+
# if result.response?
|
|
234
|
+
# p result.response
|
|
235
|
+
# else
|
|
236
|
+
# puts "No response received."
|
|
237
|
+
# end
|
|
238
|
+
#
|
|
197
239
|
def create_key request, options = nil
|
|
198
240
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
199
241
|
|
|
@@ -268,6 +310,26 @@ module Google
|
|
|
268
310
|
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApiKeys::V2::Key>]
|
|
269
311
|
#
|
|
270
312
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
313
|
+
#
|
|
314
|
+
# @example Basic example
|
|
315
|
+
# require "google/cloud/api_keys/v2"
|
|
316
|
+
#
|
|
317
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
318
|
+
# client = Google::Cloud::ApiKeys::V2::ApiKeys::Rest::Client.new
|
|
319
|
+
#
|
|
320
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
321
|
+
# request = Google::Cloud::ApiKeys::V2::ListKeysRequest.new
|
|
322
|
+
#
|
|
323
|
+
# # Call the list_keys method.
|
|
324
|
+
# result = client.list_keys 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::ApiKeys::V2::Key.
|
|
330
|
+
# p item
|
|
331
|
+
# end
|
|
332
|
+
#
|
|
271
333
|
def list_keys request, options = nil
|
|
272
334
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
273
335
|
|
|
@@ -335,6 +397,22 @@ module Google
|
|
|
335
397
|
# @return [::Google::Cloud::ApiKeys::V2::Key]
|
|
336
398
|
#
|
|
337
399
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
400
|
+
#
|
|
401
|
+
# @example Basic example
|
|
402
|
+
# require "google/cloud/api_keys/v2"
|
|
403
|
+
#
|
|
404
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
405
|
+
# client = Google::Cloud::ApiKeys::V2::ApiKeys::Rest::Client.new
|
|
406
|
+
#
|
|
407
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
408
|
+
# request = Google::Cloud::ApiKeys::V2::GetKeyRequest.new
|
|
409
|
+
#
|
|
410
|
+
# # Call the get_key method.
|
|
411
|
+
# result = client.get_key request
|
|
412
|
+
#
|
|
413
|
+
# # The returned object is of type Google::Cloud::ApiKeys::V2::Key.
|
|
414
|
+
# p result
|
|
415
|
+
#
|
|
338
416
|
def get_key request, options = nil
|
|
339
417
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
340
418
|
|
|
@@ -400,6 +478,22 @@ module Google
|
|
|
400
478
|
# @return [::Google::Cloud::ApiKeys::V2::GetKeyStringResponse]
|
|
401
479
|
#
|
|
402
480
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
481
|
+
#
|
|
482
|
+
# @example Basic example
|
|
483
|
+
# require "google/cloud/api_keys/v2"
|
|
484
|
+
#
|
|
485
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
486
|
+
# client = Google::Cloud::ApiKeys::V2::ApiKeys::Rest::Client.new
|
|
487
|
+
#
|
|
488
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
489
|
+
# request = Google::Cloud::ApiKeys::V2::GetKeyStringRequest.new
|
|
490
|
+
#
|
|
491
|
+
# # Call the get_key_string method.
|
|
492
|
+
# result = client.get_key_string request
|
|
493
|
+
#
|
|
494
|
+
# # The returned object is of type Google::Cloud::ApiKeys::V2::GetKeyStringResponse.
|
|
495
|
+
# p result
|
|
496
|
+
#
|
|
403
497
|
def get_key_string request, options = nil
|
|
404
498
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
405
499
|
|
|
@@ -476,6 +570,29 @@ module Google
|
|
|
476
570
|
# @return [::Gapic::Operation]
|
|
477
571
|
#
|
|
478
572
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
573
|
+
#
|
|
574
|
+
# @example Basic example
|
|
575
|
+
# require "google/cloud/api_keys/v2"
|
|
576
|
+
#
|
|
577
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
578
|
+
# client = Google::Cloud::ApiKeys::V2::ApiKeys::Rest::Client.new
|
|
579
|
+
#
|
|
580
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
581
|
+
# request = Google::Cloud::ApiKeys::V2::UpdateKeyRequest.new
|
|
582
|
+
#
|
|
583
|
+
# # Call the update_key method.
|
|
584
|
+
# result = client.update_key request
|
|
585
|
+
#
|
|
586
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
587
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
588
|
+
# # Here is how to wait for a response.
|
|
589
|
+
# result.wait_until_done! timeout: 60
|
|
590
|
+
# if result.response?
|
|
591
|
+
# p result.response
|
|
592
|
+
# else
|
|
593
|
+
# puts "No response received."
|
|
594
|
+
# end
|
|
595
|
+
#
|
|
479
596
|
def update_key request, options = nil
|
|
480
597
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
481
598
|
|
|
@@ -546,6 +663,29 @@ module Google
|
|
|
546
663
|
# @return [::Gapic::Operation]
|
|
547
664
|
#
|
|
548
665
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
666
|
+
#
|
|
667
|
+
# @example Basic example
|
|
668
|
+
# require "google/cloud/api_keys/v2"
|
|
669
|
+
#
|
|
670
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
671
|
+
# client = Google::Cloud::ApiKeys::V2::ApiKeys::Rest::Client.new
|
|
672
|
+
#
|
|
673
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
674
|
+
# request = Google::Cloud::ApiKeys::V2::DeleteKeyRequest.new
|
|
675
|
+
#
|
|
676
|
+
# # Call the delete_key method.
|
|
677
|
+
# result = client.delete_key request
|
|
678
|
+
#
|
|
679
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
680
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
681
|
+
# # Here is how to wait for a response.
|
|
682
|
+
# result.wait_until_done! timeout: 60
|
|
683
|
+
# if result.response?
|
|
684
|
+
# p result.response
|
|
685
|
+
# else
|
|
686
|
+
# puts "No response received."
|
|
687
|
+
# end
|
|
688
|
+
#
|
|
549
689
|
def delete_key request, options = nil
|
|
550
690
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
551
691
|
|
|
@@ -612,6 +752,29 @@ module Google
|
|
|
612
752
|
# @return [::Gapic::Operation]
|
|
613
753
|
#
|
|
614
754
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
755
|
+
#
|
|
756
|
+
# @example Basic example
|
|
757
|
+
# require "google/cloud/api_keys/v2"
|
|
758
|
+
#
|
|
759
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
760
|
+
# client = Google::Cloud::ApiKeys::V2::ApiKeys::Rest::Client.new
|
|
761
|
+
#
|
|
762
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
763
|
+
# request = Google::Cloud::ApiKeys::V2::UndeleteKeyRequest.new
|
|
764
|
+
#
|
|
765
|
+
# # Call the undelete_key method.
|
|
766
|
+
# result = client.undelete_key request
|
|
767
|
+
#
|
|
768
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
769
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
770
|
+
# # Here is how to wait for a response.
|
|
771
|
+
# result.wait_until_done! timeout: 60
|
|
772
|
+
# if result.response?
|
|
773
|
+
# p result.response
|
|
774
|
+
# else
|
|
775
|
+
# puts "No response received."
|
|
776
|
+
# end
|
|
777
|
+
#
|
|
615
778
|
def undelete_key request, options = nil
|
|
616
779
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
617
780
|
|
|
@@ -679,6 +842,22 @@ module Google
|
|
|
679
842
|
# @return [::Google::Cloud::ApiKeys::V2::LookupKeyResponse]
|
|
680
843
|
#
|
|
681
844
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
845
|
+
#
|
|
846
|
+
# @example Basic example
|
|
847
|
+
# require "google/cloud/api_keys/v2"
|
|
848
|
+
#
|
|
849
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
850
|
+
# client = Google::Cloud::ApiKeys::V2::ApiKeys::Rest::Client.new
|
|
851
|
+
#
|
|
852
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
853
|
+
# request = Google::Cloud::ApiKeys::V2::LookupKeyRequest.new
|
|
854
|
+
#
|
|
855
|
+
# # Call the lookup_key method.
|
|
856
|
+
# result = client.lookup_key request
|
|
857
|
+
#
|
|
858
|
+
# # The returned object is of type Google::Cloud::ApiKeys::V2::LookupKeyResponse.
|
|
859
|
+
# p result
|
|
860
|
+
#
|
|
682
861
|
def lookup_key request, options = nil
|
|
683
862
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
684
863
|
|
|
@@ -744,9 +923,9 @@ module Google
|
|
|
744
923
|
# end
|
|
745
924
|
#
|
|
746
925
|
# @!attribute [rw] endpoint
|
|
747
|
-
#
|
|
748
|
-
#
|
|
749
|
-
# @return [::String]
|
|
926
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
927
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
928
|
+
# @return [::String,nil]
|
|
750
929
|
# @!attribute [rw] credentials
|
|
751
930
|
# Credentials to send with calls. You may provide any of the following types:
|
|
752
931
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -783,13 +962,20 @@ module Google
|
|
|
783
962
|
# @!attribute [rw] quota_project
|
|
784
963
|
# A separate project against which to charge quota.
|
|
785
964
|
# @return [::String]
|
|
965
|
+
# @!attribute [rw] universe_domain
|
|
966
|
+
# The universe domain within which to make requests. This determines the
|
|
967
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
968
|
+
# universe (usually the default "googleapis.com" universe).
|
|
969
|
+
# @return [::String,nil]
|
|
786
970
|
#
|
|
787
971
|
class Configuration
|
|
788
972
|
extend ::Gapic::Config
|
|
789
973
|
|
|
974
|
+
# @private
|
|
975
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
790
976
|
DEFAULT_ENDPOINT = "apikeys.googleapis.com"
|
|
791
977
|
|
|
792
|
-
config_attr :endpoint,
|
|
978
|
+
config_attr :endpoint, nil, ::String, nil
|
|
793
979
|
config_attr :credentials, nil do |value|
|
|
794
980
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
795
981
|
allowed.any? { |klass| klass === value }
|
|
@@ -801,6 +987,7 @@ module Google
|
|
|
801
987
|
config_attr :metadata, nil, ::Hash, nil
|
|
802
988
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
803
989
|
config_attr :quota_project, nil, ::String, nil
|
|
990
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
804
991
|
|
|
805
992
|
# @private
|
|
806
993
|
def initialize parent_config = nil
|
|
@@ -26,6 +26,9 @@ module Google
|
|
|
26
26
|
module Rest
|
|
27
27
|
# Service that implements Longrunning Operations API.
|
|
28
28
|
class Operations
|
|
29
|
+
# @private
|
|
30
|
+
DEFAULT_ENDPOINT_TEMPLATE = "apikeys.$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:
|
|
88
|
-
|
|
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
|
-
#
|
|
407
|
-
#
|
|
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 = "apikeys.googleapis.com"
|
|
450
546
|
|
|
451
|
-
config_attr :endpoint,
|
|
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,
|
|
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
|
##
|
|
@@ -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 create_key REST call
|
|
45
57
|
#
|
|
@@ -53,8 +53,8 @@ module Google
|
|
|
53
53
|
# updated.
|
|
54
54
|
# @!attribute [r] delete_time
|
|
55
55
|
# @return [::Google::Protobuf::Timestamp]
|
|
56
|
-
# Output only. A timestamp when this key was deleted. If the resource is not
|
|
57
|
-
# this must be empty.
|
|
56
|
+
# Output only. A timestamp when this key was deleted. If the resource is not
|
|
57
|
+
# deleted, this must be empty.
|
|
58
58
|
# @!attribute [rw] annotations
|
|
59
59
|
# @return [::Google::Protobuf::Map{::String => ::String}]
|
|
60
60
|
# Annotations is an unstructured key-value map stored with a policy that
|
|
@@ -65,10 +65,10 @@ module Google
|
|
|
65
65
|
# Key restrictions.
|
|
66
66
|
# @!attribute [r] etag
|
|
67
67
|
# @return [::String]
|
|
68
|
-
# Output only. A checksum computed by the server based on the current value
|
|
69
|
-
# resource. This may be sent on update and delete requests to
|
|
70
|
-
# client has an up-to-date value before proceeding.
|
|
71
|
-
#
|
|
68
|
+
# Output only. A checksum computed by the server based on the current value
|
|
69
|
+
# of the Key resource. This may be sent on update and delete requests to
|
|
70
|
+
# ensure the client has an up-to-date value before proceeding. See
|
|
71
|
+
# https://google.aip.dev/154.
|
|
72
72
|
class Key
|
|
73
73
|
include ::Google::Protobuf::MessageExts
|
|
74
74
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -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
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-api_keys-v2
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.5.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
|
|
@@ -219,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
219
219
|
- !ruby/object:Gem::Version
|
|
220
220
|
version: '0'
|
|
221
221
|
requirements: []
|
|
222
|
-
rubygems_version: 3.
|
|
222
|
+
rubygems_version: 3.5.3
|
|
223
223
|
signing_key:
|
|
224
224
|
specification_version: 4
|
|
225
225
|
summary: Manages the API keys associated with developer projects.
|