google-cloud-storage_insights-v1 0.a → 0.1.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.
Files changed (33) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +149 -0
  4. data/README.md +144 -8
  5. data/lib/google/cloud/storage_insights/v1/bindings_override.rb +102 -0
  6. data/lib/google/cloud/storage_insights/v1/rest.rb +38 -0
  7. data/lib/google/cloud/storage_insights/v1/storage_insights/client.rb +1055 -0
  8. data/lib/google/cloud/storage_insights/v1/storage_insights/credentials.rb +47 -0
  9. data/lib/google/cloud/storage_insights/v1/storage_insights/paths.rb +90 -0
  10. data/lib/google/cloud/storage_insights/v1/storage_insights/rest/client.rb +872 -0
  11. data/lib/google/cloud/storage_insights/v1/storage_insights/rest/service_stub.rb +463 -0
  12. data/lib/google/cloud/storage_insights/v1/storage_insights/rest.rb +53 -0
  13. data/lib/google/cloud/storage_insights/v1/storage_insights.rb +55 -0
  14. data/lib/google/cloud/storage_insights/v1/version.rb +7 -2
  15. data/lib/google/cloud/storage_insights/v1.rb +45 -0
  16. data/lib/google/cloud/storageinsights/v1/storageinsights_pb.rb +164 -0
  17. data/lib/google/cloud/storageinsights/v1/storageinsights_services_pb.rb +57 -0
  18. data/lib/google-cloud-storage_insights-v1.rb +21 -0
  19. data/proto_docs/README.md +4 -0
  20. data/proto_docs/google/api/client.rb +372 -0
  21. data/proto_docs/google/api/field_behavior.rb +71 -0
  22. data/proto_docs/google/api/launch_stage.rb +71 -0
  23. data/proto_docs/google/api/resource.rb +222 -0
  24. data/proto_docs/google/cloud/storageinsights/v1/storageinsights.rb +431 -0
  25. data/proto_docs/google/protobuf/any.rb +141 -0
  26. data/proto_docs/google/protobuf/duration.rb +98 -0
  27. data/proto_docs/google/protobuf/empty.rb +34 -0
  28. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  29. data/proto_docs/google/protobuf/timestamp.rb +129 -0
  30. data/proto_docs/google/rpc/status.rb +48 -0
  31. data/proto_docs/google/type/date.rb +53 -0
  32. data/proto_docs/google/type/datetime.rb +99 -0
  33. metadata +206 -12
