google-cloud-dialogflow-cx-v3 0.10.2 → 0.11.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (69) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/dialogflow/cx/v3/agent_services_pb.rb +2 -1
  4. data/lib/google/cloud/dialogflow/cx/v3/agents/client.rb +8 -6
  5. data/lib/google/cloud/dialogflow/cx/v3/agents.rb +1 -1
  6. data/lib/google/cloud/dialogflow/cx/v3/changelogs.rb +1 -1
  7. data/lib/google/cloud/dialogflow/cx/v3/deployment_services_pb.rb +4 -2
  8. data/lib/google/cloud/dialogflow/cx/v3/deployments/client.rb +11 -7
  9. data/lib/google/cloud/dialogflow/cx/v3/deployments.rb +1 -1
  10. data/lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb +5 -3
  11. data/lib/google/cloud/dialogflow/cx/v3/entity_types.rb +1 -1
  12. data/lib/google/cloud/dialogflow/cx/v3/environment_services_pb.rb +26 -13
  13. data/lib/google/cloud/dialogflow/cx/v3/environments/client.rb +40 -23
  14. data/lib/google/cloud/dialogflow/cx/v3/environments.rb +3 -2
  15. data/lib/google/cloud/dialogflow/cx/v3/experiment_services_pb.rb +15 -9
  16. data/lib/google/cloud/dialogflow/cx/v3/experiments/client.rb +28 -18
  17. data/lib/google/cloud/dialogflow/cx/v3/experiments.rb +1 -1
  18. data/lib/google/cloud/dialogflow/cx/v3/flow_services_pb.rb +4 -2
  19. data/lib/google/cloud/dialogflow/cx/v3/flows/client.rb +8 -6
  20. data/lib/google/cloud/dialogflow/cx/v3/flows.rb +1 -1
  21. data/lib/google/cloud/dialogflow/cx/v3/intents.rb +1 -1
  22. data/lib/google/cloud/dialogflow/cx/v3/pages.rb +1 -1
  23. data/lib/google/cloud/dialogflow/cx/v3/response_message_pb.rb +1 -0
  24. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/client.rb +14 -9
  25. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service.rb +1 -1
  26. data/lib/google/cloud/dialogflow/cx/v3/security_settings_services_pb.rb +7 -4
  27. data/lib/google/cloud/dialogflow/cx/v3/session_entity_type_services_pb.rb +2 -1
  28. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/client.rb +2 -1
  29. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types.rb +3 -2
  30. data/lib/google/cloud/dialogflow/cx/v3/session_pb.rb +1 -0
  31. data/lib/google/cloud/dialogflow/cx/v3/session_services_pb.rb +10 -5
  32. data/lib/google/cloud/dialogflow/cx/v3/sessions/client.rb +10 -5
  33. data/lib/google/cloud/dialogflow/cx/v3/sessions.rb +4 -3
  34. data/lib/google/cloud/dialogflow/cx/v3/test_case_services_pb.rb +16 -8
  35. data/lib/google/cloud/dialogflow/cx/v3/test_cases/client.rb +27 -18
  36. data/lib/google/cloud/dialogflow/cx/v3/test_cases.rb +1 -1
  37. data/lib/google/cloud/dialogflow/cx/v3/transition_route_group_services_pb.rb +11 -5
  38. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/client.rb +21 -11
  39. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups.rb +3 -2
  40. data/lib/google/cloud/dialogflow/cx/v3/version.rb +1 -1
  41. data/lib/google/cloud/dialogflow/cx/v3/version_services_pb.rb +6 -3
  42. data/lib/google/cloud/dialogflow/cx/v3/versions/client.rb +22 -18
  43. data/lib/google/cloud/dialogflow/cx/v3/versions.rb +1 -1
  44. data/lib/google/cloud/dialogflow/cx/v3/webhooks/client.rb +4 -3
  45. data/lib/google/cloud/dialogflow/cx/v3/webhooks.rb +1 -1
  46. data/lib/google/cloud/dialogflow/cx/v3.rb +2 -2
  47. data/proto_docs/google/api/client.rb +318 -0
  48. data/proto_docs/google/api/launch_stage.rb +71 -0
  49. data/proto_docs/google/cloud/dialogflow/cx/v3/agent.rb +55 -31
  50. data/proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb +16 -12
  51. data/proto_docs/google/cloud/dialogflow/cx/v3/changelog.rb +6 -3
  52. data/proto_docs/google/cloud/dialogflow/cx/v3/deployment.rb +13 -8
  53. data/proto_docs/google/cloud/dialogflow/cx/v3/entity_type.rb +24 -12
  54. data/proto_docs/google/cloud/dialogflow/cx/v3/environment.rb +65 -41
  55. data/proto_docs/google/cloud/dialogflow/cx/v3/experiment.rb +31 -19
  56. data/proto_docs/google/cloud/dialogflow/cx/v3/flow.rb +38 -22
  57. data/proto_docs/google/cloud/dialogflow/cx/v3/fulfillment.rb +10 -5
  58. data/proto_docs/google/cloud/dialogflow/cx/v3/intent.rb +27 -15
  59. data/proto_docs/google/cloud/dialogflow/cx/v3/page.rb +62 -37
  60. data/proto_docs/google/cloud/dialogflow/cx/v3/response_message.rb +32 -21
  61. data/proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb +35 -25
  62. data/proto_docs/google/cloud/dialogflow/cx/v3/session.rb +109 -68
  63. data/proto_docs/google/cloud/dialogflow/cx/v3/session_entity_type.rb +22 -15
  64. data/proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb +82 -55
  65. data/proto_docs/google/cloud/dialogflow/cx/v3/transition_route_group.rb +32 -20
  66. data/proto_docs/google/cloud/dialogflow/cx/v3/version.rb +36 -26
  67. data/proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb +106 -66
  68. data/proto_docs/google/rpc/status.rb +4 -2
  69. metadata +7 -5
