google-cloud-gke_connect-gateway-v1 0.a → 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +122 -0
- data/README.md +118 -8
- data/lib/google/cloud/gke_connect/gateway/v1/gateway_control/credentials.rb +49 -0
- data/lib/google/cloud/gke_connect/gateway/v1/gateway_control/rest/client.rb +417 -0
- data/lib/google/cloud/gke_connect/gateway/v1/gateway_control/rest/service_stub.rb +130 -0
- data/lib/google/cloud/gke_connect/gateway/v1/gateway_control/rest.rb +53 -0
- data/lib/google/cloud/gke_connect/gateway/v1/gateway_control.rb +49 -0
- data/lib/google/cloud/gke_connect/gateway/v1/rest.rb +39 -0
- data/lib/google/cloud/gke_connect/gateway/v1/version.rb +7 -2
- data/lib/google/cloud/gke_connect/gateway/v1.rb +42 -0
- data/lib/google/cloud/gkeconnect/gateway/v1/control_pb.rb +50 -0
- data/lib/google/cloud/gkeconnect/gateway/v1/control_services_pb.rb +48 -0
- data/lib/google-cloud-gke_connect-gateway-v1.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/client.rb +440 -0
- data/proto_docs/google/api/field_behavior.rb +85 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/api/resource.rb +227 -0
- data/proto_docs/google/cloud/gkeconnect/gateway/v1/control.rb +84 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- metadata +65 -11
@@ -0,0 +1,39 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 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/gke_connect/gateway/v1/gateway_control/rest"
|
20
|
+
require "google/cloud/gke_connect/gateway/v1/version"
|
21
|
+
|
22
|
+
module Google
|
23
|
+
module Cloud
|
24
|
+
module GkeConnect
|
25
|
+
module Gateway
|
26
|
+
##
|
27
|
+
# To load just the REST part of this package, including all its services, and instantiate a REST client:
|
28
|
+
#
|
29
|
+
# @example
|
30
|
+
#
|
31
|
+
# require "google/cloud/gke_connect/gateway/v1/rest"
|
32
|
+
# client = ::Google::Cloud::GkeConnect::Gateway::V1::GatewayControl::Rest::Client.new
|
33
|
+
#
|
34
|
+
module V1
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
@@ -1,10 +1,12 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# Copyright 2024 Google LLC
|
2
4
|
#
|
3
5
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
6
|
# you may not use this file except in compliance with the License.
|
5
7
|
# You may obtain a copy of the License at
|
6
8
|
#
|
7
|
-
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
8
10
|
#
|
9
11
|
# Unless required by applicable law or agreed to in writing, software
|
10
12
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
@@ -12,12 +14,15 @@
|
|
12
14
|
# See the License for the specific language governing permissions and
|
13
15
|
# limitations under the License.
|
14
16
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
15
20
|
module Google
|
16
21
|
module Cloud
|
17
22
|
module GkeConnect
|
18
23
|
module Gateway
|
19
24
|
module V1
|
20
|
-
VERSION = "0.
|
25
|
+
VERSION = "0.2.0"
|
21
26
|
end
|
22
27
|
end
|
23
28
|
end
|
@@ -0,0 +1,42 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 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/gke_connect/gateway/v1/gateway_control"
|
20
|
+
require "google/cloud/gke_connect/gateway/v1/version"
|
21
|
+
|
22
|
+
module Google
|
23
|
+
module Cloud
|
24
|
+
module GkeConnect
|
25
|
+
module Gateway
|
26
|
+
##
|
27
|
+
# API client module.
|
28
|
+
#
|
29
|
+
# @example Load this package, including all its services, and instantiate a REST client
|
30
|
+
#
|
31
|
+
# require "google/cloud/gke_connect/gateway/v1"
|
32
|
+
# client = ::Google::Cloud::GkeConnect::Gateway::V1::GatewayControl::Rest::Client.new
|
33
|
+
#
|
34
|
+
module V1
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
helper_path = ::File.join __dir__, "v1", "_helpers.rb"
|
42
|
+
require "google/cloud/gke_connect/gateway/v1/_helpers" if ::File.file? helper_path
|
@@ -0,0 +1,50 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
3
|
+
# source: google/cloud/gkeconnect/gateway/v1/control.proto
|
4
|
+
|
5
|
+
require 'google/protobuf'
|
6
|
+
|
7
|
+
require 'google/api/annotations_pb'
|
8
|
+
require 'google/api/client_pb'
|
9
|
+
require 'google/api/field_behavior_pb'
|
10
|
+
|
11
|
+
|
12
|
+
descriptor_data = "\n0google/cloud/gkeconnect/gateway/v1/control.proto\x12\"google.cloud.gkeconnect.gateway.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\"\xc8\x02\n\x1aGenerateCredentialsRequest\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x02\x12\x1c\n\x0f\x66orce_use_agent\x18\x02 \x01(\x08\x42\x03\xe0\x41\x01\x12\x14\n\x07version\x18\x03 \x01(\tB\x03\xe0\x41\x01\x12!\n\x14kubernetes_namespace\x18\x04 \x01(\tB\x03\xe0\x41\x01\x12m\n\x10operating_system\x18\x05 \x01(\x0e\x32N.google.cloud.gkeconnect.gateway.v1.GenerateCredentialsRequest.OperatingSystemB\x03\xe0\x41\x01\"Q\n\x0fOperatingSystem\x12 \n\x1cOPERATING_SYSTEM_UNSPECIFIED\x10\x00\x12\x1c\n\x18OPERATING_SYSTEM_WINDOWS\x10\x01\"C\n\x1bGenerateCredentialsResponse\x12\x12\n\nkubeconfig\x18\x01 \x01(\x0c\x12\x10\n\x08\x65ndpoint\x18\x02 \x01(\t2\xc9\x02\n\x0eGatewayControl\x12\xe3\x01\n\x13GenerateCredentials\x12>.google.cloud.gkeconnect.gateway.v1.GenerateCredentialsRequest\x1a?.google.cloud.gkeconnect.gateway.v1.GenerateCredentialsResponse\"K\x82\xd3\xe4\x93\x02\x45\x12\x43/v1/{name=projects/*/locations/*/memberships/*}:generateCredentials\x1aQ\xca\x41\x1d\x63onnectgateway.googleapis.com\xd2\x41.https://www.googleapis.com/auth/cloud-platformB\xed\x01\n&com.google.cloud.gkeconnect.gateway.v1B\x0c\x43ontrolProtoP\x01Z@cloud.google.com/go/gkeconnect/gateway/apiv1/gatewaypb;gatewaypb\xaa\x02\"Google.Cloud.GkeConnect.Gateway.V1\xca\x02\"Google\\Cloud\\GkeConnect\\Gateway\\V1\xea\x02&Google::Cloud::GkeConnect::Gateway::V1b\x06proto3"
|
13
|
+
|
14
|
+
pool = Google::Protobuf::DescriptorPool.generated_pool
|
15
|
+
|
16
|
+
begin
|
17
|
+
pool.add_serialized_file(descriptor_data)
|
18
|
+
rescue TypeError
|
19
|
+
# Compatibility code: will be removed in the next major version.
|
20
|
+
require 'google/protobuf/descriptor_pb'
|
21
|
+
parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
|
22
|
+
parsed.clear_dependency
|
23
|
+
serialized = parsed.class.encode(parsed)
|
24
|
+
file = pool.add_serialized_file(serialized)
|
25
|
+
warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
|
26
|
+
imports = [
|
27
|
+
]
|
28
|
+
imports.each do |type_name, expected_filename|
|
29
|
+
import_file = pool.lookup(type_name).file_descriptor
|
30
|
+
if import_file.name != expected_filename
|
31
|
+
warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
|
32
|
+
end
|
33
|
+
end
|
34
|
+
warn "Each proto file must use a consistent fully-qualified name."
|
35
|
+
warn "This will become an error in the next major version."
|
36
|
+
end
|
37
|
+
|
38
|
+
module Google
|
39
|
+
module Cloud
|
40
|
+
module GkeConnect
|
41
|
+
module Gateway
|
42
|
+
module V1
|
43
|
+
GenerateCredentialsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.gkeconnect.gateway.v1.GenerateCredentialsRequest").msgclass
|
44
|
+
GenerateCredentialsRequest::OperatingSystem = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.gkeconnect.gateway.v1.GenerateCredentialsRequest.OperatingSystem").enummodule
|
45
|
+
GenerateCredentialsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.gkeconnect.gateway.v1.GenerateCredentialsResponse").msgclass
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
50
|
+
end
|
@@ -0,0 +1,48 @@
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
|
+
# Source: google/cloud/gkeconnect/gateway/v1/control.proto for package 'Google.Cloud.GkeConnect.Gateway.V1'
|
3
|
+
# Original file comments:
|
4
|
+
# Copyright 2024 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/gkeconnect/gateway/v1/control_pb'
|
21
|
+
|
22
|
+
module Google
|
23
|
+
module Cloud
|
24
|
+
module GkeConnect
|
25
|
+
module Gateway
|
26
|
+
module V1
|
27
|
+
module GatewayControl
|
28
|
+
# GatewayControl is the control plane API for Connect Gateway.
|
29
|
+
class Service
|
30
|
+
|
31
|
+
include ::GRPC::GenericService
|
32
|
+
|
33
|
+
self.marshal_class_method = :encode
|
34
|
+
self.unmarshal_class_method = :decode
|
35
|
+
self.service_name = 'google.cloud.gkeconnect.gateway.v1.GatewayControl'
|
36
|
+
|
37
|
+
# GenerateCredentials provides connection information that allows a user to
|
38
|
+
# access the specified membership using Connect Gateway.
|
39
|
+
rpc :GenerateCredentials, ::Google::Cloud::GkeConnect::Gateway::V1::GenerateCredentialsRequest, ::Google::Cloud::GkeConnect::Gateway::V1::GenerateCredentialsResponse
|
40
|
+
end
|
41
|
+
|
42
|
+
Stub = Service.rpc_stub_class
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 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/gke_connect/gateway/v1"
|
@@ -0,0 +1,440 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 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
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
25
|
+
# @return [::String]
|
26
|
+
# Link to automatically generated reference documentation. Example:
|
27
|
+
# https://cloud.google.com/nodejs/docs/reference/asset/latest
|
28
|
+
# @!attribute [rw] destinations
|
29
|
+
# @return [::Array<::Google::Api::ClientLibraryDestination>]
|
30
|
+
# The destination where API teams want this client library to be published.
|
31
|
+
# @!attribute [rw] selective_gapic_generation
|
32
|
+
# @return [::Google::Api::SelectiveGapicGeneration]
|
33
|
+
# Configuration for which RPCs should be generated in the GAPIC client.
|
34
|
+
class CommonLanguageSettings
|
35
|
+
include ::Google::Protobuf::MessageExts
|
36
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
37
|
+
end
|
38
|
+
|
39
|
+
# Details about how and where to publish client libraries.
|
40
|
+
# @!attribute [rw] version
|
41
|
+
# @return [::String]
|
42
|
+
# Version of the API to apply these settings to. This is the full protobuf
|
43
|
+
# package for the API, ending in the version element.
|
44
|
+
# Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
|
45
|
+
# @!attribute [rw] launch_stage
|
46
|
+
# @return [::Google::Api::LaunchStage]
|
47
|
+
# Launch stage of this version of the API.
|
48
|
+
# @!attribute [rw] rest_numeric_enums
|
49
|
+
# @return [::Boolean]
|
50
|
+
# When using transport=rest, the client request will encode enums as
|
51
|
+
# numbers rather than strings.
|
52
|
+
# @!attribute [rw] java_settings
|
53
|
+
# @return [::Google::Api::JavaSettings]
|
54
|
+
# Settings for legacy Java features, supported in the Service YAML.
|
55
|
+
# @!attribute [rw] cpp_settings
|
56
|
+
# @return [::Google::Api::CppSettings]
|
57
|
+
# Settings for C++ client libraries.
|
58
|
+
# @!attribute [rw] php_settings
|
59
|
+
# @return [::Google::Api::PhpSettings]
|
60
|
+
# Settings for PHP client libraries.
|
61
|
+
# @!attribute [rw] python_settings
|
62
|
+
# @return [::Google::Api::PythonSettings]
|
63
|
+
# Settings for Python client libraries.
|
64
|
+
# @!attribute [rw] node_settings
|
65
|
+
# @return [::Google::Api::NodeSettings]
|
66
|
+
# Settings for Node client libraries.
|
67
|
+
# @!attribute [rw] dotnet_settings
|
68
|
+
# @return [::Google::Api::DotnetSettings]
|
69
|
+
# Settings for .NET client libraries.
|
70
|
+
# @!attribute [rw] ruby_settings
|
71
|
+
# @return [::Google::Api::RubySettings]
|
72
|
+
# Settings for Ruby client libraries.
|
73
|
+
# @!attribute [rw] go_settings
|
74
|
+
# @return [::Google::Api::GoSettings]
|
75
|
+
# Settings for Go client libraries.
|
76
|
+
class ClientLibrarySettings
|
77
|
+
include ::Google::Protobuf::MessageExts
|
78
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
79
|
+
end
|
80
|
+
|
81
|
+
# This message configures the settings for publishing [Google Cloud Client
|
82
|
+
# libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
|
83
|
+
# generated from the service config.
|
84
|
+
# @!attribute [rw] method_settings
|
85
|
+
# @return [::Array<::Google::Api::MethodSettings>]
|
86
|
+
# A list of API method settings, e.g. the behavior for methods that use the
|
87
|
+
# long-running operation pattern.
|
88
|
+
# @!attribute [rw] new_issue_uri
|
89
|
+
# @return [::String]
|
90
|
+
# Link to a *public* URI where users can report issues. Example:
|
91
|
+
# https://issuetracker.google.com/issues/new?component=190865&template=1161103
|
92
|
+
# @!attribute [rw] documentation_uri
|
93
|
+
# @return [::String]
|
94
|
+
# Link to product home page. Example:
|
95
|
+
# https://cloud.google.com/asset-inventory/docs/overview
|
96
|
+
# @!attribute [rw] api_short_name
|
97
|
+
# @return [::String]
|
98
|
+
# Used as a tracking tag when collecting data about the APIs developer
|
99
|
+
# relations artifacts like docs, packages delivered to package managers,
|
100
|
+
# etc. Example: "speech".
|
101
|
+
# @!attribute [rw] github_label
|
102
|
+
# @return [::String]
|
103
|
+
# GitHub label to apply to issues and pull requests opened for this API.
|
104
|
+
# @!attribute [rw] codeowner_github_teams
|
105
|
+
# @return [::Array<::String>]
|
106
|
+
# GitHub teams to be added to CODEOWNERS in the directory in GitHub
|
107
|
+
# containing source code for the client libraries for this API.
|
108
|
+
# @!attribute [rw] doc_tag_prefix
|
109
|
+
# @return [::String]
|
110
|
+
# A prefix used in sample code when demarking regions to be included in
|
111
|
+
# documentation.
|
112
|
+
# @!attribute [rw] organization
|
113
|
+
# @return [::Google::Api::ClientLibraryOrganization]
|
114
|
+
# For whom the client library is being published.
|
115
|
+
# @!attribute [rw] library_settings
|
116
|
+
# @return [::Array<::Google::Api::ClientLibrarySettings>]
|
117
|
+
# Client library settings. If the same version string appears multiple
|
118
|
+
# times in this list, then the last one wins. Settings from earlier
|
119
|
+
# settings with the same version string are discarded.
|
120
|
+
# @!attribute [rw] proto_reference_documentation_uri
|
121
|
+
# @return [::String]
|
122
|
+
# Optional link to proto reference documentation. Example:
|
123
|
+
# https://cloud.google.com/pubsub/lite/docs/reference/rpc
|
124
|
+
# @!attribute [rw] rest_reference_documentation_uri
|
125
|
+
# @return [::String]
|
126
|
+
# Optional link to REST reference documentation. Example:
|
127
|
+
# https://cloud.google.com/pubsub/lite/docs/reference/rest
|
128
|
+
class Publishing
|
129
|
+
include ::Google::Protobuf::MessageExts
|
130
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
131
|
+
end
|
132
|
+
|
133
|
+
# Settings for Java client libraries.
|
134
|
+
# @!attribute [rw] library_package
|
135
|
+
# @return [::String]
|
136
|
+
# The package name to use in Java. Clobbers the java_package option
|
137
|
+
# set in the protobuf. This should be used **only** by APIs
|
138
|
+
# who have already set the language_settings.java.package_name" field
|
139
|
+
# in gapic.yaml. API teams should use the protobuf java_package option
|
140
|
+
# where possible.
|
141
|
+
#
|
142
|
+
# Example of a YAML configuration::
|
143
|
+
#
|
144
|
+
# publishing:
|
145
|
+
# java_settings:
|
146
|
+
# library_package: com.google.cloud.pubsub.v1
|
147
|
+
# @!attribute [rw] service_class_names
|
148
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
149
|
+
# Configure the Java class name to use instead of the service's for its
|
150
|
+
# corresponding generated GAPIC client. Keys are fully-qualified
|
151
|
+
# service names as they appear in the protobuf (including the full
|
152
|
+
# the language_settings.java.interface_names" field in gapic.yaml. API
|
153
|
+
# teams should otherwise use the service name as it appears in the
|
154
|
+
# protobuf.
|
155
|
+
#
|
156
|
+
# Example of a YAML configuration::
|
157
|
+
#
|
158
|
+
# publishing:
|
159
|
+
# java_settings:
|
160
|
+
# service_class_names:
|
161
|
+
# - google.pubsub.v1.Publisher: TopicAdmin
|
162
|
+
# - google.pubsub.v1.Subscriber: SubscriptionAdmin
|
163
|
+
# @!attribute [rw] common
|
164
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
165
|
+
# Some settings.
|
166
|
+
class JavaSettings
|
167
|
+
include ::Google::Protobuf::MessageExts
|
168
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
169
|
+
|
170
|
+
# @!attribute [rw] key
|
171
|
+
# @return [::String]
|
172
|
+
# @!attribute [rw] value
|
173
|
+
# @return [::String]
|
174
|
+
class ServiceClassNamesEntry
|
175
|
+
include ::Google::Protobuf::MessageExts
|
176
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
177
|
+
end
|
178
|
+
end
|
179
|
+
|
180
|
+
# Settings for C++ client libraries.
|
181
|
+
# @!attribute [rw] common
|
182
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
183
|
+
# Some settings.
|
184
|
+
class CppSettings
|
185
|
+
include ::Google::Protobuf::MessageExts
|
186
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
187
|
+
end
|
188
|
+
|
189
|
+
# Settings for Php client libraries.
|
190
|
+
# @!attribute [rw] common
|
191
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
192
|
+
# Some settings.
|
193
|
+
class PhpSettings
|
194
|
+
include ::Google::Protobuf::MessageExts
|
195
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
196
|
+
end
|
197
|
+
|
198
|
+
# Settings for Python client libraries.
|
199
|
+
# @!attribute [rw] common
|
200
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
201
|
+
# Some settings.
|
202
|
+
# @!attribute [rw] experimental_features
|
203
|
+
# @return [::Google::Api::PythonSettings::ExperimentalFeatures]
|
204
|
+
# Experimental features to be included during client library generation.
|
205
|
+
class PythonSettings
|
206
|
+
include ::Google::Protobuf::MessageExts
|
207
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
208
|
+
|
209
|
+
# Experimental features to be included during client library generation.
|
210
|
+
# These fields will be deprecated once the feature graduates and is enabled
|
211
|
+
# by default.
|
212
|
+
# @!attribute [rw] rest_async_io_enabled
|
213
|
+
# @return [::Boolean]
|
214
|
+
# Enables generation of asynchronous REST clients if `rest` transport is
|
215
|
+
# enabled. By default, asynchronous REST clients will not be generated.
|
216
|
+
# This feature will be enabled by default 1 month after launching the
|
217
|
+
# feature in preview packages.
|
218
|
+
# @!attribute [rw] protobuf_pythonic_types_enabled
|
219
|
+
# @return [::Boolean]
|
220
|
+
# Enables generation of protobuf code using new types that are more
|
221
|
+
# Pythonic which are included in `protobuf>=5.29.x`. This feature will be
|
222
|
+
# enabled by default 1 month after launching the feature in preview
|
223
|
+
# packages.
|
224
|
+
class ExperimentalFeatures
|
225
|
+
include ::Google::Protobuf::MessageExts
|
226
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
227
|
+
end
|
228
|
+
end
|
229
|
+
|
230
|
+
# Settings for Node client libraries.
|
231
|
+
# @!attribute [rw] common
|
232
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
233
|
+
# Some settings.
|
234
|
+
class NodeSettings
|
235
|
+
include ::Google::Protobuf::MessageExts
|
236
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
237
|
+
end
|
238
|
+
|
239
|
+
# Settings for Dotnet client libraries.
|
240
|
+
# @!attribute [rw] common
|
241
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
242
|
+
# Some settings.
|
243
|
+
# @!attribute [rw] renamed_services
|
244
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
245
|
+
# Map from original service names to renamed versions.
|
246
|
+
# This is used when the default generated types
|
247
|
+
# would cause a naming conflict. (Neither name is
|
248
|
+
# fully-qualified.)
|
249
|
+
# Example: Subscriber to SubscriberServiceApi.
|
250
|
+
# @!attribute [rw] renamed_resources
|
251
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
252
|
+
# Map from full resource types to the effective short name
|
253
|
+
# for the resource. This is used when otherwise resource
|
254
|
+
# named from different services would cause naming collisions.
|
255
|
+
# Example entry:
|
256
|
+
# "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
|
257
|
+
# @!attribute [rw] ignored_resources
|
258
|
+
# @return [::Array<::String>]
|
259
|
+
# List of full resource types to ignore during generation.
|
260
|
+
# This is typically used for API-specific Location resources,
|
261
|
+
# which should be handled by the generator as if they were actually
|
262
|
+
# the common Location resources.
|
263
|
+
# Example entry: "documentai.googleapis.com/Location"
|
264
|
+
# @!attribute [rw] forced_namespace_aliases
|
265
|
+
# @return [::Array<::String>]
|
266
|
+
# Namespaces which must be aliased in snippets due to
|
267
|
+
# a known (but non-generator-predictable) naming collision
|
268
|
+
# @!attribute [rw] handwritten_signatures
|
269
|
+
# @return [::Array<::String>]
|
270
|
+
# Method signatures (in the form "service.method(signature)")
|
271
|
+
# which are provided separately, so shouldn't be generated.
|
272
|
+
# Snippets *calling* these methods are still generated, however.
|
273
|
+
class DotnetSettings
|
274
|
+
include ::Google::Protobuf::MessageExts
|
275
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
276
|
+
|
277
|
+
# @!attribute [rw] key
|
278
|
+
# @return [::String]
|
279
|
+
# @!attribute [rw] value
|
280
|
+
# @return [::String]
|
281
|
+
class RenamedServicesEntry
|
282
|
+
include ::Google::Protobuf::MessageExts
|
283
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
284
|
+
end
|
285
|
+
|
286
|
+
# @!attribute [rw] key
|
287
|
+
# @return [::String]
|
288
|
+
# @!attribute [rw] value
|
289
|
+
# @return [::String]
|
290
|
+
class RenamedResourcesEntry
|
291
|
+
include ::Google::Protobuf::MessageExts
|
292
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
293
|
+
end
|
294
|
+
end
|
295
|
+
|
296
|
+
# Settings for Ruby client libraries.
|
297
|
+
# @!attribute [rw] common
|
298
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
299
|
+
# Some settings.
|
300
|
+
class RubySettings
|
301
|
+
include ::Google::Protobuf::MessageExts
|
302
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
303
|
+
end
|
304
|
+
|
305
|
+
# Settings for Go client libraries.
|
306
|
+
# @!attribute [rw] common
|
307
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
308
|
+
# Some settings.
|
309
|
+
class GoSettings
|
310
|
+
include ::Google::Protobuf::MessageExts
|
311
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
312
|
+
end
|
313
|
+
|
314
|
+
# Describes the generator configuration for a method.
|
315
|
+
# @!attribute [rw] selector
|
316
|
+
# @return [::String]
|
317
|
+
# The fully qualified name of the method, for which the options below apply.
|
318
|
+
# This is used to find the method to apply the options.
|
319
|
+
#
|
320
|
+
# Example:
|
321
|
+
#
|
322
|
+
# publishing:
|
323
|
+
# method_settings:
|
324
|
+
# - selector: google.storage.control.v2.StorageControl.CreateFolder
|
325
|
+
# # method settings for CreateFolder...
|
326
|
+
# @!attribute [rw] long_running
|
327
|
+
# @return [::Google::Api::MethodSettings::LongRunning]
|
328
|
+
# Describes settings to use for long-running operations when generating
|
329
|
+
# API methods for RPCs. Complements RPCs that use the annotations in
|
330
|
+
# google/longrunning/operations.proto.
|
331
|
+
#
|
332
|
+
# Example of a YAML configuration::
|
333
|
+
#
|
334
|
+
# publishing:
|
335
|
+
# method_settings:
|
336
|
+
# - selector: google.cloud.speech.v2.Speech.BatchRecognize
|
337
|
+
# long_running:
|
338
|
+
# initial_poll_delay: 60s # 1 minute
|
339
|
+
# poll_delay_multiplier: 1.5
|
340
|
+
# max_poll_delay: 360s # 6 minutes
|
341
|
+
# total_poll_timeout: 54000s # 90 minutes
|
342
|
+
# @!attribute [rw] auto_populated_fields
|
343
|
+
# @return [::Array<::String>]
|
344
|
+
# List of top-level fields of the request message, that should be
|
345
|
+
# automatically populated by the client libraries based on their
|
346
|
+
# (google.api.field_info).format. Currently supported format: UUID4.
|
347
|
+
#
|
348
|
+
# Example of a YAML configuration:
|
349
|
+
#
|
350
|
+
# publishing:
|
351
|
+
# method_settings:
|
352
|
+
# - selector: google.example.v1.ExampleService.CreateExample
|
353
|
+
# auto_populated_fields:
|
354
|
+
# - request_id
|
355
|
+
class MethodSettings
|
356
|
+
include ::Google::Protobuf::MessageExts
|
357
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
358
|
+
|
359
|
+
# Describes settings to use when generating API methods that use the
|
360
|
+
# long-running operation pattern.
|
361
|
+
# All default values below are from those used in the client library
|
362
|
+
# generators (e.g.
|
363
|
+
# [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
|
364
|
+
# @!attribute [rw] initial_poll_delay
|
365
|
+
# @return [::Google::Protobuf::Duration]
|
366
|
+
# Initial delay after which the first poll request will be made.
|
367
|
+
# Default value: 5 seconds.
|
368
|
+
# @!attribute [rw] poll_delay_multiplier
|
369
|
+
# @return [::Float]
|
370
|
+
# Multiplier to gradually increase delay between subsequent polls until it
|
371
|
+
# reaches max_poll_delay.
|
372
|
+
# Default value: 1.5.
|
373
|
+
# @!attribute [rw] max_poll_delay
|
374
|
+
# @return [::Google::Protobuf::Duration]
|
375
|
+
# Maximum time between two subsequent poll requests.
|
376
|
+
# Default value: 45 seconds.
|
377
|
+
# @!attribute [rw] total_poll_timeout
|
378
|
+
# @return [::Google::Protobuf::Duration]
|
379
|
+
# Total polling timeout.
|
380
|
+
# Default value: 5 minutes.
|
381
|
+
class LongRunning
|
382
|
+
include ::Google::Protobuf::MessageExts
|
383
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
384
|
+
end
|
385
|
+
end
|
386
|
+
|
387
|
+
# This message is used to configure the generation of a subset of the RPCs in
|
388
|
+
# a service for client libraries.
|
389
|
+
# @!attribute [rw] methods
|
390
|
+
# @return [::Array<::String>]
|
391
|
+
# An allowlist of the fully qualified names of RPCs that should be included
|
392
|
+
# on public client surfaces.
|
393
|
+
class SelectiveGapicGeneration
|
394
|
+
include ::Google::Protobuf::MessageExts
|
395
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
396
|
+
end
|
397
|
+
|
398
|
+
# The organization for which the client libraries are being published.
|
399
|
+
# Affects the url where generated docs are published, etc.
|
400
|
+
module ClientLibraryOrganization
|
401
|
+
# Not useful.
|
402
|
+
CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
|
403
|
+
|
404
|
+
# Google Cloud Platform Org.
|
405
|
+
CLOUD = 1
|
406
|
+
|
407
|
+
# Ads (Advertising) Org.
|
408
|
+
ADS = 2
|
409
|
+
|
410
|
+
# Photos Org.
|
411
|
+
PHOTOS = 3
|
412
|
+
|
413
|
+
# Street View Org.
|
414
|
+
STREET_VIEW = 4
|
415
|
+
|
416
|
+
# Shopping Org.
|
417
|
+
SHOPPING = 5
|
418
|
+
|
419
|
+
# Geo Org.
|
420
|
+
GEO = 6
|
421
|
+
|
422
|
+
# Generative AI - https://developers.generativeai.google
|
423
|
+
GENERATIVE_AI = 7
|
424
|
+
end
|
425
|
+
|
426
|
+
# To where should client libraries be published?
|
427
|
+
module ClientLibraryDestination
|
428
|
+
# Client libraries will neither be generated nor published to package
|
429
|
+
# managers.
|
430
|
+
CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
|
431
|
+
|
432
|
+
# Generate the client library in a repo under github.com/googleapis,
|
433
|
+
# but don't publish it to package managers.
|
434
|
+
GITHUB = 10
|
435
|
+
|
436
|
+
# Publish the library to package managers like nuget.org and npmjs.com.
|
437
|
+
PACKAGE_MANAGER = 20
|
438
|
+
end
|
439
|
+
end
|
440
|
+
end
|