google-cloud-certificate_manager-v1 0.3.1 → 0.4.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -24,6 +24,25 @@ module Google
24
24
  module CertificateManager
25
25
  # Path helper methods for the CertificateManager API.
26
26
  module Paths
27
+ ##
28
+ # Create a fully-qualified CaPool resource string.
29
+ #
30
+ # The resource will be in the following format:
31
+ #
32
+ # `projects/{project}/locations/{location}/caPools/{ca_pool}`
33
+ #
34
+ # @param project [String]
35
+ # @param location [String]
36
+ # @param ca_pool [String]
37
+ #
38
+ # @return [::String]
39
+ def ca_pool_path project:, location:, ca_pool:
40
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
41
+ raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
42
+
43
+ "projects/#{project}/locations/#{location}/caPools/#{ca_pool}"
44
+ end
45
+
27
46
  ##
28
47
  # Create a fully-qualified Certificate resource string.
29
48
  #
@@ -43,6 +62,25 @@ module Google
43
62
  "projects/#{project}/locations/#{location}/certificates/#{certificate}"
44
63
  end
45
64
 
65
+ ##
66
+ # Create a fully-qualified CertificateIssuanceConfig resource string.
67
+ #
68
+ # The resource will be in the following format:
69
+ #
70
+ # `projects/{project}/locations/{location}/certificateIssuanceConfigs/{certificate_issuance_config}`
71
+ #
72
+ # @param project [String]
73
+ # @param location [String]
74
+ # @param certificate_issuance_config [String]
75
+ #
76
+ # @return [::String]
77
+ def certificate_issuance_config_path project:, location:, certificate_issuance_config:
78
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
79
+ raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
80
+
81
+ "projects/#{project}/locations/#{location}/certificateIssuanceConfigs/#{certificate_issuance_config}"
82
+ end
83
+
46
84
  ##
47
85
  # Create a fully-qualified CertificateMap resource string.
48
86
  #
@@ -45,21 +45,21 @@ module Google
45
45
  #
46
46
  # The Certificates Manager service exposes the following resources:
47
47
  #
48
- # * `Certificate` which describes a single TLS certificate.
49
- # * `CertificateMap` which describes a collection of certificates that can be
48
+ # * `Certificate` that describes a single TLS certificate.
49
+ # * `CertificateMap` that describes a collection of certificates that can be
50
50
  # attached to a target resource.
51
- # * `CertificateMapEntry` which describes a single configuration entry that
51
+ # * `CertificateMapEntry` that describes a single configuration entry that
52
52
  # consists of a SNI and a group of certificates. It's a subresource of
53
53
  # CertificateMap.
54
54
  #
55
55
  # Certificate, CertificateMap and CertificateMapEntry IDs
56
- # have to match "^[a-z0-9-]\\{1,63}$" regexp, which means that
56
+ # have to fully match the regexp `[a-z0-9-]{1,63}`. In other words,
57
57
  # - only lower case letters, digits, and hyphen are allowed
58
58
  # - length of the resource ID has to be in [1,63] range.
59
59
  #
60
60
  # Provides methods to manage Cloud Certificate Manager entities.
61
61
  #
62
- # To load this service and instantiate a client:
62
+ # @example Load this service and instantiate a gRPC client
63
63
  #
64
64
  # require "google/cloud/certificate_manager/v1/certificate_manager"
65
65
  # client = ::Google::Cloud::CertificateManager::V1::CertificateManager::Client.new
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module CertificateManager
23
23
  module V1
24
- VERSION = "0.3.1"
24
+ VERSION = "0.4.1"
25
25
  end
26
26
  end
27
27
  end
@@ -23,9 +23,9 @@ module Google
23
23
  module Cloud
24
24
  module CertificateManager
25
25
  ##
26
- # To load this package, including all its services, and instantiate a client:
26
+ # API client module.
27
27
  #
28
- # @example
28
+ # @example Load this package, including all its services, and instantiate a gRPC client
29
29
  #
30
30
  # require "google/cloud/certificate_manager/v1"
31
31
  # client = ::Google::Cloud::CertificateManager::V1::CertificateManager::Client.new