@@ -0,0 +1,164 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/cloud/storageinsights/v1/storageinsights.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ require 'google/api/annotations_pb'
7
+ require 'google/api/client_pb'
8
+ require 'google/api/field_behavior_pb'
9
+ require 'google/api/resource_pb'
10
+ require 'google/protobuf/empty_pb'
11
+ require 'google/protobuf/field_mask_pb'
12
+ require 'google/protobuf/timestamp_pb'
13
+ require 'google/rpc/status_pb'
14
+ require 'google/type/date_pb'
15
+ require 'google/type/datetime_pb'
16
+
17
+ Google::Protobuf::DescriptorPool.generated_pool.build do
18
+ add_file("google/cloud/storageinsights/v1/storageinsights.proto", :syntax => :proto3) do
19
+ add_message "google.cloud.storageinsights.v1.ListReportConfigsRequest" do
20
+ optional :parent, :string, 1
21
+ optional :page_size, :int32, 2
22
+ optional :page_token, :string, 3
23
+ optional :filter, :string, 4
24
+ optional :order_by, :string, 5
25
+ end
26
+ add_message "google.cloud.storageinsights.v1.ListReportConfigsResponse" do
27
+ repeated :report_configs, :message, 1, "google.cloud.storageinsights.v1.ReportConfig"
28
+ optional :next_page_token, :string, 2
29
+ repeated :unreachable, :string, 3
30
+ end
31
+ add_message "google.cloud.storageinsights.v1.GetReportConfigRequest" do
32
+ optional :name, :string, 1
33
+ end
34
+ add_message "google.cloud.storageinsights.v1.CreateReportConfigRequest" do
35
+ optional :parent, :string, 1
36
+ optional :report_config, :message, 3, "google.cloud.storageinsights.v1.ReportConfig"
37
+ optional :request_id, :string, 4
38
+ end
39
+ add_message "google.cloud.storageinsights.v1.UpdateReportConfigRequest" do
40
+ optional :update_mask, :message, 1, "google.protobuf.FieldMask"
41
+ optional :report_config, :message, 2, "google.cloud.storageinsights.v1.ReportConfig"
42
+ optional :request_id, :string, 3
43
+ end
44
+ add_message "google.cloud.storageinsights.v1.DeleteReportConfigRequest" do
45
+ optional :name, :string, 1
46
+ optional :force, :bool, 2
47
+ optional :request_id, :string, 3
48
+ end
49
+ add_message "google.cloud.storageinsights.v1.ReportDetail" do
50
+ optional :name, :string, 1
51
+ optional :snapshot_time, :message, 2, "google.protobuf.Timestamp"
52
+ optional :report_path_prefix, :string, 8
53
+ optional :shards_count, :int64, 9
54
+ optional :status, :message, 4, "google.rpc.Status"
55
+ map :labels, :string, :string, 5
56
+ optional :target_datetime, :message, 6, "google.type.DateTime"
57
+ optional :report_metrics, :message, 7, "google.cloud.storageinsights.v1.ReportDetail.Metrics"
58
+ end
59
+ add_message "google.cloud.storageinsights.v1.ReportDetail.Metrics" do
60
+ optional :processed_records_count, :int64, 1
61
+ end
62
+ add_message "google.cloud.storageinsights.v1.ListReportDetailsRequest" do
63
+ optional :parent, :string, 1
64
+ optional :page_size, :int32, 2
65
+ optional :page_token, :string, 3
66
+ optional :filter, :string, 4
67
+ optional :order_by, :string, 5
68
+ end
69
+ add_message "google.cloud.storageinsights.v1.ListReportDetailsResponse" do
70
+ repeated :report_details, :message, 1, "google.cloud.storageinsights.v1.ReportDetail"
71
+ optional :next_page_token, :string, 2
72
+ repeated :unreachable, :string, 3
73
+ end
74
+ add_message "google.cloud.storageinsights.v1.GetReportDetailRequest" do
75
+ optional :name, :string, 1
76
+ end
77
+ add_message "google.cloud.storageinsights.v1.OperationMetadata" do
78
+ optional :create_time, :message, 1, "google.protobuf.Timestamp"
79
+ optional :end_time, :message, 2, "google.protobuf.Timestamp"
80
+ optional :target, :string, 3
81
+ optional :verb, :string, 4
82
+ optional :status_message, :string, 5
83
+ optional :requested_cancellation, :bool, 6
84
+ optional :api_version, :string, 7
85
+ end
86
+ add_message "google.cloud.storageinsights.v1.FrequencyOptions" do
87
+ optional :frequency, :enum, 1, "google.cloud.storageinsights.v1.FrequencyOptions.Frequency"
88
+ optional :start_date, :message, 2, "google.type.Date"
89
+ optional :end_date, :message, 3, "google.type.Date"
90
+ end
91
+ add_enum "google.cloud.storageinsights.v1.FrequencyOptions.Frequency" do
92
+ value :FREQUENCY_UNSPECIFIED, 0
93
+ value :DAILY, 1
94
+ value :WEEKLY, 2
95
+ end
96
+ add_message "google.cloud.storageinsights.v1.CSVOptions" do
97
+ optional :record_separator, :string, 1
98
+ optional :delimiter, :string, 2
99
+ optional :header_required, :bool, 3
100
+ end
101
+ add_message "google.cloud.storageinsights.v1.ParquetOptions" do
102
+ end
103
+ add_message "google.cloud.storageinsights.v1.CloudStorageFilters" do
104
+ optional :bucket, :string, 1
105
+ end
106
+ add_message "google.cloud.storageinsights.v1.CloudStorageDestinationOptions" do
107
+ optional :bucket, :string, 1
108
+ optional :destination_path, :string, 2
109
+ end
110
+ add_message "google.cloud.storageinsights.v1.ObjectMetadataReportOptions" do
111
+ repeated :metadata_fields, :string, 1
112
+ oneof :filter do
113
+ optional :storage_filters, :message, 2, "google.cloud.storageinsights.v1.CloudStorageFilters"
114
+ end
115
+ oneof :destination_options do
116
+ optional :storage_destination_options, :message, 3, "google.cloud.storageinsights.v1.CloudStorageDestinationOptions"
117
+ end
118
+ end
119
+ add_message "google.cloud.storageinsights.v1.ReportConfig" do
120
+ optional :name, :string, 1
121
+ optional :create_time, :message, 2, "google.protobuf.Timestamp"
122
+ optional :update_time, :message, 3, "google.protobuf.Timestamp"
123
+ optional :frequency_options, :message, 5, "google.cloud.storageinsights.v1.FrequencyOptions"
124
+ map :labels, :string, :string, 10
125
+ optional :display_name, :string, 11
126
+ oneof :report_format do
127
+ optional :csv_options, :message, 6, "google.cloud.storageinsights.v1.CSVOptions"
128
+ optional :parquet_options, :message, 7, "google.cloud.storageinsights.v1.ParquetOptions"
129
+ end
130
+ oneof :report_kind do
131
+ optional :object_metadata_report_options, :message, 8, "google.cloud.storageinsights.v1.ObjectMetadataReportOptions"
132
+ end
133
+ end
134
+ end
135
+ end
136
+
137
+ module Google
138
+ module Cloud
139
+ module StorageInsights
140
+ module V1
141
+ ListReportConfigsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.storageinsights.v1.ListReportConfigsRequest").msgclass
142
+ ListReportConfigsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.storageinsights.v1.ListReportConfigsResponse").msgclass
143
+ GetReportConfigRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.storageinsights.v1.GetReportConfigRequest").msgclass
144
+ CreateReportConfigRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.storageinsights.v1.CreateReportConfigRequest").msgclass
145
+ UpdateReportConfigRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.storageinsights.v1.UpdateReportConfigRequest").msgclass
146
+ DeleteReportConfigRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.storageinsights.v1.DeleteReportConfigRequest").msgclass
147
+ ReportDetail = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.storageinsights.v1.ReportDetail").msgclass
148
+ ReportDetail::Metrics = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.storageinsights.v1.ReportDetail.Metrics").msgclass
149
+ ListReportDetailsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.storageinsights.v1.ListReportDetailsRequest").msgclass
150
+ ListReportDetailsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.storageinsights.v1.ListReportDetailsResponse").msgclass
151
+ GetReportDetailRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.storageinsights.v1.GetReportDetailRequest").msgclass
152
+ OperationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.storageinsights.v1.OperationMetadata").msgclass
153
+ FrequencyOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.storageinsights.v1.FrequencyOptions").msgclass
154
+ FrequencyOptions::Frequency = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.storageinsights.v1.FrequencyOptions.Frequency").enummodule
155
+ CSVOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.storageinsights.v1.CSVOptions").msgclass
156
+ ParquetOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.storageinsights.v1.ParquetOptions").msgclass
157
+ CloudStorageFilters = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.storageinsights.v1.CloudStorageFilters").msgclass
158
+ CloudStorageDestinationOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.storageinsights.v1.CloudStorageDestinationOptions").msgclass
159
+ ObjectMetadataReportOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.storageinsights.v1.ObjectMetadataReportOptions").msgclass
160
+ ReportConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.storageinsights.v1.ReportConfig").msgclass
161
+ end
162
+ end
163
+ end
164
+ end
@@ -0,0 +1,57 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # Source: google/cloud/storageinsights/v1/storageinsights.proto for package 'Google.Cloud.StorageInsights.V1'
3
+ # Original file comments:
4
+ # Copyright 2023 Google LLC
5
+ #
6
+ # Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ # See the License for the specific language governing permissions and
16
+ # limitations under the License.
17
+ #
18
+
19
+ require 'grpc'
20
+ require 'google/cloud/storageinsights/v1/storageinsights_pb'
21
+
22
+ module Google
23
+ module Cloud
24
+ module StorageInsights
25
+ module V1
26
+ module StorageInsights
27
+ # Service describing handlers for resources
28
+ class Service
29
+
30
+ include ::GRPC::GenericService
31
+
32
+ self.marshal_class_method = :encode
33
+ self.unmarshal_class_method = :decode
34
+ self.service_name = 'google.cloud.storageinsights.v1.StorageInsights'
35
+
36
+ # Lists ReportConfigs in a given project and location.
37
+ rpc :ListReportConfigs, ::Google::Cloud::StorageInsights::V1::ListReportConfigsRequest, ::Google::Cloud::StorageInsights::V1::ListReportConfigsResponse
38
+ # Gets details of a single ReportConfig.
39
+ rpc :GetReportConfig, ::Google::Cloud::StorageInsights::V1::GetReportConfigRequest, ::Google::Cloud::StorageInsights::V1::ReportConfig
40
+ # Creates a new ReportConfig in a given project and location.
41
+ rpc :CreateReportConfig, ::Google::Cloud::StorageInsights::V1::CreateReportConfigRequest, ::Google::Cloud::StorageInsights::V1::ReportConfig
42
+ # Updates the parameters of a single ReportConfig.
43
+ rpc :UpdateReportConfig, ::Google::Cloud::StorageInsights::V1::UpdateReportConfigRequest, ::Google::Cloud::StorageInsights::V1::ReportConfig
44
+ # Deletes a single ReportConfig.
45
+ rpc :DeleteReportConfig, ::Google::Cloud::StorageInsights::V1::DeleteReportConfigRequest, ::Google::Protobuf::Empty
46
+ # Lists ReportDetails in a given project and location.
47
+ rpc :ListReportDetails, ::Google::Cloud::StorageInsights::V1::ListReportDetailsRequest, ::Google::Cloud::StorageInsights::V1::ListReportDetailsResponse
48
+ # Gets details of a single ReportDetail.
49
+ rpc :GetReportDetail, ::Google::Cloud::StorageInsights::V1::GetReportDetailRequest, ::Google::Cloud::StorageInsights::V1::ReportDetail
50
+ end
51
+
52
+ Stub = Service.rpc_stub_class
53
+ end
54
+ end
55
+ end
56
+ end
57
+ end
@@ -0,0 +1,21 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 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
+ # This gem does not autoload during Bundler.require. To load this gem,
20
+ # issue explicit require statements for the packages desired, e.g.:
21
+ # require "google/cloud/storage_insights/v1"
@@ -0,0 +1,4 @@
1
+ # Storage Insights V1 Protocol Buffer Documentation
2
+
3
+ These files are for the YARD documentation of the generated protobuf files.
4
+ They are not intended to be required or loaded at runtime.
@@ -0,0 +1,372 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 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. This is the full protobuf
39
+ # package for the API, ending in the version element.
40
+ # Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
41
+ # @!attribute [rw] launch_stage
42
+ # @return [::Google::Api::LaunchStage]
43
+ # Launch stage of this version of the API.
44
+ # @!attribute [rw] rest_numeric_enums
45
+ # @return [::Boolean]
46
+ # When using transport=rest, the client request will encode enums as
47
+ # numbers rather than strings.
48
+ # @!attribute [rw] java_settings
49
+ # @return [::Google::Api::JavaSettings]
50
+ # Settings for legacy Java features, supported in the Service YAML.
51
+ # @!attribute [rw] cpp_settings
52
+ # @return [::Google::Api::CppSettings]
53
+ # Settings for C++ client libraries.
54
+ # @!attribute [rw] php_settings
55
+ # @return [::Google::Api::PhpSettings]
56
+ # Settings for PHP client libraries.
57
+ # @!attribute [rw] python_settings
58
+ # @return [::Google::Api::PythonSettings]
59
+ # Settings for Python client libraries.
60
+ # @!attribute [rw] node_settings
61
+ # @return [::Google::Api::NodeSettings]
62
+ # Settings for Node client libraries.
63
+ # @!attribute [rw] dotnet_settings
64
+ # @return [::Google::Api::DotnetSettings]
65
+ # Settings for .NET client libraries.
66
+ # @!attribute [rw] ruby_settings
67
+ # @return [::Google::Api::RubySettings]
68
+ # Settings for Ruby client libraries.
69
+ # @!attribute [rw] go_settings
70
+ # @return [::Google::Api::GoSettings]
71
+ # Settings for Go client libraries.
72
+ class ClientLibrarySettings
73
+ include ::Google::Protobuf::MessageExts
74
+ extend ::Google::Protobuf::MessageExts::ClassMethods
75
+ end
76
+
77
+ # This message configures the settings for publishing [Google Cloud Client
78
+ # libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
79
+ # generated from the service config.
80
+ # @!attribute [rw] method_settings
81
+ # @return [::Array<::Google::Api::MethodSettings>]
82
+ # A list of API method settings, e.g. the behavior for methods that use the
83
+ # long-running operation pattern.
84
+ # @!attribute [rw] new_issue_uri
85
+ # @return [::String]
86
+ # Link to a place that API users can report issues. Example:
87
+ # https://issuetracker.google.com/issues/new?component=190865&template=1161103
88
+ # @!attribute [rw] documentation_uri
89
+ # @return [::String]
90
+ # Link to product home page. Example:
91
+ # https://cloud.google.com/asset-inventory/docs/overview
92
+ # @!attribute [rw] api_short_name
93
+ # @return [::String]
94
+ # Used as a tracking tag when collecting data about the APIs developer
95
+ # relations artifacts like docs, packages delivered to package managers,
96
+ # etc. Example: "speech".
97
+ # @!attribute [rw] github_label
98
+ # @return [::String]
99
+ # GitHub label to apply to issues and pull requests opened for this API.
100
+ # @!attribute [rw] codeowner_github_teams
101
+ # @return [::Array<::String>]
102
+ # GitHub teams to be added to CODEOWNERS in the directory in GitHub
103
+ # containing source code for the client libraries for this API.
104
+ # @!attribute [rw] doc_tag_prefix
105
+ # @return [::String]
106
+ # A prefix used in sample code when demarking regions to be included in
107
+ # documentation.
108
+ # @!attribute [rw] organization
109
+ # @return [::Google::Api::ClientLibraryOrganization]
110
+ # For whom the client library is being published.
111
+ # @!attribute [rw] library_settings
112
+ # @return [::Array<::Google::Api::ClientLibrarySettings>]
113
+ # Client library settings. If the same version string appears multiple
114
+ # times in this list, then the last one wins. Settings from earlier
115
+ # settings with the same version string are discarded.
116
+ # @!attribute [rw] proto_reference_documentation_uri
117
+ # @return [::String]
118
+ # Optional link to proto reference documentation. Example:
119
+ # https://cloud.google.com/pubsub/lite/docs/reference/rpc
120
+ class Publishing
121
+ include ::Google::Protobuf::MessageExts
122
+ extend ::Google::Protobuf::MessageExts::ClassMethods
123
+ end
124
+
125
+ # Settings for Java client libraries.
126
+ # @!attribute [rw] library_package
127
+ # @return [::String]
128
+ # The package name to use in Java. Clobbers the java_package option
129
+ # set in the protobuf. This should be used **only** by APIs
130
+ # who have already set the language_settings.java.package_name" field
131
+ # in gapic.yaml. API teams should use the protobuf java_package option
132
+ # where possible.
133
+ #
134
+ # Example of a YAML configuration::
135
+ #
136
+ # publishing:
137
+ # java_settings:
138
+ # library_package: com.google.cloud.pubsub.v1
139
+ # @!attribute [rw] service_class_names
140
+ # @return [::Google::Protobuf::Map{::String => ::String}]
141
+ # Configure the Java class name to use instead of the service's for its
142
+ # corresponding generated GAPIC client. Keys are fully-qualified
143
+ # service names as they appear in the protobuf (including the full
144
+ # the language_settings.java.interface_names" field in gapic.yaml. API
145
+ # teams should otherwise use the service name as it appears in the
146
+ # protobuf.
147
+ #
148
+ # Example of a YAML configuration::
149
+ #
150
+ # publishing:
151
+ # java_settings:
152
+ # service_class_names:
153
+ # - google.pubsub.v1.Publisher: TopicAdmin
154
+ # - google.pubsub.v1.Subscriber: SubscriptionAdmin
155
+ # @!attribute [rw] common
156
+ # @return [::Google::Api::CommonLanguageSettings]
157
+ # Some settings.
158
+ class JavaSettings
159
+ include ::Google::Protobuf::MessageExts
160
+ extend ::Google::Protobuf::MessageExts::ClassMethods
161
+
162
+ # @!attribute [rw] key
163
+ # @return [::String]
164
+ # @!attribute [rw] value
165
+ # @return [::String]
166
+ class ServiceClassNamesEntry
167
+ include ::Google::Protobuf::MessageExts
168
+ extend ::Google::Protobuf::MessageExts::ClassMethods
169
+ end
170
+ end
171
+
172
+ # Settings for C++ client libraries.
173
+ # @!attribute [rw] common
174
+ # @return [::Google::Api::CommonLanguageSettings]
175
+ # Some settings.
176
+ class CppSettings
177
+ include ::Google::Protobuf::MessageExts
178
+ extend ::Google::Protobuf::MessageExts::ClassMethods
179
+ end
180
+
181
+ # Settings for Php client libraries.
182
+ # @!attribute [rw] common
183
+ # @return [::Google::Api::CommonLanguageSettings]
184
+ # Some settings.
185
+ class PhpSettings
186
+ include ::Google::Protobuf::MessageExts
187
+ extend ::Google::Protobuf::MessageExts::ClassMethods
188
+ end
189
+
190
+ # Settings for Python client libraries.
191
+ # @!attribute [rw] common
192
+ # @return [::Google::Api::CommonLanguageSettings]
193
+ # Some settings.
194
+ class PythonSettings
195
+ include ::Google::Protobuf::MessageExts
196
+ extend ::Google::Protobuf::MessageExts::ClassMethods
197
+ end
198
+
199
+ # Settings for Node client libraries.
200
+ # @!attribute [rw] common
201
+ # @return [::Google::Api::CommonLanguageSettings]
202
+ # Some settings.
203
+ class NodeSettings
204
+ include ::Google::Protobuf::MessageExts
205
+ extend ::Google::Protobuf::MessageExts::ClassMethods
206
+ end
207
+
208
+ # Settings for Dotnet client libraries.
209
+ # @!attribute [rw] common
210
+ # @return [::Google::Api::CommonLanguageSettings]
211
+ # Some settings.
212
+ # @!attribute [rw] renamed_services
213
+ # @return [::Google::Protobuf::Map{::String => ::String}]
214
+ # Map from original service names to renamed versions.
215
+ # This is used when the default generated types
216
+ # would cause a naming conflict. (Neither name is
217
+ # fully-qualified.)
218
+ # Example: Subscriber to SubscriberServiceApi.
219
+ # @!attribute [rw] renamed_resources
220
+ # @return [::Google::Protobuf::Map{::String => ::String}]
221
+ # Map from full resource types to the effective short name
222
+ # for the resource. This is used when otherwise resource
223
+ # named from different services would cause naming collisions.
224
+ # Example entry:
225
+ # "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
226
+ # @!attribute [rw] ignored_resources
227
+ # @return [::Array<::String>]
228
+ # List of full resource types to ignore during generation.
229
+ # This is typically used for API-specific Location resources,
230
+ # which should be handled by the generator as if they were actually
231
+ # the common Location resources.
232
+ # Example entry: "documentai.googleapis.com/Location"
233
+ # @!attribute [rw] forced_namespace_aliases
234
+ # @return [::Array<::String>]
235
+ # Namespaces which must be aliased in snippets due to
236
+ # a known (but non-generator-predictable) naming collision
237
+ # @!attribute [rw] handwritten_signatures
238
+ # @return [::Array<::String>]
239
+ # Method signatures (in the form "service.method(signature)")
240
+ # which are provided separately, so shouldn't be generated.
241
+ # Snippets *calling* these methods are still generated, however.
242
+ class DotnetSettings
243
+ include ::Google::Protobuf::MessageExts
244
+ extend ::Google::Protobuf::MessageExts::ClassMethods
245
+
246
+ # @!attribute [rw] key
247
+ # @return [::String]
248
+ # @!attribute [rw] value
249
+ # @return [::String]
250
+ class RenamedServicesEntry
251
+ include ::Google::Protobuf::MessageExts
252
+ extend ::Google::Protobuf::MessageExts::ClassMethods
253
+ end
254
+
255
+ # @!attribute [rw] key
256
+ # @return [::String]
257
+ # @!attribute [rw] value
258
+ # @return [::String]
259
+ class RenamedResourcesEntry
260
+ include ::Google::Protobuf::MessageExts
261
+ extend ::Google::Protobuf::MessageExts::ClassMethods
262
+ end
263
+ end
264
+
265
+ # Settings for Ruby client libraries.
266
+ # @!attribute [rw] common
267
+ # @return [::Google::Api::CommonLanguageSettings]
268
+ # Some settings.
269
+ class RubySettings
270
+ include ::Google::Protobuf::MessageExts
271
+ extend ::Google::Protobuf::MessageExts::ClassMethods
272
+ end
273
+
274
+ # Settings for Go client libraries.
275
+ # @!attribute [rw] common
276
+ # @return [::Google::Api::CommonLanguageSettings]
277
+ # Some settings.
278
+ class GoSettings
279
+ include ::Google::Protobuf::MessageExts
280
+ extend ::Google::Protobuf::MessageExts::ClassMethods
281
+ end
282
+
283
+ # Describes the generator configuration for a method.
284
+ # @!attribute [rw] selector
285
+ # @return [::String]
286
+ # The fully qualified name of the method, for which the options below apply.
287
+ # This is used to find the method to apply the options.
288
+ # @!attribute [rw] long_running
289
+ # @return [::Google::Api::MethodSettings::LongRunning]
290
+ # Describes settings to use for long-running operations when generating
291
+ # API methods for RPCs. Complements RPCs that use the annotations in
292
+ # google/longrunning/operations.proto.
293
+ #
294
+ # Example of a YAML configuration::
295
+ #
296
+ # publishing:
297
+ # method_settings:
298
+ # - selector: google.cloud.speech.v2.Speech.BatchRecognize
299
+ # long_running:
300
+ # initial_poll_delay:
301
+ # seconds: 60 # 1 minute
302
+ # poll_delay_multiplier: 1.5
303
+ # max_poll_delay:
304
+ # seconds: 360 # 6 minutes
305
+ # total_poll_timeout:
306
+ # seconds: 54000 # 90 minutes
307
+ class MethodSettings
308
+ include ::Google::Protobuf::MessageExts
309
+ extend ::Google::Protobuf::MessageExts::ClassMethods
310
+
311
+ # Describes settings to use when generating API methods that use the
312
+ # long-running operation pattern.
313
+ # All default values below are from those used in the client library
314
+ # generators (e.g.
315
+ # [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
316
+ # @!attribute [rw] initial_poll_delay
317
+ # @return [::Google::Protobuf::Duration]
318
+ # Initial delay after which the first poll request will be made.
319
+ # Default value: 5 seconds.
320
+ # @!attribute [rw] poll_delay_multiplier
321
+ # @return [::Float]
322
+ # Multiplier to gradually increase delay between subsequent polls until it
323
+ # reaches max_poll_delay.
324
+ # Default value: 1.5.
325
+ # @!attribute [rw] max_poll_delay
326
+ # @return [::Google::Protobuf::Duration]
327
+ # Maximum time between two subsequent poll requests.
328
+ # Default value: 45 seconds.
329
+ # @!attribute [rw] total_poll_timeout
330
+ # @return [::Google::Protobuf::Duration]
331
+ # Total polling timeout.
332
+ # Default value: 5 minutes.
333
+ class LongRunning
334
+ include ::Google::Protobuf::MessageExts
335
+ extend ::Google::Protobuf::MessageExts::ClassMethods
336
+ end
337
+ end
338
+
339
+ # The organization for which the client libraries are being published.
340
+ # Affects the url where generated docs are published, etc.
341
+ module ClientLibraryOrganization
342
+ # Not useful.
343
+ CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
344
+
345
+ # Google Cloud Platform Org.
346
+ CLOUD = 1
347
+
348
+ # Ads (Advertising) Org.
349
+ ADS = 2
350
+
351
+ # Photos Org.
352
+ PHOTOS = 3
353
+
354
+ # Street View Org.
355
+ STREET_VIEW = 4
356
+ end
357
+
358
+ # To where should client libraries be published?
359
+ module ClientLibraryDestination
360
+ # Client libraries will neither be generated nor published to package
361
+ # managers.
362
+ CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
363
+
364
+ # Generate the client library in a repo under github.com/googleapis,
365
+ # but don't publish it to package managers.
366
+ GITHUB = 10
367
+
368
+ # Publish the library to package managers like nuget.org and npmjs.com.
369
+ PACKAGE_MANAGER = 20
370
+ end
371
+ end
372
+ end