google-cloud-security_center-v2 0.a → 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (115) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/README.md +144 -8
  5. data/lib/google/cloud/security_center/v2/rest.rb +37 -0
  6. data/lib/google/cloud/security_center/v2/security_center/client.rb +4728 -0
  7. data/lib/google/cloud/security_center/v2/security_center/credentials.rb +51 -0
  8. data/lib/google/cloud/security_center/v2/security_center/operations.rb +801 -0
  9. data/lib/google/cloud/security_center/v2/security_center/paths.rb +973 -0
  10. data/lib/google/cloud/security_center/v2/security_center/rest/client.rb +4347 -0
  11. data/lib/google/cloud/security_center/v2/security_center/rest/operations.rb +894 -0
  12. data/lib/google/cloud/security_center/v2/security_center/rest/service_stub.rb +3165 -0
  13. data/lib/google/cloud/security_center/v2/security_center/rest.rb +53 -0
  14. data/lib/google/cloud/security_center/v2/security_center.rb +56 -0
  15. data/lib/google/cloud/security_center/v2/version.rb +7 -2
  16. data/lib/google/cloud/security_center/v2.rb +45 -0
  17. data/lib/google/cloud/securitycenter/v2/access_pb.rb +44 -0
  18. data/lib/google/cloud/securitycenter/v2/application_pb.rb +42 -0
  19. data/lib/google/cloud/securitycenter/v2/attack_exposure_pb.rb +47 -0
  20. data/lib/google/cloud/securitycenter/v2/attack_path_pb.rb +49 -0
  21. data/lib/google/cloud/securitycenter/v2/backup_disaster_recovery_pb.rb +45 -0
  22. data/lib/google/cloud/securitycenter/v2/bigquery_export_pb.rb +47 -0
  23. data/lib/google/cloud/securitycenter/v2/cloud_dlp_data_profile_pb.rb +45 -0
  24. data/lib/google/cloud/securitycenter/v2/cloud_dlp_inspection_pb.rb +44 -0
  25. data/lib/google/cloud/securitycenter/v2/compliance_pb.rb +42 -0
  26. data/lib/google/cloud/securitycenter/v2/connection_pb.rb +43 -0
  27. data/lib/google/cloud/securitycenter/v2/contact_details_pb.rb +43 -0
  28. data/lib/google/cloud/securitycenter/v2/container_pb.rb +47 -0
  29. data/lib/google/cloud/securitycenter/v2/database_pb.rb +42 -0
  30. data/lib/google/cloud/securitycenter/v2/exfiltration_pb.rb +43 -0
  31. data/lib/google/cloud/securitycenter/v2/external_system_pb.rb +47 -0
  32. data/lib/google/cloud/securitycenter/v2/file_pb.rb +43 -0
  33. data/lib/google/cloud/securitycenter/v2/finding_pb.rb +105 -0
  34. data/lib/google/cloud/securitycenter/v2/iam_binding_pb.rb +43 -0
  35. data/lib/google/cloud/securitycenter/v2/indicator_pb.rb +47 -0
  36. data/lib/google/cloud/securitycenter/v2/kernel_rootkit_pb.rb +42 -0
  37. data/lib/google/cloud/securitycenter/v2/kubernetes_pb.rb +57 -0
  38. data/lib/google/cloud/securitycenter/v2/label_pb.rb +42 -0
  39. data/lib/google/cloud/securitycenter/v2/load_balancer_pb.rb +42 -0
  40. data/lib/google/cloud/securitycenter/v2/log_entry_pb.rb +46 -0
  41. data/lib/google/cloud/securitycenter/v2/mitre_attack_pb.rb +44 -0
  42. data/lib/google/cloud/securitycenter/v2/mute_config_pb.rb +48 -0
  43. data/lib/google/cloud/securitycenter/v2/notification_config_pb.rb +46 -0
  44. data/lib/google/cloud/securitycenter/v2/notification_message_pb.rb +47 -0
  45. data/lib/google/cloud/securitycenter/v2/org_policy_pb.rb +44 -0
  46. data/lib/google/cloud/securitycenter/v2/process_pb.rb +46 -0
  47. data/lib/google/cloud/securitycenter/v2/resource_pb.rb +44 -0
  48. data/lib/google/cloud/securitycenter/v2/resource_value_config_pb.rb +49 -0
  49. data/lib/google/cloud/securitycenter/v2/security_marks_pb.rb +44 -0
  50. data/lib/google/cloud/securitycenter/v2/security_posture_pb.rb +43 -0
  51. data/lib/google/cloud/securitycenter/v2/securitycenter_service_pb.rb +128 -0
  52. data/lib/google/cloud/securitycenter/v2/securitycenter_service_services_pb.rb +167 -0
  53. data/lib/google/cloud/securitycenter/v2/simulation_pb.rb +49 -0
  54. data/lib/google/cloud/securitycenter/v2/source_pb.rb +44 -0
  55. data/lib/google/cloud/securitycenter/v2/valued_resource_pb.rb +46 -0
  56. data/lib/google/cloud/securitycenter/v2/vulnerability_pb.rb +58 -0
  57. data/lib/google-cloud-security_center-v2.rb +21 -0
  58. data/proto_docs/README.md +4 -0
  59. data/proto_docs/google/api/client.rb +399 -0
  60. data/proto_docs/google/api/field_behavior.rb +85 -0
  61. data/proto_docs/google/api/launch_stage.rb +71 -0
  62. data/proto_docs/google/api/resource.rb +222 -0
  63. data/proto_docs/google/api/routing.rb +459 -0
  64. data/proto_docs/google/cloud/securitycenter/v2/access.rb +120 -0
  65. data/proto_docs/google/cloud/securitycenter/v2/application.rb +40 -0
  66. data/proto_docs/google/cloud/securitycenter/v2/attack_exposure.rb +73 -0
  67. data/proto_docs/google/cloud/securitycenter/v2/attack_path.rb +147 -0
  68. data/proto_docs/google/cloud/securitycenter/v2/backup_disaster_recovery.rb +90 -0
  69. data/proto_docs/google/cloud/securitycenter/v2/bigquery_export.rb +96 -0
  70. data/proto_docs/google/cloud/securitycenter/v2/cloud_dlp_data_profile.rb +52 -0
  71. data/proto_docs/google/cloud/securitycenter/v2/cloud_dlp_inspection.rb +50 -0
  72. data/proto_docs/google/cloud/securitycenter/v2/compliance.rb +43 -0
  73. data/proto_docs/google/cloud/securitycenter/v2/connection.rb +70 -0
  74. data/proto_docs/google/cloud/securitycenter/v2/contact_details.rb +44 -0
  75. data/proto_docs/google/cloud/securitycenter/v2/container.rb +49 -0
  76. data/proto_docs/google/cloud/securitycenter/v2/database.rb +67 -0
  77. data/proto_docs/google/cloud/securitycenter/v2/exfiltration.rb +64 -0
  78. data/proto_docs/google/cloud/securitycenter/v2/external_system.rb +106 -0
  79. data/proto_docs/google/cloud/securitycenter/v2/file.rb +72 -0
  80. data/proto_docs/google/cloud/securitycenter/v2/finding.rb +411 -0
  81. data/proto_docs/google/cloud/securitycenter/v2/iam_binding.rb +56 -0
  82. data/proto_docs/google/cloud/securitycenter/v2/indicator.rb +112 -0
  83. data/proto_docs/google/cloud/securitycenter/v2/kernel_rootkit.rb +66 -0
  84. data/proto_docs/google/cloud/securitycenter/v2/kubernetes.rb +241 -0
  85. data/proto_docs/google/cloud/securitycenter/v2/label.rb +41 -0
  86. data/proto_docs/google/cloud/securitycenter/v2/load_balancer.rb +36 -0
  87. data/proto_docs/google/cloud/securitycenter/v2/log_entry.rb +58 -0
  88. data/proto_docs/google/cloud/securitycenter/v2/mitre_attack.rb +285 -0
  89. data/proto_docs/google/cloud/securitycenter/v2/mute_config.rb +100 -0
  90. data/proto_docs/google/cloud/securitycenter/v2/notification_config.rb +90 -0
  91. data/proto_docs/google/cloud/securitycenter/v2/notification_message.rb +42 -0
  92. data/proto_docs/google/cloud/securitycenter/v2/org_policy.rb +37 -0
  93. data/proto_docs/google/cloud/securitycenter/v2/process.rb +79 -0
  94. data/proto_docs/google/cloud/securitycenter/v2/resource.rb +42 -0
  95. data/proto_docs/google/cloud/securitycenter/v2/resource_value_config.rb +122 -0
  96. data/proto_docs/google/cloud/securitycenter/v2/security_marks.rb +84 -0
  97. data/proto_docs/google/cloud/securitycenter/v2/security_posture.rb +83 -0
  98. data/proto_docs/google/cloud/securitycenter/v2/securitycenter_service.rb +1136 -0
  99. data/proto_docs/google/cloud/securitycenter/v2/simulation.rb +43 -0
  100. data/proto_docs/google/cloud/securitycenter/v2/source.rb +65 -0
  101. data/proto_docs/google/cloud/securitycenter/v2/valued_resource.rb +86 -0
  102. data/proto_docs/google/cloud/securitycenter/v2/vulnerability.rb +333 -0
  103. data/proto_docs/google/iam/v1/iam_policy.rb +87 -0
  104. data/proto_docs/google/iam/v1/options.rb +50 -0
  105. data/proto_docs/google/iam/v1/policy.rb +426 -0
  106. data/proto_docs/google/longrunning/operations.rb +164 -0
  107. data/proto_docs/google/protobuf/any.rb +145 -0
  108. data/proto_docs/google/protobuf/duration.rb +98 -0
  109. data/proto_docs/google/protobuf/empty.rb +34 -0
  110. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  111. data/proto_docs/google/protobuf/struct.rb +96 -0
  112. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  113. data/proto_docs/google/rpc/status.rb +48 -0
  114. data/proto_docs/google/type/expr.rb +75 -0
  115. metadata +169 -10
