google-cloud-netapp-v1 0.a → 0.2.0

data/proto_docs/google/api/resource.rb

@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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 Api
+    # A simple descriptor of a resource type.
+    #
+    # ResourceDescriptor annotates a resource message (either by means of a
+    # protobuf annotation or use in the service config), and associates the
+    # resource's schema, the resource type, and the pattern of the resource name.
+    #
+    # Example:
+    #
+    #     message Topic {
+    #       // Indicates this message defines a resource schema.
+    #       // Declares the resource type in the format of {service}/{kind}.
+    #       // For Kubernetes resources, the format is {api group}/{kind}.
+    #       option (google.api.resource) = {
+    #         type: "pubsub.googleapis.com/Topic"
+    #         pattern: "projects/{project}/topics/{topic}"
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: "pubsub.googleapis.com/Topic"
+    #       pattern: "projects/{project}/topics/{topic}"
+    #
+    # Sometimes, resources have multiple patterns, typically because they can
+    # live under multiple parents.
+    #
+    # Example:
+    #
+    #     message LogEntry {
+    #       option (google.api.resource) = {
+    #         type: "logging.googleapis.com/LogEntry"
+    #         pattern: "projects/{project}/logs/{log}"
+    #         pattern: "folders/{folder}/logs/{log}"
+    #         pattern: "organizations/{organization}/logs/{log}"
+    #         pattern: "billingAccounts/{billing_account}/logs/{log}"
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: 'logging.googleapis.com/LogEntry'
+    #       pattern: "projects/{project}/logs/{log}"
+    #       pattern: "folders/{folder}/logs/{log}"
+    #       pattern: "organizations/{organization}/logs/{log}"
+    #       pattern: "billingAccounts/{billing_account}/logs/{log}"
+    # @!attribute [rw] type
+    #   @return [::String]
+    #     The resource type. It must be in the format of
+    #     \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
+    #     singular and must not include version numbers.
+    #
+    #     Example: `storage.googleapis.com/Bucket`
+    #
+    #     The value of the resource_type_kind must follow the regular expression
+    #     /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
+    #     should use PascalCase (UpperCamelCase). The maximum number of
+    #     characters allowed for the `resource_type_kind` is 100.
+    # @!attribute [rw] pattern
+    #   @return [::Array<::String>]
+    #     Optional. The relative resource name pattern associated with this resource
+    #     type. The DNS prefix of the full resource name shouldn't be specified here.
+    #
+    #     The path pattern must follow the syntax, which aligns with HTTP binding
+    #     syntax:
+    #
+    #         Template = Segment { "/" Segment } ;
+    #         Segment = LITERAL | Variable ;
+    #         Variable = "{" LITERAL "}" ;
+    #
+    #     Examples:
+    #
+    #         - "projects/\\{project}/topics/\\{topic}"
+    #         - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
+    #
+    #     The components in braces correspond to the IDs for each resource in the
+    #     hierarchy. It is expected that, if multiple patterns are provided,
+    #     the same component name (e.g. "project") refers to IDs of the same
+    #     type of resource.
+    # @!attribute [rw] name_field
+    #   @return [::String]
+    #     Optional. The field on the resource that designates the resource name
+    #     field. If omitted, this is assumed to be "name".
+    # @!attribute [rw] history
+    #   @return [::Google::Api::ResourceDescriptor::History]
+    #     Optional. The historical or future-looking state of the resource pattern.
+    #
+    #     Example:
+    #
+    #         // The InspectTemplate message originally only supported resource
+    #         // names with organization, and project was added later.
+    #         message InspectTemplate {
+    #           option (google.api.resource) = {
+    #             type: "dlp.googleapis.com/InspectTemplate"
+    #             pattern:
+    #             "organizations/{organization}/inspectTemplates/{inspect_template}"
+    #             pattern: "projects/{project}/inspectTemplates/{inspect_template}"
+    #             history: ORIGINALLY_SINGLE_PATTERN
+    #           };
+    #         }
+    # @!attribute [rw] plural
+    #   @return [::String]
+    #     The plural name used in the resource name and permission names, such as
+    #     'projects' for the resource name of 'projects/\\{project}' and the permission
+    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
+    #     concept of the `plural` field in k8s CRD spec
+    #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #
+    #     Note: The plural form is required even for singleton resources. See
+    #     https://aip.dev/156
+    # @!attribute [rw] singular
+    #   @return [::String]
+    #     The same concept of the `singular` field in k8s CRD spec
+    #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #     Such as "project" for the `resourcemanager.googleapis.com/Project` type.
+    # @!attribute [rw] style
+    #   @return [::Array<::Google::Api::ResourceDescriptor::Style>]
+    #     Style flag(s) for this resource.
+    #     These indicate that a resource is expected to conform to a given
+    #     style. See the specific style flags for additional information.
+    class ResourceDescriptor
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # A description of the historical or future-looking state of the
+      # resource pattern.
+      module History
+        # The "unset" value.
+        HISTORY_UNSPECIFIED = 0
+
+        # The resource originally had one pattern and launched as such, and
+        # additional patterns were added later.
+        ORIGINALLY_SINGLE_PATTERN = 1
+
+        # The resource has one pattern, but the API owner expects to add more
+        # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
+        # that from being necessary once there are multiple patterns.)
+        FUTURE_MULTI_PATTERN = 2
+      end
+
+      # A flag representing a specific style that a resource claims to conform to.
+      module Style
+        # The unspecified value. Do not use.
+        STYLE_UNSPECIFIED = 0
+
+        # This resource is intended to be "declarative-friendly".
+        #
+        # Declarative-friendly resources must be more strictly consistent, and
+        # setting this to true communicates to tools that this resource should
+        # adhere to declarative-friendly expectations.
+        #
+        # Note: This is used by the API linter (linter.aip.dev) to enable
+        # additional checks.
+        DECLARATIVE_FRIENDLY = 1
+      end
+    end
+
+    # Defines a proto annotation that describes a string field that refers to
+    # an API resource.
+    # @!attribute [rw] type
+    #   @return [::String]
+    #     The resource type that the annotated field references.
+    #
+    #     Example:
+    #
+    #         message Subscription {
+    #           string topic = 2 [(google.api.resource_reference) = {
+    #             type: "pubsub.googleapis.com/Topic"
+    #           }];
+    #         }
+    #
+    #     Occasionally, a field may reference an arbitrary resource. In this case,
+    #     APIs use the special value * in their resource reference.
+    #
+    #     Example:
+    #
+    #         message GetIamPolicyRequest {
+    #           string resource = 2 [(google.api.resource_reference) = {
+    #             type: "*"
+    #           }];
+    #         }
+    # @!attribute [rw] child_type
+    #   @return [::String]
+    #     The resource type of a child collection that the annotated field
+    #     references. This is useful for annotating the `parent` field that
+    #     doesn't have a fixed resource type.
+    #
+    #     Example:
+    #
+    #         message ListLogEntriesRequest {
+    #           string parent = 1 [(google.api.resource_reference) = {
+    #             child_type: "logging.googleapis.com/LogEntry"
+    #           };
+    #         }
+    class ResourceReference
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/cloud/netapp/v1/active_directory.rb

