google-cloud-assured_workloads-v1 0.8.0 → 0.9.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/assured_workloads/v1/assured_workloads_service/client.rb +32 -8
- data/lib/google/cloud/assured_workloads/v1/assured_workloads_service/operations.rb +28 -6
- data/lib/google/cloud/assured_workloads/v1/assured_workloads_service/rest/client.rb +34 -7
- data/lib/google/cloud/assured_workloads/v1/assured_workloads_service/rest/operations.rb +33 -8
- data/lib/google/cloud/assured_workloads/v1/assured_workloads_service/rest/service_stub.rb +14 -2
- data/lib/google/cloud/assured_workloads/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -0
- data/proto_docs/google/cloud/assuredworkloads/v1/assuredworkloads.rb +3 -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: 9354ed79e459dacba3c61fcbe9c65f482d634d449bf68eebad8ff51c2e3f6028
|
|
4
|
+
data.tar.gz: ecd38469055b0ca90ee8783ea9070981be29cd1c64759d897afdb660b3c2ec5d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: bfba8bca3e0b8fbcf519b65ce3019500a686784ba308e887e4164d3b955b87992e2a2db3bc876a53ec160ce8e2e420382be136f566421f7577b0a418cc7ebe58
|
|
7
|
+
data.tar.gz: 4d92d1d68180d8c8fd7d2d969c13f1bbde7c13d9e421dffea5b6449662f6d9df537db3d696176bd53e2067bd6f058a4e8040a6694256432132513a5b800aced6
|
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-assured_workloads-v1 library is to use
|
|
4
|
+
[Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
|
|
5
|
+
To review all of your authentication options, see [Credentials lookup](#credential-lookup).
|
|
15
6
|
|
|
16
7
|
## Quickstart
|
|
17
8
|
|
|
18
|
-
|
|
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-assured_workloads-v1 library aims to make authentication
|
|
36
|
-
as simple as possible, and provides several mechanisms to configure your system
|
|
37
|
-
without requiring **Service Account Credentials** directly in code.
|
|
38
|
-
|
|
39
|
-
**Credentials** are discovered in the following order:
|
|
40
|
-
|
|
41
|
-
1. Specify credentials in method arguments
|
|
42
|
-
2. Specify credentials in configuration
|
|
43
|
-
3. Discover credentials path in environment variables
|
|
44
|
-
4. Discover credentials JSON in environment variables
|
|
45
|
-
5. Discover credentials file in the Cloud SDK's path
|
|
46
|
-
6. Discover GCP credentials
|
|
47
|
-
|
|
48
|
-
### Google Cloud Platform environments
|
|
22
|
+
3. Write code as if already authenticated.
|
|
49
23
|
|
|
50
|
-
|
|
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-assured_workloads-v1 library provides several mechanisms to configure your system.
|
|
30
|
+
Generally, using Application Default Credentials to facilitate automatic
|
|
31
|
+
credentials discovery is the easist method. But if you need to explicitly specify
|
|
32
|
+
credentials, there are several methods available to you.
|
|
64
33
|
|
|
65
|
-
|
|
66
|
-
checks for credentials are configured on the service Credentials class (such as
|
|
67
|
-
{::Google::Cloud::AssuredWorkloads::V1::AssuredWorkloadsService::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/assured_workloads/v1"
|
|
77
|
-
|
|
78
|
-
ENV["ASSURED_WORKLOADS_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/assured_workloads/v1"
|
|
90
58
|
|
|
91
59
|
client = ::Google::Cloud::AssuredWorkloads::V1::AssuredWorkloadsService::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/assured_workloads/v1"
|
|
100
68
|
|
|
101
69
|
::Google::Cloud::AssuredWorkloads::V1::AssuredWorkloadsService::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::AssuredWorkloads::V1::AssuredWorkloadsService::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-assured_workloads-v1
|
|
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/assured_workloads/v1"
|
|
124
100
|
|
|
125
|
-
|
|
126
|
-
connect to the APIs. You will use the **JSON key file** to
|
|
127
|
-
connect to most services with google-cloud-assured_workloads-v1.
|
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
|
128
102
|
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
need a Google Developers service account.
|
|
103
|
+
client = ::Google::Cloud::AssuredWorkloads::V1::AssuredWorkloadsService::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).
|
|
@@ -30,6 +30,9 @@ module Google
|
|
|
30
30
|
# Service to manage AssuredWorkloads.
|
|
31
31
|
#
|
|
32
32
|
class Client
|
|
33
|
+
# @private
|
|
34
|
+
DEFAULT_ENDPOINT_TEMPLATE = "assuredworkloads.$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
|
+
@assured_workloads_service_stub.universe_domain
|
|
105
|
+
end
|
|
106
|
+
|
|
95
107
|
##
|
|
96
108
|
# Create a new AssuredWorkloadsService 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,12 +152,15 @@ 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
|
@assured_workloads_service_stub = ::Gapic::ServiceStub.new(
|
|
145
159
|
::Google::Cloud::AssuredWorkloads::V1::AssuredWorkloadsService::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
165
|
interceptors: @config.interceptors,
|
|
150
166
|
channel_pool_config: @config.channel_pool
|
|
@@ -1029,9 +1045,9 @@ module Google
|
|
|
1029
1045
|
# end
|
|
1030
1046
|
#
|
|
1031
1047
|
# @!attribute [rw] endpoint
|
|
1032
|
-
#
|
|
1033
|
-
#
|
|
1034
|
-
# @return [::String]
|
|
1048
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
1049
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
1050
|
+
# @return [::String,nil]
|
|
1035
1051
|
# @!attribute [rw] credentials
|
|
1036
1052
|
# Credentials to send with calls. You may provide any of the following types:
|
|
1037
1053
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -1077,13 +1093,20 @@ module Google
|
|
|
1077
1093
|
# @!attribute [rw] quota_project
|
|
1078
1094
|
# A separate project against which to charge quota.
|
|
1079
1095
|
# @return [::String]
|
|
1096
|
+
# @!attribute [rw] universe_domain
|
|
1097
|
+
# The universe domain within which to make requests. This determines the
|
|
1098
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
1099
|
+
# universe (usually the default "googleapis.com" universe).
|
|
1100
|
+
# @return [::String,nil]
|
|
1080
1101
|
#
|
|
1081
1102
|
class Configuration
|
|
1082
1103
|
extend ::Gapic::Config
|
|
1083
1104
|
|
|
1105
|
+
# @private
|
|
1106
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
1084
1107
|
DEFAULT_ENDPOINT = "assuredworkloads.googleapis.com"
|
|
1085
1108
|
|
|
1086
|
-
config_attr :endpoint,
|
|
1109
|
+
config_attr :endpoint, nil, ::String, nil
|
|
1087
1110
|
config_attr :credentials, nil do |value|
|
|
1088
1111
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
1089
1112
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -1098,6 +1121,7 @@ module Google
|
|
|
1098
1121
|
config_attr :metadata, nil, ::Hash, nil
|
|
1099
1122
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
1100
1123
|
config_attr :quota_project, nil, ::String, nil
|
|
1124
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
1101
1125
|
|
|
1102
1126
|
# @private
|
|
1103
1127
|
def initialize parent_config = nil
|
|
@@ -26,6 +26,9 @@ module Google
|
|
|
26
26
|
module AssuredWorkloadsService
|
|
27
27
|
# Service that implements Longrunning Operations API.
|
|
28
28
|
class Operations
|
|
29
|
+
# @private
|
|
30
|
+
DEFAULT_ENDPOINT_TEMPLATE = "assuredworkloads.$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:
|
|
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
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
|
-
#
|
|
617
|
-
#
|
|
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 = "assuredworkloads.googleapis.com"
|
|
669
690
|
|
|
670
|
-
config_attr :endpoint,
|
|
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
|
|
@@ -32,6 +32,9 @@ module Google
|
|
|
32
32
|
# Service to manage AssuredWorkloads.
|
|
33
33
|
#
|
|
34
34
|
class Client
|
|
35
|
+
# @private
|
|
36
|
+
DEFAULT_ENDPOINT_TEMPLATE = "assuredworkloads.$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
|
+
@assured_workloads_service_stub.universe_domain
|
|
107
|
+
end
|
|
108
|
+
|
|
97
109
|
##
|
|
98
110
|
# Create a new AssuredWorkloadsService 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
|
-
@assured_workloads_service_stub = ::Google::Cloud::AssuredWorkloads::V1::AssuredWorkloadsService::Rest::ServiceStub.new
|
|
155
|
+
@assured_workloads_service_stub = ::Google::Cloud::AssuredWorkloads::V1::AssuredWorkloadsService::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
|
##
|
|
@@ -709,9 +728,9 @@ module Google
|
|
|
709
728
|
# end
|
|
710
729
|
#
|
|
711
730
|
# @!attribute [rw] endpoint
|
|
712
|
-
#
|
|
713
|
-
#
|
|
714
|
-
# @return [::String]
|
|
731
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
732
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
733
|
+
# @return [::String,nil]
|
|
715
734
|
# @!attribute [rw] credentials
|
|
716
735
|
# Credentials to send with calls. You may provide any of the following types:
|
|
717
736
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -748,13 +767,20 @@ module Google
|
|
|
748
767
|
# @!attribute [rw] quota_project
|
|
749
768
|
# A separate project against which to charge quota.
|
|
750
769
|
# @return [::String]
|
|
770
|
+
# @!attribute [rw] universe_domain
|
|
771
|
+
# The universe domain within which to make requests. This determines the
|
|
772
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
773
|
+
# universe (usually the default "googleapis.com" universe).
|
|
774
|
+
# @return [::String,nil]
|
|
751
775
|
#
|
|
752
776
|
class Configuration
|
|
753
777
|
extend ::Gapic::Config
|
|
754
778
|
|
|
779
|
+
# @private
|
|
780
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
755
781
|
DEFAULT_ENDPOINT = "assuredworkloads.googleapis.com"
|
|
756
782
|
|
|
757
|
-
config_attr :endpoint,
|
|
783
|
+
config_attr :endpoint, nil, ::String, nil
|
|
758
784
|
config_attr :credentials, nil do |value|
|
|
759
785
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
760
786
|
allowed.any? { |klass| klass === value }
|
|
@@ -766,6 +792,7 @@ module Google
|
|
|
766
792
|
config_attr :metadata, nil, ::Hash, nil
|
|
767
793
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
768
794
|
config_attr :quota_project, nil, ::String, nil
|
|
795
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
769
796
|
|
|
770
797
|
# @private
|
|
771
798
|
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 = "assuredworkloads.$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
|
|
@@ -478,9 +492,9 @@ module Google
|
|
|
478
492
|
# end
|
|
479
493
|
#
|
|
480
494
|
# @!attribute [rw] endpoint
|
|
481
|
-
#
|
|
482
|
-
#
|
|
483
|
-
# @return [::String]
|
|
495
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
496
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
497
|
+
# @return [::String,nil]
|
|
484
498
|
# @!attribute [rw] credentials
|
|
485
499
|
# Credentials to send with calls. You may provide any of the following types:
|
|
486
500
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -517,13 +531,20 @@ module Google
|
|
|
517
531
|
# @!attribute [rw] quota_project
|
|
518
532
|
# A separate project against which to charge quota.
|
|
519
533
|
# @return [::String]
|
|
534
|
+
# @!attribute [rw] universe_domain
|
|
535
|
+
# The universe domain within which to make requests. This determines the
|
|
536
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
537
|
+
# universe (usually the default "googleapis.com" universe).
|
|
538
|
+
# @return [::String,nil]
|
|
520
539
|
#
|
|
521
540
|
class Configuration
|
|
522
541
|
extend ::Gapic::Config
|
|
523
542
|
|
|
543
|
+
# @private
|
|
544
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
524
545
|
DEFAULT_ENDPOINT = "assuredworkloads.googleapis.com"
|
|
525
546
|
|
|
526
|
-
config_attr :endpoint,
|
|
547
|
+
config_attr :endpoint, nil, ::String, nil
|
|
527
548
|
config_attr :credentials, nil do |value|
|
|
528
549
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
529
550
|
allowed.any? { |klass| klass === value }
|
|
@@ -535,6 +556,7 @@ module Google
|
|
|
535
556
|
config_attr :metadata, nil, ::Hash, nil
|
|
536
557
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
537
558
|
config_attr :quota_project, nil, ::String, nil
|
|
559
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
538
560
|
|
|
539
561
|
# @private
|
|
540
562
|
def initialize parent_config = nil
|
|
@@ -617,12 +639,15 @@ module Google
|
|
|
617
639
|
# Service stub contains baseline method implementations
|
|
618
640
|
# including transcoding, making the REST call, and deserialing the response.
|
|
619
641
|
class OperationsServiceStub
|
|
620
|
-
def initialize endpoint:, credentials:
|
|
642
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
621
643
|
# These require statements are intentionally placed here to initialize
|
|
622
644
|
# the REST modules only when it's required.
|
|
623
645
|
require "gapic/rest"
|
|
624
646
|
|
|
625
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
647
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
648
|
+
endpoint_template: endpoint_template,
|
|
649
|
+
universe_domain: universe_domain,
|
|
650
|
+
credentials: credentials
|
|
626
651
|
end
|
|
627
652
|
|
|
628
653
|
##
|
|
@@ -30,16 +30,28 @@ module Google
|
|
|
30
30
|
# including transcoding, making the REST call, and deserialing the response.
|
|
31
31
|
#
|
|
32
32
|
class ServiceStub
|
|
33
|
-
def initialize endpoint:, credentials:
|
|
33
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
34
34
|
# These require statements are intentionally placed here to initialize
|
|
35
35
|
# the REST modules only when it's required.
|
|
36
36
|
require "gapic/rest"
|
|
37
37
|
|
|
38
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
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_workload 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
|
|
@@ -172,6 +172,7 @@ module Google
|
|
|
172
172
|
# Format:
|
|
173
173
|
# folders/\\{folder_id}
|
|
174
174
|
# @!attribute [rw] kms_settings
|
|
175
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
175
176
|
# @return [::Google::Cloud::AssuredWorkloads::V1::Workload::KMSSettings]
|
|
176
177
|
# Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS
|
|
177
178
|
# CMEK key is provisioned.
|
|
@@ -247,6 +248,7 @@ module Google
|
|
|
247
248
|
# This message is deprecated.
|
|
248
249
|
# In order to create a Keyring, callers should specify,
|
|
249
250
|
# ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field.
|
|
251
|
+
# @deprecated This message is deprecated and may be removed in the next major version update.
|
|
250
252
|
# @!attribute [rw] next_rotation_time
|
|
251
253
|
# @return [::Google::Protobuf::Timestamp]
|
|
252
254
|
# Required. Input only. Immutable. The time at which the Key Management Service will automatically create a
|
|
@@ -472,6 +474,7 @@ module Google
|
|
|
472
474
|
# @return [::String]
|
|
473
475
|
# Required. Business justification explaining the need for violation acknowledgement
|
|
474
476
|
# @!attribute [rw] non_compliant_org_policy
|
|
477
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
475
478
|
# @return [::String]
|
|
476
479
|
# Optional. This field is deprecated and will be removed in future version of the API.
|
|
477
480
|
# Name of the OrgPolicy which was modified with non-compliant change and
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-assured_workloads-v1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.9.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
|
|
@@ -217,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
217
217
|
- !ruby/object:Gem::Version
|
|
218
218
|
version: '0'
|
|
219
219
|
requirements: []
|
|
220
|
-
rubygems_version: 3.
|
|
220
|
+
rubygems_version: 3.5.3
|
|
221
221
|
signing_key:
|
|
222
222
|
specification_version: 4
|
|
223
223
|
summary: API Client library for the Assured Workloads for Government V1 API
|