google-cloud-translate-v3 0.1.2 → 0.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE.md +188 -190
- data/README.md +66 -2
- data/lib/google/cloud/translate/v3.rb +3 -0
- data/lib/google/cloud/translate/v3/translation_service/client.rb +32 -26
- data/lib/google/cloud/translate/v3/translation_service/operations.rb +96 -11
- data/lib/google/cloud/translate/v3/translation_service_services_pb.rb +8 -8
- data/lib/google/cloud/translate/v3/version.rb +1 -1
- data/proto_docs/google/api/field_behavior.rb +6 -0
- data/proto_docs/google/api/resource.rb +50 -14
- data/proto_docs/google/cloud/translate/v3/translation_service.rb +4 -4
- data/proto_docs/google/longrunning/operations.rb +17 -3
- data/proto_docs/google/protobuf/any.rb +5 -2
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/timestamp.rb +10 -1
- metadata +12 -9
@@ -60,7 +60,7 @@ module Google
|
|
60
60
|
parent_config = while namespace.any?
|
61
61
|
parent_name = namespace.join "::"
|
62
62
|
parent_const = const_get parent_name
|
63
|
-
break parent_const.configure if parent_const
|
63
|
+
break parent_const.configure if parent_const.respond_to? :configure
|
64
64
|
namespace.pop
|
65
65
|
end
|
66
66
|
default_config = Client::Configuration.new parent_config
|
@@ -72,9 +72,9 @@ module Google
|
|
72
72
|
default_config.rpcs.get_supported_languages.timeout = 600.0
|
73
73
|
default_config.rpcs.get_supported_languages.retry_policy = {
|
74
74
|
initial_delay: 0.1,
|
75
|
-
|
76
|
-
|
77
|
-
|
75
|
+
max_delay: 60.0,
|
76
|
+
multiplier: 1.3,
|
77
|
+
retry_codes: [4, 14]
|
78
78
|
}
|
79
79
|
|
80
80
|
default_config.rpcs.batch_translate_text.timeout = 600.0
|
@@ -84,25 +84,25 @@ module Google
|
|
84
84
|
default_config.rpcs.list_glossaries.timeout = 600.0
|
85
85
|
default_config.rpcs.list_glossaries.retry_policy = {
|
86
86
|
initial_delay: 0.1,
|
87
|
-
|
88
|
-
|
89
|
-
|
87
|
+
max_delay: 60.0,
|
88
|
+
multiplier: 1.3,
|
89
|
+
retry_codes: [4, 14]
|
90
90
|
}
|
91
91
|
|
92
92
|
default_config.rpcs.get_glossary.timeout = 600.0
|
93
93
|
default_config.rpcs.get_glossary.retry_policy = {
|
94
94
|
initial_delay: 0.1,
|
95
|
-
|
96
|
-
|
97
|
-
|
95
|
+
max_delay: 60.0,
|
96
|
+
multiplier: 1.3,
|
97
|
+
retry_codes: [4, 14]
|
98
98
|
}
|
99
99
|
|
100
100
|
default_config.rpcs.delete_glossary.timeout = 600.0
|
101
101
|
default_config.rpcs.delete_glossary.retry_policy = {
|
102
102
|
initial_delay: 0.1,
|
103
|
-
|
104
|
-
|
105
|
-
|
103
|
+
max_delay: 60.0,
|
104
|
+
multiplier: 1.3,
|
105
|
+
retry_codes: [4, 14]
|
106
106
|
}
|
107
107
|
|
108
108
|
default_config
|
@@ -166,7 +166,13 @@ module Google
|
|
166
166
|
|
167
167
|
# Create credentials
|
168
168
|
credentials = @config.credentials
|
169
|
-
|
169
|
+
# Use self-signed JWT if the scope and endpoint are unchanged from default,
|
170
|
+
# but only if the default endpoint does not have a region prefix.
|
171
|
+
enable_self_signed_jwt = @config.scope == Client.configure.scope &&
|
172
|
+
@config.endpoint == Client.configure.endpoint &&
|
173
|
+
!@config.endpoint.split(".").first.include?("-")
|
174
|
+
credentials ||= Credentials.default scope: @config.scope,
|
175
|
+
enable_self_signed_jwt: enable_self_signed_jwt
|
170
176
|
if credentials.is_a?(String) || credentials.is_a?(Hash)
|
171
177
|
credentials = Credentials.new credentials, scope: @config.scope
|
172
178
|
end
|
@@ -1013,14 +1019,14 @@ module Google
|
|
1013
1019
|
|
1014
1020
|
config_attr :endpoint, "translate.googleapis.com", ::String
|
1015
1021
|
config_attr :credentials, nil do |value|
|
1016
|
-
allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
1022
|
+
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
1017
1023
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
1018
1024
|
allowed.any? { |klass| klass === value }
|
1019
1025
|
end
|
1020
1026
|
config_attr :scope, nil, ::String, ::Array, nil
|
1021
1027
|
config_attr :lib_name, nil, ::String, nil
|
1022
1028
|
config_attr :lib_version, nil, ::String, nil
|
1023
|
-
config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
|
1029
|
+
config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
|
1024
1030
|
config_attr :interceptors, nil, ::Array, nil
|
1025
1031
|
config_attr :timeout, nil, ::Numeric, nil
|
1026
1032
|
config_attr :metadata, nil, ::Hash, nil
|
@@ -1041,7 +1047,7 @@ module Google
|
|
1041
1047
|
def rpcs
|
1042
1048
|
@rpcs ||= begin
|
1043
1049
|
parent_rpcs = nil
|
1044
|
-
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config
|
1050
|
+
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
|
1045
1051
|
Rpcs.new parent_rpcs
|
1046
1052
|
end
|
1047
1053
|
end
|
@@ -1053,7 +1059,7 @@ module Google
|
|
1053
1059
|
# Each configuration object is of type `Gapic::Config::Method` and includes
|
1054
1060
|
# the following configuration fields:
|
1055
1061
|
#
|
1056
|
-
# * `timeout` (*type:* `Numeric`) - The call timeout in
|
1062
|
+
# * `timeout` (*type:* `Numeric`) - The call timeout in seconds
|
1057
1063
|
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
|
1058
1064
|
# * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
|
1059
1065
|
# include the following keys:
|
@@ -1107,21 +1113,21 @@ module Google
|
|
1107
1113
|
|
1108
1114
|
# @private
|
1109
1115
|
def initialize parent_rpcs = nil
|
1110
|
-
translate_text_config = parent_rpcs
|
1116
|
+
translate_text_config = parent_rpcs.translate_text if parent_rpcs.respond_to? :translate_text
|
1111
1117
|
@translate_text = ::Gapic::Config::Method.new translate_text_config
|
1112
|
-
detect_language_config = parent_rpcs
|
1118
|
+
detect_language_config = parent_rpcs.detect_language if parent_rpcs.respond_to? :detect_language
|
1113
1119
|
@detect_language = ::Gapic::Config::Method.new detect_language_config
|
1114
|
-
get_supported_languages_config = parent_rpcs
|
1120
|
+
get_supported_languages_config = parent_rpcs.get_supported_languages if parent_rpcs.respond_to? :get_supported_languages
|
1115
1121
|
@get_supported_languages = ::Gapic::Config::Method.new get_supported_languages_config
|
1116
|
-
batch_translate_text_config = parent_rpcs
|
1122
|
+
batch_translate_text_config = parent_rpcs.batch_translate_text if parent_rpcs.respond_to? :batch_translate_text
|
1117
1123
|
@batch_translate_text = ::Gapic::Config::Method.new batch_translate_text_config
|
1118
|
-
create_glossary_config = parent_rpcs
|
1124
|
+
create_glossary_config = parent_rpcs.create_glossary if parent_rpcs.respond_to? :create_glossary
|
1119
1125
|
@create_glossary = ::Gapic::Config::Method.new create_glossary_config
|
1120
|
-
list_glossaries_config = parent_rpcs
|
1126
|
+
list_glossaries_config = parent_rpcs.list_glossaries if parent_rpcs.respond_to? :list_glossaries
|
1121
1127
|
@list_glossaries = ::Gapic::Config::Method.new list_glossaries_config
|
1122
|
-
get_glossary_config = parent_rpcs
|
1128
|
+
get_glossary_config = parent_rpcs.get_glossary if parent_rpcs.respond_to? :get_glossary
|
1123
1129
|
@get_glossary = ::Gapic::Config::Method.new get_glossary_config
|
1124
|
-
delete_glossary_config = parent_rpcs
|
1130
|
+
delete_glossary_config = parent_rpcs.delete_glossary if parent_rpcs.respond_to? :delete_glossary
|
1125
1131
|
@delete_glossary = ::Gapic::Config::Method.new delete_glossary_config
|
1126
1132
|
|
1127
1133
|
yield self if block_given?
|
@@ -103,8 +103,13 @@ module Google
|
|
103
103
|
# Lists operations that match the specified filter in the request. If the
|
104
104
|
# server doesn't support this method, it returns `UNIMPLEMENTED`.
|
105
105
|
#
|
106
|
-
# NOTE: the `name` binding
|
107
|
-
# to use different resource name schemes, such as `users/*/operations`.
|
106
|
+
# NOTE: the `name` binding allows API services to override the binding
|
107
|
+
# to use different resource name schemes, such as `users/*/operations`. To
|
108
|
+
# override the binding, API services can add a binding such as
|
109
|
+
# `"/v1/{name=users/*}/operations"` to their service configuration.
|
110
|
+
# For backwards compatibility, the default name includes the operations
|
111
|
+
# collection id, however overriding users must ensure the name binding
|
112
|
+
# is the parent resource, without the operations collection id.
|
108
113
|
#
|
109
114
|
# @overload list_operations(request, options = nil)
|
110
115
|
# Pass arguments to `list_operations` via a request object, either of type
|
@@ -122,7 +127,7 @@ module Google
|
|
122
127
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
123
128
|
#
|
124
129
|
# @param name [::String]
|
125
|
-
# The name of the operation
|
130
|
+
# The name of the operation's parent resource.
|
126
131
|
# @param filter [::String]
|
127
132
|
# The standard list filter.
|
128
133
|
# @param page_size [::Integer]
|
@@ -390,6 +395,79 @@ module Google
|
|
390
395
|
raise ::Google::Cloud::Error.from_error(e)
|
391
396
|
end
|
392
397
|
|
398
|
+
##
|
399
|
+
# Waits for the specified long-running operation until it is done or reaches
|
400
|
+
# at most a specified timeout, returning the latest state. If the operation
|
401
|
+
# is already done, the latest state is immediately returned. If the timeout
|
402
|
+
# specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
|
403
|
+
# timeout is used. If the server does not support this method, it returns
|
404
|
+
# `google.rpc.Code.UNIMPLEMENTED`.
|
405
|
+
# Note that this method is on a best-effort basis. It may return the latest
|
406
|
+
# state before the specified timeout (including immediately), meaning even an
|
407
|
+
# immediate response is no guarantee that the operation is done.
|
408
|
+
#
|
409
|
+
# @overload wait_operation(request, options = nil)
|
410
|
+
# Pass arguments to `wait_operation` via a request object, either of type
|
411
|
+
# {::Google::Longrunning::WaitOperationRequest} or an equivalent Hash.
|
412
|
+
#
|
413
|
+
# @param request [::Google::Longrunning::WaitOperationRequest, ::Hash]
|
414
|
+
# A request object representing the call parameters. Required. To specify no
|
415
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
416
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
417
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
418
|
+
#
|
419
|
+
# @overload wait_operation(name: nil, timeout: nil)
|
420
|
+
# Pass arguments to `wait_operation` via keyword arguments. Note that at
|
421
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
422
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
423
|
+
#
|
424
|
+
# @param name [::String]
|
425
|
+
# The name of the operation resource to wait on.
|
426
|
+
# @param timeout [::Google::Protobuf::Duration, ::Hash]
|
427
|
+
# The maximum duration to wait before timing out. If left blank, the wait
|
428
|
+
# will be at most the time permitted by the underlying HTTP/RPC protocol.
|
429
|
+
# If RPC context deadline is also specified, the shorter one will be used.
|
430
|
+
#
|
431
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
432
|
+
# @yieldparam response [::Gapic::Operation]
|
433
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
434
|
+
#
|
435
|
+
# @return [::Gapic::Operation]
|
436
|
+
#
|
437
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
438
|
+
#
|
439
|
+
def wait_operation request, options = nil
|
440
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
441
|
+
|
442
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Longrunning::WaitOperationRequest
|
443
|
+
|
444
|
+
# Converts hash and nil to an options object
|
445
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
446
|
+
|
447
|
+
# Customize the options with defaults
|
448
|
+
metadata = @config.rpcs.wait_operation.metadata.to_h
|
449
|
+
|
450
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
451
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
452
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
453
|
+
gapic_version: ::Google::Cloud::Translate::V3::VERSION
|
454
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
455
|
+
|
456
|
+
options.apply_defaults timeout: @config.rpcs.wait_operation.timeout,
|
457
|
+
metadata: metadata,
|
458
|
+
retry_policy: @config.rpcs.wait_operation.retry_policy
|
459
|
+
options.apply_defaults metadata: @config.metadata,
|
460
|
+
retry_policy: @config.retry_policy
|
461
|
+
|
462
|
+
@operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
|
463
|
+
response = ::Gapic::Operation.new response, @operations_client, options: options
|
464
|
+
yield response, operation if block_given?
|
465
|
+
return response
|
466
|
+
end
|
467
|
+
rescue ::GRPC::BadStatus => e
|
468
|
+
raise ::Google::Cloud::Error.from_error(e)
|
469
|
+
end
|
470
|
+
|
393
471
|
##
|
394
472
|
# Configuration class for the Operations API.
|
395
473
|
#
|
@@ -475,14 +553,14 @@ module Google
|
|
475
553
|
|
476
554
|
config_attr :endpoint, "translate.googleapis.com", ::String
|
477
555
|
config_attr :credentials, nil do |value|
|
478
|
-
allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
556
|
+
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
479
557
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
480
558
|
allowed.any? { |klass| klass === value }
|
481
559
|
end
|
482
560
|
config_attr :scope, nil, ::String, ::Array, nil
|
483
561
|
config_attr :lib_name, nil, ::String, nil
|
484
562
|
config_attr :lib_version, nil, ::String, nil
|
485
|
-
config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
|
563
|
+
config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
|
486
564
|
config_attr :interceptors, nil, ::Array, nil
|
487
565
|
config_attr :timeout, nil, ::Numeric, nil
|
488
566
|
config_attr :metadata, nil, ::Hash, nil
|
@@ -503,7 +581,7 @@ module Google
|
|
503
581
|
def rpcs
|
504
582
|
@rpcs ||= begin
|
505
583
|
parent_rpcs = nil
|
506
|
-
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config
|
584
|
+
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
|
507
585
|
Rpcs.new parent_rpcs
|
508
586
|
end
|
509
587
|
end
|
@@ -515,7 +593,7 @@ module Google
|
|
515
593
|
# Each configuration object is of type `Gapic::Config::Method` and includes
|
516
594
|
# the following configuration fields:
|
517
595
|
#
|
518
|
-
# * `timeout` (*type:* `Numeric`) - The call timeout in
|
596
|
+
# * `timeout` (*type:* `Numeric`) - The call timeout in seconds
|
519
597
|
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
|
520
598
|
# * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
|
521
599
|
# include the following keys:
|
@@ -546,17 +624,24 @@ module Google
|
|
546
624
|
# @return [::Gapic::Config::Method]
|
547
625
|
#
|
548
626
|
attr_reader :cancel_operation
|
627
|
+
##
|
628
|
+
# RPC-specific configuration for `wait_operation`
|
629
|
+
# @return [::Gapic::Config::Method]
|
630
|
+
#
|
631
|
+
attr_reader :wait_operation
|
549
632
|
|
550
633
|
# @private
|
551
634
|
def initialize parent_rpcs = nil
|
552
|
-
list_operations_config = parent_rpcs
|
635
|
+
list_operations_config = parent_rpcs.list_operations if parent_rpcs.respond_to? :list_operations
|
553
636
|
@list_operations = ::Gapic::Config::Method.new list_operations_config
|
554
|
-
get_operation_config = parent_rpcs
|
637
|
+
get_operation_config = parent_rpcs.get_operation if parent_rpcs.respond_to? :get_operation
|
555
638
|
@get_operation = ::Gapic::Config::Method.new get_operation_config
|
556
|
-
delete_operation_config = parent_rpcs
|
639
|
+
delete_operation_config = parent_rpcs.delete_operation if parent_rpcs.respond_to? :delete_operation
|
557
640
|
@delete_operation = ::Gapic::Config::Method.new delete_operation_config
|
558
|
-
cancel_operation_config = parent_rpcs
|
641
|
+
cancel_operation_config = parent_rpcs.cancel_operation if parent_rpcs.respond_to? :cancel_operation
|
559
642
|
@cancel_operation = ::Gapic::Config::Method.new cancel_operation_config
|
643
|
+
wait_operation_config = parent_rpcs.wait_operation if parent_rpcs.respond_to? :wait_operation
|
644
|
+
@wait_operation = ::Gapic::Config::Method.new wait_operation_config
|
560
645
|
|
561
646
|
yield self if block_given?
|
562
647
|
end
|
@@ -37,11 +37,11 @@ module Google
|
|
37
37
|
self.service_name = 'google.cloud.translation.v3.TranslationService'
|
38
38
|
|
39
39
|
# Translates input text and returns translated text.
|
40
|
-
rpc :TranslateText, Google::Cloud::Translate::V3::TranslateTextRequest, Google::Cloud::Translate::V3::TranslateTextResponse
|
40
|
+
rpc :TranslateText, ::Google::Cloud::Translate::V3::TranslateTextRequest, ::Google::Cloud::Translate::V3::TranslateTextResponse
|
41
41
|
# Detects the language of text within a request.
|
42
|
-
rpc :DetectLanguage, Google::Cloud::Translate::V3::DetectLanguageRequest, Google::Cloud::Translate::V3::DetectLanguageResponse
|
42
|
+
rpc :DetectLanguage, ::Google::Cloud::Translate::V3::DetectLanguageRequest, ::Google::Cloud::Translate::V3::DetectLanguageResponse
|
43
43
|
# Returns a list of supported languages for translation.
|
44
|
-
rpc :GetSupportedLanguages, Google::Cloud::Translate::V3::GetSupportedLanguagesRequest, Google::Cloud::Translate::V3::SupportedLanguages
|
44
|
+
rpc :GetSupportedLanguages, ::Google::Cloud::Translate::V3::GetSupportedLanguagesRequest, ::Google::Cloud::Translate::V3::SupportedLanguages
|
45
45
|
# Translates a large volume of text in asynchronous batch mode.
|
46
46
|
# This function provides real-time output as the inputs are being processed.
|
47
47
|
# If caller cancels a request, the partial results (for an input file, it's
|
@@ -49,20 +49,20 @@ module Google
|
|
49
49
|
#
|
50
50
|
# This call returns immediately and you can
|
51
51
|
# use google.longrunning.Operation.name to poll the status of the call.
|
52
|
-
rpc :BatchTranslateText, Google::Cloud::Translate::V3::BatchTranslateTextRequest, Google::Longrunning::Operation
|
52
|
+
rpc :BatchTranslateText, ::Google::Cloud::Translate::V3::BatchTranslateTextRequest, ::Google::Longrunning::Operation
|
53
53
|
# Creates a glossary and returns the long-running operation. Returns
|
54
54
|
# NOT_FOUND, if the project doesn't exist.
|
55
|
-
rpc :CreateGlossary, Google::Cloud::Translate::V3::CreateGlossaryRequest, Google::Longrunning::Operation
|
55
|
+
rpc :CreateGlossary, ::Google::Cloud::Translate::V3::CreateGlossaryRequest, ::Google::Longrunning::Operation
|
56
56
|
# Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't
|
57
57
|
# exist.
|
58
|
-
rpc :ListGlossaries, Google::Cloud::Translate::V3::ListGlossariesRequest, Google::Cloud::Translate::V3::ListGlossariesResponse
|
58
|
+
rpc :ListGlossaries, ::Google::Cloud::Translate::V3::ListGlossariesRequest, ::Google::Cloud::Translate::V3::ListGlossariesResponse
|
59
59
|
# Gets a glossary. Returns NOT_FOUND, if the glossary doesn't
|
60
60
|
# exist.
|
61
|
-
rpc :GetGlossary, Google::Cloud::Translate::V3::GetGlossaryRequest, Google::Cloud::Translate::V3::Glossary
|
61
|
+
rpc :GetGlossary, ::Google::Cloud::Translate::V3::GetGlossaryRequest, ::Google::Cloud::Translate::V3::Glossary
|
62
62
|
# Deletes a glossary, or cancels glossary construction
|
63
63
|
# if the glossary isn't created yet.
|
64
64
|
# Returns NOT_FOUND, if the glossary doesn't exist.
|
65
|
-
rpc :DeleteGlossary, Google::Cloud::Translate::V3::DeleteGlossaryRequest, Google::Longrunning::Operation
|
65
|
+
rpc :DeleteGlossary, ::Google::Cloud::Translate::V3::DeleteGlossaryRequest, ::Google::Longrunning::Operation
|
66
66
|
end
|
67
67
|
|
68
68
|
Stub = Service.rpc_stub_class
|
@@ -54,6 +54,12 @@ module Google
|
|
54
54
|
# This indicates that the field may be set once in a request to create a
|
55
55
|
# resource, but may not be changed thereafter.
|
56
56
|
IMMUTABLE = 5
|
57
|
+
|
58
|
+
# Denotes that a (repeated) field is an unordered list.
|
59
|
+
# This indicates that the service may provide the elements of the list
|
60
|
+
# in any arbitrary order, rather than the order the user originally
|
61
|
+
# provided. Additionally, the list's order may or may not be stable.
|
62
|
+
UNORDERED_LIST = 6
|
57
63
|
end
|
58
64
|
end
|
59
65
|
end
|
@@ -43,12 +43,12 @@ module Google
|
|
43
43
|
#
|
44
44
|
# The ResourceDescriptor Yaml config will look like:
|
45
45
|
#
|
46
|
-
#
|
47
|
-
#
|
48
|
-
#
|
49
|
-
#
|
50
|
-
#
|
51
|
-
#
|
46
|
+
# resources:
|
47
|
+
# - type: "pubsub.googleapis.com/Topic"
|
48
|
+
# name_descriptor:
|
49
|
+
# - pattern: "projects/{project}/topics/{topic}"
|
50
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
51
|
+
# parent_name_extractor: "projects/{project}"
|
52
52
|
#
|
53
53
|
# Sometimes, resources have multiple patterns, typically because they can
|
54
54
|
# live under multiple parents.
|
@@ -183,15 +183,24 @@ module Google
|
|
183
183
|
# }
|
184
184
|
# @!attribute [rw] plural
|
185
185
|
# @return [::String]
|
186
|
-
# The plural name used in the resource name, such as
|
187
|
-
# the name of 'projects/\\{project}'
|
188
|
-
#
|
186
|
+
# The plural name used in the resource name and permission names, such as
|
187
|
+
# 'projects' for the resource name of 'projects/\\{project}' and the permission
|
188
|
+
# name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
|
189
|
+
# concept of the `plural` field in k8s CRD spec
|
189
190
|
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
191
|
+
#
|
192
|
+
# Note: The plural form is required even for singleton resources. See
|
193
|
+
# https://aip.dev/156
|
190
194
|
# @!attribute [rw] singular
|
191
195
|
# @return [::String]
|
192
196
|
# The same concept of the `singular` field in k8s CRD spec
|
193
197
|
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
194
198
|
# Such as "project" for the `resourcemanager.googleapis.com/Project` type.
|
199
|
+
# @!attribute [rw] style
|
200
|
+
# @return [::Array<::Google::Api::ResourceDescriptor::Style>]
|
201
|
+
# Style flag(s) for this resource.
|
202
|
+
# These indicate that a resource is expected to conform to a given
|
203
|
+
# style. See the specific style flags for additional information.
|
195
204
|
class ResourceDescriptor
|
196
205
|
include ::Google::Protobuf::MessageExts
|
197
206
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -211,6 +220,22 @@ module Google
|
|
211
220
|
# that from being necessary once there are multiple patterns.)
|
212
221
|
FUTURE_MULTI_PATTERN = 2
|
213
222
|
end
|
223
|
+
|
224
|
+
# A flag representing a specific style that a resource claims to conform to.
|
225
|
+
module Style
|
226
|
+
# The unspecified value. Do not use.
|
227
|
+
STYLE_UNSPECIFIED = 0
|
228
|
+
|
229
|
+
# This resource is intended to be "declarative-friendly".
|
230
|
+
#
|
231
|
+
# Declarative-friendly resources must be more strictly consistent, and
|
232
|
+
# setting this to true communicates to tools that this resource should
|
233
|
+
# adhere to declarative-friendly expectations.
|
234
|
+
#
|
235
|
+
# Note: This is used by the API linter (linter.aip.dev) to enable
|
236
|
+
# additional checks.
|
237
|
+
DECLARATIVE_FRIENDLY = 1
|
238
|
+
end
|
214
239
|
end
|
215
240
|
|
216
241
|
# Defines a proto annotation that describes a string field that refers to
|
@@ -226,6 +251,17 @@ module Google
|
|
226
251
|
# type: "pubsub.googleapis.com/Topic"
|
227
252
|
# }];
|
228
253
|
# }
|
254
|
+
#
|
255
|
+
# Occasionally, a field may reference an arbitrary resource. In this case,
|
256
|
+
# APIs use the special value * in their resource reference.
|
257
|
+
#
|
258
|
+
# Example:
|
259
|
+
#
|
260
|
+
# message GetIamPolicyRequest {
|
261
|
+
# string resource = 2 [(google.api.resource_reference) = {
|
262
|
+
# type: "*"
|
263
|
+
# }];
|
264
|
+
# }
|
229
265
|
# @!attribute [rw] child_type
|
230
266
|
# @return [::String]
|
231
267
|
# The resource type of a child collection that the annotated field
|
@@ -234,11 +270,11 @@ module Google
|
|
234
270
|
#
|
235
271
|
# Example:
|
236
272
|
#
|
237
|
-
#
|
238
|
-
#
|
239
|
-
#
|
240
|
-
#
|
241
|
-
#
|
273
|
+
# message ListLogEntriesRequest {
|
274
|
+
# string parent = 1 [(google.api.resource_reference) = {
|
275
|
+
# child_type: "logging.googleapis.com/LogEntry"
|
276
|
+
# };
|
277
|
+
# }
|
242
278
|
class ResourceReference
|
243
279
|
include ::Google::Protobuf::MessageExts
|
244
280
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|