@@ -34,17 +34,20 @@ module Google
34
34
  self.unmarshal_class_method = :decode
35
35
  self.service_name = 'google.cloud.dialogflow.cx.v3.Versions'
36
36
 
37
- # Returns the list of all versions in the specified [Flow][google.cloud.dialogflow.cx.v3.Flow].
37
+ # Returns the list of all versions in the specified
38
+ # [Flow][google.cloud.dialogflow.cx.v3.Flow].
38
39
  rpc :ListVersions, ::Google::Cloud::Dialogflow::CX::V3::ListVersionsRequest, ::Google::Cloud::Dialogflow::CX::V3::ListVersionsResponse
39
40
  # Retrieves the specified [Version][google.cloud.dialogflow.cx.v3.Version].
40
41
  rpc :GetVersion, ::Google::Cloud::Dialogflow::CX::V3::GetVersionRequest, ::Google::Cloud::Dialogflow::CX::V3::Version
41
- # Creates a [Version][google.cloud.dialogflow.cx.v3.Version] in the specified [Flow][google.cloud.dialogflow.cx.v3.Flow].
42
+ # Creates a [Version][google.cloud.dialogflow.cx.v3.Version] in the specified
43
+ # [Flow][google.cloud.dialogflow.cx.v3.Flow].
42
44
  #
43
45
  # This method is a [long-running
44
46
  # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
45
47
  # The returned `Operation` type has the following method-specific fields:
46
48
  #
47
- # - `metadata`: [CreateVersionOperationMetadata][google.cloud.dialogflow.cx.v3.CreateVersionOperationMetadata]
49
+ # - `metadata`:
50
+ # [CreateVersionOperationMetadata][google.cloud.dialogflow.cx.v3.CreateVersionOperationMetadata]
48
51
  # - `response`: [Version][google.cloud.dialogflow.cx.v3.Version]
49
52
  rpc :CreateVersion, ::Google::Cloud::Dialogflow::CX::V3::CreateVersionRequest, ::Google::Longrunning::Operation
50
53
  # Updates the specified [Version][google.cloud.dialogflow.cx.v3.Version].
@@ -178,7 +178,8 @@ module Google
178
178
  # Service calls
179
179
 
180
180
  ##
