google-cloud-bigquery-data_transfer-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.
Files changed (30) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +169 -0
  4. data/LICENSE.md +203 -0
  5. data/README.md +71 -0
  6. data/lib/google-cloud-bigquery-data_transfer-v1.rb +21 -0
  7. data/lib/google/cloud/bigquery/data_transfer/v1.rb +37 -0
  8. data/lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service.rb +54 -0
  9. data/lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/client.rb +1567 -0
  10. data/lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/credentials.rb +53 -0
  11. data/lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/paths.rb +193 -0
  12. data/lib/google/cloud/bigquery/data_transfer/v1/version.rb +30 -0
  13. data/lib/google/cloud/bigquery/datatransfer/v1/datatransfer_pb.rb +217 -0
  14. data/lib/google/cloud/bigquery/datatransfer/v1/datatransfer_services_pb.rb +92 -0
  15. data/lib/google/cloud/bigquery/datatransfer/v1/transfer_pb.rb +104 -0
  16. data/lib/google/cloud/common_resources_pb.rb +15 -0
  17. data/proto_docs/README.md +4 -0
  18. data/proto_docs/google/api/field_behavior.rb +59 -0
  19. data/proto_docs/google/api/resource.rb +247 -0
  20. data/proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb +646 -0
  21. data/proto_docs/google/cloud/bigquery/datatransfer/v1/transfer.rb +276 -0
  22. data/proto_docs/google/protobuf/any.rb +138 -0
  23. data/proto_docs/google/protobuf/duration.rb +98 -0
  24. data/proto_docs/google/protobuf/empty.rb +36 -0
  25. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  26. data/proto_docs/google/protobuf/struct.rb +96 -0
  27. data/proto_docs/google/protobuf/timestamp.rb +120 -0
  28. data/proto_docs/google/protobuf/wrappers.rb +121 -0
  29. data/proto_docs/google/rpc/status.rb +46 -0
  30. metadata +183 -0
