google-cloud-recommender-v1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,52 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 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 "googleauth"
20
+
21
+
22
+ module Google
23
+ module Cloud
24
+ module Recommender
25
+ module V1
26
+ module Recommender
27
+ # Credentials for the Recommender API.
28
+ class Credentials < Google::Auth::Credentials
29
+ self.scope = [
30
+ "https://www.googleapis.com/auth/cloud-platform"
31
+ ]
32
+ self.env_vars = [
33
+ "RECOMMENDER_CREDENTIALS",
34
+ "RECOMMENDER_KEYFILE",
35
+ "GOOGLE_CLOUD_CREDENTIALS",
36
+ "GOOGLE_CLOUD_KEYFILE",
37
+ "GCLOUD_KEYFILE",
38
+ "RECOMMENDER_CREDENTIALS_JSON",
39
+ "RECOMMENDER_KEYFILE_JSON",
40
+ "GOOGLE_CLOUD_CREDENTIALS_JSON",
41
+ "GOOGLE_CLOUD_KEYFILE_JSON",
42
+ "GCLOUD_KEYFILE_JSON"
43
+ ]
44
+ self.paths = [
45
+ "~/.config/google_cloud/application_default_credentials.json"
46
+ ]
47
+ end
48
+ end
49
+ end
50
+ end
51
+ end
52
+ end
@@ -0,0 +1,71 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Recommender
23
+ module V1
24
+ module Recommender
25
+ # Path helper methods for the Recommender API.
26
+ module Paths
27
+ ##
28
+ # Create a fully-qualified Recommendation resource string.
29
+ #
30
+ # The resource will be in the following format:
31
+ #
32
+ # `projects/{project}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}`
33
+ #
34
+ # @param project [String]
35
+ # @param location [String]
36
+ # @param recommender [String]
37
+ # @param recommendation [String]
38
+ #
39
+ # @return [String]
40
+ def recommendation_path project:, location:, recommender:, recommendation:
41
+ raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
42
+ raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
43
+ raise ArgumentError, "recommender cannot contain /" if recommender.to_s.include? "/"
44
+
45
+ "projects/#{project}/locations/#{location}/recommenders/#{recommender}/recommendations/#{recommendation}"
46
+ end
47
+
48
+ ##
49
+ # Create a fully-qualified Recommender resource string.
50
+ #
51
+ # The resource will be in the following format:
52
+ #
53
+ # `projects/{project}/locations/{location}/recommenders/{recommender}`
54
+ #
55
+ # @param project [String]
56
+ # @param location [String]
57
+ # @param recommender [String]
58
+ #
59
+ # @return [String]
60
+ def recommender_path project:, location:, recommender:
61
+ raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
62
+ raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
63
+
64
+ "projects/#{project}/locations/#{location}/recommenders/#{recommender}"
65
+ end
66
+ end
67
+ end
68
+ end
69
+ end
70
+ end
71
+ end
@@ -0,0 +1,57 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/cloud/recommender/v1/recommender_service.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ require 'google/api/annotations_pb'
7
+ require 'google/api/client_pb'
8
+ require 'google/api/field_behavior_pb'
9
+ require 'google/api/resource_pb'
10
+ require 'google/cloud/recommender/v1/recommendation_pb'
11
+ Google::Protobuf::DescriptorPool.generated_pool.build do
12
+ add_file("google/cloud/recommender/v1/recommender_service.proto", :syntax => :proto3) do
13
+ add_message "google.cloud.recommender.v1.ListRecommendationsRequest" do
14
+ optional :parent, :string, 1
15
+ optional :page_size, :int32, 2
16
+ optional :page_token, :string, 3
17
+ optional :filter, :string, 5
18
+ end
19
+ add_message "google.cloud.recommender.v1.ListRecommendationsResponse" do
20
+ repeated :recommendations, :message, 1, "google.cloud.recommender.v1.Recommendation"
21
+ optional :next_page_token, :string, 2
22
+ end
23
+ add_message "google.cloud.recommender.v1.GetRecommendationRequest" do
24
+ optional :name, :string, 1
25
+ end
26
+ add_message "google.cloud.recommender.v1.MarkRecommendationClaimedRequest" do
27
+ optional :name, :string, 1
28
+ map :state_metadata, :string, :string, 2
29
+ optional :etag, :string, 3
30
+ end
31
+ add_message "google.cloud.recommender.v1.MarkRecommendationSucceededRequest" do
32
+ optional :name, :string, 1
33
+ map :state_metadata, :string, :string, 2
34
+ optional :etag, :string, 3
35
+ end
36
+ add_message "google.cloud.recommender.v1.MarkRecommendationFailedRequest" do
37
+ optional :name, :string, 1
38
+ map :state_metadata, :string, :string, 2
39
+ optional :etag, :string, 3
40
+ end
41
+ end
42
+ end
43
+
44
+ module Google
45
+ module Cloud
46
+ module Recommender
47
+ module V1
48
+ ListRecommendationsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.ListRecommendationsRequest").msgclass
49
+ ListRecommendationsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.ListRecommendationsResponse").msgclass
50
+ GetRecommendationRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.GetRecommendationRequest").msgclass
51
+ MarkRecommendationClaimedRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.MarkRecommendationClaimedRequest").msgclass
52
+ MarkRecommendationSucceededRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.MarkRecommendationSucceededRequest").msgclass
53
+ MarkRecommendationFailedRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommender.v1.MarkRecommendationFailedRequest").msgclass
54
+ end
55
+ end
56
+ end
57
+ end
@@ -0,0 +1,86 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # Source: google/cloud/recommender/v1/recommender_service.proto for package 'google.cloud.recommender.v1'
3
+ # Original file comments:
4
+ # Copyright 2019 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
+
20
+ require 'grpc'
21
+ require 'google/cloud/recommender/v1/recommender_service_pb'
22
+
23
+ module Google
24
+ module Cloud
25
+ module Recommender
26
+ module V1
27
+ module Recommender
28
+ # Provides recommendations for cloud customers for various categories like
29
+ # performance optimization, cost savings, reliability, feature discovery, etc.
30
+ # These recommendations are generated automatically based on analysis of user
31
+ # resources, configuration and monitoring metrics.
32
+ class Service
33
+
34
+ include GRPC::GenericService
35
+
36
+ self.marshal_class_method = :encode
37
+ self.unmarshal_class_method = :decode
38
+ self.service_name = 'google.cloud.recommender.v1.Recommender'
39
+
40
+ # Lists recommendations for a Cloud project. Requires the recommender.*.list
41
+ # IAM permission for the specified recommender.
42
+ rpc :ListRecommendations, ListRecommendationsRequest, ListRecommendationsResponse
43
+ # Gets the requested recommendation. Requires the recommender.*.get
44
+ # IAM permission for the specified recommender.
45
+ rpc :GetRecommendation, GetRecommendationRequest, Recommendation
46
+ # Mark the Recommendation State as Claimed. Users can use this method to
47
+ # indicate to the Recommender API that they are starting to apply the
48
+ # recommendation themselves. This stops the recommendation content from being
49
+ # updated.
50
+ #
51
+ # MarkRecommendationClaimed can be applied to recommendations in CLAIMED,
52
+ # SUCCEEDED, FAILED, or ACTIVE state.
53
+ #
54
+ # Requires the recommender.*.update IAM permission for the specified
55
+ # recommender.
56
+ rpc :MarkRecommendationClaimed, MarkRecommendationClaimedRequest, Recommendation
57
+ # Mark the Recommendation State as Succeeded. Users can use this method to
58
+ # indicate to the Recommender API that they have applied the recommendation
59
+ # themselves, and the operation was successful. This stops the recommendation
60
+ # content from being updated.
61
+ #
62
+ # MarkRecommendationSucceeded can be applied to recommendations in ACTIVE,
63
+ # CLAIMED, SUCCEEDED, or FAILED state.
64
+ #
65
+ # Requires the recommender.*.update IAM permission for the specified
66
+ # recommender.
67
+ rpc :MarkRecommendationSucceeded, MarkRecommendationSucceededRequest, Recommendation
68
+ # Mark the Recommendation State as Failed. Users can use this method to
69
+ # indicate to the Recommender API that they have applied the recommendation
70
+ # themselves, and the operation failed. This stops the recommendation content
71
+ # from being updated.
72
+ #
73
+ # MarkRecommendationFailed can be applied to recommendations in ACTIVE,
74
+ # CLAIMED, SUCCEEDED, or FAILED state.
75
+ #
76
+ # Requires the recommender.*.update IAM permission for the specified
77
+ # recommender.
78
+ rpc :MarkRecommendationFailed, MarkRecommendationFailedRequest, Recommendation
79
+ end
80
+
81
+ Stub = Service.rpc_stub_class
82
+ end
83
+ end
84
+ end
85
+ end
86
+ end
@@ -0,0 +1,28 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Recommender
23
+ module V1
24
+ VERSION = "0.1.0"
25
+ end
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,4 @@
1
+ # Recommender V1 Protocol Buffer Documentation
2
+
3
+ These files are for the YARD documentation of the generated protobuf files.
4
+ They are not intended to be required or loaded at runtime.
@@ -0,0 +1,59 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 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
+ # An indicator of the behavior of a given field (for example, that a field
23
+ # is required in requests, or given as output but ignored as input).
24
+ # This **does not** change the behavior in protocol buffers itself; it only
25
+ # denotes the behavior and may affect how API tooling handles the field.
26
+ #
27
+ # Note: This enum **may** receive new values in the future.
28
+ module FieldBehavior
29
+ # Conventional default for enums. Do not use this.
30
+ FIELD_BEHAVIOR_UNSPECIFIED = 0
31
+
32
+ # Specifically denotes a field as optional.
33
+ # While all fields in protocol buffers are optional, this may be specified
34
+ # for emphasis if appropriate.
35
+ OPTIONAL = 1
36
+
37
+ # Denotes a field as required.
38
+ # This indicates that the field **must** be provided as part of the request,
39
+ # and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
40
+ REQUIRED = 2
41
+
42
+ # Denotes a field as output only.
43
+ # This indicates that the field is provided in responses, but including the
44
+ # field in a request does nothing (the server *must* ignore it and
45
+ # *must not* throw an error as a result of the field's presence).
46
+ OUTPUT_ONLY = 3
47
+
48
+ # Denotes a field as input only.
49
+ # This indicates that the field is provided in requests, and the
50
+ # corresponding field is not included in output.
51
+ INPUT_ONLY = 4
52
+
53
+ # Denotes a field as immutable.
54
+ # This indicates that the field may be set once in a request to create a
55
+ # resource, but may not be changed thereafter.
56
+ IMMUTABLE = 5
57
+ end
58
+ end
59
+ end
@@ -0,0 +1,247 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 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
+ # name_descriptor: \\\{
37
+ # pattern: "projects/\\\{project\}/topics/\\\{topic\}"
38
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
39
+ # parent_name_extractor: "projects/\\\{project\}"
40
+ # \}
41
+ # \};
42
+ # \}
43
+ #
44
+ # The ResourceDescriptor Yaml config will look like:
45
+ #
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
+ #
53
+ # Sometimes, resources have multiple patterns, typically because they can
54
+ # live under multiple parents.
55
+ #
56
+ # Example:
57
+ #
58
+ # message LogEntry \\\{
59
+ # option (google.api.resource) = \\\{
60
+ # type: "logging.googleapis.com/LogEntry"
61
+ # name_descriptor: \\\{
62
+ # pattern: "projects/\\\{project\}/logs/\\\{log\}"
63
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
64
+ # parent_name_extractor: "projects/\\\{project\}"
65
+ # \}
66
+ # name_descriptor: \\\{
67
+ # pattern: "folders/\\\{folder\}/logs/\\\{log\}"
68
+ # parent_type: "cloudresourcemanager.googleapis.com/Folder"
69
+ # parent_name_extractor: "folders/\\\{folder\}"
70
+ # \}
71
+ # name_descriptor: \\\{
72
+ # pattern: "organizations/\\\{organization\}/logs/\\\{log\}"
73
+ # parent_type: "cloudresourcemanager.googleapis.com/Organization"
74
+ # parent_name_extractor: "organizations/\\\{organization\}"
75
+ # \}
76
+ # name_descriptor: \\\{
77
+ # pattern: "billingAccounts/\\\{billing_account\}/logs/\\\{log\}"
78
+ # parent_type: "billing.googleapis.com/BillingAccount"
79
+ # parent_name_extractor: "billingAccounts/\\\{billing_account\}"
80
+ # \}
81
+ # \};
82
+ # \}
83
+ #
84
+ # The ResourceDescriptor Yaml config will look like:
85
+ #
86
+ # resources:
87
+ # - type: 'logging.googleapis.com/LogEntry'
88
+ # name_descriptor:
89
+ # - pattern: "projects/\\\{project\}/logs/\\\{log\}"
90
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
91
+ # parent_name_extractor: "projects/\\\{project\}"
92
+ # - pattern: "folders/\\\{folder\}/logs/\\\{log\}"
93
+ # parent_type: "cloudresourcemanager.googleapis.com/Folder"
94
+ # parent_name_extractor: "folders/\\\{folder\}"
95
+ # - pattern: "organizations/\\\{organization\}/logs/\\\{log\}"
96
+ # parent_type: "cloudresourcemanager.googleapis.com/Organization"
97
+ # parent_name_extractor: "organizations/\\\{organization\}"
98
+ # - pattern: "billingAccounts/\\\{billing_account\}/logs/\\\{log\}"
99
+ # parent_type: "billing.googleapis.com/BillingAccount"
100
+ # parent_name_extractor: "billingAccounts/\\\{billing_account\}"
101
+ #
102
+ # For flexible resources, the resource name doesn't contain parent names, but
103
+ # the resource itself has parents for policy evaluation.
104
+ #
105
+ # Example:
106
+ #
107
+ # message Shelf \\\{
108
+ # option (google.api.resource) = \\\{
109
+ # type: "library.googleapis.com/Shelf"
110
+ # name_descriptor: \\\{
111
+ # pattern: "shelves/\\\{shelf\}"
112
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
113
+ # \}
114
+ # name_descriptor: \\\{
115
+ # pattern: "shelves/\\\{shelf\}"
116
+ # parent_type: "cloudresourcemanager.googleapis.com/Folder"
117
+ # \}
118
+ # \};
119
+ # \}
120
+ #
121
+ # The ResourceDescriptor Yaml config will look like:
122
+ #
123
+ # resources:
124
+ # - type: 'library.googleapis.com/Shelf'
125
+ # name_descriptor:
126
+ # - pattern: "shelves/\\\{shelf\}"
127
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
128
+ # - pattern: "shelves/\\\{shelf\}"
129
+ # parent_type: "cloudresourcemanager.googleapis.com/Folder"
130
+ # @!attribute [rw] type
131
+ # @return [String]
132
+ # The resource type. It must be in the format of
133
+ # \\\{service_name\}/\\\{resource_type_kind\}. The `resource_type_kind` must be
134
+ # singular and must not include version numbers.
135
+ #
136
+ # Example: `storage.googleapis.com/Bucket`
137
+ #
138
+ # The value of the resource_type_kind must follow the regular expression
139
+ # /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
140
+ # should use PascalCase (UpperCamelCase). The maximum number of
141
+ # characters allowed for the `resource_type_kind` is 100.
142
+ # @!attribute [rw] pattern
143
+ # @return [Array<String>]
144
+ # Optional. The relative resource name pattern associated with this resource
145
+ # type. The DNS prefix of the full resource name shouldn't be specified here.
146
+ #
147
+ # The path pattern must follow the syntax, which aligns with HTTP binding
148
+ # syntax:
149
+ #
150
+ # Template = Segment \\\{ "/" Segment \} ;
151
+ # Segment = LITERAL | Variable ;
152
+ # Variable = "\\\{" LITERAL "\}" ;
153
+ #
154
+ # Examples:
155
+ #
156
+ # - "projects/\\\{project\}/topics/\\\{topic\}"
157
+ # - "projects/\\\{project\}/knowledgeBases/\\\{knowledge_base\}"
158
+ #
159
+ # The components in braces correspond to the IDs for each resource in the
160
+ # hierarchy. It is expected that, if multiple patterns are provided,
161
+ # the same component name (e.g. "project") refers to IDs of the same
162
+ # type of resource.
163
+ # @!attribute [rw] name_field
164
+ # @return [String]
165
+ # Optional. The field on the resource that designates the resource name
166
+ # field. If omitted, this is assumed to be "name".
167
+ # @!attribute [rw] history
168
+ # @return [ENUM(History)]
169
+ # Optional. The historical or future-looking state of the resource pattern.
170
+ #
171
+ # Example:
172
+ #
173
+ # // The InspectTemplate message originally only supported resource
174
+ # // names with organization, and project was added later.
175
+ # message InspectTemplate \\\{
176
+ # option (google.api.resource) = \\\{
177
+ # type: "dlp.googleapis.com/InspectTemplate"
178
+ # pattern:
179
+ # "organizations/\\\{organization\}/inspectTemplates/\\\{inspect_template\}"
180
+ # pattern: "projects/\\\{project\}/inspectTemplates/\\\{inspect_template\}"
181
+ # history: ORIGINALLY_SINGLE_PATTERN
182
+ # \};
183
+ # \}
184
+ # @!attribute [rw] plural
185
+ # @return [String]
186
+ # The plural name used in the resource name, such as 'projects' for
187
+ # the name of 'projects/\\\{project\}'. It is the same concept of the `plural`
188
+ # field in k8s CRD spec
189
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
190
+ # @!attribute [rw] singular
191
+ # @return [String]
192
+ # The same concept of the `singular` field in k8s CRD spec
193
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
194
+ # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
195
+ class ResourceDescriptor
196
+ include Google::Protobuf::MessageExts
197
+ extend Google::Protobuf::MessageExts::ClassMethods
198
+
199
+ # A description of the historical or future-looking state of the
200
+ # resource pattern.
201
+ module History
202
+ # The "unset" value.
203
+ HISTORY_UNSPECIFIED = 0
204
+
205
+ # The resource originally had one pattern and launched as such, and
206
+ # additional patterns were added later.
207
+ ORIGINALLY_SINGLE_PATTERN = 1
208
+
209
+ # The resource has one pattern, but the API owner expects to add more
210
+ # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
211
+ # that from being necessary once there are multiple patterns.)
212
+ FUTURE_MULTI_PATTERN = 2
213
+ end
214
+ end
215
+
216
+ # Defines a proto annotation that describes a string field that refers to
217
+ # an API resource.
218
+ # @!attribute [rw] type
219
+ # @return [String]
220
+ # The resource type that the annotated field references.
221
+ #
222
+ # Example:
223
+ #
224
+ # message Subscription \\\{
225
+ # string topic = 2 [(google.api.resource_reference) = \\\{
226
+ # type: "pubsub.googleapis.com/Topic"
227
+ # \}];
228
+ # \}
229
+ # @!attribute [rw] child_type
230
+ # @return [String]
231
+ # The resource type of a child collection that the annotated field
232
+ # references. This is useful for annotating the `parent` field that
233
+ # doesn't have a fixed resource type.
234
+ #
235
+ # Example:
236
+ #
237
+ # message ListLogEntriesRequest \\\{
238
+ # string parent = 1 [(google.api.resource_reference) = \\\{
239
+ # child_type: "logging.googleapis.com/LogEntry"
240
+ # \};
241
+ # \}
242
+ class ResourceReference
243
+ include Google::Protobuf::MessageExts
244
+ extend Google::Protobuf::MessageExts::ClassMethods
245
+ end
246
+ end
247
+ end