google-cloud-managed_identities-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 (28) 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 +75 -0
  6. data/lib/google-cloud-managed_identities-v1.rb +21 -0
  7. data/lib/google/cloud/managed_identities/v1.rb +38 -0
  8. data/lib/google/cloud/managed_identities/v1/managed_identities_service.rb +81 -0
  9. data/lib/google/cloud/managed_identities/v1/managed_identities_service/client.rb +1160 -0
  10. data/lib/google/cloud/managed_identities/v1/managed_identities_service/credentials.rb +51 -0
  11. data/lib/google/cloud/managed_identities/v1/managed_identities_service/operations.rb +570 -0
  12. data/lib/google/cloud/managed_identities/v1/managed_identities_service/paths.rb +69 -0
  13. data/lib/google/cloud/managed_identities/v1/version.rb +28 -0
  14. data/lib/google/cloud/managedidentities/v1/managed_identities_service_pb.rb +97 -0
  15. data/lib/google/cloud/managedidentities/v1/managed_identities_service_services_pb.rb +96 -0
  16. data/lib/google/cloud/managedidentities/v1/resource_pb.rb +84 -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 +283 -0
  20. data/proto_docs/google/cloud/managedidentities/v1/managed_identities_service.rb +253 -0
  21. data/proto_docs/google/cloud/managedidentities/v1/resource.rb +218 -0
  22. data/proto_docs/google/longrunning/operations.rb +150 -0
  23. data/proto_docs/google/protobuf/any.rb +138 -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/timestamp.rb +120 -0
  27. data/proto_docs/google/rpc/status.rb +46 -0
  28. metadata +210 -0