181
- # Returns the list of all versions in the specified {::Google::Cloud::Dialogflow::CX::V3::Flow Flow}.
181
+ # Returns the list of all versions in the specified
182
+ # {::Google::Cloud::Dialogflow::CX::V3::Flow Flow}.
182
183
  #
183
184
  # @overload list_versions(request, options = nil)
184
185
  # Pass arguments to `list_versions` via a request object, either of type
@@ -196,9 +197,9 @@ module Google
196
197
  # the default parameter values, pass an empty Hash as a request object (see above).
197
198
  #
198
199
  # @param parent [::String]
199
- # Required. The {::Google::Cloud::Dialogflow::CX::V3::Flow Flow} to list all versions for.
200
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
201
- # ID>/flows/<Flow ID>`.
200
+ # Required. The {::Google::Cloud::Dialogflow::CX::V3::Flow Flow} to list all
201
+ # versions for. Format: `projects/<Project ID>/locations/<Location
202
+ # ID>/agents/<Agent ID>/flows/<Flow ID>`.
202
203
  # @param page_size [::Integer]
203
204
  # The maximum number of items to return in a single page. By default 20 and
204
205
  # at most 100.
@@ -364,13 +365,15 @@ module Google
364
365
  end
365
366
 
366
367
  ##
367
- # Creates a {::Google::Cloud::Dialogflow::CX::V3::Version Version} in the specified {::Google::Cloud::Dialogflow::CX::V3::Flow Flow}.
368
+ # Creates a {::Google::Cloud::Dialogflow::CX::V3::Version Version} in the specified
369
+ # {::Google::Cloud::Dialogflow::CX::V3::Flow Flow}.
368
370
  #
369
371
  # This method is a [long-running
370
372
  # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
371
373
  # The returned `Operation` type has the following method-specific fields:
372
374
  #
373
- # - `metadata`: {::Google::Cloud::Dialogflow::CX::V3::CreateVersionOperationMetadata CreateVersionOperationMetadata}
375
+ # - `metadata`:
376
+ # {::Google::Cloud::Dialogflow::CX::V3::CreateVersionOperationMetadata CreateVersionOperationMetadata}
374
377
  # - `response`: {::Google::Cloud::Dialogflow::CX::V3::Version Version}
375
378
  #
376
379
  # @overload create_version(request, options = nil)
@@ -389,8 +392,9 @@ module Google
389
392
  # the default parameter values, pass an empty Hash as a request object (see above).
390
393
  #
391
394
  # @param parent [::String]
392
- # Required. The {::Google::Cloud::Dialogflow::CX::V3::Flow Flow} to create an {::Google::Cloud::Dialogflow::CX::V3::Version Version} for.
393
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
395
+ # Required. The {::Google::Cloud::Dialogflow::CX::V3::Flow Flow} to create an
396
+ # {::Google::Cloud::Dialogflow::CX::V3::Version Version} for. Format:
397
+ # `projects/<Project ID>/locations/<Location ID>/agents/<Agent
394
398
  # ID>/flows/<Flow ID>`.
395
399
  # @param version [::Google::Cloud::Dialogflow::CX::V3::Version, ::Hash]
396
400
  # Required. The version to create.
@@ -488,8 +492,8 @@ module Google
488
492
  # @param version [::Google::Cloud::Dialogflow::CX::V3::Version, ::Hash]
489
493
  # Required. The version to update.
490
494
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
491
- # Required. The mask to control which fields get updated. Currently only `description`
492
- # and `display_name` can be updated.
495
+ # Required. The mask to control which fields get updated. Currently only
496
+ # `description` and `display_name` can be updated.
493
497
  #
494
498
  # @yield [response, operation] Access the result along with the RPC operation
495
499
  # @yieldparam response [::Google::Cloud::Dialogflow::CX::V3::Version]
@@ -574,9 +578,9 @@ module Google
574
578
  # the default parameter values, pass an empty Hash as a request object (see above).
575
579
  #
576
580
  # @param name [::String]
577
- # Required. The name of the {::Google::Cloud::Dialogflow::CX::V3::Version Version} to delete.
578
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
579
- # ID>/flows/<Flow ID>/versions/<Version ID>`.
581
+ # Required. The name of the {::Google::Cloud::Dialogflow::CX::V3::Version Version}
582
+ # to delete. Format: `projects/<Project ID>/locations/<Location
583
+ # ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>`.
580
584
  #
