google-cloud-datastore-admin-v1 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,30 @@
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 Datastore
23
+ module Admin
24
+ module V1
25
+ VERSION = "0.1.0"
26
+ end
27
+ end
28
+ end
29
+ end
30
+ end
@@ -0,0 +1,120 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/datastore/admin/v1/datastore_admin.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/datastore/admin/v1/index_pb'
10
+ require 'google/longrunning/operations_pb'
11
+ require 'google/protobuf/timestamp_pb'
12
+ Google::Protobuf::DescriptorPool.generated_pool.build do
13
+ add_file("google/datastore/admin/v1/datastore_admin.proto", :syntax => :proto3) do
14
+ add_message "google.datastore.admin.v1.CommonMetadata" do
15
+ optional :start_time, :message, 1, "google.protobuf.Timestamp"
16
+ optional :end_time, :message, 2, "google.protobuf.Timestamp"
17
+ optional :operation_type, :enum, 3, "google.datastore.admin.v1.OperationType"
18
+ map :labels, :string, :string, 4
19
+ optional :state, :enum, 5, "google.datastore.admin.v1.CommonMetadata.State"
20
+ end
21
+ add_enum "google.datastore.admin.v1.CommonMetadata.State" do
22
+ value :STATE_UNSPECIFIED, 0
23
+ value :INITIALIZING, 1
24
+ value :PROCESSING, 2
25
+ value :CANCELLING, 3
26
+ value :FINALIZING, 4
27
+ value :SUCCESSFUL, 5
28
+ value :FAILED, 6
29
+ value :CANCELLED, 7
30
+ end
31
+ add_message "google.datastore.admin.v1.Progress" do
32
+ optional :work_completed, :int64, 1
33
+ optional :work_estimated, :int64, 2
34
+ end
35
+ add_message "google.datastore.admin.v1.ExportEntitiesRequest" do
36
+ optional :project_id, :string, 1
37
+ map :labels, :string, :string, 2
38
+ optional :entity_filter, :message, 3, "google.datastore.admin.v1.EntityFilter"
39
+ optional :output_url_prefix, :string, 4
40
+ end
41
+ add_message "google.datastore.admin.v1.ImportEntitiesRequest" do
42
+ optional :project_id, :string, 1
43
+ map :labels, :string, :string, 2
44
+ optional :input_url, :string, 3
45
+ optional :entity_filter, :message, 4, "google.datastore.admin.v1.EntityFilter"
46
+ end
47
+ add_message "google.datastore.admin.v1.ExportEntitiesResponse" do
48
+ optional :output_url, :string, 1
49
+ end
50
+ add_message "google.datastore.admin.v1.ExportEntitiesMetadata" do
51
+ optional :common, :message, 1, "google.datastore.admin.v1.CommonMetadata"
52
+ optional :progress_entities, :message, 2, "google.datastore.admin.v1.Progress"
53
+ optional :progress_bytes, :message, 3, "google.datastore.admin.v1.Progress"
54
+ optional :entity_filter, :message, 4, "google.datastore.admin.v1.EntityFilter"
55
+ optional :output_url_prefix, :string, 5
56
+ end
57
+ add_message "google.datastore.admin.v1.ImportEntitiesMetadata" do
58
+ optional :common, :message, 1, "google.datastore.admin.v1.CommonMetadata"
59
+ optional :progress_entities, :message, 2, "google.datastore.admin.v1.Progress"
60
+ optional :progress_bytes, :message, 3, "google.datastore.admin.v1.Progress"
61
+ optional :entity_filter, :message, 4, "google.datastore.admin.v1.EntityFilter"
62
+ optional :input_url, :string, 5
63
+ end
64
+ add_message "google.datastore.admin.v1.EntityFilter" do
65
+ repeated :kinds, :string, 1
66
+ repeated :namespace_ids, :string, 2
67
+ end
68
+ add_message "google.datastore.admin.v1.GetIndexRequest" do
69
+ optional :project_id, :string, 1
70
+ optional :index_id, :string, 3
71
+ end
72
+ add_message "google.datastore.admin.v1.ListIndexesRequest" do
73
+ optional :project_id, :string, 1
74
+ optional :filter, :string, 3
75
+ optional :page_size, :int32, 4
76
+ optional :page_token, :string, 5
77
+ end
78
+ add_message "google.datastore.admin.v1.ListIndexesResponse" do
79
+ repeated :indexes, :message, 1, "google.datastore.admin.v1.Index"
80
+ optional :next_page_token, :string, 2
81
+ end
82
+ add_message "google.datastore.admin.v1.IndexOperationMetadata" do
83
+ optional :common, :message, 1, "google.datastore.admin.v1.CommonMetadata"
84
+ optional :progress_entities, :message, 2, "google.datastore.admin.v1.Progress"
85
+ optional :index_id, :string, 3
86
+ end
87
+ add_enum "google.datastore.admin.v1.OperationType" do
88
+ value :OPERATION_TYPE_UNSPECIFIED, 0
89
+ value :EXPORT_ENTITIES, 1
90
+ value :IMPORT_ENTITIES, 2
91
+ value :CREATE_INDEX, 3
92
+ value :DELETE_INDEX, 4
93
+ end
94
+ end
95
+ end
96
+
97
+ module Google
98
+ module Cloud
99
+ module Datastore
100
+ module Admin
101
+ module V1
102
+ CommonMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.CommonMetadata").msgclass
103
+ CommonMetadata::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.CommonMetadata.State").enummodule
104
+ Progress = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.Progress").msgclass
105
+ ExportEntitiesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.ExportEntitiesRequest").msgclass
106
+ ImportEntitiesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.ImportEntitiesRequest").msgclass
107
+ ExportEntitiesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.ExportEntitiesResponse").msgclass
108
+ ExportEntitiesMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.ExportEntitiesMetadata").msgclass
109
+ ImportEntitiesMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.ImportEntitiesMetadata").msgclass
110
+ EntityFilter = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.EntityFilter").msgclass
111
+ GetIndexRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.GetIndexRequest").msgclass
112
+ ListIndexesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.ListIndexesRequest").msgclass
113
+ ListIndexesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.ListIndexesResponse").msgclass
114
+ IndexOperationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.IndexOperationMetadata").msgclass
115
+ OperationType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.OperationType").enummodule
116
+ end
117
+ end
118
+ end
119
+ end
120
+ end
@@ -0,0 +1,126 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # Source: google/datastore/admin/v1/datastore_admin.proto for package 'Google.Cloud.Datastore.Admin.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
+ require 'grpc'
20
+ require 'google/datastore/admin/v1/datastore_admin_pb'
21
+
22
+ module Google
23
+ module Cloud
24
+ module Datastore
25
+ module Admin
26
+ module V1
27
+ module DatastoreAdmin
28
+ # Google Cloud Datastore Admin API
29
+ #
30
+ #
31
+ # The Datastore Admin API provides several admin services for Cloud Datastore.
32
+ #
33
+ # -----------------------------------------------------------------------------
34
+ # ## Concepts
35
+ #
36
+ # Project, namespace, kind, and entity as defined in the Google Cloud Datastore
37
+ # API.
38
+ #
39
+ # Operation: An Operation represents work being performed in the background.
40
+ #
41
+ # EntityFilter: Allows specifying a subset of entities in a project. This is
42
+ # specified as a combination of kinds and namespaces (either or both of which
43
+ # may be all).
44
+ #
45
+ # -----------------------------------------------------------------------------
46
+ # ## Services
47
+ #
48
+ # # Export/Import
49
+ #
50
+ # The Export/Import service provides the ability to copy all or a subset of
51
+ # entities to/from Google Cloud Storage.
52
+ #
53
+ # Exported data may be imported into Cloud Datastore for any Google Cloud
54
+ # Platform project. It is not restricted to the export source project. It is
55
+ # possible to export from one project and then import into another.
56
+ #
57
+ # Exported data can also be loaded into Google BigQuery for analysis.
58
+ #
59
+ # Exports and imports are performed asynchronously. An Operation resource is
60
+ # created for each export/import. The state (including any errors encountered)
61
+ # of the export/import may be queried via the Operation resource.
62
+ #
63
+ # # Index
64
+ #
65
+ # The index service manages Cloud Datastore composite indexes.
66
+ #
67
+ # Index creation and deletion are performed asynchronously.
68
+ # An Operation resource is created for each such asynchronous operation.
69
+ # The state of the operation (including any errors encountered)
70
+ # may be queried via the Operation resource.
71
+ #
72
+ # # Operation
73
+ #
74
+ # The Operations collection provides a record of actions performed for the
75
+ # specified project (including any operations in progress). Operations are not
76
+ # created directly but through calls on other collections or resources.
77
+ #
78
+ # An operation that is not yet done may be cancelled. The request to cancel is
79
+ # asynchronous and the operation may continue to run for some time after the
80
+ # request to cancel is made.
81
+ #
82
+ # An operation that is done may be deleted so that it is no longer listed as
83
+ # part of the Operation collection.
84
+ #
85
+ # ListOperations returns all pending operations, but not completed operations.
86
+ #
87
+ # Operations are created by service DatastoreAdmin,
88
+ # but are accessed via service google.longrunning.Operations.
89
+ class Service
90
+
91
+ include GRPC::GenericService
92
+
93
+ self.marshal_class_method = :encode
94
+ self.unmarshal_class_method = :decode
95
+ self.service_name = 'google.datastore.admin.v1.DatastoreAdmin'
96
+
97
+ # Exports a copy of all or a subset of entities from Google Cloud Datastore
98
+ # to another storage system, such as Google Cloud Storage. Recent updates to
99
+ # entities may not be reflected in the export. The export occurs in the
100
+ # background and its progress can be monitored and managed via the
101
+ # Operation resource that is created. The output of an export may only be
102
+ # used once the associated operation is done. If an export operation is
103
+ # cancelled before completion it may leave partial data behind in Google
104
+ # Cloud Storage.
105
+ rpc :ExportEntities, Google::Cloud::Datastore::Admin::V1::ExportEntitiesRequest, Google::Longrunning::Operation
106
+ # Imports entities into Google Cloud Datastore. Existing entities with the
107
+ # same key are overwritten. The import occurs in the background and its
108
+ # progress can be monitored and managed via the Operation resource that is
109
+ # created. If an ImportEntities operation is cancelled, it is possible
110
+ # that a subset of the data has already been imported to Cloud Datastore.
111
+ rpc :ImportEntities, Google::Cloud::Datastore::Admin::V1::ImportEntitiesRequest, Google::Longrunning::Operation
112
+ # Gets an index.
113
+ rpc :GetIndex, Google::Cloud::Datastore::Admin::V1::GetIndexRequest, Google::Cloud::Datastore::Admin::V1::Index
114
+ # Lists the indexes that match the specified filters. Datastore uses an
115
+ # eventually consistent query to fetch the list of indexes and may
116
+ # occasionally return stale results.
117
+ rpc :ListIndexes, Google::Cloud::Datastore::Admin::V1::ListIndexesRequest, Google::Cloud::Datastore::Admin::V1::ListIndexesResponse
118
+ end
119
+
120
+ Stub = Service.rpc_stub_class
121
+ end
122
+ end
123
+ end
124
+ end
125
+ end
126
+ end
@@ -0,0 +1,56 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/datastore/admin/v1/index.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ require 'google/api/field_behavior_pb'
7
+ require 'google/api/annotations_pb'
8
+ Google::Protobuf::DescriptorPool.generated_pool.build do
9
+ add_file("google/datastore/admin/v1/index.proto", :syntax => :proto3) do
10
+ add_message "google.datastore.admin.v1.Index" do
11
+ optional :project_id, :string, 1
12
+ optional :index_id, :string, 3
13
+ optional :kind, :string, 4
14
+ optional :ancestor, :enum, 5, "google.datastore.admin.v1.Index.AncestorMode"
15
+ repeated :properties, :message, 6, "google.datastore.admin.v1.Index.IndexedProperty"
16
+ optional :state, :enum, 7, "google.datastore.admin.v1.Index.State"
17
+ end
18
+ add_message "google.datastore.admin.v1.Index.IndexedProperty" do
19
+ optional :name, :string, 1
20
+ optional :direction, :enum, 2, "google.datastore.admin.v1.Index.Direction"
21
+ end
22
+ add_enum "google.datastore.admin.v1.Index.AncestorMode" do
23
+ value :ANCESTOR_MODE_UNSPECIFIED, 0
24
+ value :NONE, 1
25
+ value :ALL_ANCESTORS, 2
26
+ end
27
+ add_enum "google.datastore.admin.v1.Index.Direction" do
28
+ value :DIRECTION_UNSPECIFIED, 0
29
+ value :ASCENDING, 1
30
+ value :DESCENDING, 2
31
+ end
32
+ add_enum "google.datastore.admin.v1.Index.State" do
33
+ value :STATE_UNSPECIFIED, 0
34
+ value :CREATING, 1
35
+ value :READY, 2
36
+ value :DELETING, 3
37
+ value :ERROR, 4
38
+ end
39
+ end
40
+ end
41
+
42
+ module Google
43
+ module Cloud
44
+ module Datastore
45
+ module Admin
46
+ module V1
47
+ Index = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.Index").msgclass
48
+ Index::IndexedProperty = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.Index.IndexedProperty").msgclass
49
+ Index::AncestorMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.Index.AncestorMode").enummodule
50
+ Index::Direction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.Index.Direction").enummodule
51
+ Index::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.admin.v1.Index.State").enummodule
52
+ end
53
+ end
54
+ end
55
+ end
56
+ end
@@ -0,0 +1,4 @@
1
+ # Firestore in Datastore mode Admin 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 [::Google::Api::ResourceDescriptor::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