@@ -0,0 +1,92 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # Source: google/cloud/bigquery/datatransfer/v1/datatransfer.proto for package 'Google.Cloud.Bigquery.DataTransfer.V1'
3
+ # Original file comments:
4
+ # Copyright 2020 Google LLC
5
+ #
6
+ # Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ # See the License for the specific language governing permissions and
16
+ # limitations under the License.
17
+ #
18
+
19
+ require 'grpc'
20
+ require 'google/cloud/bigquery/datatransfer/v1/datatransfer_pb'
21
+
22
+ module Google
23
+ module Cloud
24
+ module Bigquery
25
+ module DataTransfer
26
+ module V1
27
+ module DataTransferService
28
+ # The Google BigQuery Data Transfer Service API enables BigQuery users to
29
+ # configure the transfer of their data from other Google Products into
30
+ # BigQuery. This service contains methods that are end user exposed. It backs
31
+ # up the frontend.
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.bigquery.datatransfer.v1.DataTransferService'
39
+
40
+ # Retrieves a supported data source and returns its settings,
41
+ # which can be used for UI rendering.
42
+ rpc :GetDataSource, Google::Cloud::Bigquery::DataTransfer::V1::GetDataSourceRequest, Google::Cloud::Bigquery::DataTransfer::V1::DataSource
43
+ # Lists supported data sources and returns their settings,
44
+ # which can be used for UI rendering.
45
+ rpc :ListDataSources, Google::Cloud::Bigquery::DataTransfer::V1::ListDataSourcesRequest, Google::Cloud::Bigquery::DataTransfer::V1::ListDataSourcesResponse
46
+ # Creates a new data transfer configuration.
47
+ rpc :CreateTransferConfig, Google::Cloud::Bigquery::DataTransfer::V1::CreateTransferConfigRequest, Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig
48
+ # Updates a data transfer configuration.
49
+ # All fields must be set, even if they are not updated.
50
+ rpc :UpdateTransferConfig, Google::Cloud::Bigquery::DataTransfer::V1::UpdateTransferConfigRequest, Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig
51
+ # Deletes a data transfer configuration,
52
+ # including any associated transfer runs and logs.
53
+ rpc :DeleteTransferConfig, Google::Cloud::Bigquery::DataTransfer::V1::DeleteTransferConfigRequest, Google::Protobuf::Empty
54
+ # Returns information about a data transfer config.
55
+ rpc :GetTransferConfig, Google::Cloud::Bigquery::DataTransfer::V1::GetTransferConfigRequest, Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig
56
+ # Returns information about all data transfers in the project.
57
+ rpc :ListTransferConfigs, Google::Cloud::Bigquery::DataTransfer::V1::ListTransferConfigsRequest, Google::Cloud::Bigquery::DataTransfer::V1::ListTransferConfigsResponse
58
+ # Creates transfer runs for a time range [start_time, end_time].
59
+ # For each date - or whatever granularity the data source supports - in the
60
+ # range, one transfer run is created.
61
+ # Note that runs are created per UTC time in the time range.
62
+ # DEPRECATED: use StartManualTransferRuns instead.
63
+ rpc :ScheduleTransferRuns, Google::Cloud::Bigquery::DataTransfer::V1::ScheduleTransferRunsRequest, Google::Cloud::Bigquery::DataTransfer::V1::ScheduleTransferRunsResponse
64
+ # Start manual transfer runs to be executed now with schedule_time equal to
65
+ # current time. The transfer runs can be created for a time range where the
66
+ # run_time is between start_time (inclusive) and end_time (exclusive), or for
67
+ # a specific run_time.
68
+ rpc :StartManualTransferRuns, Google::Cloud::Bigquery::DataTransfer::V1::StartManualTransferRunsRequest, Google::Cloud::Bigquery::DataTransfer::V1::StartManualTransferRunsResponse
69
+ # Returns information about the particular transfer run.
70
+ rpc :GetTransferRun, Google::Cloud::Bigquery::DataTransfer::V1::GetTransferRunRequest, Google::Cloud::Bigquery::DataTransfer::V1::TransferRun
71
+ # Deletes the specified transfer run.
72
+ rpc :DeleteTransferRun, Google::Cloud::Bigquery::DataTransfer::V1::DeleteTransferRunRequest, Google::Protobuf::Empty
73
+ # Returns information about running and completed jobs.
74
+ rpc :ListTransferRuns, Google::Cloud::Bigquery::DataTransfer::V1::ListTransferRunsRequest, Google::Cloud::Bigquery::DataTransfer::V1::ListTransferRunsResponse
75
+ # Returns user facing log messages for the data transfer run.
76
+ rpc :ListTransferLogs, Google::Cloud::Bigquery::DataTransfer::V1::ListTransferLogsRequest, Google::Cloud::Bigquery::DataTransfer::V1::ListTransferLogsResponse
77
+ # Returns true if valid credentials exist for the given data source and
78
+ # requesting user.
79
+ # Some data sources doesn't support service account, so we need to talk to
80
+ # them on behalf of the end user. This API just checks whether we have OAuth
81
+ # token for the particular user, which is a pre-requisite before user can
82
+ # create a transfer config.
83
+ rpc :CheckValidCreds, Google::Cloud::Bigquery::DataTransfer::V1::CheckValidCredsRequest, Google::Cloud::Bigquery::DataTransfer::V1::CheckValidCredsResponse
84
+ end
85
+
86
+ Stub = Service.rpc_stub_class
87
+ end
88
+ end
89
+ end
90
+ end
91
+ end
92
+ end
@@ -0,0 +1,104 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/cloud/bigquery/datatransfer/v1/transfer.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ require 'google/api/field_behavior_pb'
7
+ require 'google/api/resource_pb'
8
+ require 'google/protobuf/struct_pb'
9
+ require 'google/protobuf/timestamp_pb'
10
+ require 'google/rpc/status_pb'
11
+ Google::Protobuf::DescriptorPool.generated_pool.build do
12
+ add_file("google/cloud/bigquery/datatransfer/v1/transfer.proto", :syntax => :proto3) do
13
+ add_message "google.cloud.bigquery.datatransfer.v1.EmailPreferences" do
14
+ optional :enable_failure_email, :bool, 1
15
+ end
16
+ add_message "google.cloud.bigquery.datatransfer.v1.ScheduleOptions" do
17
+ optional :disable_auto_scheduling, :bool, 3
18
+ optional :start_time, :message, 1, "google.protobuf.Timestamp"
19
+ optional :end_time, :message, 2, "google.protobuf.Timestamp"
20
+ end
21
+ add_message "google.cloud.bigquery.datatransfer.v1.TransferConfig" do
22
+ optional :name, :string, 1
23
+ optional :display_name, :string, 3
24
+ optional :data_source_id, :string, 5
25
+ optional :params, :message, 9, "google.protobuf.Struct"
26
+ optional :schedule, :string, 7
27
+ optional :schedule_options, :message, 24, "google.cloud.bigquery.datatransfer.v1.ScheduleOptions"
28
+ optional :data_refresh_window_days, :int32, 12
29
+ optional :disabled, :bool, 13
30
+ optional :update_time, :message, 4, "google.protobuf.Timestamp"
31
+ optional :next_run_time, :message, 8, "google.protobuf.Timestamp"
32
+ optional :state, :enum, 10, "google.cloud.bigquery.datatransfer.v1.TransferState"
33
+ optional :user_id, :int64, 11
34
+ optional :dataset_region, :string, 14
35
+ optional :notification_pubsub_topic, :string, 15
36
+ optional :email_preferences, :message, 18, "google.cloud.bigquery.datatransfer.v1.EmailPreferences"
37
+ oneof :destination do
38
+ optional :destination_dataset_id, :string, 2
39
+ end
40
+ end
41
+ add_message "google.cloud.bigquery.datatransfer.v1.TransferRun" do
42
+ optional :name, :string, 1
43
+ optional :schedule_time, :message, 3, "google.protobuf.Timestamp"
44
+ optional :run_time, :message, 10, "google.protobuf.Timestamp"
45
+ optional :error_status, :message, 21, "google.rpc.Status"
46
+ optional :start_time, :message, 4, "google.protobuf.Timestamp"
47
+ optional :end_time, :message, 5, "google.protobuf.Timestamp"
48
+ optional :update_time, :message, 6, "google.protobuf.Timestamp"
49
+ optional :params, :message, 9, "google.protobuf.Struct"
50
+ optional :data_source_id, :string, 7
51
+ optional :state, :enum, 8, "google.cloud.bigquery.datatransfer.v1.TransferState"
52
+ optional :user_id, :int64, 11
53
+ optional :schedule, :string, 12
54
+ optional :notification_pubsub_topic, :string, 23
55
+ optional :email_preferences, :message, 25, "google.cloud.bigquery.datatransfer.v1.EmailPreferences"
56
+ oneof :destination do
57
+ optional :destination_dataset_id, :string, 2
58
+ end
59
+ end
60
+ add_message "google.cloud.bigquery.datatransfer.v1.TransferMessage" do
61
+ optional :message_time, :message, 1, "google.protobuf.Timestamp"
62
+ optional :severity, :enum, 2, "google.cloud.bigquery.datatransfer.v1.TransferMessage.MessageSeverity"
63
+ optional :message_text, :string, 3
64
+ end
65
+ add_enum "google.cloud.bigquery.datatransfer.v1.TransferMessage.MessageSeverity" do
66
+ value :MESSAGE_SEVERITY_UNSPECIFIED, 0
67
+ value :INFO, 1
68
+ value :WARNING, 2
69
+ value :ERROR, 3
70
+ end
71
+ add_enum "google.cloud.bigquery.datatransfer.v1.TransferType" do
72
+ value :TRANSFER_TYPE_UNSPECIFIED, 0
73
+ value :BATCH, 1
74
+ value :STREAMING, 2
75
+ end
76
+ add_enum "google.cloud.bigquery.datatransfer.v1.TransferState" do
77
+ value :TRANSFER_STATE_UNSPECIFIED, 0
78
+ value :PENDING, 2
79
+ value :RUNNING, 3
80
+ value :SUCCEEDED, 4
81
+ value :FAILED, 5
82
+ value :CANCELLED, 6
83
+ end
84
+ end
85
+ end
86
+
87
+ module Google
88
+ module Cloud
89
+ module Bigquery
90
+ module DataTransfer
91
+ module V1
92
+ EmailPreferences = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.EmailPreferences").msgclass
93
+ ScheduleOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.ScheduleOptions").msgclass
94
+ TransferConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.TransferConfig").msgclass
95
+ TransferRun = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.TransferRun").msgclass
96
+ TransferMessage = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.TransferMessage").msgclass
97
+ TransferMessage::MessageSeverity = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.TransferMessage.MessageSeverity").enummodule
98
+ TransferType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.TransferType").enummodule
99
+ TransferState = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.datatransfer.v1.TransferState").enummodule
100
+ end
101
+ end
102
+ end
103
+ end
104
+ end
@@ -0,0 +1,15 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/cloud/common_resources.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ require 'google/api/resource_pb'
7
+ Google::Protobuf::DescriptorPool.generated_pool.build do
8
+ add_file("google/cloud/common_resources.proto", :syntax => :proto3) do
9
+ end
10
+ end
11
+
12
+ module Google
13
+ module Cloud
14
+ end
15
+ end
@@ -0,0 +1,4 @@
1
+ # BigQuery Data Transfer 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