@@ -0,0 +1,69 @@
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 ManagedIdentities
23
+ module V1
24
+ module ManagedIdentitiesService
25
+ # Path helper methods for the ManagedIdentitiesService API.
26
+ module Paths
27
+ ##
28
+ # Create a fully-qualified Domain resource string.
29
+ #
30
+ # The resource will be in the following format:
31
+ #
32
+ # `projects/{project}/locations/{location}/domains/{domain}`
33
+ #
34
+ # @param project [String]
35
+ # @param location [String]
36
+ # @param domain [String]
37
+ #
38
+ # @return [::String]
39
+ def domain_path project:, location:, domain:
40
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
41
+ raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
42
+
43
+ "projects/#{project}/locations/#{location}/domains/#{domain}"
44
+ end
45
+
46
+ ##
47
+ # Create a fully-qualified Location resource string.
48
+ #
49
+ # The resource will be in the following format:
50
+ #
51
+ # `projects/{project}/locations/{location}`
52
+ #
53
+ # @param project [String]
54
+ # @param location [String]
55
+ #
56
+ # @return [::String]
57
+ def location_path project:, location:
58
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
59
+
60
+ "projects/#{project}/locations/#{location}"
61
+ end
62
+
63
+ extend self
64
+ end
65
+ end
66
+ end
67
+ end
68
+ end
69
+ 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 ManagedIdentities
23
+ module V1
24
+ VERSION = "0.1.0"
25
+ end
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,97 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/cloud/managedidentities/v1/managed_identities_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/managedidentities/v1/resource_pb'
11
+ require 'google/longrunning/operations_pb'
12
+ require 'google/protobuf/field_mask_pb'
13
+ require 'google/protobuf/timestamp_pb'
14
+ Google::Protobuf::DescriptorPool.generated_pool.build do
15
+ add_file("google/cloud/managedidentities/v1/managed_identities_service.proto", :syntax => :proto3) do
16
+ add_message "google.cloud.managedidentities.v1.OpMetadata" do
17
+ optional :create_time, :message, 1, "google.protobuf.Timestamp"
18
+ optional :end_time, :message, 2, "google.protobuf.Timestamp"
19
+ optional :target, :string, 3
20
+ optional :verb, :string, 4
21
+ optional :requested_cancellation, :bool, 5
22
+ optional :api_version, :string, 6
23
+ end
24
+ add_message "google.cloud.managedidentities.v1.CreateMicrosoftAdDomainRequest" do
25
+ optional :parent, :string, 1
26
+ optional :domain_name, :string, 2
27
+ optional :domain, :message, 3, "google.cloud.managedidentities.v1.Domain"
28
+ end
29
+ add_message "google.cloud.managedidentities.v1.ResetAdminPasswordRequest" do
30
+ optional :name, :string, 1
31
+ end
32
+ add_message "google.cloud.managedidentities.v1.ResetAdminPasswordResponse" do
33
+ optional :password, :string, 1
34
+ end
35
+ add_message "google.cloud.managedidentities.v1.ListDomainsRequest" do
36
+ optional :parent, :string, 1
37
+ optional :page_size, :int32, 2
38
+ optional :page_token, :string, 3
39
+ optional :filter, :string, 4
40
+ optional :order_by, :string, 5
41
+ end
42
+ add_message "google.cloud.managedidentities.v1.ListDomainsResponse" do
43
+ repeated :domains, :message, 1, "google.cloud.managedidentities.v1.Domain"
44
+ optional :next_page_token, :string, 2
45
+ repeated :unreachable, :string, 3
46
+ end
47
+ add_message "google.cloud.managedidentities.v1.GetDomainRequest" do
48
+ optional :name, :string, 1
49
+ end
50
+ add_message "google.cloud.managedidentities.v1.UpdateDomainRequest" do
51
+ optional :update_mask, :message, 1, "google.protobuf.FieldMask"
52
+ optional :domain, :message, 2, "google.cloud.managedidentities.v1.Domain"
53
+ end
54
+ add_message "google.cloud.managedidentities.v1.DeleteDomainRequest" do
55
+ optional :name, :string, 1
56
+ end
57
+ add_message "google.cloud.managedidentities.v1.AttachTrustRequest" do
58
+ optional :name, :string, 1
59
+ optional :trust, :message, 2, "google.cloud.managedidentities.v1.Trust"
60
+ end
61
+ add_message "google.cloud.managedidentities.v1.ReconfigureTrustRequest" do
62
+ optional :name, :string, 1
63
+ optional :target_domain_name, :string, 2
64
+ repeated :target_dns_ip_addresses, :string, 3
65
+ end
66
+ add_message "google.cloud.managedidentities.v1.DetachTrustRequest" do
67
+ optional :name, :string, 1
68
+ optional :trust, :message, 2, "google.cloud.managedidentities.v1.Trust"
69
+ end
70
+ add_message "google.cloud.managedidentities.v1.ValidateTrustRequest" do
71
+ optional :name, :string, 1
72
+ optional :trust, :message, 2, "google.cloud.managedidentities.v1.Trust"
73
+ end
74
+ end
75
+ end
76
+
77
+ module Google
78
+ module Cloud
79
+ module ManagedIdentities
80
+ module V1
81
+ OpMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.managedidentities.v1.OpMetadata").msgclass
82
+ CreateMicrosoftAdDomainRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.managedidentities.v1.CreateMicrosoftAdDomainRequest").msgclass
83
+ ResetAdminPasswordRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.managedidentities.v1.ResetAdminPasswordRequest").msgclass
84
+ ResetAdminPasswordResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.managedidentities.v1.ResetAdminPasswordResponse").msgclass
85
+ ListDomainsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.managedidentities.v1.ListDomainsRequest").msgclass
86
+ ListDomainsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.managedidentities.v1.ListDomainsResponse").msgclass
87
+ GetDomainRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.managedidentities.v1.GetDomainRequest").msgclass
88
+ UpdateDomainRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.managedidentities.v1.UpdateDomainRequest").msgclass
89
+ DeleteDomainRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.managedidentities.v1.DeleteDomainRequest").msgclass
90
+ AttachTrustRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.managedidentities.v1.AttachTrustRequest").msgclass
91
+ ReconfigureTrustRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.managedidentities.v1.ReconfigureTrustRequest").msgclass
92
+ DetachTrustRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.managedidentities.v1.DetachTrustRequest").msgclass
93
+ ValidateTrustRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.managedidentities.v1.ValidateTrustRequest").msgclass
94
+ end
95
+ end
96
+ end
97
+ end
@@ -0,0 +1,96 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # Source: google/cloud/managedidentities/v1/managed_identities_service.proto for package 'Google.Cloud.ManagedIdentities.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/managedidentities/v1/managed_identities_service_pb'
22
+
23
+ module Google
24
+ module Cloud
25
+ module ManagedIdentities
26
+ module V1
27
+ module ManagedIdentitiesService
28
+ # ## API Overview
29
+ #
30
+ # The `managedidentites.googleapis.com` service implements the Google Cloud
31
+ # Managed Identites API for identity services
32
+ # (e.g. Microsoft Active Directory).
33
+ #
34
+ # The Managed Identities service provides methods to manage
35
+ # (create/read/update/delete) domains, reset managed identities admin password,
36
+ # add/remove domain controllers in GCP regions and add/remove VPC peering.
37
+ #
38
+ # ## Data Model
39
+ #
40
+ # The Managed Identities service exposes the following resources:
41
+ #
42
+ # * Locations as global, named as follows:
43
+ # `projects/{project_id}/locations/global`.
44
+ #
45
+ # * Domains, named as follows:
46
+ # `/projects/{project_id}/locations/global/domain/{domain_name}`.
47
+ #
48
+ # The `{domain_name}` refers to fully qualified domain name in the customer
49
+ # project e.g. mydomain.myorganization.com, with the following restrictions:
50
+ #
51
+ # * Must contain only lowercase letters, numbers, periods and hyphens.
52
+ # * Must start with a letter.
53
+ # * Must contain between 2-64 characters.
54
+ # * Must end with a number or a letter.
55
+ # * Must not start with period.
56
+ # * First segement length (mydomain form example above) shouldn't exceed
57
+ # 15 chars.
58
+ # * The last segment cannot be fully numeric.
59
+ # * Must be unique within the customer project.
60
+ class Service
61
+
62
+ include GRPC::GenericService
63
+
64
+ self.marshal_class_method = :encode
65
+ self.unmarshal_class_method = :decode
66
+ self.service_name = 'google.cloud.managedidentities.v1.ManagedIdentitiesService'
67
+
68
+ # Creates a Microsoft AD domain.
69
+ rpc :CreateMicrosoftAdDomain, ::Google::Cloud::ManagedIdentities::V1::CreateMicrosoftAdDomainRequest, ::Google::Longrunning::Operation
70
+ # Resets a domain's administrator password.
71
+ rpc :ResetAdminPassword, ::Google::Cloud::ManagedIdentities::V1::ResetAdminPasswordRequest, ::Google::Cloud::ManagedIdentities::V1::ResetAdminPasswordResponse
72
+ # Lists domains in a project.
73
+ rpc :ListDomains, ::Google::Cloud::ManagedIdentities::V1::ListDomainsRequest, ::Google::Cloud::ManagedIdentities::V1::ListDomainsResponse
74
+ # Gets information about a domain.
75
+ rpc :GetDomain, ::Google::Cloud::ManagedIdentities::V1::GetDomainRequest, ::Google::Cloud::ManagedIdentities::V1::Domain
76
+ # Updates the metadata and configuration of a domain.
77
+ rpc :UpdateDomain, ::Google::Cloud::ManagedIdentities::V1::UpdateDomainRequest, ::Google::Longrunning::Operation
78
+ # Deletes a domain.
79
+ rpc :DeleteDomain, ::Google::Cloud::ManagedIdentities::V1::DeleteDomainRequest, ::Google::Longrunning::Operation
80
+ # Adds an AD trust to a domain.
81
+ rpc :AttachTrust, ::Google::Cloud::ManagedIdentities::V1::AttachTrustRequest, ::Google::Longrunning::Operation
82
+ # Updates the DNS conditional forwarder.
83
+ rpc :ReconfigureTrust, ::Google::Cloud::ManagedIdentities::V1::ReconfigureTrustRequest, ::Google::Longrunning::Operation
84
+ # Removes an AD trust.
85
+ rpc :DetachTrust, ::Google::Cloud::ManagedIdentities::V1::DetachTrustRequest, ::Google::Longrunning::Operation
86
+ # Validates a trust state, that the target domain is reachable, and that the
87
+ # target domain is able to accept incoming trust requests.
88
+ rpc :ValidateTrust, ::Google::Cloud::ManagedIdentities::V1::ValidateTrustRequest, ::Google::Longrunning::Operation
89
+ end
90
+
91
+ Stub = Service.rpc_stub_class
92
+ end
93
+ end
94
+ end
95
+ end
96
+ end
@@ -0,0 +1,84 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/cloud/managedidentities/v1/resource.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ require 'google/api/field_behavior_pb'
7
+ require 'google/api/resource_pb'
8
+ require 'google/protobuf/timestamp_pb'
9
+ require 'google/api/annotations_pb'
10
+ Google::Protobuf::DescriptorPool.generated_pool.build do
11
+ add_file("google/cloud/managedidentities/v1/resource.proto", :syntax => :proto3) do
12
+ add_message "google.cloud.managedidentities.v1.Domain" do
13
+ optional :name, :string, 1
14
+ map :labels, :string, :string, 2
15
+ repeated :authorized_networks, :string, 3
16
+ optional :reserved_ip_range, :string, 4
17
+ repeated :locations, :string, 5
18
+ optional :admin, :string, 6
19
+ optional :fqdn, :string, 10
20
+ optional :create_time, :message, 11, "google.protobuf.Timestamp"
21
+ optional :update_time, :message, 12, "google.protobuf.Timestamp"
22
+ optional :state, :enum, 13, "google.cloud.managedidentities.v1.Domain.State"
23
+ optional :status_message, :string, 14
24
+ repeated :trusts, :message, 15, "google.cloud.managedidentities.v1.Trust"
25
+ end
26
+ add_enum "google.cloud.managedidentities.v1.Domain.State" do
27
+ value :STATE_UNSPECIFIED, 0
28
+ value :CREATING, 1
29
+ value :READY, 2
30
+ value :UPDATING, 3
31
+ value :DELETING, 4
32
+ value :REPAIRING, 5
33
+ value :PERFORMING_MAINTENANCE, 6
34
+ value :UNAVAILABLE, 7
35
+ end
36
+ add_message "google.cloud.managedidentities.v1.Trust" do
37
+ optional :target_domain_name, :string, 1
38
+ optional :trust_type, :enum, 2, "google.cloud.managedidentities.v1.Trust.TrustType"
39
+ optional :trust_direction, :enum, 3, "google.cloud.managedidentities.v1.Trust.TrustDirection"
40
+ optional :selective_authentication, :bool, 4
41
+ repeated :target_dns_ip_addresses, :string, 5
42
+ optional :trust_handshake_secret, :string, 6
43
+ optional :create_time, :message, 7, "google.protobuf.Timestamp"
44
+ optional :update_time, :message, 8, "google.protobuf.Timestamp"
45
+ optional :state, :enum, 9, "google.cloud.managedidentities.v1.Trust.State"
46
+ optional :state_description, :string, 11
47
+ optional :last_trust_heartbeat_time, :message, 12, "google.protobuf.Timestamp"
48
+ end
49
+ add_enum "google.cloud.managedidentities.v1.Trust.State" do
50
+ value :STATE_UNSPECIFIED, 0
51
+ value :CREATING, 1
52
+ value :UPDATING, 2
53
+ value :DELETING, 3
54
+ value :CONNECTED, 4
55
+ value :DISCONNECTED, 5
56
+ end
57
+ add_enum "google.cloud.managedidentities.v1.Trust.TrustType" do
58
+ value :TRUST_TYPE_UNSPECIFIED, 0
59
+ value :FOREST, 1
60
+ value :EXTERNAL, 2
61
+ end
62
+ add_enum "google.cloud.managedidentities.v1.Trust.TrustDirection" do
63
+ value :TRUST_DIRECTION_UNSPECIFIED, 0
64
+ value :INBOUND, 1
65
+ value :OUTBOUND, 2
66
+ value :BIDIRECTIONAL, 3
67
+ end
68
+ end
69
+ end
70
+
71
+ module Google
72
+ module Cloud
73
+ module ManagedIdentities
74
+ module V1
75
+ Domain = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.managedidentities.v1.Domain").msgclass
76
+ Domain::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.managedidentities.v1.Domain.State").enummodule
77
+ Trust = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.managedidentities.v1.Trust").msgclass
78
+ Trust::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.managedidentities.v1.Trust.State").enummodule
79
+ Trust::TrustType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.managedidentities.v1.Trust.TrustType").enummodule
80
+ Trust::TrustDirection = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.managedidentities.v1.Trust.TrustDirection").enummodule
81
+ end
82
+ end
83
+ end
84
+ end
@@ -0,0 +1,4 @@
1
+ # Managed Service for Microsoft Active Directory API 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,283 @@
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 and permission names, such as
187
+ # 'projects' for the resource name of 'projects/\\{project}' and the permission
188
+ # name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
189
+ # concept of the `plural` field in k8s CRD spec
190
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
191
+ #
192
+ # Note: The plural form is required even for singleton resources. See
193
+ # https://aip.dev/156
194
+ # @!attribute [rw] singular
195
+ # @return [::String]
196
+ # The same concept of the `singular` field in k8s CRD spec
197
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
198
+ # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
199
+ # @!attribute [rw] style
200
+ # @return [::Array<::Google::Api::ResourceDescriptor::Style>]
201
+ # Style flag(s) for this resource.
202
+ # These indicate that a resource is expected to conform to a given
203
+ # style. See the specific style flags for additional information.
204
+ class ResourceDescriptor
205
+ include ::Google::Protobuf::MessageExts
206
+ extend ::Google::Protobuf::MessageExts::ClassMethods
207
+
208
+ # A description of the historical or future-looking state of the
209
+ # resource pattern.
210
+ module History
211
+ # The "unset" value.
212
+ HISTORY_UNSPECIFIED = 0
213
+
214
+ # The resource originally had one pattern and launched as such, and
215
+ # additional patterns were added later.
216
+ ORIGINALLY_SINGLE_PATTERN = 1
217
+
218
+ # The resource has one pattern, but the API owner expects to add more
219
+ # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
220
+ # that from being necessary once there are multiple patterns.)
221
+ FUTURE_MULTI_PATTERN = 2
222
+ end
223
+
224
+ # A flag representing a specific style that a resource claims to conform to.
225
+ module Style
226
+ # The unspecified value. Do not use.
227
+ STYLE_UNSPECIFIED = 0
228
+
229
+ # This resource is intended to be "declarative-friendly".
230
+ #
231
+ # Declarative-friendly resources must be more strictly consistent, and
232
+ # setting this to true communicates to tools that this resource should
233
+ # adhere to declarative-friendly expectations.
234
+ #
235
+ # Note: This is used by the API linter (linter.aip.dev) to enable
236
+ # additional checks.
237
+ DECLARATIVE_FRIENDLY = 1
238
+ end
239
+ end
240
+
241
+ # Defines a proto annotation that describes a string field that refers to
242
+ # an API resource.
243
+ # @!attribute [rw] type
244
+ # @return [::String]
245
+ # The resource type that the annotated field references.
246
+ #
247
+ # Example:
248
+ #
249
+ # message Subscription {
250
+ # string topic = 2 [(google.api.resource_reference) = {
251
+ # type: "pubsub.googleapis.com/Topic"
252
+ # }];
253
+ # }
254
+ #
255
+ # Occasionally, a field may reference an arbitrary resource. In this case,
256
+ # APIs use the special value * in their resource reference.
257
+ #
258
+ # Example:
259
+ #
260
+ # message GetIamPolicyRequest {
261
+ # string resource = 2 [(google.api.resource_reference) = {
262
+ # type: "*"
263
+ # }];
264
+ # }
265
+ # @!attribute [rw] child_type
266
+ # @return [::String]
267
+ # The resource type of a child collection that the annotated field
268
+ # references. This is useful for annotating the `parent` field that
269
+ # doesn't have a fixed resource type.
270
+ #
271
+ # Example:
272
+ #
273
+ # message ListLogEntriesRequest {
274
+ # string parent = 1 [(google.api.resource_reference) = {
275
+ # child_type: "logging.googleapis.com/LogEntry"
276
+ # };
277
+ # }
278
+ class ResourceReference
279
+ include ::Google::Protobuf::MessageExts
280
+ extend ::Google::Protobuf::MessageExts::ClassMethods
281
+ end
282
+ end
283
+ end