@@ -0,0 +1,79 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/cloud/certificatemanager/v1/certificate_issuance_config.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ require 'google/api/field_behavior_pb'
7
+ require 'google/api/resource_pb'
8
+ require 'google/protobuf/duration_pb'
9
+ require 'google/protobuf/timestamp_pb'
10
+
11
+ Google::Protobuf::DescriptorPool.generated_pool.build do
12
+ add_file("google/cloud/certificatemanager/v1/certificate_issuance_config.proto", :syntax => :proto3) do
13
+ add_message "google.cloud.certificatemanager.v1.ListCertificateIssuanceConfigsRequest" do
14
+ optional :parent, :string, 1
15
+ optional :page_size, :int32, 2
16
+ optional :page_token, :string, 3
17
+ optional :filter, :string, 4
18
+ optional :order_by, :string, 5
19
+ end
20
+ add_message "google.cloud.certificatemanager.v1.ListCertificateIssuanceConfigsResponse" do
21
+ repeated :certificate_issuance_configs, :message, 1, "google.cloud.certificatemanager.v1.CertificateIssuanceConfig"
22
+ optional :next_page_token, :string, 2
23
+ repeated :unreachable, :string, 3
24
+ end
25
+ add_message "google.cloud.certificatemanager.v1.GetCertificateIssuanceConfigRequest" do
26
+ optional :name, :string, 1
27
+ end
28
+ add_message "google.cloud.certificatemanager.v1.CreateCertificateIssuanceConfigRequest" do
29
+ optional :parent, :string, 1
30
+ optional :certificate_issuance_config_id, :string, 2
31
+ optional :certificate_issuance_config, :message, 3, "google.cloud.certificatemanager.v1.CertificateIssuanceConfig"
32
+ end
33
+ add_message "google.cloud.certificatemanager.v1.DeleteCertificateIssuanceConfigRequest" do
34
+ optional :name, :string, 1
35
+ end
36
+ add_message "google.cloud.certificatemanager.v1.CertificateIssuanceConfig" do
37
+ optional :name, :string, 1
38
+ optional :create_time, :message, 2, "google.protobuf.Timestamp"
39
+ optional :update_time, :message, 3, "google.protobuf.Timestamp"
40
+ map :labels, :string, :string, 4
41
+ optional :description, :string, 5
42
+ optional :certificate_authority_config, :message, 6, "google.cloud.certificatemanager.v1.CertificateIssuanceConfig.CertificateAuthorityConfig"
43
+ optional :lifetime, :message, 7, "google.protobuf.Duration"
44
+ optional :rotation_window_percentage, :int32, 8
45
+ optional :key_algorithm, :enum, 9, "google.cloud.certificatemanager.v1.CertificateIssuanceConfig.KeyAlgorithm"
46
+ end
47
+ add_message "google.cloud.certificatemanager.v1.CertificateIssuanceConfig.CertificateAuthorityConfig" do
48
+ oneof :kind do
49
+ optional :certificate_authority_service_config, :message, 1, "google.cloud.certificatemanager.v1.CertificateIssuanceConfig.CertificateAuthorityConfig.CertificateAuthorityServiceConfig"
50
+ end
51
+ end
52
+ add_message "google.cloud.certificatemanager.v1.CertificateIssuanceConfig.CertificateAuthorityConfig.CertificateAuthorityServiceConfig" do
53
+ optional :ca_pool, :string, 1
54
+ end
55
+ add_enum "google.cloud.certificatemanager.v1.CertificateIssuanceConfig.KeyAlgorithm" do
56
+ value :KEY_ALGORITHM_UNSPECIFIED, 0
57
+ value :RSA_2048, 1
58
+ value :ECDSA_P256, 4
59
+ end
60
+ end
61
+ end
62
+
63
+ module Google
64
+ module Cloud
65
+ module CertificateManager
66
+ module V1
67
+ ListCertificateIssuanceConfigsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.certificatemanager.v1.ListCertificateIssuanceConfigsRequest").msgclass
68
+ ListCertificateIssuanceConfigsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.certificatemanager.v1.ListCertificateIssuanceConfigsResponse").msgclass
69
+ GetCertificateIssuanceConfigRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.certificatemanager.v1.GetCertificateIssuanceConfigRequest").msgclass
70
+ CreateCertificateIssuanceConfigRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.certificatemanager.v1.CreateCertificateIssuanceConfigRequest").msgclass
71
+ DeleteCertificateIssuanceConfigRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.certificatemanager.v1.DeleteCertificateIssuanceConfigRequest").msgclass
72
+ CertificateIssuanceConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.certificatemanager.v1.CertificateIssuanceConfig").msgclass
73
+ CertificateIssuanceConfig::CertificateAuthorityConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.certificatemanager.v1.CertificateIssuanceConfig.CertificateAuthorityConfig").msgclass
74
+ CertificateIssuanceConfig::CertificateAuthorityConfig::CertificateAuthorityServiceConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.certificatemanager.v1.CertificateIssuanceConfig.CertificateAuthorityConfig.CertificateAuthorityServiceConfig").msgclass
75
+ CertificateIssuanceConfig::KeyAlgorithm = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.certificatemanager.v1.CertificateIssuanceConfig.KeyAlgorithm").enummodule
76
+ end
77
+ end
78
+ end
79
+ end
@@ -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/certificatemanager/v1/certificate_issuance_config_pb'
10
11
  require 'google/longrunning/operations_pb'