581
585
  # @yield [response, operation] Access the result along with the RPC operation
582
586
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -670,9 +674,9 @@ module Google
670
674
  # the default parameter values, pass an empty Hash as a request object (see above).
671
675
  #
672
676
  # @param name [::String]
673
- # Required. The {::Google::Cloud::Dialogflow::CX::V3::Version Version} to be loaded to draft flow.
674
- # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
675
- # ID>/flows/<Flow ID>/versions/<Version ID>`.
677
+ # Required. The {::Google::Cloud::Dialogflow::CX::V3::Version Version} to be loaded
678
+ # to draft flow. Format: `projects/<Project ID>/locations/<Location
679
+ # ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>`.
676
680
  # @param allow_override_agent_resources [::Boolean]
677
681
  # This field is used to prevent accidental overwrite of other agent
678
682
  # resources, which can potentially impact other flow's behavior. If
@@ -770,8 +774,8 @@ module Google
770
774
  # the default parameter values, pass an empty Hash as a request object (see above).
771
775
  #
772
776
  # @param base_version [::String]
773
- # Required. Name of the base flow version to compare with the target version. Use
774
- # version ID `0` to indicate the draft version of the specified flow.
777
+ # Required. Name of the base flow version to compare with the target version.
778
+ # Use version ID `0` to indicate the draft version of the specified flow.
775
779
  #
776
780
  # Format: `projects/<Project ID>/locations/<Location ID>/agents/
777
781
  # <Agent ID>/flows/<Flow ID>/versions/<Version ID>`.
@@ -35,7 +35,7 @@ module Google
35
35
  ##
36
36
  # Service for managing {::Google::Cloud::Dialogflow::CX::V3::Version Versions}.
37
37
  #
38
- # To load this service and instantiate a client:
38
+ # @example Load this service and instantiate a gRPC client
39
39
  #
40
40
  # require "google/cloud/dialogflow/cx/v3/versions"
41
41
  # client = ::Google::Cloud::Dialogflow::CX::V3::Versions::Client.new
@@ -554,9 +554,10 @@ module Google
554
554
  # * If `force` is set to false, an error will be returned with message
555
555
  # indicating the referenced resources.
556
556
  # * If `force` is set to true, Dialogflow will remove the webhook, as well
557
- # as any references to the webhook (i.e. {::Google::Cloud::Dialogflow::CX::V3::Fulfillment#webhook Webhook}
558
- # and {::Google::Cloud::Dialogflow::CX::V3::Fulfillment#tag tag}in fulfillments that point to this webhook
559
- # will be removed).
557
+ # as any references to the webhook (i.e.
558
+ # {::Google::Cloud::Dialogflow::CX::V3::Fulfillment#webhook Webhook} and
559
+ # {::Google::Cloud::Dialogflow::CX::V3::Fulfillment#tag tag}in fulfillments that
560
+ # point to this webhook will be removed).
560
561
  #
561
562
  # @yield [response, operation] Access the result along with the RPC operation
562
563
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -34,7 +34,7 @@ module Google
34
34
  ##
35
35
  # Service for managing {::Google::Cloud::Dialogflow::CX::V3::Webhook Webhooks}.
36
36
  #
37
- # To load this service and instantiate a client:
37
+ # @example Load this service and instantiate a gRPC client
38
38
  #
39
39
  # require "google/cloud/dialogflow/cx/v3/webhooks"
40
40
  # client = ::Google::Cloud::Dialogflow::CX::V3::Webhooks::Client.new
@@ -39,9 +39,9 @@ module Google
39
39
  module Dialogflow
40
40
  module CX
41
41
  ##
42
- # To load this package, including all its services, and instantiate a client:
42
+ # API client module.
43
43
  #
44
- # @example
44
+ # @example Load this package, including all its services, and instantiate a gRPC client
45
45
  #
46
46
  # require "google/cloud/dialogflow/cx/v3"
47
47
  # client = ::Google::Cloud::Dialogflow::CX::V3::Pages::Client.new
@@ -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