google-cloud-notebooks-v1 0.3.0 → 0.4.1

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.
@@ -18,6 +18,8 @@
18
18
 
19
19
  require "google/cloud/errors"
20
20
  require "google/cloud/notebooks/v1/service_pb"
21
+ require "google/cloud/location"
22
+ require "google/iam/v1"
21
23
 
22
24
  module Google
23
25
  module Cloud
@@ -105,6 +107,8 @@ module Google
105
107
 
106
108
  default_config.rpcs.rollback_instance.timeout = 60.0
107
109
 
110
+ default_config.rpcs.diagnose_instance.timeout = 60.0
111
+
108
112
  default_config.rpcs.upgrade_instance_internal.timeout = 60.0
109
113
 
110
114
  default_config.rpcs.list_environments.timeout = 60.0
@@ -206,6 +210,18 @@ module Google
206
210
  config.endpoint = @config.endpoint
207
211
  end
208
212
 
213
+ @location_client = Google::Cloud::Location::Locations::Client.new do |config|
214
+ config.credentials = credentials
215
+ config.quota_project = @quota_project_id
216
+ config.endpoint = @config.endpoint
217
+ end
218
+
219
+ @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
220
+ config.credentials = credentials
221
+ config.quota_project = @quota_project_id
222
+ config.endpoint = @config.endpoint
223
+ end
224
+
209
225
  @notebook_service_stub = ::Gapic::ServiceStub.new(
210
226
  ::Google::Cloud::Notebooks::V1::NotebookService::Stub,
211
227
  credentials: credentials,
@@ -222,6 +238,20 @@ module Google
222
238
  #
223
239
  attr_reader :operations_client
224
240
 
241
+ ##
242
+ # Get the associated client for mix-in of the Locations.
243
+ #
244
+ # @return [Google::Cloud::Location::Locations::Client]
245
+ #
246
+ attr_reader :location_client
247
+
248
+ ##
249
+ # Get the associated client for mix-in of the IAMPolicy.
250
+ #
251
+ # @return [Google::Iam::V1::IAMPolicy::Client]
252
+ #
253
+ attr_reader :iam_policy_client
254
+
225
255
  # Service calls
226
256
 
227
257
  ##
@@ -2031,6 +2061,102 @@ module Google
2031
2061
  raise ::Google::Cloud::Error.from_error(e)
2032
2062
  end
2033
2063
 
2064
+ ##
2065
+ # Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
2066
+ #
2067
+ # @overload diagnose_instance(request, options = nil)
2068
+ # Pass arguments to `diagnose_instance` via a request object, either of type
2069
+ # {::Google::Cloud::Notebooks::V1::DiagnoseInstanceRequest} or an equivalent Hash.
2070
+ #
2071
+ # @param request [::Google::Cloud::Notebooks::V1::DiagnoseInstanceRequest, ::Hash]
2072
+ # A request object representing the call parameters. Required. To specify no
2073
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2074
+ # @param options [::Gapic::CallOptions, ::Hash]
2075
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2076
+ #
2077
+ # @overload diagnose_instance(name: nil, diagnostic_config: nil)
2078
+ # Pass arguments to `diagnose_instance` via keyword arguments. Note that at
2079
+ # least one keyword argument is required. To specify no parameters, or to keep all
2080
+ # the default parameter values, pass an empty Hash as a request object (see above).
2081
+ #
2082
+ # @param name [::String]
2083
+ # Required. Format:
2084
+ # `projects/{project_id}/locations/{location}/instances/{instance_id}`
2085
+ # @param diagnostic_config [::Google::Cloud::Notebooks::V1::DiagnosticConfig, ::Hash]
2086
+ # Required. Defines flags that are used to run the diagnostic tool
2087
+ #
2088
+ # @yield [response, operation] Access the result along with the RPC operation
2089
+ # @yieldparam response [::Gapic::Operation]
2090
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
2091
+ #
2092
+ # @return [::Gapic::Operation]
2093
+ #
2094
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
2095
+ #
2096
+ # @example Basic example
2097
+ # require "google/cloud/notebooks/v1"
2098
+ #
2099
+ # # Create a client object. The client can be reused for multiple calls.
2100
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Client.new
2101
+ #
2102
+ # # Create a request. To set request fields, pass in keyword arguments.
2103
+ # request = Google::Cloud::Notebooks::V1::DiagnoseInstanceRequest.new
2104
+ #
2105
+ # # Call the diagnose_instance method.
2106
+ # result = client.diagnose_instance request
2107
+ #
2108
+ # # The returned object is of type Gapic::Operation. You can use this
2109
+ # # object to check the status of an operation, cancel it, or wait
2110
+ # # for results. Here is how to block until completion:
2111
+ # result.wait_until_done! timeout: 60
2112
+ # if result.response?
2113
+ # p result.response
2114
+ # else
2115
+ # puts "Error!"
2116
+ # end
2117
+ #
2118
+ def diagnose_instance request, options = nil
2119
+ raise ::ArgumentError, "request must be provided" if request.nil?
2120
+
2121
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Notebooks::V1::DiagnoseInstanceRequest
2122
+
2123
+ # Converts hash and nil to an options object
2124
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2125
+
2126
+ # Customize the options with defaults
2127
+ metadata = @config.rpcs.diagnose_instance.metadata.to_h
2128
+
2129
+ # Set x-goog-api-client and x-goog-user-project headers
2130
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2131
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2132
+ gapic_version: ::Google::Cloud::Notebooks::V1::VERSION
2133
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2134
+
2135
+ header_params = {}
2136
+ if request.name
2137
+ header_params["name"] = request.name
2138
+ end
2139
+
2140
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2141
+ metadata[:"x-goog-request-params"] ||= request_params_header
2142
+
2143
+ options.apply_defaults timeout: @config.rpcs.diagnose_instance.timeout,
2144
+ metadata: metadata,
2145
+ retry_policy: @config.rpcs.diagnose_instance.retry_policy
2146
+
2147
+ options.apply_defaults timeout: @config.timeout,
2148
+ metadata: @config.metadata,
2149
+ retry_policy: @config.retry_policy
2150
+
2151
+ @notebook_service_stub.call_rpc :diagnose_instance, request, options: options do |response, operation|
2152
+ response = ::Gapic::Operation.new response, @operations_client, options: options
2153
+ yield response, operation if block_given?
2154
+ return response
2155
+ end
2156
+ rescue ::GRPC::BadStatus => e
2157
+ raise ::Google::Cloud::Error.from_error(e)
2158
+ end
2159
+
2034
2160
  ##
2035
2161
  # Allows notebook instances to
2036
2162
  # call this endpoint to upgrade themselves. Do not use this method directly.
@@ -3596,6 +3722,11 @@ module Google
3596
3722
  #
3597
3723
  attr_reader :rollback_instance
3598
3724
  ##
3725
+ # RPC-specific configuration for `diagnose_instance`
3726
+ # @return [::Gapic::Config::Method]
3727
+ #
3728
+ attr_reader :diagnose_instance
3729
+ ##
3599
3730
  # RPC-specific configuration for `upgrade_instance_internal`
3600
3731
  # @return [::Gapic::Config::Method]
3601
3732
  #
@@ -3706,6 +3837,8 @@ module Google
3706
3837
  @upgrade_instance = ::Gapic::Config::Method.new upgrade_instance_config
3707
3838
  rollback_instance_config = parent_rpcs.rollback_instance if parent_rpcs.respond_to? :rollback_instance
3708
3839
  @rollback_instance = ::Gapic::Config::Method.new rollback_instance_config
3840
+ diagnose_instance_config = parent_rpcs.diagnose_instance if parent_rpcs.respond_to? :diagnose_instance
3841
+ @diagnose_instance = ::Gapic::Config::Method.new diagnose_instance_config
3709
3842
  upgrade_instance_internal_config = parent_rpcs.upgrade_instance_internal if parent_rpcs.respond_to? :upgrade_instance_internal
3710
3843
  @upgrade_instance_internal = ::Gapic::Config::Method.new upgrade_instance_internal_config
3711
3844
  list_environments_config = parent_rpcs.list_environments if parent_rpcs.respond_to? :list_environments
@@ -113,6 +113,14 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
113
113
  optional :post_startup_script, :string, 7
114
114
  repeated :kernels, :message, 8, "google.cloud.notebooks.v1.ContainerImage"
115
115
  proto3_optional :upgradeable, :bool, 9
116
+ optional :post_startup_script_behavior, :enum, 10, "google.cloud.notebooks.v1.RuntimeSoftwareConfig.PostStartupScriptBehavior"
117
+ proto3_optional :disable_terminal, :bool, 11
118
+ proto3_optional :version, :string, 12
119
+ end
120
+ add_enum "google.cloud.notebooks.v1.RuntimeSoftwareConfig.PostStartupScriptBehavior" do
121
+ value :POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED, 0
122
+ value :RUN_EVERY_START, 1
123
+ value :DOWNLOAD_AND_RUN_EVERY_START, 2
116
124
  end
117
125
  add_message "google.cloud.notebooks.v1.RuntimeMetrics" do
118
126
  map :system_metrics, :string, :string, 1
@@ -173,6 +181,7 @@ module Google
173
181
  RuntimeAccessConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.RuntimeAccessConfig").msgclass
174
182
  RuntimeAccessConfig::RuntimeAccessType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.RuntimeAccessConfig.RuntimeAccessType").enummodule
175
183
  RuntimeSoftwareConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.RuntimeSoftwareConfig").msgclass
184
+ RuntimeSoftwareConfig::PostStartupScriptBehavior = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.RuntimeSoftwareConfig.PostStartupScriptBehavior").enummodule
176
185
  RuntimeMetrics = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.RuntimeMetrics").msgclass
177
186
  RuntimeShieldedInstanceConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.RuntimeShieldedInstanceConfig").msgclass
178
187
  VirtualMachine = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.VirtualMachine").msgclass
@@ -7,6 +7,7 @@ require 'google/api/annotations_pb'
7
7
  require 'google/api/client_pb'
8
8
  require 'google/api/field_behavior_pb'
9
9
  require 'google/api/resource_pb'
10
+ require 'google/cloud/notebooks/v1/diagnostic_config_pb'
10
11
  require 'google/cloud/notebooks/v1/environment_pb'
11
12
  require 'google/cloud/notebooks/v1/execution_pb'
12
13
  require 'google/cloud/notebooks/v1/instance_pb'
@@ -136,6 +137,10 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
136
137
  optional :page_size, :int32, 2
137
138
  optional :page_token, :string, 3
138
139
  end
140
+ add_message "google.cloud.notebooks.v1.DiagnoseInstanceRequest" do
141
+ optional :name, :string, 1
142
+ optional :diagnostic_config, :message, 2, "google.cloud.notebooks.v1.DiagnosticConfig"
143
+ end
139
144
  add_message "google.cloud.notebooks.v1.ListEnvironmentsResponse" do
140
145
  repeated :environments, :message, 1, "google.cloud.notebooks.v1.Environment"
141
146
  optional :next_page_token, :string, 2
@@ -242,6 +247,7 @@ module Google
242
247
  RollbackInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.RollbackInstanceRequest").msgclass
243
248
  UpgradeInstanceInternalRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.UpgradeInstanceInternalRequest").msgclass
244
249
  ListEnvironmentsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.ListEnvironmentsRequest").msgclass
250
+ DiagnoseInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.DiagnoseInstanceRequest").msgclass
245
251
  ListEnvironmentsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.ListEnvironmentsResponse").msgclass
246
252
  GetEnvironmentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.GetEnvironmentRequest").msgclass
247
253
  CreateEnvironmentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.notebooks.v1.CreateEnvironmentRequest").msgclass
@@ -77,6 +77,8 @@ module Google
77
77
  rpc :UpgradeInstance, ::Google::Cloud::Notebooks::V1::UpgradeInstanceRequest, ::Google::Longrunning::Operation
78
78
  # Rollbacks a notebook instance to the previous version.
79
79
  rpc :RollbackInstance, ::Google::Cloud::Notebooks::V1::RollbackInstanceRequest, ::Google::Longrunning::Operation
80
+ # Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
81
+ rpc :DiagnoseInstance, ::Google::Cloud::Notebooks::V1::DiagnoseInstanceRequest, ::Google::Longrunning::Operation
80
82
  # Allows notebook instances to
81
83
  # call this endpoint to upgrade themselves. Do not use this method directly.
82
84
  rpc :UpgradeInstanceInternal, ::Google::Cloud::Notebooks::V1::UpgradeInstanceInternalRequest, ::Google::Longrunning::Operation
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Notebooks
23
23
  module V1
24
- VERSION = "0.3.0"
24
+ VERSION = "0.4.1"
25
25
  end
26
26
  end
27
27
  end
@@ -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
@@ -0,0 +1,71 @@
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
+ # The launch stage as defined by [Google Cloud Platform
23
+ # Launch Stages](https://cloud.google.com/terms/launch-stages).
24
+ module LaunchStage
25
+ # Do not use this default value.
26
+ LAUNCH_STAGE_UNSPECIFIED = 0
27
+
28
+ # The feature is not yet implemented. Users can not use it.
29
+ UNIMPLEMENTED = 6
30
+
31
+ # Prelaunch features are hidden from users and are only visible internally.
32
+ PRELAUNCH = 7
33
+
34
+ # Early Access features are limited to a closed group of testers. To use
35
+ # these features, you must sign up in advance and sign a Trusted Tester
36
+ # agreement (which includes confidentiality provisions). These features may
37
+ # be unstable, changed in backward-incompatible ways, and are not
38
+ # guaranteed to be released.
39
+ EARLY_ACCESS = 1
40
+
41
+ # Alpha is a limited availability test for releases before they are cleared
42
+ # for widespread use. By Alpha, all significant design issues are resolved
43
+ # and we are in the process of verifying functionality. Alpha customers
44
+ # need to apply for access, agree to applicable terms, and have their
45
+ # projects allowlisted. Alpha releases don't have to be feature complete,
46
+ # no SLAs are provided, and there are no technical support obligations, but
47
+ # they will be far enough along that customers can actually use them in
48
+ # test environments or for limited-use tests -- just like they would in
49
+ # normal production cases.
50
+ ALPHA = 2
51
+
52
+ # Beta is the point at which we are ready to open a release for any
53
+ # customer to use. There are no SLA or technical support obligations in a
54
+ # Beta release. Products will be complete from a feature perspective, but
55
+ # may have some open outstanding issues. Beta releases are suitable for
56
+ # limited production use cases.
57
+ BETA = 3
58
+
59
+ # GA features are open to all developers and are considered stable and
60
+ # fully qualified for production use.
61
+ GA = 4
62
+
63
+ # Deprecated features are scheduled to be shut down and removed. For more
64
+ # information, see the "Deprecation Policy" section of our [Terms of
65
+ # Service](https://cloud.google.com/terms/)
66
+ # and the [Google Cloud Platform Subject to the Deprecation
67
+ # Policy](https://cloud.google.com/terms/deprecation) documentation.
68
+ DEPRECATED = 5
69
+ end
70
+ end
71
+ end