google-cloud-spanner-admin-database-v1 0.11.0 → 0.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +1 -1
- data/README.md +3 -3
- data/lib/google/cloud/spanner/admin/database/v1/database_admin/client.rb +187 -52
- data/lib/google/cloud/spanner/admin/database/v1/database_admin/operations.rb +14 -16
- data/lib/google/cloud/spanner/admin/database/v1/database_admin/rest/client.rb +2236 -0
- data/lib/google/cloud/spanner/admin/database/v1/database_admin/rest/operations.rb +880 -0
- data/lib/google/cloud/spanner/admin/database/v1/database_admin/rest/service_stub.rb +1274 -0
- data/lib/google/cloud/spanner/admin/database/v1/database_admin/rest.rb +63 -0
- data/lib/google/cloud/spanner/admin/database/v1/database_admin.rb +7 -1
- data/lib/google/cloud/spanner/admin/database/v1/rest.rb +41 -0
- data/lib/google/cloud/spanner/admin/database/v1/version.rb +1 -1
- data/lib/google/cloud/spanner/admin/database/v1.rb +7 -2
- data/lib/google/spanner/admin/database/v1/spanner_database_admin_pb.rb +14 -0
- data/lib/google/spanner/admin/database/v1/spanner_database_admin_services_pb.rb +37 -0
- data/proto_docs/google/api/client.rb +381 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/iam/v1/policy.rb +8 -4
- data/proto_docs/google/protobuf/empty.rb +0 -2
- data/proto_docs/google/rpc/status.rb +4 -2
- data/proto_docs/google/spanner/admin/database/v1/spanner_database_admin.rb +44 -0
- metadata +16 -8
@@ -0,0 +1,63 @@
|
|
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
|
+
require "gapic/rest"
|
20
|
+
require "gapic/config"
|
21
|
+
require "gapic/config/method"
|
22
|
+
|
23
|
+
require "google/cloud/spanner/admin/database/v1/version"
|
24
|
+
|
25
|
+
require "google/cloud/spanner/admin/database/v1/database_admin/credentials"
|
26
|
+
require "google/cloud/spanner/admin/database/v1/database_admin/paths"
|
27
|
+
require "google/cloud/spanner/admin/database/v1/database_admin/rest/operations"
|
28
|
+
require "google/cloud/spanner/admin/database/v1/database_admin/rest/client"
|
29
|
+
|
30
|
+
module Google
|
31
|
+
module Cloud
|
32
|
+
module Spanner
|
33
|
+
module Admin
|
34
|
+
module Database
|
35
|
+
module V1
|
36
|
+
##
|
37
|
+
# Cloud Spanner Database Admin API
|
38
|
+
#
|
39
|
+
# The Cloud Spanner Database Admin API can be used to:
|
40
|
+
# * create, drop, and list databases
|
41
|
+
# * update the schema of pre-existing databases
|
42
|
+
# * create, delete and list backups for a database
|
43
|
+
# * restore a database from an existing backup
|
44
|
+
#
|
45
|
+
# To load this service and instantiate a REST client:
|
46
|
+
#
|
47
|
+
# require "google/cloud/spanner/admin/database/v1/database_admin/rest"
|
48
|
+
# client = ::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Rest::Client.new
|
49
|
+
#
|
50
|
+
module DatabaseAdmin
|
51
|
+
# Client for the REST transport
|
52
|
+
module Rest
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
58
|
+
end
|
59
|
+
end
|
60
|
+
end
|
61
|
+
|
62
|
+
helper_path = ::File.join __dir__, "rest", "helpers.rb"
|
63
|
+
require "google/cloud/spanner/admin/database/v1/database_admin/rest/helpers" if ::File.file? helper_path
|
@@ -26,6 +26,7 @@ require "google/cloud/spanner/admin/database/v1/database_admin/credentials"
|
|
26
26
|
require "google/cloud/spanner/admin/database/v1/database_admin/paths"
|
27
27
|
require "google/cloud/spanner/admin/database/v1/database_admin/operations"
|
28
28
|
require "google/cloud/spanner/admin/database/v1/database_admin/client"
|
29
|
+
require "google/cloud/spanner/admin/database/v1/database_admin/rest"
|
29
30
|
|
30
31
|
module Google
|
31
32
|
module Cloud
|
@@ -42,11 +43,16 @@ module Google
|
|
42
43
|
# * create, delete and list backups for a database
|
43
44
|
# * restore a database from an existing backup
|
44
45
|
#
|
45
|
-
#
|
46
|
+
# @example Load this service and instantiate a gRPC client
|
46
47
|
#
|
47
48
|
# require "google/cloud/spanner/admin/database/v1/database_admin"
|
48
49
|
# client = ::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client.new
|
49
50
|
#
|
51
|
+
# @example Load this service and instantiate a REST client
|
52
|
+
#
|
53
|
+
# require "google/cloud/spanner/admin/database/v1/database_admin/rest"
|
54
|
+
# client = ::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Rest::Client.new
|
55
|
+
#
|
50
56
|
module DatabaseAdmin
|
51
57
|
end
|
52
58
|
end
|
@@ -0,0 +1,41 @@
|
|
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
|
+
require "google/cloud/spanner/admin/database/v1/database_admin/rest"
|
20
|
+
require "google/cloud/spanner/admin/database/v1/version"
|
21
|
+
|
22
|
+
module Google
|
23
|
+
module Cloud
|
24
|
+
module Spanner
|
25
|
+
module Admin
|
26
|
+
module Database
|
27
|
+
##
|
28
|
+
# To load just the REST part of this package, including all its services, and instantiate a REST client:
|
29
|
+
#
|
30
|
+
# @example
|
31
|
+
#
|
32
|
+
# require "google/cloud/spanner/admin/database/v1/rest"
|
33
|
+
# client = ::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Rest::Client.new
|
34
|
+
#
|
35
|
+
module V1
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
40
|
+
end
|
41
|
+
end
|
@@ -25,13 +25,18 @@ module Google
|
|
25
25
|
module Admin
|
26
26
|
module Database
|
27
27
|
##
|
28
|
-
#
|
28
|
+
# API client module.
|
29
29
|
#
|
30
|
-
# @example
|
30
|
+
# @example Load this package, including all its services, and instantiate a gRPC client
|
31
31
|
#
|
32
32
|
# require "google/cloud/spanner/admin/database/v1"
|
33
33
|
# client = ::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client.new
|
34
34
|
#
|
35
|
+
# @example Load this package, including all its services, and instantiate a REST client
|
36
|
+
#
|
37
|
+
# require "google/cloud/spanner/admin/database/v1"
|
38
|
+
# client = ::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Rest::Client.new
|
39
|
+
#
|
35
40
|
module V1
|
36
41
|
end
|
37
42
|
end
|
@@ -11,6 +11,7 @@ require 'google/iam/v1/iam_policy_pb'
|
|
11
11
|
require 'google/iam/v1/policy_pb'
|
12
12
|
require 'google/longrunning/operations_pb'
|
13
13
|
require 'google/protobuf/empty_pb'
|
14
|
+
require 'google/protobuf/field_mask_pb'
|
14
15
|
require 'google/protobuf/timestamp_pb'
|
15
16
|
require 'google/spanner/admin/database/v1/backup_pb'
|
16
17
|
require 'google/spanner/admin/database/v1/common_pb'
|
@@ -34,6 +35,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
34
35
|
optional :earliest_version_time, :message, 7, "google.protobuf.Timestamp"
|
35
36
|
optional :default_leader, :string, 9
|
36
37
|
optional :database_dialect, :enum, 10, "google.spanner.admin.database.v1.DatabaseDialect"
|
38
|
+
optional :enable_drop_protection, :bool, 11
|
39
|
+
optional :reconciling, :bool, 12
|
37
40
|
end
|
38
41
|
add_enum "google.spanner.admin.database.v1.Database.State" do
|
39
42
|
value :STATE_UNSPECIFIED, 0
|
@@ -63,6 +66,15 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
63
66
|
add_message "google.spanner.admin.database.v1.GetDatabaseRequest" do
|
64
67
|
optional :name, :string, 1
|
65
68
|
end
|
69
|
+
add_message "google.spanner.admin.database.v1.UpdateDatabaseRequest" do
|
70
|
+
optional :database, :message, 1, "google.spanner.admin.database.v1.Database"
|
71
|
+
optional :update_mask, :message, 2, "google.protobuf.FieldMask"
|
72
|
+
end
|
73
|
+
add_message "google.spanner.admin.database.v1.UpdateDatabaseMetadata" do
|
74
|
+
optional :request, :message, 1, "google.spanner.admin.database.v1.UpdateDatabaseRequest"
|
75
|
+
optional :progress, :message, 2, "google.spanner.admin.database.v1.OperationProgress"
|
76
|
+
optional :cancel_time, :message, 3, "google.protobuf.Timestamp"
|
77
|
+
end
|
66
78
|
add_message "google.spanner.admin.database.v1.UpdateDatabaseDdlRequest" do
|
67
79
|
optional :database, :string, 1
|
68
80
|
repeated :statements, :string, 2
|
@@ -159,6 +171,8 @@ module Google
|
|
159
171
|
CreateDatabaseRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.database.v1.CreateDatabaseRequest").msgclass
|
160
172
|
CreateDatabaseMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.database.v1.CreateDatabaseMetadata").msgclass
|
161
173
|
GetDatabaseRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.database.v1.GetDatabaseRequest").msgclass
|
174
|
+
UpdateDatabaseRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.database.v1.UpdateDatabaseRequest").msgclass
|
175
|
+
UpdateDatabaseMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.database.v1.UpdateDatabaseMetadata").msgclass
|
162
176
|
UpdateDatabaseDdlRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.database.v1.UpdateDatabaseDdlRequest").msgclass
|
163
177
|
UpdateDatabaseDdlMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata").msgclass
|
164
178
|
DropDatabaseRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.database.v1.DropDatabaseRequest").msgclass
|
@@ -54,6 +54,43 @@ module Google
|
|
54
54
|
rpc :CreateDatabase, ::Google::Cloud::Spanner::Admin::Database::V1::CreateDatabaseRequest, ::Google::Longrunning::Operation
|
55
55
|
# Gets the state of a Cloud Spanner database.
|
56
56
|
rpc :GetDatabase, ::Google::Cloud::Spanner::Admin::Database::V1::GetDatabaseRequest, ::Google::Cloud::Spanner::Admin::Database::V1::Database
|
57
|
+
# Updates a Cloud Spanner database. The returned
|
58
|
+
# [long-running operation][google.longrunning.Operation] can be used to track
|
59
|
+
# the progress of updating the database. If the named database does not
|
60
|
+
# exist, returns `NOT_FOUND`.
|
61
|
+
#
|
62
|
+
# While the operation is pending:
|
63
|
+
#
|
64
|
+
# * The database's
|
65
|
+
# [reconciling][google.spanner.admin.database.v1.Database.reconciling]
|
66
|
+
# field is set to true.
|
67
|
+
# * Cancelling the operation is best-effort. If the cancellation succeeds,
|
68
|
+
# the operation metadata's
|
69
|
+
# [cancel_time][google.spanner.admin.database.v1.UpdateDatabaseMetadata.cancel_time]
|
70
|
+
# is set, the updates are reverted, and the operation terminates with a
|
71
|
+
# `CANCELLED` status.
|
72
|
+
# * New UpdateDatabase requests will return a `FAILED_PRECONDITION` error
|
73
|
+
# until the pending operation is done (returns successfully or with
|
74
|
+
# error).
|
75
|
+
# * Reading the database via the API continues to give the pre-request
|
76
|
+
# values.
|
77
|
+
#
|
78
|
+
# Upon completion of the returned operation:
|
79
|
+
#
|
80
|
+
# * The new values are in effect and readable via the API.
|
81
|
+
# * The database's
|
82
|
+
# [reconciling][google.spanner.admin.database.v1.Database.reconciling]
|
83
|
+
# field becomes false.
|
84
|
+
#
|
85
|
+
# The returned [long-running operation][google.longrunning.Operation] will
|
86
|
+
# have a name of the format
|
87
|
+
# `projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>`
|
88
|
+
# and can be used to track the database modification. The
|
89
|
+
# [metadata][google.longrunning.Operation.metadata] field type is
|
90
|
+
# [UpdateDatabaseMetadata][google.spanner.admin.database.v1.UpdateDatabaseMetadata].
|
91
|
+
# The [response][google.longrunning.Operation.response] field type is
|
92
|
+
# [Database][google.spanner.admin.database.v1.Database], if successful.
|
93
|
+
rpc :UpdateDatabase, ::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseRequest, ::Google::Longrunning::Operation
|
57
94
|
# Updates the schema of a Cloud Spanner database by
|
58
95
|
# creating/altering/dropping tables, columns, indexes, etc. The returned
|
59
96
|
# [long-running operation][google.longrunning.Operation] will have a name of
|
@@ -0,0 +1,381 @@
|
|
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. 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 *public* URI where 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
|
+
|
357
|
+
# Shopping Org.
|
358
|
+
SHOPPING = 5
|
359
|
+
|
360
|
+
# Geo Org.
|
361
|
+
GEO = 6
|
362
|
+
|
363
|
+
# Generative AI - https://developers.generativeai.google
|
364
|
+
GENERATIVE_AI = 7
|
365
|
+
end
|
366
|
+
|
367
|
+
# To where should client libraries be published?
|
368
|
+
module ClientLibraryDestination
|
369
|
+
# Client libraries will neither be generated nor published to package
|
370
|
+
# managers.
|
371
|
+
CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
|
372
|
+
|
373
|
+
# Generate the client library in a repo under github.com/googleapis,
|
374
|
+
# but don't publish it to package managers.
|
375
|
+
GITHUB = 10
|
376
|
+
|
377
|
+
# Publish the library to package managers like nuget.org and npmjs.com.
|
378
|
+
PACKAGE_MANAGER = 20
|
379
|
+
end
|
380
|
+
end
|
381
|
+
end
|