@@ -0,0 +1,222 @@
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
+ # A simple descriptor of a resource type.
23
+ #
24
+ # ResourceDescriptor annotates a resource message (either by means of a
25
+ # protobuf annotation or use in the service config), and associates the
26
+ # resource's schema, the resource type, and the pattern of the resource name.
27
+ #
28
+ # Example:
29
+ #
30
+ # message Topic {
31
+ # // Indicates this message defines a resource schema.
32
+ # // Declares the resource type in the format of {service}/{kind}.
33
+ # // For Kubernetes resources, the format is {api group}/{kind}.
34
+ # option (google.api.resource) = {
35
+ # type: "pubsub.googleapis.com/Topic"
36
+ # pattern: "projects/{project}/topics/{topic}"
37
+ # };
38
+ # }
39
+ #
40
+ # The ResourceDescriptor Yaml config will look like:
41
+ #
42
+ # resources:
43
+ # - type: "pubsub.googleapis.com/Topic"
44
+ # pattern: "projects/{project}/topics/{topic}"
45
+ #
46
+ # Sometimes, resources have multiple patterns, typically because they can
47
+ # live under multiple parents.
48
+ #
49
+ # Example:
50
+ #
51
+ # message LogEntry {
52
+ # option (google.api.resource) = {
53
+ # type: "logging.googleapis.com/LogEntry"
54
+ # pattern: "projects/{project}/logs/{log}"
55
+ # pattern: "folders/{folder}/logs/{log}"
56
+ # pattern: "organizations/{organization}/logs/{log}"
57
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
58
+ # };
59
+ # }
60
+ #
61
+ # The ResourceDescriptor Yaml config will look like:
62
+ #
63
+ # resources:
64
+ # - type: 'logging.googleapis.com/LogEntry'
65
+ # pattern: "projects/{project}/logs/{log}"
66
+ # pattern: "folders/{folder}/logs/{log}"
67
+ # pattern: "organizations/{organization}/logs/{log}"
68
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
69
+ # @!attribute [rw] type
70
+ # @return [::String]
71
+ # The resource type. It must be in the format of
72
+ # \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
73
+ # singular and must not include version numbers.
74
+ #
75
+ # Example: `storage.googleapis.com/Bucket`
76
+ #
77
+ # The value of the resource_type_kind must follow the regular expression
78
+ # /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
79
+ # should use PascalCase (UpperCamelCase). The maximum number of
80
+ # characters allowed for the `resource_type_kind` is 100.
81
+ # @!attribute [rw] pattern
82
+ # @return [::Array<::String>]
83
+ # Optional. The relative resource name pattern associated with this resource
84
+ # type. The DNS prefix of the full resource name shouldn't be specified here.
85
+ #
86
+ # The path pattern must follow the syntax, which aligns with HTTP binding
87
+ # syntax:
88
+ #
89
+ # Template = Segment { "/" Segment } ;
90
+ # Segment = LITERAL | Variable ;
91
+ # Variable = "{" LITERAL "}" ;
92
+ #
93
+ # Examples:
94
+ #
95
+ # - "projects/\\{project}/topics/\\{topic}"
96
+ # - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
97
+ #
98
+ # The components in braces correspond to the IDs for each resource in the
99
+ # hierarchy. It is expected that, if multiple patterns are provided,
100
+ # the same component name (e.g. "project") refers to IDs of the same
101
+ # type of resource.
102
+ # @!attribute [rw] name_field
103
+ # @return [::String]
104
+ # Optional. The field on the resource that designates the resource name
105
+ # field. If omitted, this is assumed to be "name".
106
+ # @!attribute [rw] history
107
+ # @return [::Google::Api::ResourceDescriptor::History]
108
+ # Optional. The historical or future-looking state of the resource pattern.
109
+ #
110
+ # Example:
111
+ #
112
+ # // The InspectTemplate message originally only supported resource
113
+ # // names with organization, and project was added later.
114
+ # message InspectTemplate {
115
+ # option (google.api.resource) = {
116
+ # type: "dlp.googleapis.com/InspectTemplate"
117
+ # pattern:
118
+ # "organizations/{organization}/inspectTemplates/{inspect_template}"
119
+ # pattern: "projects/{project}/inspectTemplates/{inspect_template}"
120
+ # history: ORIGINALLY_SINGLE_PATTERN
121
+ # };
122
+ # }
123
+ # @!attribute [rw] plural
124
+ # @return [::String]
125
+ # The plural name used in the resource name and permission names, such as
126
+ # 'projects' for the resource name of 'projects/\\{project}' and the permission
127
+ # name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
128
+ # concept of the `plural` field in k8s CRD spec
129
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
130
+ #
131
+ # Note: The plural form is required even for singleton resources. See
132
+ # https://aip.dev/156
133
+ # @!attribute [rw] singular
134
+ # @return [::String]
135
+ # The same concept of the `singular` field in k8s CRD spec
136
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
137
+ # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
138
+ # @!attribute [rw] style
139
+ # @return [::Array<::Google::Api::ResourceDescriptor::Style>]
140
+ # Style flag(s) for this resource.
141
+ # These indicate that a resource is expected to conform to a given
142
+ # style. See the specific style flags for additional information.
143
+ class ResourceDescriptor
144
+ include ::Google::Protobuf::MessageExts
145
+ extend ::Google::Protobuf::MessageExts::ClassMethods
146
+
147
+ # A description of the historical or future-looking state of the
148
+ # resource pattern.
149
+ module History
150
+ # The "unset" value.
151
+ HISTORY_UNSPECIFIED = 0
152
+
153
+ # The resource originally had one pattern and launched as such, and
154
+ # additional patterns were added later.
155
+ ORIGINALLY_SINGLE_PATTERN = 1
156
+
157
+ # The resource has one pattern, but the API owner expects to add more
158
+ # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
159
+ # that from being necessary once there are multiple patterns.)
160
+ FUTURE_MULTI_PATTERN = 2
161
+ end
162
+
163
+ # A flag representing a specific style that a resource claims to conform to.
164
+ module Style
165
+ # The unspecified value. Do not use.
166
+ STYLE_UNSPECIFIED = 0
167
+
168
+ # This resource is intended to be "declarative-friendly".
169
+ #
170
+ # Declarative-friendly resources must be more strictly consistent, and
171
+ # setting this to true communicates to tools that this resource should
172
+ # adhere to declarative-friendly expectations.
173
+ #
174
+ # Note: This is used by the API linter (linter.aip.dev) to enable
175
+ # additional checks.
176
+ DECLARATIVE_FRIENDLY = 1
177
+ end
178
+ end
179
+
180
+ # Defines a proto annotation that describes a string field that refers to
181
+ # an API resource.
182
+ # @!attribute [rw] type
183
+ # @return [::String]
184
+ # The resource type that the annotated field references.
185
+ #
186
+ # Example:
187
+ #
188
+ # message Subscription {
189
+ # string topic = 2 [(google.api.resource_reference) = {
190
+ # type: "pubsub.googleapis.com/Topic"
191
+ # }];
192
+ # }
193
+ #
194
+ # Occasionally, a field may reference an arbitrary resource. In this case,
195
+ # APIs use the special value * in their resource reference.
196
+ #
197
+ # Example:
198
+ #
199
+ # message GetIamPolicyRequest {
200
+ # string resource = 2 [(google.api.resource_reference) = {
201
+ # type: "*"
202
+ # }];
203
+ # }
204
+ # @!attribute [rw] child_type
205
+ # @return [::String]
206
+ # The resource type of a child collection that the annotated field
207
+ # references. This is useful for annotating the `parent` field that
208
+ # doesn't have a fixed resource type.
209
+ #
210
+ # Example:
211
+ #
212
+ # message ListLogEntriesRequest {
213
+ # string parent = 1 [(google.api.resource_reference) = {
214
+ # child_type: "logging.googleapis.com/LogEntry"
215
+ # };
216
+ # }
217
+ class ResourceReference
218
+ include ::Google::Protobuf::MessageExts
219
+ extend ::Google::Protobuf::MessageExts::ClassMethods
220
+ end
221
+ end
222
+ end
@@ -0,0 +1,459 @@
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
+ # Specifies the routing information that should be sent along with the request
23
+ # in the form of routing header.
24
+ # **NOTE:** All service configuration rules follow the "last one wins" order.
25
+ #
26
+ # The examples below will apply to an RPC which has the following request type:
27
+ #
28
+ # Message Definition:
29
+ #
30
+ # message Request {
31
+ # // The name of the Table
32
+ # // Values can be of the following formats:
33
+ # // - `projects/<project>/tables/<table>`
34
+ # // - `projects/<project>/instances/<instance>/tables/<table>`
35
+ # // - `region/<region>/zones/<zone>/tables/<table>`
36
+ # string table_name = 1;
37
+ #
38
+ # // This value specifies routing for replication.
39
+ # // It can be in the following formats:
40
+ # // - `profiles/<profile_id>`
41
+ # // - a legacy `profile_id` that can be any string
42
+ # string app_profile_id = 2;
43
+ # }
44
+ #
45
+ # Example message:
46
+ #
47
+ # {
48
+ # table_name: projects/proj_foo/instances/instance_bar/table/table_baz,
49
+ # app_profile_id: profiles/prof_qux
50
+ # }
51
+ #
52
+ # The routing header consists of one or multiple key-value pairs. Every key
53
+ # and value must be percent-encoded, and joined together in the format of
54
+ # `key1=value1&key2=value2`.
55
+ # In the examples below I am skipping the percent-encoding for readablity.
56
+ #
57
+ # Example 1
58
+ #
59
+ # Extracting a field from the request to put into the routing header
60
+ # unchanged, with the key equal to the field name.
61
+ #
62
+ # annotation:
63
+ #
64
+ # option (google.api.routing) = {
65
+ # // Take the `app_profile_id`.
66
+ # routing_parameters {
67
+ # field: "app_profile_id"
68
+ # }
69
+ # };
70
+ #
71
+ # result:
72
+ #
73
+ # x-goog-request-params: app_profile_id=profiles/prof_qux
74
+ #
75
+ # Example 2
76
+ #
77
+ # Extracting a field from the request to put into the routing header
78
+ # unchanged, with the key different from the field name.
79
+ #
80
+ # annotation:
81
+ #
82
+ # option (google.api.routing) = {
83
+ # // Take the `app_profile_id`, but name it `routing_id` in the header.
84
+ # routing_parameters {
85
+ # field: "app_profile_id"
86
+ # path_template: "{routing_id=**}"
87
+ # }
88
+ # };
89
+ #
90
+ # result:
91
+ #
92
+ # x-goog-request-params: routing_id=profiles/prof_qux
93
+ #
94
+ # Example 3
95
+ #
96
+ # Extracting a field from the request to put into the routing
97
+ # header, while matching a path template syntax on the field's value.
98
+ #
99
+ # NB: it is more useful to send nothing than to send garbage for the purpose
100
+ # of dynamic routing, since garbage pollutes cache. Thus the matching.
101
+ #
102
+ # Sub-example 3a
103
+ #
104
+ # The field matches the template.
105
+ #
106
+ # annotation:
107
+ #
108
+ # option (google.api.routing) = {
109
+ # // Take the `table_name`, if it's well-formed (with project-based
110
+ # // syntax).
111
+ # routing_parameters {
112
+ # field: "table_name"
113
+ # path_template: "{table_name=projects/*/instances/*/**}"
114
+ # }
115
+ # };
116
+ #
117
+ # result:
118
+ #
119
+ # x-goog-request-params:
120
+ # table_name=projects/proj_foo/instances/instance_bar/table/table_baz
121
+ #
122
+ # Sub-example 3b
123
+ #
124
+ # The field does not match the template.
125
+ #
126
+ # annotation:
127
+ #
128
+ # option (google.api.routing) = {
129
+ # // Take the `table_name`, if it's well-formed (with region-based
130
+ # // syntax).
131
+ # routing_parameters {
132
+ # field: "table_name"
133
+ # path_template: "{table_name=regions/*/zones/*/**}"
134
+ # }
135
+ # };
136
+ #
137
+ # result:
138
+ #
139
+ # <no routing header will be sent>
140
+ #
141
+ # Sub-example 3c
142
+ #
143
+ # Multiple alternative conflictingly named path templates are
144
+ # specified. The one that matches is used to construct the header.
145
+ #
146
+ # annotation:
147
+ #
148
+ # option (google.api.routing) = {
149
+ # // Take the `table_name`, if it's well-formed, whether
150
+ # // using the region- or projects-based syntax.
151
+ #
152
+ # routing_parameters {
153
+ # field: "table_name"
154
+ # path_template: "{table_name=regions/*/zones/*/**}"
155
+ # }
156
+ # routing_parameters {
157
+ # field: "table_name"
158
+ # path_template: "{table_name=projects/*/instances/*/**}"
159
+ # }
160
+ # };
161
+ #
162
+ # result:
163
+ #
164
+ # x-goog-request-params:
165
+ # table_name=projects/proj_foo/instances/instance_bar/table/table_baz
166
+ #
167
+ # Example 4
168
+ #
169
+ # Extracting a single routing header key-value pair by matching a
170
+ # template syntax on (a part of) a single request field.
171
+ #
172
+ # annotation:
173
+ #
174
+ # option (google.api.routing) = {
175
+ # // Take just the project id from the `table_name` field.
176
+ # routing_parameters {
177
+ # field: "table_name"
178
+ # path_template: "{routing_id=projects/*}/**"
179
+ # }
180
+ # };
181
+ #
182
+ # result:
183
+ #
184
+ # x-goog-request-params: routing_id=projects/proj_foo
185
+ #
186
+ # Example 5
187
+ #
188
+ # Extracting a single routing header key-value pair by matching
189
+ # several conflictingly named path templates on (parts of) a single request
190
+ # field. The last template to match "wins" the conflict.
191
+ #
192
+ # annotation:
193
+ #
194
+ # option (google.api.routing) = {
195
+ # // If the `table_name` does not have instances information,
196
+ # // take just the project id for routing.
197
+ # // Otherwise take project + instance.
198
+ #
199
+ # routing_parameters {
200
+ # field: "table_name"
201
+ # path_template: "{routing_id=projects/*}/**"
202
+ # }
203
+ # routing_parameters {
204
+ # field: "table_name"
205
+ # path_template: "{routing_id=projects/*/instances/*}/**"
206
+ # }
207
+ # };
208
+ #
209
+ # result:
210
+ #
211
+ # x-goog-request-params:
212
+ # routing_id=projects/proj_foo/instances/instance_bar
213
+ #
214
+ # Example 6
215
+ #
216
+ # Extracting multiple routing header key-value pairs by matching
217
+ # several non-conflicting path templates on (parts of) a single request field.
218
+ #
219
+ # Sub-example 6a
220
+ #
221
+ # Make the templates strict, so that if the `table_name` does not
222
+ # have an instance information, nothing is sent.
223
+ #
224
+ # annotation:
225
+ #
226
+ # option (google.api.routing) = {
227
+ # // The routing code needs two keys instead of one composite
228
+ # // but works only for the tables with the "project-instance" name
229
+ # // syntax.
230
+ #
231
+ # routing_parameters {
232
+ # field: "table_name"
233
+ # path_template: "{project_id=projects/*}/instances/*/**"
234
+ # }
235
+ # routing_parameters {
236
+ # field: "table_name"
237
+ # path_template: "projects/*/{instance_id=instances/*}/**"
238
+ # }
239
+ # };
240
+ #
241
+ # result:
242
+ #
243
+ # x-goog-request-params:
244
+ # project_id=projects/proj_foo&instance_id=instances/instance_bar
245
+ #
246
+ # Sub-example 6b
247
+ #
248
+ # Make the templates loose, so that if the `table_name` does not
249
+ # have an instance information, just the project id part is sent.
250
+ #
251
+ # annotation:
252
+ #
253
+ # option (google.api.routing) = {
254
+ # // The routing code wants two keys instead of one composite
255
+ # // but will work with just the `project_id` for tables without
256
+ # // an instance in the `table_name`.
257
+ #
258
+ # routing_parameters {
259
+ # field: "table_name"
260
+ # path_template: "{project_id=projects/*}/**"
261
+ # }
262
+ # routing_parameters {
263
+ # field: "table_name"
264
+ # path_template: "projects/*/{instance_id=instances/*}/**"
265
+ # }
266
+ # };
267
+ #
268
+ # result (is the same as 6a for our example message because it has the instance
269
+ # information):
270
+ #
271
+ # x-goog-request-params:
272
+ # project_id=projects/proj_foo&instance_id=instances/instance_bar
273
+ #
274
+ # Example 7
275
+ #
276
+ # Extracting multiple routing header key-value pairs by matching
277
+ # several path templates on multiple request fields.
278
+ #
279
+ # NB: note that here there is no way to specify sending nothing if one of the
280
+ # fields does not match its template. E.g. if the `table_name` is in the wrong
281
+ # format, the `project_id` will not be sent, but the `routing_id` will be.
282
+ # The backend routing code has to be aware of that and be prepared to not
283
+ # receive a full complement of keys if it expects multiple.
284
+ #
285
+ # annotation:
286
+ #
287
+ # option (google.api.routing) = {
288
+ # // The routing needs both `project_id` and `routing_id`
289
+ # // (from the `app_profile_id` field) for routing.
290
+ #
291
+ # routing_parameters {
292
+ # field: "table_name"
293
+ # path_template: "{project_id=projects/*}/**"
294
+ # }
295
+ # routing_parameters {
296
+ # field: "app_profile_id"
297
+ # path_template: "{routing_id=**}"
298
+ # }
299
+ # };
300
+ #
301
+ # result:
302
+ #
303
+ # x-goog-request-params:
304
+ # project_id=projects/proj_foo&routing_id=profiles/prof_qux
305
+ #
306
+ # Example 8
307
+ #
308
+ # Extracting a single routing header key-value pair by matching
309
+ # several conflictingly named path templates on several request fields. The
310
+ # last template to match "wins" the conflict.
311
+ #
312
+ # annotation:
313
+ #
314
+ # option (google.api.routing) = {
315
+ # // The `routing_id` can be a project id or a region id depending on
316
+ # // the table name format, but only if the `app_profile_id` is not set.
317
+ # // If `app_profile_id` is set it should be used instead.
318
+ #
319
+ # routing_parameters {
320
+ # field: "table_name"
321
+ # path_template: "{routing_id=projects/*}/**"
322
+ # }
323
+ # routing_parameters {
324
+ # field: "table_name"
325
+ # path_template: "{routing_id=regions/*}/**"
326
+ # }
327
+ # routing_parameters {
328
+ # field: "app_profile_id"
329
+ # path_template: "{routing_id=**}"
330
+ # }
331
+ # };
332
+ #
333
+ # result:
334
+ #
335
+ # x-goog-request-params: routing_id=profiles/prof_qux
336
+ #
337
+ # Example 9
338
+ #
339
+ # Bringing it all together.
340
+ #
341
+ # annotation:
342
+ #
343
+ # option (google.api.routing) = {
344
+ # // For routing both `table_location` and a `routing_id` are needed.
345
+ # //
346
+ # // table_location can be either an instance id or a region+zone id.
347
+ # //
348
+ # // For `routing_id`, take the value of `app_profile_id`
349
+ # // - If it's in the format `profiles/<profile_id>`, send
350
+ # // just the `<profile_id>` part.
351
+ # // - If it's any other literal, send it as is.
352
+ # // If the `app_profile_id` is empty, and the `table_name` starts with
353
+ # // the project_id, send that instead.
354
+ #
355
+ # routing_parameters {
356
+ # field: "table_name"
357
+ # path_template: "projects/*/{table_location=instances/*}/tables/*"
358
+ # }
359
+ # routing_parameters {
360
+ # field: "table_name"
361
+ # path_template: "{table_location=regions/*/zones/*}/tables/*"
362
+ # }
363
+ # routing_parameters {
364
+ # field: "table_name"
365
+ # path_template: "{routing_id=projects/*}/**"
366
+ # }
367
+ # routing_parameters {
368
+ # field: "app_profile_id"
369
+ # path_template: "{routing_id=**}"
370
+ # }
371
+ # routing_parameters {
372
+ # field: "app_profile_id"
373
+ # path_template: "profiles/{routing_id=*}"
374
+ # }
375
+ # };
376
+ #
377
+ # result:
378
+ #
379
+ # x-goog-request-params:
380
+ # table_location=instances/instance_bar&routing_id=prof_qux
381
+ # @!attribute [rw] routing_parameters
382
+ # @return [::Array<::Google::Api::RoutingParameter>]
383
+ # A collection of Routing Parameter specifications.
384
+ # **NOTE:** If multiple Routing Parameters describe the same key
385
+ # (via the `path_template` field or via the `field` field when
386
+ # `path_template` is not provided), "last one wins" rule
387
+ # determines which Parameter gets used.
388
+ # See the examples for more details.
389
+ class RoutingRule
390
+ include ::Google::Protobuf::MessageExts
391
+ extend ::Google::Protobuf::MessageExts::ClassMethods
392
+ end
393
+
394
+ # A projection from an input message to the GRPC or REST header.
395
+ # @!attribute [rw] field
396
+ # @return [::String]
397
+ # A request field to extract the header key-value pair from.
398
+ # @!attribute [rw] path_template
399
+ # @return [::String]
400
+ # A pattern matching the key-value field. Optional.
401
+ # If not specified, the whole field specified in the `field` field will be
402
+ # taken as value, and its name used as key. If specified, it MUST contain
403
+ # exactly one named segment (along with any number of unnamed segments) The
404
+ # pattern will be matched over the field specified in the `field` field, then
405
+ # if the match is successful:
406
+ # - the name of the single named segment will be used as a header name,
407
+ # - the match value of the segment will be used as a header value;
408
+ # if the match is NOT successful, nothing will be sent.
409
+ #
410
+ # Example:
411
+ #
412
+ # -- This is a field in the request message
413
+ # | that the header value will be extracted from.
414
+ # |
415
+ # | -- This is the key name in the
416
+ # | | routing header.
417
+ # V |
418
+ # field: "table_name" v
419
+ # path_template: "projects/*/{table_location=instances/*}/tables/*"
420
+ # ^ ^
421
+ # | |
422
+ # In the {} brackets is the pattern that -- |
423
+ # specifies what to extract from the |
424
+ # field as a value to be sent. |
425
+ # |
426
+ # The string in the field must match the whole pattern --
427
+ # before brackets, inside brackets, after brackets.
428
+ #
429
+ # When looking at this specific example, we can see that:
430
+ # - A key-value pair with the key `table_location`
431
+ # and the value matching `instances/*` should be added
432
+ # to the x-goog-request-params routing header.
433
+ # - The value is extracted from the request message's `table_name` field
434
+ # if it matches the full pattern specified:
435
+ # `projects/*/instances/*/tables/*`.
436
+ #
437
+ # **NB:** If the `path_template` field is not provided, the key name is
438
+ # equal to the field name, and the whole field should be sent as a value.
439
+ # This makes the pattern for the field and the value functionally equivalent
440
+ # to `**`, and the configuration
441
+ #
442
+ # {
443
+ # field: "table_name"
444
+ # }
445
+ #
446
+ # is a functionally equivalent shorthand to:
447
+ #
448
+ # {
449
+ # field: "table_name"
450
+ # path_template: "{table_name=**}"
451
+ # }
452
+ #
453
+ # See Example 1 for more details.
454
+ class RoutingParameter
455
+ include ::Google::Protobuf::MessageExts
456
+ extend ::Google::Protobuf::MessageExts::ClassMethods
457
+ end
458
+ end
459
+ end