@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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 NetApp
+      module V1
+        # ListActiveDirectoriesRequest for requesting multiple active directories.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Parent value for ListActiveDirectoriesRequest
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Requested page size. Server may return fewer items than requested.
+        #     If unspecified, the server will pick an appropriate default.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A token identifying a page of results the server should return.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Filtering results
+        # @!attribute [rw] order_by
+        #   @return [::String]
+        #     Hint for how to order the results
+        class ListActiveDirectoriesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # ListActiveDirectoriesResponse contains all the active directories requested.
+        # @!attribute [rw] active_directories
+        #   @return [::Array<::Google::Cloud::NetApp::V1::ActiveDirectory>]
+        #     The list of active directories.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token identifying a page of results the server should return.
+        # @!attribute [rw] unreachable
+        #   @return [::Array<::String>]
+        #     Locations that could not be reached.
+        class ListActiveDirectoriesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # GetActiveDirectory for getting a single active directory.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Name of the active directory.
+        class GetActiveDirectoryRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # CreateActiveDirectoryRequest for creating an active directory.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Value for parent.
+        # @!attribute [rw] active_directory
+        #   @return [::Google::Cloud::NetApp::V1::ActiveDirectory]
+        #     Required. Fields of the to be created active directory.
+        # @!attribute [rw] active_directory_id
+        #   @return [::String]
+        #     Required. ID of the active directory to create.
+        class CreateActiveDirectoryRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # UpdateActiveDirectoryRequest for updating an active directory.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Required. Field mask is used to specify the fields to be overwritten in the
+        #     Active Directory resource by the update.
+        #     The fields specified in the update_mask are relative to the resource, not
+        #     the full request. A field will be overwritten if it is in the mask. If the
+        #     user does not provide a mask then all fields will be overwritten.
+        # @!attribute [rw] active_directory
+        #   @return [::Google::Cloud::NetApp::V1::ActiveDirectory]
+        #     Required. The volume being updated
+        class UpdateActiveDirectoryRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # DeleteActiveDirectoryRequest for deleting a single active directory.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Name of the active directory.
+        class DeleteActiveDirectoryRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # ActiveDirectory is the public representation of the active directory config.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The resource name of the active directory.
+        #     Format:
+        #     `projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}`.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Create time of the active directory.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::NetApp::V1::ActiveDirectory::State]
+        #     Output only. The state of the AD.
+        # @!attribute [rw] domain
+        #   @return [::String]
+        #     Required. Name of the Active Directory domain
+        # @!attribute [rw] site
+        #   @return [::String]
+        #     The Active Directory site the service will limit Domain Controller
+        #     discovery too.
+        # @!attribute [rw] dns
+        #   @return [::String]
+        #     Required. Comma separated list of DNS server IP addresses for the Active
+        #     Directory domain.
+        # @!attribute [rw] net_bios_prefix
+        #   @return [::String]
+        #     Required. NetBIOSPrefix is used as a prefix for SMB server name.
+        # @!attribute [rw] organizational_unit
+        #   @return [::String]
+        #     The Organizational Unit (OU) within the Windows Active Directory the user
+        #     belongs to.
+        # @!attribute [rw] aes_encryption
+        #   @return [::Boolean]
+        #     If enabled, AES encryption will be enabled for SMB communication.
+        # @!attribute [rw] username
+        #   @return [::String]
+        #     Required. Username of the Active Directory domain administrator.
+        # @!attribute [rw] password
+        #   @return [::String]
+        #     Required. Password of the Active Directory domain administrator.
+        # @!attribute [rw] backup_operators
+        #   @return [::Array<::String>]
+        #     Users to be added to the Built-in Backup Operator active directory group.
+        # @!attribute [rw] security_operators
+        #   @return [::Array<::String>]
+        #     Domain users to be given the SeSecurityPrivilege.
+        # @!attribute [rw] kdc_hostname
+        #   @return [::String]
+        #     Name of the active directory machine. This optional parameter is used only
+        #     while creating kerberos volume
+        # @!attribute [rw] kdc_ip
+        #   @return [::String]
+        #     KDC server IP address for the active directory machine.
+        # @!attribute [rw] nfs_users_with_ldap
+        #   @return [::Boolean]
+        #     If enabled, will allow access to local users and LDAP users. If access is
+        #     needed for only LDAP users, it has to be disabled.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Description of the active directory.
+        # @!attribute [rw] ldap_signing
+        #   @return [::Boolean]
+        #     Specifies whether or not the LDAP traffic needs to be signed.
+        # @!attribute [rw] encrypt_dc_connections
+        #   @return [::Boolean]
+        #     If enabled, traffic between the SMB server to Domain Controller (DC) will
+        #     be encrypted.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Labels for the active directory.
+        # @!attribute [r] state_details
+        #   @return [::String]
+        #     Output only. The state details of the Active Directory.
+        class ActiveDirectory
+          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
+
+          # The Active Directory States
+          module State
+            # Unspecified Active Directory State
+            STATE_UNSPECIFIED = 0
+
+            # Active Directory State is Creating
+            CREATING = 1
+
+            # Active Directory State is Ready
+            READY = 2
+
+            # Active Directory State is Updating
+            UPDATING = 3
+
+            # Active Directory State is In use
+            IN_USE = 4
+
+            # Active Directory State is Deleting
+            DELETING = 5
+
+            # Active Directory State is Error
+            ERROR = 6
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/netapp/v1/cloud_netapp_service.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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 NetApp
+      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] status_message
+        #   @return [::String]
+        #     Output only. Human-readable status of the operation, if any.
+        # @!attribute [r] requested_cancellation
+        #   @return [::Boolean]
+        #     Output only. Identifies whether the user has requested cancellation
+        #     of the operation. Operations that have been canceled successfully
+        #     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 OperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/netapp/v1/common.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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 NetApp
+      module V1
+        # The service levels - Storage Pool, Volumes
+        module ServiceLevel
+          SERVICE_LEVEL_UNSPECIFIED = 0
+
+          PREMIUM = 1
+
+          EXTREME = 2
+
+          # Standard (Software offering)
+          STANDARD = 3
+        end
+
+        # Defined the current volume encryption key source.
+        module EncryptionType
+          # The source of encryption key is not specified.
+          ENCRYPTION_TYPE_UNSPECIFIED = 0
+
+          # Google managed encryption key.
+          SERVICE_MANAGED = 1
+
+          # Customer managed encryption key, which is stored in KMS.
+          CLOUD_KMS = 2
+        end
+      end
+    end
+  end
+end