google-cloud-managed_identities-v1 0.1.0

data/proto_docs/google/cloud/managedidentities/v1/managed_identities_service.rb

@@ -0,0 +1,253 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module ManagedIdentities
+      module V1
+        # Represents the metadata of the long-running operation.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the operation was created.
+        # @!attribute [r] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the operation finished running.
+        # @!attribute [r] target
+        #   @return [::String]
+        #     Output only. Server-defined resource path for the target of the operation.
+        # @!attribute [r] verb
+        #   @return [::String]
+        #     Output only. Name of the verb executed by the operation.
+        # @!attribute [r] requested_cancellation
+        #   @return [::Boolean]
+        #     Output only. Identifies whether the user has requested cancellation
+        #     of the operation. Operations that have successfully been cancelled
+        #     have [Operation.error][] value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
+        #     corresponding to `Code.CANCELLED`.
+        # @!attribute [r] api_version
+        #   @return [::String]
+        #     Output only. API version used to start the operation.
+        class OpMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # [CreateMicrosoftAdDomain][google.cloud.managedidentities.v1.CreateMicrosoftAdDomain]
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource project name and location using the form:
+        #     `projects/{project_id}/locations/global`
+        # @!attribute [rw] domain_name
+        #   @return [::String]
+        #     Required. The fully qualified domain name.
+        #     e.g. mydomain.myorganization.com, with the following restrictions:
+        #
+        #      * Must contain only lowercase letters, numbers, periods and hyphens.
+        #      * Must start with a letter.
+        #      * Must contain between 2-64 characters.
+        #      * Must end with a number or a letter.
+        #      * Must not start with period.
+        #      * First segement length (mydomain form example above) shouldn't exceed
+        #        15 chars.
+        #      * The last segment cannot be fully numeric.
+        #      * Must be unique within the customer project.
+        # @!attribute [rw] domain
+        #   @return [::Google::Cloud::ManagedIdentities::V1::Domain]
+        #     Required. A Managed Identity domain resource.
+        class CreateMicrosoftAdDomainRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # [ResetAdminPassword][google.cloud.managedidentities.v1.ResetAdminPassword]
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The domain resource name using the form:
+        #     `projects/{project_id}/locations/global/domains/{domain_name}`
+        class ResetAdminPasswordRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # [ResetAdminPassword][google.cloud.managedidentities.v1.ResetAdminPassword]
+        # @!attribute [rw] password
+        #   @return [::String]
+        #     A random password. See {::Google::Cloud::ManagedIdentities::V1::Domain#admin admin} for more information.
+        class ResetAdminPasswordResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # [ListDomains][google.cloud.managedidentities.v1.ListDomains]
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the domain location using the form:
+        #     `projects/{project_id}/locations/global`
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The maximum number of items to return.
+        #     If not specified, a default value of 1000 will be used.
+        #     Regardless of the page_size value, the response may include a partial list.
+        #     Callers should rely on a response's
+        #     {::Google::Cloud::ManagedIdentities::V1::ListDomainsResponse#next_page_token next_page_token}
+        #     to determine if there are additional results to list.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. The `next_page_token` value returned from a previous ListDomainsRequest
+        #     request, if any.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. A filter specifying constraints of a list operation.
+        #     For example, `Domain.fqdn="mydomain.myorginization"`.
+        # @!attribute [rw] order_by
+        #   @return [::String]
+        #     Optional. Specifies the ordering of results. See
+        #     [Sorting
+        #     order](https://cloud.google.com/apis/design/design_patterns#sorting_order)
+        #     for more information.
+        class ListDomainsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # [ListDomains][google.cloud.managedidentities.v1.ListDomains]
+        # @!attribute [rw] domains
+        #   @return [::Array<::Google::Cloud::ManagedIdentities::V1::Domain>]
+        #     A list of Managed Identities Service domains in the project.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token to retrieve the next page of results, or empty if there are no more
+        #     results in the list.
+        # @!attribute [rw] unreachable
+        #   @return [::Array<::String>]
+        #     A list of locations that could not be reached.
+        class ListDomainsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for [GetDomain][google.cloud.managedidentities.v1.GetDomain]
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The domain resource name using the form:
+        #     `projects/{project_id}/locations/global/domains/{domain_name}`
+        class GetDomainRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # [UpdateDomain][google.cloud.managedidentities.v1.UpdateDomain]
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Required. Mask of fields to update. At least one path must be supplied in this
+        #     field. The elements of the repeated paths field may only include
+        #     fields from {::Google::Cloud::ManagedIdentities::V1::Domain Domain}:
+        #      * `labels`
+        #      * `locations`
+        #      * `authorized_networks`
+        # @!attribute [rw] domain
+        #   @return [::Google::Cloud::ManagedIdentities::V1::Domain]
+        #     Required. Domain message with updated fields. Only supported fields specified in
+        #     update_mask are updated.
+        class UpdateDomainRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # [DeleteDomain][google.cloud.managedidentities.v1.DeleteDomain]
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The domain resource name using the form:
+        #     `projects/{project_id}/locations/global/domains/{domain_name}`
+        class DeleteDomainRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # [AttachTrust][google.cloud.managedidentities.v1.AttachTrust]
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource domain name, project name and location using the form:
+        #     `projects/{project_id}/locations/global/domains/{domain_name}`
+        # @!attribute [rw] trust
+        #   @return [::Google::Cloud::ManagedIdentities::V1::Trust]
+        #     Required. The domain trust resource.
+        class AttachTrustRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # [ReconfigureTrust][google.cloud.managedidentities.v1.ReconfigureTrust]
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource domain name, project name and location using the form:
+        #     `projects/{project_id}/locations/global/domains/{domain_name}`
+        # @!attribute [rw] target_domain_name
+        #   @return [::String]
+        #     Required. The fully-qualified target domain name which will be in trust with current
+        #     domain.
+        # @!attribute [rw] target_dns_ip_addresses
+        #   @return [::Array<::String>]
+        #     Required. The target DNS server IP addresses to resolve the remote domain involved
+        #     in the trust.
+        class ReconfigureTrustRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # [DetachTrust][google.cloud.managedidentities.v1.DetachTrust]
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource domain name, project name, and location using the form:
+        #     `projects/{project_id}/locations/global/domains/{domain_name}`
+        # @!attribute [rw] trust
+        #   @return [::Google::Cloud::ManagedIdentities::V1::Trust]
+        #     Required. The domain trust resource to removed.
+        class DetachTrustRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # [ValidateTrust][google.cloud.managedidentities.v1.ValidateTrust]
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource domain name, project name, and location using the form:
+        #     `projects/{project_id}/locations/global/domains/{domain_name}`
+        # @!attribute [rw] trust
+        #   @return [::Google::Cloud::ManagedIdentities::V1::Trust]
+        #     Required. The domain trust to validate trust state for.
+        class ValidateTrustRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/managedidentities/v1/resource.rb

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module ManagedIdentities
+      module V1
+        # Represents a managed Microsoft Active Directory domain.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The unique name of the domain using the form:
+        #     `projects/{project_id}/locations/global/domains/{domain_name}`.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. Resource labels that can contain user-provided metadata.
+        # @!attribute [rw] authorized_networks
+        #   @return [::Array<::String>]
+        #     Optional. The full names of the Google Compute Engine
+        #     [networks](/compute/docs/networks-and-firewalls#networks) the domain
+        #     instance is connected to. Networks can be added using UpdateDomain.
+        #     The domain is only available on networks listed in `authorized_networks`.
+        #     If CIDR subnets overlap between networks, domain creation will fail.
+        # @!attribute [rw] reserved_ip_range
+        #   @return [::String]
+        #     Required. The CIDR range of internal addresses that are reserved for this
+        #     domain. Reserved networks must be /24 or larger. Ranges must be
+        #     unique and non-overlapping with existing subnets in
+        #     [Domain].[authorized_networks].
+        # @!attribute [rw] locations
+        #   @return [::Array<::String>]
+        #     Required. Locations where domain needs to be provisioned.
+        #     [regions][compute/docs/regions-zones/]
+        #     e.g. us-west1 or us-east4
+        #     Service supports up to 4 locations at once. Each location will use a /26
+        #     block.
+        # @!attribute [rw] admin
+        #   @return [::String]
+        #     Optional. The name of delegated administrator account used to perform
+        #     Active Directory operations. If not specified, `setupadmin` will be used.
+        # @!attribute [r] fqdn
+        #   @return [::String]
+        #     Output only. The fully-qualified domain name of the exposed domain used by
+        #     clients to connect to the service. Similar to what would be chosen for an
+        #     Active Directory set up on an internal network.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the instance was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The last update time.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::ManagedIdentities::V1::Domain::State]
+        #     Output only. The current state of this domain.
+        # @!attribute [r] status_message
+        #   @return [::String]
+        #     Output only. Additional information about the current status of this
+        #     domain, if available.
+        # @!attribute [r] trusts
+        #   @return [::Array<::Google::Cloud::ManagedIdentities::V1::Trust>]
+        #     Output only. The current trusts associated with the domain.
+        class Domain
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Represents the different states of a managed domain.
+          module State
+            # Not set.
+            STATE_UNSPECIFIED = 0
+
+            # The domain is being created.
+            CREATING = 1
+
+            # The domain has been created and is fully usable.
+            READY = 2
+
+            # The domain's configuration is being updated.
+            UPDATING = 3
+
+            # The domain is being deleted.
+            DELETING = 4
+
+            # The domain is being repaired and may be unusable. Details
+            # can be found in the `status_message` field.
+            REPAIRING = 5
+
+            # The domain is undergoing maintenance.
+            PERFORMING_MAINTENANCE = 6
+
+            # The domain is not serving requests.
+            UNAVAILABLE = 7
+          end
+        end
+
+        # Represents a relationship between two domains. This allows a controller in
+        # one domain to authenticate a user in another domain.
+        # @!attribute [rw] target_domain_name
+        #   @return [::String]
+        #     Required. The fully qualified target domain name which will be in trust with the
+        #     current domain.
+        # @!attribute [rw] trust_type
+        #   @return [::Google::Cloud::ManagedIdentities::V1::Trust::TrustType]
+        #     Required. The type of trust represented by the trust resource.
+        # @!attribute [rw] trust_direction
+        #   @return [::Google::Cloud::ManagedIdentities::V1::Trust::TrustDirection]
+        #     Required. The trust direction, which decides if the current domain is trusted,
+        #     trusting, or both.
+        # @!attribute [rw] selective_authentication
+        #   @return [::Boolean]
+        #     Optional. The trust authentication type, which decides whether the trusted side has
+        #     forest/domain wide access or selective access to an approved set of
+        #     resources.
+        # @!attribute [rw] target_dns_ip_addresses
+        #   @return [::Array<::String>]
+        #     Required. The target DNS server IP addresses which can resolve the remote domain
+        #     involved in the trust.
+        # @!attribute [rw] trust_handshake_secret
+        #   @return [::String]
+        #     Required. The trust secret used for the handshake with the target domain. This will
+        #     not be stored.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the instance was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The last update time.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::ManagedIdentities::V1::Trust::State]
+        #     Output only. The current state of the trust.
+        # @!attribute [r] state_description
+        #   @return [::String]
+        #     Output only. Additional information about the current state of the trust, if available.
+        # @!attribute [r] last_trust_heartbeat_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The last heartbeat time when the trust was known to be connected.
+        class Trust
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Represents the different states of a domain trust.
+          module State
+            # Not set.
+            STATE_UNSPECIFIED = 0
+
+            # The domain trust is being created.
+            CREATING = 1
+
+            # The domain trust is being updated.
+            UPDATING = 2
+
+            # The domain trust is being deleted.
+            DELETING = 3
+
+            # The domain trust is connected.
+            CONNECTED = 4
+
+            # The domain trust is disconnected.
+            DISCONNECTED = 5
+          end
+
+          # Represents the different inter-forest trust types.
+          module TrustType
+            # Not set.
+            TRUST_TYPE_UNSPECIFIED = 0
+
+            # The forest trust.
+            FOREST = 1
+
+            # The external domain trust.
+            EXTERNAL = 2
+          end
+
+          # Represents the direction of trust.
+          # See
+          # [System.DirectoryServices.ActiveDirectory.TrustDirection](https://docs.microsoft.com/en-us/dotnet/api/system.directoryservices.activedirectory.trustdirection?view=netframework-4.7.2)
+          # for more information.
+          module TrustDirection
+            # Not set.
+            TRUST_DIRECTION_UNSPECIFIED = 0
+
+            # The inbound direction represents the trusting side.
+            INBOUND = 1
+
+            # The outboud direction represents the trusted side.
+            OUTBOUND = 2
+
+            # The bidirectional direction represents the trusted / trusting side.
+            BIDIRECTIONAL = 3
+          end
+        end
+      end
+    end
+  end
+end