google-cloud-kms-inventory-v1 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +149 -0
- data/LICENSE.md +201 -0
- data/README.md +144 -0
- data/lib/google/cloud/kms/inventory/v1/key_dashboard_service/client.rb +406 -0
- data/lib/google/cloud/kms/inventory/v1/key_dashboard_service/credentials.rb +49 -0
- data/lib/google/cloud/kms/inventory/v1/key_dashboard_service/paths.rb +49 -0
- data/lib/google/cloud/kms/inventory/v1/key_dashboard_service/rest/client.rb +359 -0
- data/lib/google/cloud/kms/inventory/v1/key_dashboard_service/rest/service_stub.rb +109 -0
- data/lib/google/cloud/kms/inventory/v1/key_dashboard_service/rest.rb +54 -0
- data/lib/google/cloud/kms/inventory/v1/key_dashboard_service.rb +57 -0
- data/lib/google/cloud/kms/inventory/v1/key_dashboard_service_pb.rb +37 -0
- data/lib/google/cloud/kms/inventory/v1/key_dashboard_service_services_pb.rb +49 -0
- data/lib/google/cloud/kms/inventory/v1/key_tracking_service/client.rb +514 -0
- data/lib/google/cloud/kms/inventory/v1/key_tracking_service/credentials.rb +49 -0
- data/lib/google/cloud/kms/inventory/v1/key_tracking_service/paths.rb +98 -0
- data/lib/google/cloud/kms/inventory/v1/key_tracking_service/rest/client.rb +444 -0
- data/lib/google/cloud/kms/inventory/v1/key_tracking_service/rest/service_stub.rb +168 -0
- data/lib/google/cloud/kms/inventory/v1/key_tracking_service/rest.rb +55 -0
- data/lib/google/cloud/kms/inventory/v1/key_tracking_service.rb +58 -0
- data/lib/google/cloud/kms/inventory/v1/key_tracking_service_pb.rb +64 -0
- data/lib/google/cloud/kms/inventory/v1/key_tracking_service_services_pb.rb +55 -0
- data/lib/google/cloud/kms/inventory/v1/rest.rb +40 -0
- data/lib/google/cloud/kms/inventory/v1/version.rb +30 -0
- data/lib/google/cloud/kms/inventory/v1.rb +48 -0
- data/lib/google-cloud-kms-inventory-v1.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/client.rb +318 -0
- data/proto_docs/google/api/field_behavior.rb +71 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/api/resource.rb +222 -0
- data/proto_docs/google/cloud/kms/inventory/v1/key_dashboard_service.rb +62 -0
- data/proto_docs/google/cloud/kms/inventory/v1/key_tracking_service.rb +200 -0
- data/proto_docs/google/cloud/kms/v1/resources.rb +839 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/timestamp.rb +129 -0
- data/proto_docs/google/protobuf/wrappers.rb +121 -0
- metadata +248 -0
@@ -0,0 +1,58 @@
|
|
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/common"
|
20
|
+
require "gapic/config"
|
21
|
+
require "gapic/config/method"
|
22
|
+
|
23
|
+
require "google/cloud/kms/inventory/v1/version"
|
24
|
+
|
25
|
+
require "google/cloud/kms/inventory/v1/key_tracking_service/credentials"
|
26
|
+
require "google/cloud/kms/inventory/v1/key_tracking_service/paths"
|
27
|
+
require "google/cloud/kms/inventory/v1/key_tracking_service/client"
|
28
|
+
require "google/cloud/kms/inventory/v1/key_tracking_service/rest"
|
29
|
+
|
30
|
+
module Google
|
31
|
+
module Cloud
|
32
|
+
module Kms
|
33
|
+
module Inventory
|
34
|
+
module V1
|
35
|
+
##
|
36
|
+
# Returns information about the resources in an org that are protected by a
|
37
|
+
# given Cloud KMS key via CMEK.
|
38
|
+
#
|
39
|
+
# @example Load this service and instantiate a gRPC client
|
40
|
+
#
|
41
|
+
# require "google/cloud/kms/inventory/v1/key_tracking_service"
|
42
|
+
# client = ::Google::Cloud::Kms::Inventory::V1::KeyTrackingService::Client.new
|
43
|
+
#
|
44
|
+
# @example Load this service and instantiate a REST client
|
45
|
+
#
|
46
|
+
# require "google/cloud/kms/inventory/v1/key_tracking_service/rest"
|
47
|
+
# client = ::Google::Cloud::Kms::Inventory::V1::KeyTrackingService::Rest::Client.new
|
48
|
+
#
|
49
|
+
module KeyTrackingService
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
57
|
+
helper_path = ::File.join __dir__, "key_tracking_service", "helpers.rb"
|
58
|
+
require "google/cloud/kms/inventory/v1/key_tracking_service/helpers" if ::File.file? helper_path
|
@@ -0,0 +1,64 @@
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
|
+
# source: google/cloud/kms/inventory/v1/key_tracking_service.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/timestamp_pb'
|
11
|
+
|
12
|
+
Google::Protobuf::DescriptorPool.generated_pool.build do
|
13
|
+
add_file("google/cloud/kms/inventory/v1/key_tracking_service.proto", :syntax => :proto3) do
|
14
|
+
add_message "google.cloud.kms.inventory.v1.GetProtectedResourcesSummaryRequest" do
|
15
|
+
optional :name, :string, 1
|
16
|
+
end
|
17
|
+
add_message "google.cloud.kms.inventory.v1.ProtectedResourcesSummary" do
|
18
|
+
optional :name, :string, 5
|
19
|
+
optional :resource_count, :int64, 1
|
20
|
+
optional :project_count, :int32, 2
|
21
|
+
map :resource_types, :string, :int64, 3
|
22
|
+
map :cloud_products, :string, :int64, 6
|
23
|
+
map :locations, :string, :int64, 4
|
24
|
+
end
|
25
|
+
add_message "google.cloud.kms.inventory.v1.SearchProtectedResourcesRequest" do
|
26
|
+
optional :scope, :string, 2
|
27
|
+
optional :crypto_key, :string, 1
|
28
|
+
optional :page_size, :int32, 3
|
29
|
+
optional :page_token, :string, 4
|
30
|
+
end
|
31
|
+
add_message "google.cloud.kms.inventory.v1.SearchProtectedResourcesResponse" do
|
32
|
+
repeated :protected_resources, :message, 1, "google.cloud.kms.inventory.v1.ProtectedResource"
|
33
|
+
optional :next_page_token, :string, 2
|
34
|
+
end
|
35
|
+
add_message "google.cloud.kms.inventory.v1.ProtectedResource" do
|
36
|
+
optional :name, :string, 1
|
37
|
+
optional :project, :string, 2
|
38
|
+
optional :project_id, :string, 9
|
39
|
+
optional :cloud_product, :string, 8
|
40
|
+
optional :resource_type, :string, 3
|
41
|
+
optional :location, :string, 4
|
42
|
+
map :labels, :string, :string, 5
|
43
|
+
optional :crypto_key_version, :string, 6
|
44
|
+
repeated :crypto_key_versions, :string, 10
|
45
|
+
optional :create_time, :message, 7, "google.protobuf.Timestamp"
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
49
|
+
|
50
|
+
module Google
|
51
|
+
module Cloud
|
52
|
+
module Kms
|
53
|
+
module Inventory
|
54
|
+
module V1
|
55
|
+
GetProtectedResourcesSummaryRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.kms.inventory.v1.GetProtectedResourcesSummaryRequest").msgclass
|
56
|
+
ProtectedResourcesSummary = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.kms.inventory.v1.ProtectedResourcesSummary").msgclass
|
57
|
+
SearchProtectedResourcesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.kms.inventory.v1.SearchProtectedResourcesRequest").msgclass
|
58
|
+
SearchProtectedResourcesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.kms.inventory.v1.SearchProtectedResourcesResponse").msgclass
|
59
|
+
ProtectedResource = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.kms.inventory.v1.ProtectedResource").msgclass
|
60
|
+
end
|
61
|
+
end
|
62
|
+
end
|
63
|
+
end
|
64
|
+
end
|
@@ -0,0 +1,55 @@
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
|
+
# Source: google/cloud/kms/inventory/v1/key_tracking_service.proto for package 'google.cloud.kms.inventory.v1'
|
3
|
+
# Original file comments:
|
4
|
+
# Copyright 2022 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/kms/inventory/v1/key_tracking_service_pb'
|
21
|
+
|
22
|
+
module Google
|
23
|
+
module Cloud
|
24
|
+
module Kms
|
25
|
+
module Inventory
|
26
|
+
module V1
|
27
|
+
module KeyTrackingService
|
28
|
+
# Returns information about the resources in an org that are protected by a
|
29
|
+
# given Cloud KMS key via CMEK.
|
30
|
+
class Service
|
31
|
+
|
32
|
+
include ::GRPC::GenericService
|
33
|
+
|
34
|
+
self.marshal_class_method = :encode
|
35
|
+
self.unmarshal_class_method = :decode
|
36
|
+
self.service_name = 'google.cloud.kms.inventory.v1.KeyTrackingService'
|
37
|
+
|
38
|
+
# Returns aggregate information about the resources protected by the given
|
39
|
+
# Cloud KMS [CryptoKey][google.cloud.kms.v1.CryptoKey]. Only resources within
|
40
|
+
# the same Cloud organization as the key will be returned. The project that
|
41
|
+
# holds the key must be part of an organization in order for this call to
|
42
|
+
# succeed.
|
43
|
+
rpc :GetProtectedResourcesSummary, ::Google::Cloud::Kms::Inventory::V1::GetProtectedResourcesSummaryRequest, ::Google::Cloud::Kms::Inventory::V1::ProtectedResourcesSummary
|
44
|
+
# Returns metadata about the resources protected by the given Cloud KMS
|
45
|
+
# [CryptoKey][google.cloud.kms.v1.CryptoKey] in the given Cloud organization.
|
46
|
+
rpc :SearchProtectedResources, ::Google::Cloud::Kms::Inventory::V1::SearchProtectedResourcesRequest, ::Google::Cloud::Kms::Inventory::V1::SearchProtectedResourcesResponse
|
47
|
+
end
|
48
|
+
|
49
|
+
Stub = Service.rpc_stub_class
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
@@ -0,0 +1,40 @@
|
|
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/kms/inventory/v1/key_dashboard_service/rest"
|
20
|
+
require "google/cloud/kms/inventory/v1/key_tracking_service/rest"
|
21
|
+
require "google/cloud/kms/inventory/v1/version"
|
22
|
+
|
23
|
+
module Google
|
24
|
+
module Cloud
|
25
|
+
module Kms
|
26
|
+
module Inventory
|
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/kms/inventory/v1/rest"
|
33
|
+
# client = ::Google::Cloud::Kms::Inventory::V1::KeyDashboardService::Rest::Client.new
|
34
|
+
#
|
35
|
+
module V1
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
40
|
+
end
|
@@ -0,0 +1,30 @@
|
|
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 Cloud
|
22
|
+
module Kms
|
23
|
+
module Inventory
|
24
|
+
module V1
|
25
|
+
VERSION = "0.1.0"
|
26
|
+
end
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
30
|
+
end
|
@@ -0,0 +1,48 @@
|
|
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/kms/inventory/v1/key_dashboard_service"
|
20
|
+
require "google/cloud/kms/inventory/v1/key_tracking_service"
|
21
|
+
require "google/cloud/kms/inventory/v1/version"
|
22
|
+
|
23
|
+
module Google
|
24
|
+
module Cloud
|
25
|
+
module Kms
|
26
|
+
module Inventory
|
27
|
+
##
|
28
|
+
# API client module.
|
29
|
+
#
|
30
|
+
# @example Load this package, including all its services, and instantiate a gRPC client
|
31
|
+
#
|
32
|
+
# require "google/cloud/kms/inventory/v1"
|
33
|
+
# client = ::Google::Cloud::Kms::Inventory::V1::KeyDashboardService::Client.new
|
34
|
+
#
|
35
|
+
# @example Load this package, including all its services, and instantiate a REST client
|
36
|
+
#
|
37
|
+
# require "google/cloud/kms/inventory/v1"
|
38
|
+
# client = ::Google::Cloud::Kms::Inventory::V1::KeyDashboardService::Rest::Client.new
|
39
|
+
#
|
40
|
+
module V1
|
41
|
+
end
|
42
|
+
end
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
47
|
+
helper_path = ::File.join __dir__, "v1", "_helpers.rb"
|
48
|
+
require "google/cloud/kms/inventory/v1/_helpers" if ::File.file? helper_path
|
@@ -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/kms/inventory/v1"
|
@@ -0,0 +1,318 @@
|
|
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.
|
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
|