google-cloud-notebooks-v1beta1 0.4.5 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +1 -1
- data/README.md +11 -6
- data/lib/google/cloud/notebooks/v1beta1/environment_pb.rb +2 -2
- data/lib/google/cloud/notebooks/v1beta1/instance_pb.rb +26 -2
- data/lib/google/cloud/notebooks/v1beta1/notebook_service/client.rb +45 -8
- data/lib/google/cloud/notebooks/v1beta1/notebook_service/operations.rb +3 -0
- data/lib/google/cloud/notebooks/v1beta1/service_pb.rb +4 -2
- data/lib/google/cloud/notebooks/v1beta1/service_services_pb.rb +3 -0
- data/lib/google/cloud/notebooks/v1beta1/version.rb +1 -1
- data/lib/google/cloud/notebooks/v1beta1.rb +2 -0
- data/proto_docs/google/api/client.rb +318 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/cloud/notebooks/v1beta1/instance.rb +88 -29
- data/proto_docs/google/cloud/notebooks/v1beta1/service.rb +14 -10
- data/proto_docs/google/protobuf/any.rb +3 -3
- data/proto_docs/google/protobuf/empty.rb +0 -2
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/type/expr.rb +75 -0
- metadata +56 -12
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b1e33d32b2b464040081f9c1d0b733b6ddde42d8744a1b71c0f5a2a2e4fe9801
|
4
|
+
data.tar.gz: f9aabf3a9396b00880a6596aecd8b91ee39a0827222862ce1252f962f08c6214
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2bbc38566b30c7ac8e21338aab293db432d9ee87d63c5e4386b2cf6fbb9ee2a4f3dfa62c651e6c65d06f2932bf51cae50615637f5fba8c52113119aab2760b71
|
7
|
+
data.tar.gz: fd70574c20b8721228295fe8ec402bf9e1dcb9aee3902930312e62061da2ff1a44893dfa08fefb18e3ea0175ab87cded94f790699f0131d7213cf143899296e2
|
data/AUTHENTICATION.md
CHANGED
@@ -114,7 +114,7 @@ credentials are discovered.
|
|
114
114
|
To configure your system for this, simply:
|
115
115
|
|
116
116
|
1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
|
117
|
-
2. Authenticate using OAuth 2.0 `$ gcloud auth login`
|
117
|
+
2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
|
118
118
|
3. Write code as if already authenticated.
|
119
119
|
|
120
120
|
**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
|
data/README.md
CHANGED
@@ -37,7 +37,7 @@ request = ::Google::Cloud::Notebooks::V1beta1::ListInstancesRequest.new # (reque
|
|
37
37
|
response = client.list_instances request
|
38
38
|
```
|
39
39
|
|
40
|
-
View the [Client Library Documentation](https://
|
40
|
+
View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v1beta1/latest)
|
41
41
|
for class and method documentation.
|
42
42
|
|
43
43
|
See also the [Product Documentation](https://cloud.google.com/ai-platform-notebooks)
|
@@ -69,16 +69,21 @@ module GRPC
|
|
69
69
|
end
|
70
70
|
```
|
71
71
|
|
72
|
+
|
73
|
+
## Google Cloud Samples
|
74
|
+
|
75
|
+
To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
|
76
|
+
|
72
77
|
## Supported Ruby Versions
|
73
78
|
|
74
|
-
This library is supported on Ruby 2.
|
79
|
+
This library is supported on Ruby 2.6+.
|
75
80
|
|
76
81
|
Google provides official support for Ruby versions that are actively supported
|
77
82
|
by Ruby Core—that is, Ruby versions that are either in normal maintenance or
|
78
|
-
in security maintenance, and not end of life.
|
79
|
-
|
80
|
-
|
81
|
-
|
83
|
+
in security maintenance, and not end of life. Older versions of Ruby _may_
|
84
|
+
still work, but are unsupported and not recommended. See
|
85
|
+
https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
|
86
|
+
support schedule.
|
82
87
|
|
83
88
|
## Which client should I use?
|
84
89
|
|
@@ -1,11 +1,11 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/cloud/notebooks/v1beta1/environment.proto
|
3
3
|
|
4
|
+
require 'google/protobuf'
|
5
|
+
|
4
6
|
require 'google/api/field_behavior_pb'
|
5
7
|
require 'google/api/resource_pb'
|
6
8
|
require 'google/protobuf/timestamp_pb'
|
7
|
-
require 'google/api/annotations_pb'
|
8
|
-
require 'google/protobuf'
|
9
9
|
|
10
10
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
11
11
|
add_file("google/cloud/notebooks/v1beta1/environment.proto", :syntax => :proto3) do
|
@@ -1,15 +1,26 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/cloud/notebooks/v1beta1/instance.proto
|
3
3
|
|
4
|
+
require 'google/protobuf'
|
5
|
+
|
4
6
|
require 'google/api/field_behavior_pb'
|
5
7
|
require 'google/api/resource_pb'
|
6
8
|
require 'google/cloud/notebooks/v1beta1/environment_pb'
|
7
9
|
require 'google/protobuf/timestamp_pb'
|
8
|
-
require 'google/api/annotations_pb'
|
9
|
-
require 'google/protobuf'
|
10
10
|
|
11
11
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
12
12
|
add_file("google/cloud/notebooks/v1beta1/instance.proto", :syntax => :proto3) do
|
13
|
+
add_message "google.cloud.notebooks.v1beta1.ReservationAffinity" do
|
14
|
+
optional :consume_reservation_type, :enum, 1, "google.cloud.notebooks.v1beta1.ReservationAffinity.Type"
|
15
|
+
optional :key, :string, 2
|
16
|
+
repeated :values, :string, 3
|
17
|
+
end
|
18
|
+
add_enum "google.cloud.notebooks.v1beta1.ReservationAffinity.Type" do
|
19
|
+
value :TYPE_UNSPECIFIED, 0
|
20
|
+
value :NO_RESERVATION, 1
|
21
|
+
value :ANY_RESERVATION, 2
|
22
|
+
value :SPECIFIC_RESERVATION, 3
|
23
|
+
end
|
13
24
|
add_message "google.cloud.notebooks.v1beta1.Instance" do
|
14
25
|
optional :name, :string, 1
|
15
26
|
optional :post_startup_script, :string, 4
|
@@ -34,6 +45,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
34
45
|
optional :subnet, :string, 20
|
35
46
|
map :labels, :string, :string, 21
|
36
47
|
map :metadata, :string, :string, 22
|
48
|
+
optional :nic_type, :enum, 28, "google.cloud.notebooks.v1beta1.Instance.NicType"
|
49
|
+
optional :reservation_affinity, :message, 29, "google.cloud.notebooks.v1beta1.ReservationAffinity"
|
50
|
+
optional :can_ip_forward, :bool, 31
|
37
51
|
optional :create_time, :message, 23, "google.protobuf.Timestamp"
|
38
52
|
optional :update_time, :message, 24, "google.protobuf.Timestamp"
|
39
53
|
oneof :environment do
|
@@ -69,6 +83,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
69
83
|
value :UPGRADING, 7
|
70
84
|
value :INITIALIZING, 8
|
71
85
|
value :REGISTERING, 9
|
86
|
+
value :SUSPENDING, 10
|
87
|
+
value :SUSPENDED, 11
|
72
88
|
end
|
73
89
|
add_enum "google.cloud.notebooks.v1beta1.Instance.DiskType" do
|
74
90
|
value :DISK_TYPE_UNSPECIFIED, 0
|
@@ -81,6 +97,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
81
97
|
value :GMEK, 1
|
82
98
|
value :CMEK, 2
|
83
99
|
end
|
100
|
+
add_enum "google.cloud.notebooks.v1beta1.Instance.NicType" do
|
101
|
+
value :UNSPECIFIED_NIC_TYPE, 0
|
102
|
+
value :VIRTIO_NET, 1
|
103
|
+
value :GVNIC, 2
|
104
|
+
end
|
84
105
|
end
|
85
106
|
end
|
86
107
|
|
@@ -88,12 +109,15 @@ module Google
|
|
88
109
|
module Cloud
|
89
110
|
module Notebooks
|
90
111
|
module V1beta1
|
112
|
+
ReservationAffinity = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1beta1.ReservationAffinity").msgclass
|
113
|
+
ReservationAffinity::Type = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1beta1.ReservationAffinity.Type").enummodule
|
91
114
|
Instance = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1beta1.Instance").msgclass
|
92
115
|
Instance::AcceleratorConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1beta1.Instance.AcceleratorConfig").msgclass
|
93
116
|
Instance::AcceleratorType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1beta1.Instance.AcceleratorType").enummodule
|
94
117
|
Instance::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1beta1.Instance.State").enummodule
|
95
118
|
Instance::DiskType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1beta1.Instance.DiskType").enummodule
|
96
119
|
Instance::DiskEncryption = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1beta1.Instance.DiskEncryption").enummodule
|
120
|
+
Instance::NicType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1beta1.Instance.NicType").enummodule
|
97
121
|
end
|
98
122
|
end
|
99
123
|
end
|
@@ -18,6 +18,8 @@
|
|
18
18
|
|
19
19
|
require "google/cloud/errors"
|
20
20
|
require "google/cloud/notebooks/v1beta1/service_pb"
|
21
|
+
require "google/cloud/location"
|
22
|
+
require "google/iam/v1"
|
21
23
|
|
22
24
|
module Google
|
23
25
|
module Cloud
|
@@ -182,6 +184,18 @@ module Google
|
|
182
184
|
config.endpoint = @config.endpoint
|
183
185
|
end
|
184
186
|
|
187
|
+
@location_client = Google::Cloud::Location::Locations::Client.new do |config|
|
188
|
+
config.credentials = credentials
|
189
|
+
config.quota_project = @quota_project_id
|
190
|
+
config.endpoint = @config.endpoint
|
191
|
+
end
|
192
|
+
|
193
|
+
@iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
|
194
|
+
config.credentials = credentials
|
195
|
+
config.quota_project = @quota_project_id
|
196
|
+
config.endpoint = @config.endpoint
|
197
|
+
end
|
198
|
+
|
185
199
|
@notebook_service_stub = ::Gapic::ServiceStub.new(
|
186
200
|
::Google::Cloud::Notebooks::V1beta1::NotebookService::Stub,
|
187
201
|
credentials: credentials,
|
@@ -198,6 +212,20 @@ module Google
|
|
198
212
|
#
|
199
213
|
attr_reader :operations_client
|
200
214
|
|
215
|
+
##
|
216
|
+
# Get the associated client for mix-in of the Locations.
|
217
|
+
#
|
218
|
+
# @return [Google::Cloud::Location::Locations::Client]
|
219
|
+
#
|
220
|
+
attr_reader :location_client
|
221
|
+
|
222
|
+
##
|
223
|
+
# Get the associated client for mix-in of the IAMPolicy.
|
224
|
+
#
|
225
|
+
# @return [Google::Iam::V1::IAMPolicy::Client]
|
226
|
+
#
|
227
|
+
attr_reader :iam_policy_client
|
228
|
+
|
201
229
|
# Service calls
|
202
230
|
|
203
231
|
##
|
@@ -608,10 +636,10 @@ module Google
|
|
608
636
|
# @param type [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
|
609
637
|
# Required. Type of this accelerator.
|
610
638
|
# @param core_count [::Integer]
|
611
|
-
# Required. Count of cores of this accelerator. Note that not all
|
612
|
-
#
|
613
|
-
# Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to
|
614
|
-
# valid combination. TPUs are not supported.
|
639
|
+
# Required. Count of cores of this accelerator. Note that not all combinations
|
640
|
+
# of `type` and `core_count` are valid. Check [GPUs on
|
641
|
+
# Compute Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to
|
642
|
+
# find a valid combination. TPUs are not supported.
|
615
643
|
#
|
616
644
|
# @yield [response, operation] Access the result along with the RPC operation
|
617
645
|
# @yieldparam response [::Gapic::Operation]
|
@@ -1360,6 +1388,9 @@ module Google
|
|
1360
1388
|
|
1361
1389
|
##
|
1362
1390
|
# Check if a notebook instance is upgradable.
|
1391
|
+
# Deprecated. Please consider using v1.
|
1392
|
+
#
|
1393
|
+
# @deprecated This method is deprecated and may be removed in the next major version update.
|
1363
1394
|
#
|
1364
1395
|
# @overload is_instance_upgradeable(request, options = nil)
|
1365
1396
|
# Pass arguments to `is_instance_upgradeable` via a request object, either of type
|
@@ -1446,6 +1477,9 @@ module Google
|
|
1446
1477
|
|
1447
1478
|
##
|
1448
1479
|
# Upgrades a notebook instance to the latest version.
|
1480
|
+
# Deprecated. Please consider using v1.
|
1481
|
+
#
|
1482
|
+
# @deprecated This method is deprecated and may be removed in the next major version update.
|
1449
1483
|
#
|
1450
1484
|
# @overload upgrade_instance(request, options = nil)
|
1451
1485
|
# Pass arguments to `upgrade_instance` via a request object, either of type
|
@@ -1541,6 +1575,9 @@ module Google
|
|
1541
1575
|
##
|
1542
1576
|
# Allows notebook instances to
|
1543
1577
|
# call this endpoint to upgrade themselves. Do not use this method directly.
|
1578
|
+
# Deprecated. Please consider using v1.
|
1579
|
+
#
|
1580
|
+
# @deprecated This method is deprecated and may be removed in the next major version update.
|
1544
1581
|
#
|
1545
1582
|
# @overload upgrade_instance_internal(request, options = nil)
|
1546
1583
|
# Pass arguments to `upgrade_instance_internal` via a request object, either of type
|
@@ -1840,10 +1877,10 @@ module Google
|
|
1840
1877
|
# @param parent [::String]
|
1841
1878
|
# Required. Format: `projects/{project_id}/locations/{location}`
|
1842
1879
|
# @param environment_id [::String]
|
1843
|
-
# Required. User-defined unique ID of this environment. The `environment_id`
|
1844
|
-
#
|
1845
|
-
# characters, and dashes. The first character must be a lowercase
|
1846
|
-
# the last character cannot be a dash.
|
1880
|
+
# Required. User-defined unique ID of this environment. The `environment_id` must
|
1881
|
+
# be 1 to 63 characters long and contain only lowercase letters,
|
1882
|
+
# numeric characters, and dashes. The first character must be a lowercase
|
1883
|
+
# letter and the last character cannot be a dash.
|
1847
1884
|
# @param environment [::Google::Cloud::Notebooks::V1beta1::Environment, ::Hash]
|
1848
1885
|
# Required. The environment to be created.
|
1849
1886
|
#
|
@@ -1,14 +1,15 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/cloud/notebooks/v1beta1/service.proto
|
3
3
|
|
4
|
+
require 'google/protobuf'
|
5
|
+
|
4
6
|
require 'google/api/annotations_pb'
|
7
|
+
require 'google/api/client_pb'
|
5
8
|
require 'google/api/field_behavior_pb'
|
6
9
|
require 'google/cloud/notebooks/v1beta1/environment_pb'
|
7
10
|
require 'google/cloud/notebooks/v1beta1/instance_pb'
|
8
11
|
require 'google/longrunning/operations_pb'
|
9
12
|
require 'google/protobuf/timestamp_pb'
|
10
|
-
require 'google/api/client_pb'
|
11
|
-
require 'google/protobuf'
|
12
13
|
|
13
14
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
14
15
|
add_file("google/cloud/notebooks/v1beta1/service.proto", :syntax => :proto3) do
|
@@ -81,6 +82,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
81
82
|
optional :upgradeable, :bool, 1
|
82
83
|
optional :upgrade_version, :string, 2
|
83
84
|
optional :upgrade_info, :string, 3
|
85
|
+
optional :upgrade_image, :string, 4
|
84
86
|
end
|
85
87
|
add_message "google.cloud.notebooks.v1beta1.UpgradeInstanceRequest" do
|
86
88
|
optional :name, :string, 1
|
@@ -64,11 +64,14 @@ module Google
|
|
64
64
|
# the instance metadata store. Do not use this method directly.
|
65
65
|
rpc :ReportInstanceInfo, ::Google::Cloud::Notebooks::V1beta1::ReportInstanceInfoRequest, ::Google::Longrunning::Operation
|
66
66
|
# Check if a notebook instance is upgradable.
|
67
|
+
# Deprecated. Please consider using v1.
|
67
68
|
rpc :IsInstanceUpgradeable, ::Google::Cloud::Notebooks::V1beta1::IsInstanceUpgradeableRequest, ::Google::Cloud::Notebooks::V1beta1::IsInstanceUpgradeableResponse
|
68
69
|
# Upgrades a notebook instance to the latest version.
|
70
|
+
# Deprecated. Please consider using v1.
|
69
71
|
rpc :UpgradeInstance, ::Google::Cloud::Notebooks::V1beta1::UpgradeInstanceRequest, ::Google::Longrunning::Operation
|
70
72
|
# Allows notebook instances to
|
71
73
|
# call this endpoint to upgrade themselves. Do not use this method directly.
|
74
|
+
# Deprecated. Please consider using v1.
|
72
75
|
rpc :UpgradeInstanceInternal, ::Google::Cloud::Notebooks::V1beta1::UpgradeInstanceInternalRequest, ::Google::Longrunning::Operation
|
73
76
|
# Lists environments in a project.
|
74
77
|
rpc :ListEnvironments, ::Google::Cloud::Notebooks::V1beta1::ListEnvironmentsRequest, ::Google::Cloud::Notebooks::V1beta1::ListEnvironmentsResponse
|
@@ -0,0 +1,318 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Api
|
22
|
+
# Required information for every language.
|
23
|
+
# @!attribute [rw] reference_docs_uri
|
24
|
+
# @return [::String]
|
25
|
+
# Link to automatically generated reference documentation. Example:
|
26
|
+
# https://cloud.google.com/nodejs/docs/reference/asset/latest
|
27
|
+
# @!attribute [rw] destinations
|
28
|
+
# @return [::Array<::Google::Api::ClientLibraryDestination>]
|
29
|
+
# The destination where API teams want this client library to be published.
|
30
|
+
class CommonLanguageSettings
|
31
|
+
include ::Google::Protobuf::MessageExts
|
32
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
33
|
+
end
|
34
|
+
|
35
|
+
# Details about how and where to publish client libraries.
|
36
|
+
# @!attribute [rw] version
|
37
|
+
# @return [::String]
|
38
|
+
# Version of the API to apply these settings to.
|
39
|
+
# @!attribute [rw] launch_stage
|
40
|
+
# @return [::Google::Api::LaunchStage]
|
41
|
+
# Launch stage of this version of the API.
|
42
|
+
# @!attribute [rw] rest_numeric_enums
|
43
|
+
# @return [::Boolean]
|
44
|
+
# When using transport=rest, the client request will encode enums as
|
45
|
+
# numbers rather than strings.
|
46
|
+
# @!attribute [rw] java_settings
|
47
|
+
# @return [::Google::Api::JavaSettings]
|
48
|
+
# Settings for legacy Java features, supported in the Service YAML.
|
49
|
+
# @!attribute [rw] cpp_settings
|
50
|
+
# @return [::Google::Api::CppSettings]
|
51
|
+
# Settings for C++ client libraries.
|
52
|
+
# @!attribute [rw] php_settings
|
53
|
+
# @return [::Google::Api::PhpSettings]
|
54
|
+
# Settings for PHP client libraries.
|
55
|
+
# @!attribute [rw] python_settings
|
56
|
+
# @return [::Google::Api::PythonSettings]
|
57
|
+
# Settings for Python client libraries.
|
58
|
+
# @!attribute [rw] node_settings
|
59
|
+
# @return [::Google::Api::NodeSettings]
|
60
|
+
# Settings for Node client libraries.
|
61
|
+
# @!attribute [rw] dotnet_settings
|
62
|
+
# @return [::Google::Api::DotnetSettings]
|
63
|
+
# Settings for .NET client libraries.
|
64
|
+
# @!attribute [rw] ruby_settings
|
65
|
+
# @return [::Google::Api::RubySettings]
|
66
|
+
# Settings for Ruby client libraries.
|
67
|
+
# @!attribute [rw] go_settings
|
68
|
+
# @return [::Google::Api::GoSettings]
|
69
|
+
# Settings for Go client libraries.
|
70
|
+
class ClientLibrarySettings
|
71
|
+
include ::Google::Protobuf::MessageExts
|
72
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
73
|
+
end
|
74
|
+
|
75
|
+
# This message configures the settings for publishing [Google Cloud Client
|
76
|
+
# libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
|
77
|
+
# generated from the service config.
|
78
|
+
# @!attribute [rw] method_settings
|
79
|
+
# @return [::Array<::Google::Api::MethodSettings>]
|
80
|
+
# A list of API method settings, e.g. the behavior for methods that use the
|
81
|
+
# long-running operation pattern.
|
82
|
+
# @!attribute [rw] new_issue_uri
|
83
|
+
# @return [::String]
|
84
|
+
# Link to a place that API users can report issues. Example:
|
85
|
+
# https://issuetracker.google.com/issues/new?component=190865&template=1161103
|
86
|
+
# @!attribute [rw] documentation_uri
|
87
|
+
# @return [::String]
|
88
|
+
# Link to product home page. Example:
|
89
|
+
# https://cloud.google.com/asset-inventory/docs/overview
|
90
|
+
# @!attribute [rw] api_short_name
|
91
|
+
# @return [::String]
|
92
|
+
# Used as a tracking tag when collecting data about the APIs developer
|
93
|
+
# relations artifacts like docs, packages delivered to package managers,
|
94
|
+
# etc. Example: "speech".
|
95
|
+
# @!attribute [rw] github_label
|
96
|
+
# @return [::String]
|
97
|
+
# GitHub label to apply to issues and pull requests opened for this API.
|
98
|
+
# @!attribute [rw] codeowner_github_teams
|
99
|
+
# @return [::Array<::String>]
|
100
|
+
# GitHub teams to be added to CODEOWNERS in the directory in GitHub
|
101
|
+
# containing source code for the client libraries for this API.
|
102
|
+
# @!attribute [rw] doc_tag_prefix
|
103
|
+
# @return [::String]
|
104
|
+
# A prefix used in sample code when demarking regions to be included in
|
105
|
+
# documentation.
|
106
|
+
# @!attribute [rw] organization
|
107
|
+
# @return [::Google::Api::ClientLibraryOrganization]
|
108
|
+
# For whom the client library is being published.
|
109
|
+
# @!attribute [rw] library_settings
|
110
|
+
# @return [::Array<::Google::Api::ClientLibrarySettings>]
|
111
|
+
# Client library settings. If the same version string appears multiple
|
112
|
+
# times in this list, then the last one wins. Settings from earlier
|
113
|
+
# settings with the same version string are discarded.
|
114
|
+
class Publishing
|
115
|
+
include ::Google::Protobuf::MessageExts
|
116
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
117
|
+
end
|
118
|
+
|
119
|
+
# Settings for Java client libraries.
|
120
|
+
# @!attribute [rw] library_package
|
121
|
+
# @return [::String]
|
122
|
+
# The package name to use in Java. Clobbers the java_package option
|
123
|
+
# set in the protobuf. This should be used **only** by APIs
|
124
|
+
# who have already set the language_settings.java.package_name" field
|
125
|
+
# in gapic.yaml. API teams should use the protobuf java_package option
|
126
|
+
# where possible.
|
127
|
+
#
|
128
|
+
# Example of a YAML configuration::
|
129
|
+
#
|
130
|
+
# publishing:
|
131
|
+
# java_settings:
|
132
|
+
# library_package: com.google.cloud.pubsub.v1
|
133
|
+
# @!attribute [rw] service_class_names
|
134
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
135
|
+
# Configure the Java class name to use instead of the service's for its
|
136
|
+
# corresponding generated GAPIC client. Keys are fully-qualified
|
137
|
+
# service names as they appear in the protobuf (including the full
|
138
|
+
# the language_settings.java.interface_names" field in gapic.yaml. API
|
139
|
+
# teams should otherwise use the service name as it appears in the
|
140
|
+
# protobuf.
|
141
|
+
#
|
142
|
+
# Example of a YAML configuration::
|
143
|
+
#
|
144
|
+
# publishing:
|
145
|
+
# java_settings:
|
146
|
+
# service_class_names:
|
147
|
+
# - google.pubsub.v1.Publisher: TopicAdmin
|
148
|
+
# - google.pubsub.v1.Subscriber: SubscriptionAdmin
|
149
|
+
# @!attribute [rw] common
|
150
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
151
|
+
# Some settings.
|
152
|
+
class JavaSettings
|
153
|
+
include ::Google::Protobuf::MessageExts
|
154
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
155
|
+
|
156
|
+
# @!attribute [rw] key
|
157
|
+
# @return [::String]
|
158
|
+
# @!attribute [rw] value
|
159
|
+
# @return [::String]
|
160
|
+
class ServiceClassNamesEntry
|
161
|
+
include ::Google::Protobuf::MessageExts
|
162
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
163
|
+
end
|
164
|
+
end
|
165
|
+
|
166
|
+
# Settings for C++ client libraries.
|
167
|
+
# @!attribute [rw] common
|
168
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
169
|
+
# Some settings.
|
170
|
+
class CppSettings
|
171
|
+
include ::Google::Protobuf::MessageExts
|
172
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
173
|
+
end
|
174
|
+
|
175
|
+
# Settings for Php client libraries.
|
176
|
+
# @!attribute [rw] common
|
177
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
178
|
+
# Some settings.
|
179
|
+
class PhpSettings
|
180
|
+
include ::Google::Protobuf::MessageExts
|
181
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
182
|
+
end
|
183
|
+
|
184
|
+
# Settings for Python client libraries.
|
185
|
+
# @!attribute [rw] common
|
186
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
187
|
+
# Some settings.
|
188
|
+
class PythonSettings
|
189
|
+
include ::Google::Protobuf::MessageExts
|
190
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
191
|
+
end
|
192
|
+
|
193
|
+
# Settings for Node client libraries.
|
194
|
+
# @!attribute [rw] common
|
195
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
196
|
+
# Some settings.
|
197
|
+
class NodeSettings
|
198
|
+
include ::Google::Protobuf::MessageExts
|
199
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
200
|
+
end
|
201
|
+
|
202
|
+
# Settings for Dotnet client libraries.
|
203
|
+
# @!attribute [rw] common
|
204
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
205
|
+
# Some settings.
|
206
|
+
class DotnetSettings
|
207
|
+
include ::Google::Protobuf::MessageExts
|
208
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
209
|
+
end
|
210
|
+
|
211
|
+
# Settings for Ruby client libraries.
|
212
|
+
# @!attribute [rw] common
|
213
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
214
|
+
# Some settings.
|
215
|
+
class RubySettings
|
216
|
+
include ::Google::Protobuf::MessageExts
|
217
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
218
|
+
end
|
219
|
+
|
220
|
+
# Settings for Go client libraries.
|
221
|
+
# @!attribute [rw] common
|
222
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
223
|
+
# Some settings.
|
224
|
+
class GoSettings
|
225
|
+
include ::Google::Protobuf::MessageExts
|
226
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
227
|
+
end
|
228
|
+
|
229
|
+
# Describes the generator configuration for a method.
|
230
|
+
# @!attribute [rw] selector
|
231
|
+
# @return [::String]
|
232
|
+
# The fully qualified name of the method, for which the options below apply.
|
233
|
+
# This is used to find the method to apply the options.
|
234
|
+
# @!attribute [rw] long_running
|
235
|
+
# @return [::Google::Api::MethodSettings::LongRunning]
|
236
|
+
# Describes settings to use for long-running operations when generating
|
237
|
+
# API methods for RPCs. Complements RPCs that use the annotations in
|
238
|
+
# google/longrunning/operations.proto.
|
239
|
+
#
|
240
|
+
# Example of a YAML configuration::
|
241
|
+
#
|
242
|
+
# publishing:
|
243
|
+
# method_behavior:
|
244
|
+
# - selector: CreateAdDomain
|
245
|
+
# long_running:
|
246
|
+
# initial_poll_delay:
|
247
|
+
# seconds: 60 # 1 minute
|
248
|
+
# poll_delay_multiplier: 1.5
|
249
|
+
# max_poll_delay:
|
250
|
+
# seconds: 360 # 6 minutes
|
251
|
+
# total_poll_timeout:
|
252
|
+
# seconds: 54000 # 90 minutes
|
253
|
+
class MethodSettings
|
254
|
+
include ::Google::Protobuf::MessageExts
|
255
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
256
|
+
|
257
|
+
# Describes settings to use when generating API methods that use the
|
258
|
+
# long-running operation pattern.
|
259
|
+
# All default values below are from those used in the client library
|
260
|
+
# generators (e.g.
|
261
|
+
# [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
|
262
|
+
# @!attribute [rw] initial_poll_delay
|
263
|
+
# @return [::Google::Protobuf::Duration]
|
264
|
+
# Initial delay after which the first poll request will be made.
|
265
|
+
# Default value: 5 seconds.
|
266
|
+
# @!attribute [rw] poll_delay_multiplier
|
267
|
+
# @return [::Float]
|
268
|
+
# Multiplier to gradually increase delay between subsequent polls until it
|
269
|
+
# reaches max_poll_delay.
|
270
|
+
# Default value: 1.5.
|
271
|
+
# @!attribute [rw] max_poll_delay
|
272
|
+
# @return [::Google::Protobuf::Duration]
|
273
|
+
# Maximum time between two subsequent poll requests.
|
274
|
+
# Default value: 45 seconds.
|
275
|
+
# @!attribute [rw] total_poll_timeout
|
276
|
+
# @return [::Google::Protobuf::Duration]
|
277
|
+
# Total polling timeout.
|
278
|
+
# Default value: 5 minutes.
|
279
|
+
class LongRunning
|
280
|
+
include ::Google::Protobuf::MessageExts
|
281
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
282
|
+
end
|
283
|
+
end
|
284
|
+
|
285
|
+
# The organization for which the client libraries are being published.
|
286
|
+
# Affects the url where generated docs are published, etc.
|
287
|
+
module ClientLibraryOrganization
|
288
|
+
# Not useful.
|
289
|
+
CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
|
290
|
+
|
291
|
+
# Google Cloud Platform Org.
|
292
|
+
CLOUD = 1
|
293
|
+
|
294
|
+
# Ads (Advertising) Org.
|
295
|
+
ADS = 2
|
296
|
+
|
297
|
+
# Photos Org.
|
298
|
+
PHOTOS = 3
|
299
|
+
|
300
|
+
# Street View Org.
|
301
|
+
STREET_VIEW = 4
|
302
|
+
end
|
303
|
+
|
304
|
+
# To where should client libraries be published?
|
305
|
+
module ClientLibraryDestination
|
306
|
+
# Client libraries will neither be generated nor published to package
|
307
|
+
# managers.
|
308
|
+
CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
|
309
|
+
|
310
|
+
# Generate the client library in a repo under github.com/googleapis,
|
311
|
+
# but don't publish it to package managers.
|
312
|
+
GITHUB = 10
|
313
|
+
|
314
|
+
# Publish the library to package managers like nuget.org and npmjs.com.
|
315
|
+
PACKAGE_MANAGER = 20
|
316
|
+
end
|
317
|
+
end
|
318
|
+
end
|