google-cloud-shell-v1 0.5.1 → 0.7.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/shell/v1/cloud_shell_service/client.rb +42 -9
- data/lib/google/cloud/shell/v1/cloud_shell_service/operations.rb +38 -7
- data/lib/google/cloud/shell/v1/cloud_shell_service/rest/client.rb +142 -7
- data/lib/google/cloud/shell/v1/cloud_shell_service/rest/operations.rb +108 -8
- data/lib/google/cloud/shell/v1/cloud_shell_service/rest/service_stub.rb +14 -2
- data/lib/google/cloud/shell/v1/version.rb +1 -1
- 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: 86a7624f674421f655c84e86181a4370116009ee9ae77dd51e9a4d9f8898aaea
|
|
4
|
+
data.tar.gz: cf8dc72e7fe5a91cdec945730f231f6df9cabf2a19a8f6da412938143d2e242e
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b8fd56e048ad28483ba34e83d5d5a39337dac95c03d129b0a80531e4bafb7f106779f407803efe9dd747e77ded97f7b46bb9046310fcf82a7a2a7274c5cd5698
|
|
7
|
+
data.tar.gz: a6c99d5074ceece01d7a620ed80c475d4e704f4d8c41178aa1784f3ae92d3c5f6fa1325e75f1f45f3370077c4bfd9b48618b99cf790b50eb102b60b5056d7a5d
|
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-shell-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-shell-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-shell-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::Shell::V1::CloudShellService::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/shell/v1"
|
|
77
|
-
|
|
78
|
-
ENV["CLOUD_SHELL_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/shell/v1"
|
|
90
58
|
|
|
91
59
|
client = ::Google::Cloud::Shell::V1::CloudShellService::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/shell/v1"
|
|
100
68
|
|
|
101
69
|
::Google::Cloud::Shell::V1::CloudShellService::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::Shell::V1::CloudShellService::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-shell-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/shell/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-shell-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::Shell::V1::CloudShellService::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).
|
|
@@ -36,6 +36,9 @@ module Google
|
|
|
36
36
|
# client.
|
|
37
37
|
#
|
|
38
38
|
class Client
|
|
39
|
+
# @private
|
|
40
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudshell.$UNIVERSE_DOMAIN$"
|
|
41
|
+
|
|
39
42
|
include Paths
|
|
40
43
|
|
|
41
44
|
# @private
|
|
@@ -109,6 +112,15 @@ module Google
|
|
|
109
112
|
@config
|
|
110
113
|
end
|
|
111
114
|
|
|
115
|
+
##
|
|
116
|
+
# The effective universe domain
|
|
117
|
+
#
|
|
118
|
+
# @return [String]
|
|
119
|
+
#
|
|
120
|
+
def universe_domain
|
|
121
|
+
@cloud_shell_service_stub.universe_domain
|
|
122
|
+
end
|
|
123
|
+
|
|
112
124
|
##
|
|
113
125
|
# Create a new CloudShellService client object.
|
|
114
126
|
#
|
|
@@ -142,8 +154,9 @@ module Google
|
|
|
142
154
|
credentials = @config.credentials
|
|
143
155
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
144
156
|
# but only if the default endpoint does not have a region prefix.
|
|
145
|
-
enable_self_signed_jwt = @config.endpoint
|
|
146
|
-
|
|
157
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
158
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
159
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
147
160
|
credentials ||= Credentials.default scope: @config.scope,
|
|
148
161
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
149
162
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -156,14 +169,18 @@ module Google
|
|
|
156
169
|
config.credentials = credentials
|
|
157
170
|
config.quota_project = @quota_project_id
|
|
158
171
|
config.endpoint = @config.endpoint
|
|
172
|
+
config.universe_domain = @config.universe_domain
|
|
159
173
|
end
|
|
160
174
|
|
|
161
175
|
@cloud_shell_service_stub = ::Gapic::ServiceStub.new(
|
|
162
176
|
::Google::Cloud::Shell::V1::CloudShellService::Stub,
|
|
163
|
-
credentials:
|
|
164
|
-
endpoint:
|
|
177
|
+
credentials: credentials,
|
|
178
|
+
endpoint: @config.endpoint,
|
|
179
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
180
|
+
universe_domain: @config.universe_domain,
|
|
165
181
|
channel_args: @config.channel_args,
|
|
166
|
-
interceptors: @config.interceptors
|
|
182
|
+
interceptors: @config.interceptors,
|
|
183
|
+
channel_pool_config: @config.channel_pool
|
|
167
184
|
)
|
|
168
185
|
end
|
|
169
186
|
|
|
@@ -706,9 +723,9 @@ module Google
|
|
|
706
723
|
# end
|
|
707
724
|
#
|
|
708
725
|
# @!attribute [rw] endpoint
|
|
709
|
-
#
|
|
710
|
-
#
|
|
711
|
-
# @return [::String]
|
|
726
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
727
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
728
|
+
# @return [::String,nil]
|
|
712
729
|
# @!attribute [rw] credentials
|
|
713
730
|
# Credentials to send with calls. You may provide any of the following types:
|
|
714
731
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -754,13 +771,20 @@ module Google
|
|
|
754
771
|
# @!attribute [rw] quota_project
|
|
755
772
|
# A separate project against which to charge quota.
|
|
756
773
|
# @return [::String]
|
|
774
|
+
# @!attribute [rw] universe_domain
|
|
775
|
+
# The universe domain within which to make requests. This determines the
|
|
776
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
777
|
+
# universe (usually the default "googleapis.com" universe).
|
|
778
|
+
# @return [::String,nil]
|
|
757
779
|
#
|
|
758
780
|
class Configuration
|
|
759
781
|
extend ::Gapic::Config
|
|
760
782
|
|
|
783
|
+
# @private
|
|
784
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
761
785
|
DEFAULT_ENDPOINT = "cloudshell.googleapis.com"
|
|
762
786
|
|
|
763
|
-
config_attr :endpoint,
|
|
787
|
+
config_attr :endpoint, nil, ::String, nil
|
|
764
788
|
config_attr :credentials, nil do |value|
|
|
765
789
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
766
790
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -775,6 +799,7 @@ module Google
|
|
|
775
799
|
config_attr :metadata, nil, ::Hash, nil
|
|
776
800
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
777
801
|
config_attr :quota_project, nil, ::String, nil
|
|
802
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
778
803
|
|
|
779
804
|
# @private
|
|
780
805
|
def initialize parent_config = nil
|
|
@@ -795,6 +820,14 @@ module Google
|
|
|
795
820
|
end
|
|
796
821
|
end
|
|
797
822
|
|
|
823
|
+
##
|
|
824
|
+
# Configuration for the channel pool
|
|
825
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
|
826
|
+
#
|
|
827
|
+
def channel_pool
|
|
828
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
|
829
|
+
end
|
|
830
|
+
|
|
798
831
|
##
|
|
799
832
|
# Configuration RPC class for the CloudShellService API.
|
|
800
833
|
#
|
|
@@ -26,6 +26,9 @@ module Google
|
|
|
26
26
|
module CloudShellService
|
|
27
27
|
# Service that implements Longrunning Operations API.
|
|
28
28
|
class Operations
|
|
29
|
+
# @private
|
|
30
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudshell.$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 = "cloudshell.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
|
#
|
|
@@ -38,6 +38,9 @@ module Google
|
|
|
38
38
|
# client.
|
|
39
39
|
#
|
|
40
40
|
class Client
|
|
41
|
+
# @private
|
|
42
|
+
DEFAULT_ENDPOINT_TEMPLATE = "cloudshell.$UNIVERSE_DOMAIN$"
|
|
43
|
+
|
|
41
44
|
include Paths
|
|
42
45
|
|
|
43
46
|
# @private
|
|
@@ -111,6 +114,15 @@ module Google
|
|
|
111
114
|
@config
|
|
112
115
|
end
|
|
113
116
|
|
|
117
|
+
##
|
|
118
|
+
# The effective universe domain
|
|
119
|
+
#
|
|
120
|
+
# @return [String]
|
|
121
|
+
#
|
|
122
|
+
def universe_domain
|
|
123
|
+
@cloud_shell_service_stub.universe_domain
|
|
124
|
+
end
|
|
125
|
+
|
|
114
126
|
##
|
|
115
127
|
# Create a new CloudShellService REST client object.
|
|
116
128
|
#
|
|
@@ -138,8 +150,9 @@ module Google
|
|
|
138
150
|
credentials = @config.credentials
|
|
139
151
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
140
152
|
# but only if the default endpoint does not have a region prefix.
|
|
141
|
-
enable_self_signed_jwt = @config.endpoint
|
|
142
|
-
|
|
153
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
154
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
155
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
143
156
|
credentials ||= Credentials.default scope: @config.scope,
|
|
144
157
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
145
158
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -153,9 +166,15 @@ module Google
|
|
|
153
166
|
config.credentials = credentials
|
|
154
167
|
config.quota_project = @quota_project_id
|
|
155
168
|
config.endpoint = @config.endpoint
|
|
169
|
+
config.universe_domain = @config.universe_domain
|
|
156
170
|
end
|
|
157
171
|
|
|
158
|
-
@cloud_shell_service_stub = ::Google::Cloud::Shell::V1::CloudShellService::Rest::ServiceStub.new
|
|
172
|
+
@cloud_shell_service_stub = ::Google::Cloud::Shell::V1::CloudShellService::Rest::ServiceStub.new(
|
|
173
|
+
endpoint: @config.endpoint,
|
|
174
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
175
|
+
universe_domain: @config.universe_domain,
|
|
176
|
+
credentials: credentials
|
|
177
|
+
)
|
|
159
178
|
end
|
|
160
179
|
|
|
161
180
|
##
|
|
@@ -195,6 +214,22 @@ module Google
|
|
|
195
214
|
# @return [::Google::Cloud::Shell::V1::Environment]
|
|
196
215
|
#
|
|
197
216
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
217
|
+
#
|
|
218
|
+
# @example Basic example
|
|
219
|
+
# require "google/cloud/shell/v1"
|
|
220
|
+
#
|
|
221
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
222
|
+
# client = Google::Cloud::Shell::V1::CloudShellService::Rest::Client.new
|
|
223
|
+
#
|
|
224
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
225
|
+
# request = Google::Cloud::Shell::V1::GetEnvironmentRequest.new
|
|
226
|
+
#
|
|
227
|
+
# # Call the get_environment method.
|
|
228
|
+
# result = client.get_environment request
|
|
229
|
+
#
|
|
230
|
+
# # The returned object is of type Google::Cloud::Shell::V1::Environment.
|
|
231
|
+
# p result
|
|
232
|
+
#
|
|
198
233
|
def get_environment request, options = nil
|
|
199
234
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
200
235
|
|
|
@@ -271,6 +306,29 @@ module Google
|
|
|
271
306
|
# @return [::Gapic::Operation]
|
|
272
307
|
#
|
|
273
308
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
309
|
+
#
|
|
310
|
+
# @example Basic example
|
|
311
|
+
# require "google/cloud/shell/v1"
|
|
312
|
+
#
|
|
313
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
314
|
+
# client = Google::Cloud::Shell::V1::CloudShellService::Rest::Client.new
|
|
315
|
+
#
|
|
316
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
317
|
+
# request = Google::Cloud::Shell::V1::StartEnvironmentRequest.new
|
|
318
|
+
#
|
|
319
|
+
# # Call the start_environment method.
|
|
320
|
+
# result = client.start_environment request
|
|
321
|
+
#
|
|
322
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
323
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
324
|
+
# # Here is how to wait for a response.
|
|
325
|
+
# result.wait_until_done! timeout: 60
|
|
326
|
+
# if result.response?
|
|
327
|
+
# p result.response
|
|
328
|
+
# else
|
|
329
|
+
# puts "No response received."
|
|
330
|
+
# end
|
|
331
|
+
#
|
|
274
332
|
def start_environment request, options = nil
|
|
275
333
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
276
334
|
|
|
@@ -346,6 +404,29 @@ module Google
|
|
|
346
404
|
# @return [::Gapic::Operation]
|
|
347
405
|
#
|
|
348
406
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
407
|
+
#
|
|
408
|
+
# @example Basic example
|
|
409
|
+
# require "google/cloud/shell/v1"
|
|
410
|
+
#
|
|
411
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
412
|
+
# client = Google::Cloud::Shell::V1::CloudShellService::Rest::Client.new
|
|
413
|
+
#
|
|
414
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
415
|
+
# request = Google::Cloud::Shell::V1::AuthorizeEnvironmentRequest.new
|
|
416
|
+
#
|
|
417
|
+
# # Call the authorize_environment method.
|
|
418
|
+
# result = client.authorize_environment request
|
|
419
|
+
#
|
|
420
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
421
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
422
|
+
# # Here is how to wait for a response.
|
|
423
|
+
# result.wait_until_done! timeout: 60
|
|
424
|
+
# if result.response?
|
|
425
|
+
# p result.response
|
|
426
|
+
# else
|
|
427
|
+
# puts "No response received."
|
|
428
|
+
# end
|
|
429
|
+
#
|
|
349
430
|
def authorize_environment request, options = nil
|
|
350
431
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
351
432
|
|
|
@@ -419,6 +500,29 @@ module Google
|
|
|
419
500
|
# @return [::Gapic::Operation]
|
|
420
501
|
#
|
|
421
502
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
503
|
+
#
|
|
504
|
+
# @example Basic example
|
|
505
|
+
# require "google/cloud/shell/v1"
|
|
506
|
+
#
|
|
507
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
508
|
+
# client = Google::Cloud::Shell::V1::CloudShellService::Rest::Client.new
|
|
509
|
+
#
|
|
510
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
511
|
+
# request = Google::Cloud::Shell::V1::AddPublicKeyRequest.new
|
|
512
|
+
#
|
|
513
|
+
# # Call the add_public_key method.
|
|
514
|
+
# result = client.add_public_key request
|
|
515
|
+
#
|
|
516
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
517
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
518
|
+
# # Here is how to wait for a response.
|
|
519
|
+
# result.wait_until_done! timeout: 60
|
|
520
|
+
# if result.response?
|
|
521
|
+
# p result.response
|
|
522
|
+
# else
|
|
523
|
+
# puts "No response received."
|
|
524
|
+
# end
|
|
525
|
+
#
|
|
422
526
|
def add_public_key request, options = nil
|
|
423
527
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
424
528
|
|
|
@@ -488,6 +592,29 @@ module Google
|
|
|
488
592
|
# @return [::Gapic::Operation]
|
|
489
593
|
#
|
|
490
594
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
595
|
+
#
|
|
596
|
+
# @example Basic example
|
|
597
|
+
# require "google/cloud/shell/v1"
|
|
598
|
+
#
|
|
599
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
600
|
+
# client = Google::Cloud::Shell::V1::CloudShellService::Rest::Client.new
|
|
601
|
+
#
|
|
602
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
603
|
+
# request = Google::Cloud::Shell::V1::RemovePublicKeyRequest.new
|
|
604
|
+
#
|
|
605
|
+
# # Call the remove_public_key method.
|
|
606
|
+
# result = client.remove_public_key request
|
|
607
|
+
#
|
|
608
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
609
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
610
|
+
# # Here is how to wait for a response.
|
|
611
|
+
# result.wait_until_done! timeout: 60
|
|
612
|
+
# if result.response?
|
|
613
|
+
# p result.response
|
|
614
|
+
# else
|
|
615
|
+
# puts "No response received."
|
|
616
|
+
# end
|
|
617
|
+
#
|
|
491
618
|
def remove_public_key request, options = nil
|
|
492
619
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
493
620
|
|
|
@@ -554,9 +681,9 @@ module Google
|
|
|
554
681
|
# end
|
|
555
682
|
#
|
|
556
683
|
# @!attribute [rw] endpoint
|
|
557
|
-
#
|
|
558
|
-
#
|
|
559
|
-
# @return [::String]
|
|
684
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
685
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
686
|
+
# @return [::String,nil]
|
|
560
687
|
# @!attribute [rw] credentials
|
|
561
688
|
# Credentials to send with calls. You may provide any of the following types:
|
|
562
689
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -593,13 +720,20 @@ module Google
|
|
|
593
720
|
# @!attribute [rw] quota_project
|
|
594
721
|
# A separate project against which to charge quota.
|
|
595
722
|
# @return [::String]
|
|
723
|
+
# @!attribute [rw] universe_domain
|
|
724
|
+
# The universe domain within which to make requests. This determines the
|
|
725
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
726
|
+
# universe (usually the default "googleapis.com" universe).
|
|
727
|
+
# @return [::String,nil]
|
|
596
728
|
#
|
|
597
729
|
class Configuration
|
|
598
730
|
extend ::Gapic::Config
|
|
599
731
|
|
|
732
|
+
# @private
|
|
733
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
600
734
|
DEFAULT_ENDPOINT = "cloudshell.googleapis.com"
|
|
601
735
|
|
|
602
|
-
config_attr :endpoint,
|
|
736
|
+
config_attr :endpoint, nil, ::String, nil
|
|
603
737
|
config_attr :credentials, nil do |value|
|
|
604
738
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
605
739
|
allowed.any? { |klass| klass === value }
|
|
@@ -611,6 +745,7 @@ module Google
|
|
|
611
745
|
config_attr :metadata, nil, ::Hash, nil
|
|
612
746
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
613
747
|
config_attr :quota_project, nil, ::String, nil
|
|
748
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
614
749
|
|
|
615
750
|
# @private
|
|
616
751
|
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 = "cloudshell.$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 = "cloudshell.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 get_environment REST call
|
|
45
57
|
#
|
|
@@ -21,6 +21,7 @@ module Google
|
|
|
21
21
|
module Api
|
|
22
22
|
# Required information for every language.
|
|
23
23
|
# @!attribute [rw] reference_docs_uri
|
|
24
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
24
25
|
# @return [::String]
|
|
25
26
|
# Link to automatically generated reference documentation. Example:
|
|
26
27
|
# https://cloud.google.com/nodejs/docs/reference/asset/latest
|
|
@@ -304,6 +305,19 @@ module Google
|
|
|
304
305
|
# seconds: 360 # 6 minutes
|
|
305
306
|
# total_poll_timeout:
|
|
306
307
|
# seconds: 54000 # 90 minutes
|
|
308
|
+
# @!attribute [rw] auto_populated_fields
|
|
309
|
+
# @return [::Array<::String>]
|
|
310
|
+
# List of top-level fields of the request message, that should be
|
|
311
|
+
# automatically populated by the client libraries based on their
|
|
312
|
+
# (google.api.field_info).format. Currently supported format: UUID4.
|
|
313
|
+
#
|
|
314
|
+
# Example of a YAML configuration:
|
|
315
|
+
#
|
|
316
|
+
# publishing:
|
|
317
|
+
# method_settings:
|
|
318
|
+
# - selector: google.example.v1.ExampleService.CreateExample
|
|
319
|
+
# auto_populated_fields:
|
|
320
|
+
# - request_id
|
|
307
321
|
class MethodSettings
|
|
308
322
|
include ::Google::Protobuf::MessageExts
|
|
309
323
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -66,6 +66,20 @@ module Google
|
|
|
66
66
|
# a non-empty value will be returned. The user will not be aware of what
|
|
67
67
|
# non-empty value to expect.
|
|
68
68
|
NON_EMPTY_DEFAULT = 7
|
|
69
|
+
|
|
70
|
+
# Denotes that the field in a resource (a message annotated with
|
|
71
|
+
# google.api.resource) is used in the resource name to uniquely identify the
|
|
72
|
+
# resource. For AIP-compliant APIs, this should only be applied to the
|
|
73
|
+
# `name` field on the resource.
|
|
74
|
+
#
|
|
75
|
+
# This behavior should not be applied to references to other resources within
|
|
76
|
+
# the message.
|
|
77
|
+
#
|
|
78
|
+
# The identifier field of resources often have different field behavior
|
|
79
|
+
# depending on the request it is embedded in (e.g. for Create methods name
|
|
80
|
+
# is optional and unused, while for Update methods it is required). Instead
|
|
81
|
+
# of method-specific annotations, only `IDENTIFIER` is required.
|
|
82
|
+
IDENTIFIER = 8
|
|
69
83
|
end
|
|
70
84
|
end
|
|
71
85
|
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-shell-v1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.7.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
|
|
@@ -216,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
216
216
|
- !ruby/object:Gem::Version
|
|
217
217
|
version: '0'
|
|
218
218
|
requirements: []
|
|
219
|
-
rubygems_version: 3.
|
|
219
|
+
rubygems_version: 3.5.3
|
|
220
220
|
signing_key:
|
|
221
221
|
specification_version: 4
|
|
222
222
|
summary: Allows users to start, configure, and connect to interactive shell sessions
|