google-cloud-support-v2 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 +149 -0
- data/README.md +144 -8
- data/lib/google/cloud/support/v2/actor_pb.rb +44 -0
- data/lib/google/cloud/support/v2/attachment_pb.rb +49 -0
- data/lib/google/cloud/support/v2/attachment_service_pb.rb +50 -0
- data/lib/google/cloud/support/v2/attachment_service_services_pb.rb +45 -0
- data/lib/google/cloud/support/v2/case_attachment_service/client.rb +416 -0
- data/lib/google/cloud/support/v2/case_attachment_service/credentials.rb +47 -0
- data/lib/google/cloud/support/v2/case_attachment_service/paths.rb +72 -0
- data/lib/google/cloud/support/v2/case_attachment_service.rb +49 -0
- data/lib/google/cloud/support/v2/case_pb.rb +52 -0
- data/lib/google/cloud/support/v2/case_service/client.rb +1180 -0
- data/lib/google/cloud/support/v2/case_service/credentials.rb +47 -0
- data/lib/google/cloud/support/v2/case_service/paths.rb +100 -0
- data/lib/google/cloud/support/v2/case_service.rb +49 -0
- data/lib/google/cloud/support/v2/case_service_pb.rb +63 -0
- data/lib/google/cloud/support/v2/case_service_services_pb.rb +75 -0
- data/lib/google/cloud/support/v2/comment_pb.rb +49 -0
- data/lib/google/cloud/support/v2/comment_service/client.rb +511 -0
- data/lib/google/cloud/support/v2/comment_service/credentials.rb +47 -0
- data/lib/google/cloud/support/v2/comment_service/paths.rb +115 -0
- data/lib/google/cloud/support/v2/comment_service.rb +49 -0
- data/lib/google/cloud/support/v2/comment_service_pb.rb +51 -0
- data/lib/google/cloud/support/v2/comment_service_services_pb.rb +48 -0
- data/lib/google/cloud/support/v2/escalation_pb.rb +45 -0
- data/lib/google/cloud/support/v2/version.rb +7 -2
- data/lib/google/cloud/support/v2.rb +42 -0
- data/lib/google-cloud-support-v2.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/client.rb +381 -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 +222 -0
- data/proto_docs/google/cloud/support/v2/actor.rb +49 -0
- data/proto_docs/google/cloud/support/v2/attachment.rb +51 -0
- data/proto_docs/google/cloud/support/v2/attachment_service.rb +59 -0
- data/proto_docs/google/cloud/support/v2/case.rb +152 -0
- data/proto_docs/google/cloud/support/v2/case_service.rb +240 -0
- data/proto_docs/google/cloud/support/v2/comment.rb +49 -0
- data/proto_docs/google/cloud/support/v2/comment_service.rb +69 -0
- data/proto_docs/google/cloud/support/v2/escalation.rb +55 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/timestamp.rb +127 -0
- metadata +201 -13
@@ -0,0 +1,49 @@
|
|
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/support/v2/version"
|
24
|
+
|
25
|
+
require "google/cloud/support/v2/comment_service/credentials"
|
26
|
+
require "google/cloud/support/v2/comment_service/paths"
|
27
|
+
require "google/cloud/support/v2/comment_service/client"
|
28
|
+
|
29
|
+
module Google
|
30
|
+
module Cloud
|
31
|
+
module Support
|
32
|
+
module V2
|
33
|
+
##
|
34
|
+
# A service to manage comments on cases.
|
35
|
+
#
|
36
|
+
# @example Load this service and instantiate a gRPC client
|
37
|
+
#
|
38
|
+
# require "google/cloud/support/v2/comment_service"
|
39
|
+
# client = ::Google::Cloud::Support::V2::CommentService::Client.new
|
40
|
+
#
|
41
|
+
module CommentService
|
42
|
+
end
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
48
|
+
helper_path = ::File.join __dir__, "comment_service", "helpers.rb"
|
49
|
+
require "google/cloud/support/v2/comment_service/helpers" if ::File.file? helper_path
|
@@ -0,0 +1,51 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
3
|
+
# source: google/cloud/support/v2/comment_service.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
|
+
require 'google/api/resource_pb'
|
11
|
+
require 'google/cloud/support/v2/comment_pb'
|
12
|
+
|
13
|
+
|
14
|
+
descriptor_data = "\n-google/cloud/support/v2/comment_service.proto\x12\x17google.cloud.support.v2\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a%google/cloud/support/v2/comment.proto\"v\n\x13ListCommentsRequest\x12\x38\n\x06parent\x18\x01 \x01(\tB(\xe0\x41\x02\xfa\x41\"\n cloudsupport.googleapis.com/Case\x12\x11\n\tpage_size\x18\x04 \x01(\x05\x12\x12\n\npage_token\x18\x05 \x01(\t\"c\n\x14ListCommentsResponse\x12\x32\n\x08\x63omments\x18\x01 \x03(\x0b\x32 .google.cloud.support.v2.Comment\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\"\x88\x01\n\x14\x43reateCommentRequest\x12\x38\n\x06parent\x18\x01 \x01(\tB(\xe0\x41\x02\xfa\x41\"\n cloudsupport.googleapis.com/Case\x12\x36\n\x07\x63omment\x18\x02 \x01(\x0b\x32 .google.cloud.support.v2.CommentB\x03\xe0\x41\x02\x32\xa5\x04\n\x0e\x43ommentService\x12\xd7\x01\n\x0cListComments\x12,.google.cloud.support.v2.ListCommentsRequest\x1a-.google.cloud.support.v2.ListCommentsResponse\"j\x82\xd3\xe4\x93\x02[\x12(/v2/{parent=projects/*/cases/*}/commentsZ/\x12-/v2/{parent=organizations/*/cases/*}/comments\xda\x41\x06parent\x12\xe7\x01\n\rCreateComment\x12-.google.cloud.support.v2.CreateCommentRequest\x1a .google.cloud.support.v2.Comment\"\x84\x01\x82\xd3\xe4\x93\x02m\"(/v2/{parent=projects/*/cases/*}/comments:\x07\x63ommentZ8\"-/v2/{parent=organizations/*/cases/*}/comments:\x07\x63omment\xda\x41\x0eparent,comment\x1aO\xca\x41\x1b\x63loudsupport.googleapis.com\xd2\x41.https://www.googleapis.com/auth/cloud-platformB\xbc\x01\n\x1b\x63om.google.cloud.support.v2B\x13\x43ommentServiceProtoP\x01Z5cloud.google.com/go/support/apiv2/supportpb;supportpb\xaa\x02\x17Google.Cloud.Support.V2\xca\x02\x17Google\\Cloud\\Support\\V2\xea\x02\x1aGoogle::Cloud::Support::V2b\x06proto3"
|
15
|
+
|
16
|
+
pool = Google::Protobuf::DescriptorPool.generated_pool
|
17
|
+
|
18
|
+
begin
|
19
|
+
pool.add_serialized_file(descriptor_data)
|
20
|
+
rescue TypeError => e
|
21
|
+
# Compatibility code: will be removed in the next major version.
|
22
|
+
require 'google/protobuf/descriptor_pb'
|
23
|
+
parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
|
24
|
+
parsed.clear_dependency
|
25
|
+
serialized = parsed.class.encode(parsed)
|
26
|
+
file = pool.add_serialized_file(serialized)
|
27
|
+
warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
|
28
|
+
imports = [
|
29
|
+
["google.cloud.support.v2.Comment", "google/cloud/support/v2/comment.proto"],
|
30
|
+
]
|
31
|
+
imports.each do |type_name, expected_filename|
|
32
|
+
import_file = pool.lookup(type_name).file_descriptor
|
33
|
+
if import_file.name != expected_filename
|
34
|
+
warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
|
35
|
+
end
|
36
|
+
end
|
37
|
+
warn "Each proto file must use a consistent fully-qualified name."
|
38
|
+
warn "This will become an error in the next major version."
|
39
|
+
end
|
40
|
+
|
41
|
+
module Google
|
42
|
+
module Cloud
|
43
|
+
module Support
|
44
|
+
module V2
|
45
|
+
ListCommentsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.support.v2.ListCommentsRequest").msgclass
|
46
|
+
ListCommentsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.support.v2.ListCommentsResponse").msgclass
|
47
|
+
CreateCommentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.support.v2.CreateCommentRequest").msgclass
|
48
|
+
end
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
@@ -0,0 +1,48 @@
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
|
+
# Source: google/cloud/support/v2/comment_service.proto for package 'Google.Cloud.Support.V2'
|
3
|
+
# Original file comments:
|
4
|
+
# Copyright 2023 Google LLC
|
5
|
+
#
|
6
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
7
|
+
# you may not use this file except in compliance with the License.
|
8
|
+
# You may obtain a copy of the License at
|
9
|
+
#
|
10
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
11
|
+
#
|
12
|
+
# Unless required by applicable law or agreed to in writing, software
|
13
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
14
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
15
|
+
# See the License for the specific language governing permissions and
|
16
|
+
# limitations under the License.
|
17
|
+
#
|
18
|
+
|
19
|
+
require 'grpc'
|
20
|
+
require 'google/cloud/support/v2/comment_service_pb'
|
21
|
+
|
22
|
+
module Google
|
23
|
+
module Cloud
|
24
|
+
module Support
|
25
|
+
module V2
|
26
|
+
module CommentService
|
27
|
+
# A service to manage comments on cases.
|
28
|
+
class Service
|
29
|
+
|
30
|
+
include ::GRPC::GenericService
|
31
|
+
|
32
|
+
self.marshal_class_method = :encode
|
33
|
+
self.unmarshal_class_method = :decode
|
34
|
+
self.service_name = 'google.cloud.support.v2.CommentService'
|
35
|
+
|
36
|
+
# Retrieve all Comments associated with the Case object.
|
37
|
+
rpc :ListComments, ::Google::Cloud::Support::V2::ListCommentsRequest, ::Google::Cloud::Support::V2::ListCommentsResponse
|
38
|
+
# Add a new comment to the specified Case.
|
39
|
+
# The comment object must have the following fields set: body.
|
40
|
+
rpc :CreateComment, ::Google::Cloud::Support::V2::CreateCommentRequest, ::Google::Cloud::Support::V2::Comment
|
41
|
+
end
|
42
|
+
|
43
|
+
Stub = Service.rpc_stub_class
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
@@ -0,0 +1,45 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
3
|
+
# source: google/cloud/support/v2/escalation.proto
|
4
|
+
|
5
|
+
require 'google/protobuf'
|
6
|
+
|
7
|
+
require 'google/api/field_behavior_pb'
|
8
|
+
|
9
|
+
|
10
|
+
descriptor_data = "\n(google/cloud/support/v2/escalation.proto\x12\x17google.cloud.support.v2\x1a\x1fgoogle/api/field_behavior.proto\"\xce\x01\n\nEscalation\x12?\n\x06reason\x18\x04 \x01(\x0e\x32*.google.cloud.support.v2.Escalation.ReasonB\x03\xe0\x41\x02\x12\x1a\n\rjustification\x18\x05 \x01(\tB\x03\xe0\x41\x02\"c\n\x06Reason\x12\x16\n\x12REASON_UNSPECIFIED\x10\x00\x12\x13\n\x0fRESOLUTION_TIME\x10\x01\x12\x17\n\x13TECHNICAL_EXPERTISE\x10\x02\x12\x13\n\x0f\x42USINESS_IMPACT\x10\x03\x42\xb8\x01\n\x1b\x63om.google.cloud.support.v2B\x0f\x45scalationProtoP\x01Z5cloud.google.com/go/support/apiv2/supportpb;supportpb\xaa\x02\x17Google.Cloud.Support.V2\xca\x02\x17Google\\Cloud\\Support\\V2\xea\x02\x1aGoogle::Cloud::Support::V2b\x06proto3"
|
11
|
+
|
12
|
+
pool = Google::Protobuf::DescriptorPool.generated_pool
|
13
|
+
|
14
|
+
begin
|
15
|
+
pool.add_serialized_file(descriptor_data)
|
16
|
+
rescue TypeError => e
|
17
|
+
# Compatibility code: will be removed in the next major version.
|
18
|
+
require 'google/protobuf/descriptor_pb'
|
19
|
+
parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
|
20
|
+
parsed.clear_dependency
|
21
|
+
serialized = parsed.class.encode(parsed)
|
22
|
+
file = pool.add_serialized_file(serialized)
|
23
|
+
warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
|
24
|
+
imports = [
|
25
|
+
]
|
26
|
+
imports.each do |type_name, expected_filename|
|
27
|
+
import_file = pool.lookup(type_name).file_descriptor
|
28
|
+
if import_file.name != expected_filename
|
29
|
+
warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
|
30
|
+
end
|
31
|
+
end
|
32
|
+
warn "Each proto file must use a consistent fully-qualified name."
|
33
|
+
warn "This will become an error in the next major version."
|
34
|
+
end
|
35
|
+
|
36
|
+
module Google
|
37
|
+
module Cloud
|
38
|
+
module Support
|
39
|
+
module V2
|
40
|
+
Escalation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.support.v2.Escalation").msgclass
|
41
|
+
Escalation::Reason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.support.v2.Escalation.Reason").enummodule
|
42
|
+
end
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
@@ -1,10 +1,12 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# Copyright 2023 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,11 +14,14 @@
|
|
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 Support
|
18
23
|
module V2
|
19
|
-
VERSION = "0.
|
24
|
+
VERSION = "0.2.0"
|
20
25
|
end
|
21
26
|
end
|
22
27
|
end
|
@@ -0,0 +1,42 @@
|
|
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/support/v2/case_attachment_service"
|
20
|
+
require "google/cloud/support/v2/case_service"
|
21
|
+
require "google/cloud/support/v2/comment_service"
|
22
|
+
require "google/cloud/support/v2/version"
|
23
|
+
|
24
|
+
module Google
|
25
|
+
module Cloud
|
26
|
+
module Support
|
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/support/v2"
|
33
|
+
# client = ::Google::Cloud::Support::V2::CaseAttachmentService::Client.new
|
34
|
+
#
|
35
|
+
module V2
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
helper_path = ::File.join __dir__, "v2", "_helpers.rb"
|
42
|
+
require "google/cloud/support/v2/_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/support/v2"
|
@@ -0,0 +1,381 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2023 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Api
|
22
|
+
# Required information for every language.
|
23
|
+
# @!attribute [rw] reference_docs_uri
|
24
|
+
# @return [::String]
|
25
|
+
# Link to automatically generated reference documentation. Example:
|
26
|
+
# https://cloud.google.com/nodejs/docs/reference/asset/latest
|
27
|
+
# @!attribute [rw] destinations
|
28
|
+
# @return [::Array<::Google::Api::ClientLibraryDestination>]
|
29
|
+
# The destination where API teams want this client library to be published.
|
30
|
+
class CommonLanguageSettings
|
31
|
+
include ::Google::Protobuf::MessageExts
|
32
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
33
|
+
end
|
34
|
+
|
35
|
+
# Details about how and where to publish client libraries.
|
36
|
+
# @!attribute [rw] version
|
37
|
+
# @return [::String]
|
38
|
+
# Version of the API to apply these settings to. This is the full protobuf
|
39
|
+
# package for the API, ending in the version element.
|
40
|
+
# Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
|
41
|
+
# @!attribute [rw] launch_stage
|
42
|
+
# @return [::Google::Api::LaunchStage]
|
43
|
+
# Launch stage of this version of the API.
|
44
|
+
# @!attribute [rw] rest_numeric_enums
|
45
|
+
# @return [::Boolean]
|
46
|
+
# When using transport=rest, the client request will encode enums as
|
47
|
+
# numbers rather than strings.
|
48
|
+
# @!attribute [rw] java_settings
|
49
|
+
# @return [::Google::Api::JavaSettings]
|
50
|
+
# Settings for legacy Java features, supported in the Service YAML.
|
51
|
+
# @!attribute [rw] cpp_settings
|
52
|
+
# @return [::Google::Api::CppSettings]
|
53
|
+
# Settings for C++ client libraries.
|
54
|
+
# @!attribute [rw] php_settings
|
55
|
+
# @return [::Google::Api::PhpSettings]
|
56
|
+
# Settings for PHP client libraries.
|
57
|
+
# @!attribute [rw] python_settings
|
58
|
+
# @return [::Google::Api::PythonSettings]
|
59
|
+
# Settings for Python client libraries.
|
60
|
+
# @!attribute [rw] node_settings
|
61
|
+
# @return [::Google::Api::NodeSettings]
|
62
|
+
# Settings for Node client libraries.
|
63
|
+
# @!attribute [rw] dotnet_settings
|
64
|
+
# @return [::Google::Api::DotnetSettings]
|
65
|
+
# Settings for .NET client libraries.
|
66
|
+
# @!attribute [rw] ruby_settings
|
67
|
+
# @return [::Google::Api::RubySettings]
|
68
|
+
# Settings for Ruby client libraries.
|
69
|
+
# @!attribute [rw] go_settings
|
70
|
+
# @return [::Google::Api::GoSettings]
|
71
|
+
# Settings for Go client libraries.
|
72
|
+
class ClientLibrarySettings
|
73
|
+
include ::Google::Protobuf::MessageExts
|
74
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
75
|
+
end
|
76
|
+
|
77
|
+
# This message configures the settings for publishing [Google Cloud Client
|
78
|
+
# libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
|
79
|
+
# generated from the service config.
|
80
|
+
# @!attribute [rw] method_settings
|
81
|
+
# @return [::Array<::Google::Api::MethodSettings>]
|
82
|
+
# A list of API method settings, e.g. the behavior for methods that use the
|
83
|
+
# long-running operation pattern.
|
84
|
+
# @!attribute [rw] new_issue_uri
|
85
|
+
# @return [::String]
|
86
|
+
# Link to a *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
|