11
12
  require 'google/protobuf/field_mask_pb'
12
13
  require 'google/protobuf/timestamp_pb'
@@ -152,6 +153,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
152
153
  add_message "google.cloud.certificatemanager.v1.Certificate.ManagedCertificate" do
153
154
  repeated :domains, :string, 1
154
155
  repeated :dns_authorizations, :string, 2
156
+ optional :issuance_config, :string, 6
155
157
  optional :state, :enum, 4, "google.cloud.certificatemanager.v1.Certificate.ManagedCertificate.State"
156
158
  optional :provisioning_issue, :message, 3, "google.cloud.certificatemanager.v1.Certificate.ManagedCertificate.ProvisioningIssue"
157
159
  repeated :authorization_attempt_info, :message, 5, "google.cloud.certificatemanager.v1.Certificate.ManagedCertificate.AuthorizationAttemptInfo"
@@ -37,15 +37,15 @@ module Google
37
37
  #
38
38
  # The Certificates Manager service exposes the following resources:
39
39
  #
40
- # * `Certificate` which describes a single TLS certificate.
41
- # * `CertificateMap` which describes a collection of certificates that can be
40
+ # * `Certificate` that describes a single TLS certificate.
41
+ # * `CertificateMap` that describes a collection of certificates that can be
42
42
  # attached to a target resource.
43
- # * `CertificateMapEntry` which describes a single configuration entry that
43
+ # * `CertificateMapEntry` that describes a single configuration entry that
44
44
  # consists of a SNI and a group of certificates. It's a subresource of
45
45
  # CertificateMap.
46
46
  #
47
47
  # Certificate, CertificateMap and CertificateMapEntry IDs
48
- # have to match "^[a-z0-9-]{1,63}$ regexp, which means that
48
+ # have to fully match the regexp `[a-z0-9-]{1,63}`. In other words,
49
49
  # - only lower case letters, digits, and hyphen are allowed
50
50
  # - length of the resource ID has to be in [1,63] range.
51
51
  #
@@ -100,6 +100,14 @@ module Google
100
100
  rpc :UpdateDnsAuthorization, ::Google::Cloud::CertificateManager::V1::UpdateDnsAuthorizationRequest, ::Google::Longrunning::Operation
101
101
  # Deletes a single DnsAuthorization.
102
102
  rpc :DeleteDnsAuthorization, ::Google::Cloud::CertificateManager::V1::DeleteDnsAuthorizationRequest, ::Google::Longrunning::Operation
103
+ # Lists CertificateIssuanceConfigs in a given project and location.
104
+ rpc :ListCertificateIssuanceConfigs, ::Google::Cloud::CertificateManager::V1::ListCertificateIssuanceConfigsRequest, ::Google::Cloud::CertificateManager::V1::ListCertificateIssuanceConfigsResponse
105
+ # Gets details of a single CertificateIssuanceConfig.
106
+ rpc :GetCertificateIssuanceConfig, ::Google::Cloud::CertificateManager::V1::GetCertificateIssuanceConfigRequest, ::Google::Cloud::CertificateManager::V1::CertificateIssuanceConfig
107
+ # Creates a new CertificateIssuanceConfig in a given project and location.
108
+ rpc :CreateCertificateIssuanceConfig, ::Google::Cloud::CertificateManager::V1::CreateCertificateIssuanceConfigRequest, ::Google::Longrunning::Operation
109
+ # Deletes a single CertificateIssuanceConfig.
110
+ rpc :DeleteCertificateIssuanceConfig, ::Google::Cloud::CertificateManager::V1::DeleteCertificateIssuanceConfigRequest, ::Google::Longrunning::Operation
103
111
  end
104
112
 
105
113
  Stub = Service.rpc_stub_class
@@ -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