google-cloud-essential_contacts-v1 0.1.0

data/proto_docs/google/api/resource.rb

@@ -0,0 +1,283 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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"
+    #         name_descriptor: {
+    #           pattern: "projects/{project}/topics/{topic}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
+    #         }
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: "pubsub.googleapis.com/Topic"
+    #       name_descriptor:
+    #         - pattern: "projects/{project}/topics/{topic}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
+    #
+    # 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"
+    #         name_descriptor: {
+    #           pattern: "projects/{project}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "folders/{folder}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #           parent_name_extractor: "folders/{folder}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "organizations/{organization}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
+    #           parent_name_extractor: "organizations/{organization}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "billingAccounts/{billing_account}/logs/{log}"
+    #           parent_type: "billing.googleapis.com/BillingAccount"
+    #           parent_name_extractor: "billingAccounts/{billing_account}"
+    #         }
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: 'logging.googleapis.com/LogEntry'
+    #       name_descriptor:
+    #         - pattern: "projects/{project}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
+    #         - pattern: "folders/{folder}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #           parent_name_extractor: "folders/{folder}"
+    #         - pattern: "organizations/{organization}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
+    #           parent_name_extractor: "organizations/{organization}"
+    #         - pattern: "billingAccounts/{billing_account}/logs/{log}"
+    #           parent_type: "billing.googleapis.com/BillingAccount"
+    #           parent_name_extractor: "billingAccounts/{billing_account}"
+    #
+    # For flexible resources, the resource name doesn't contain parent names, but
+    # the resource itself has parents for policy evaluation.
+    #
+    # Example:
+    #
+    #     message Shelf {
+    #       option (google.api.resource) = {
+    #         type: "library.googleapis.com/Shelf"
+    #         name_descriptor: {
+    #           pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #         }
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: 'library.googleapis.com/Shelf'
+    #       name_descriptor:
+    #         - pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #         - pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    # @!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/essentialcontacts/v1/enums.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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 EssentialContacts
+      module V1
+        # The notification categories that an essential contact can be subscribed to.
+        # Each notification will be categorized by the sender into one of the following
+        # categories. All contacts that are subscribed to that category will receive
+        # the notification.
+        module NotificationCategory
+          # Notification category is unrecognized or unspecified.
+          NOTIFICATION_CATEGORY_UNSPECIFIED = 0
+
+          # All notifications related to the resource, including notifications
+          # pertaining to categories added in the future.
+          ALL = 2
+
+          # Notifications related to imminent account suspension.
+          SUSPENSION = 3
+
+          # Notifications related to security/privacy incidents, notifications, and
+          # vulnerabilities.
+          SECURITY = 5
+
+          # Notifications related to technical events and issues such as outages,
+          # errors, or bugs.
+          TECHNICAL = 6
+
+          # Notifications related to billing and payments notifications, price updates,
+          # errors, or credits.
+          BILLING = 7
+
+          # Notifications related to enforcement actions, regulatory compliance, or
+          # government notices.
+          LEGAL = 8
+
+          # Notifications related to new versions, product terms updates, or
+          # deprecations.
+          PRODUCT_UPDATES = 9
+
+          # Child category of TECHNICAL. If assigned, technical incident notifications
+          # will go to these contacts instead of TECHNICAL.
+          TECHNICAL_INCIDENTS = 10
+        end
+
+        # A contact's validation state indicates whether or not it is the correct
+        # contact to be receiving notifications for a particular resource.
+        module ValidationState
+          # The validation state is unknown or unspecified.
+          VALIDATION_STATE_UNSPECIFIED = 0
+
+          # The contact is marked as valid. This is usually done manually by the
+          # contact admin. All new contacts begin in the valid state.
+          VALID = 1
+
+          # The contact is considered invalid. This may become the state if the
+          # contact's email is found to be unreachable.
+          INVALID = 2
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/essentialcontacts/v1/service.rb

@@ -0,0 +1,219 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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 EssentialContacts
+      module V1
+        # A contact that will receive notifications from Google Cloud.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     The identifier for the contact.
+        #     Format: \\{resource_type}/\\{resource_id}/contacts/\\{contact_id}
+        # @!attribute [rw] email
+        #   @return [::String]
+        #     Required. The email address to send notifications to. This does not need to
+        #     be a Google account.
+        # @!attribute [rw] notification_category_subscriptions
+        #   @return [::Array<::Google::Cloud::EssentialContacts::V1::NotificationCategory>]
+        #     The categories of notifications that the contact will receive
+        #     communications for.
+        # @!attribute [rw] language_tag
+        #   @return [::String]
+        #     The preferred language for notifications, as a ISO 639-1 language code. See
+        #     [Supported
+        #     languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages)
+        #     for a list of supported languages.
+        # @!attribute [rw] validation_state
+        #   @return [::Google::Cloud::EssentialContacts::V1::ValidationState]
+        #     The validity of the contact. A contact is considered valid if it is the
+        #     correct recipient for notifications for a particular resource.
+        # @!attribute [rw] validate_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The last time the validation_state was updated, either manually or
+        #     automatically. A contact is considered stale if its validation state was
+        #     updated more than 1 year ago.
+        class Contact
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for the ListContacts method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource name.
+        #     Format: organizations/\\{organization_id}, folders/\\{folder_id} or
+        #     projects/\\{project_id}
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The maximum number of results to return from this request.
+        #     Non-positive values are ignored. The presence of `next_page_token` in the
+        #     response indicates that more results might be available.
+        #     If not specified, the default page_size is 100.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. If present, retrieves the next batch of results from the
+        #     preceding call to this method. `page_token` must be the value of
+        #     `next_page_token` from the previous response. The values of other method
+        #     parameters should be identical to those in the previous call.
+        class ListContactsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for the ListContacts method.
+        # @!attribute [rw] contacts
+        #   @return [::Array<::Google::Cloud::EssentialContacts::V1::Contact>]
+        #     The contacts for the specified resource.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     If there are more results than those appearing in this response, then
+        #     `next_page_token` is included. To get the next set of results, call this
+        #     method again using the value of `next_page_token` as `page_token` and the
+        #     rest of the parameters the same as the original request.
+        class ListContactsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for the GetContact method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the contact to retrieve.
+        #     Format: organizations/\\{organization_id}/contacts/\\{contact_id},
+        #     folders/\\{folder_id}/contacts/\\{contact_id} or
+        #     projects/\\{project_id}/contacts/\\{contact_id}
+        class GetContactRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for the DeleteContact method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the contact to delete.
+        #     Format: organizations/\\{organization_id}/contacts/\\{contact_id},
+        #     folders/\\{folder_id}/contacts/\\{contact_id} or
+        #     projects/\\{project_id}/contacts/\\{contact_id}
+        class DeleteContactRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for the CreateContact method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource to save this contact for.
+        #     Format: organizations/\\{organization_id}, folders/\\{folder_id} or
+        #     projects/\\{project_id}
+        # @!attribute [rw] contact
+        #   @return [::Google::Cloud::EssentialContacts::V1::Contact]
+        #     Required. The contact to create. Must specify an email address and language
+        #     tag.
+        class CreateContactRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for the UpdateContact method.
+        # @!attribute [rw] contact
+        #   @return [::Google::Cloud::EssentialContacts::V1::Contact]
+        #     Required. The contact resource to replace the existing saved contact. Note:
+        #     the email address of the contact cannot be modified.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Optional. The update mask applied to the resource. For the `FieldMask`
+        #     definition, see
+        #     https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
+        class UpdateContactRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for the ComputeContacts method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The name of the resource to compute contacts for.
+        #     Format: organizations/\\{organization_id},
+        #     folders/\\{folder_id} or projects/\\{project_id}
+        # @!attribute [rw] notification_categories
+        #   @return [::Array<::Google::Cloud::EssentialContacts::V1::NotificationCategory>]
+        #     The categories of notifications to compute contacts for. If ALL is included
+        #     in this list, contacts subscribed to any notification category will be
+        #     returned.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The maximum number of results to return from this request.
+        #     Non-positive values are ignored. The presence of `next_page_token` in the
+        #     response indicates that more results might be available.
+        #     If not specified, the default page_size is 100.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. If present, retrieves the next batch of results from the
+        #     preceding call to this method. `page_token` must be the value of
+        #     `next_page_token` from the previous response. The values of other method
+        #     parameters should be identical to those in the previous call.
+        class ComputeContactsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for the ComputeContacts method.
+        # @!attribute [rw] contacts
+        #   @return [::Array<::Google::Cloud::EssentialContacts::V1::Contact>]
+        #     All contacts for the resource that are subscribed to the specified
+        #     notification categories, including contacts inherited from any parent
+        #     resources.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     If there are more results than those appearing in this response, then
+        #     `next_page_token` is included. To get the next set of results, call this
+        #     method again using the value of `next_page_token` as `page_token` and the
+        #     rest of the parameters the same as the original request.
+        class ComputeContactsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for the SendTestMessage method.
+        # @!attribute [rw] contacts
+        #   @return [::Array<::String>]
+        #     Required. The list of names of the contacts to send a test message to.
+        #     Format: organizations/\\{organization_id}/contacts/\\{contact_id},
+        #     folders/\\{folder_id}/contacts/\\{contact_id} or
+        #     projects/\\{project_id}/contacts/\\{contact_id}
+        # @!attribute [rw] resource
+        #   @return [::String]
+        #     Required. The name of the resource to send the test message for. All
+        #     contacts must either be set directly on this resource or inherited from
+        #     another resource that is an ancestor of this one. Format:
+        #     organizations/\\{organization_id}, folders/\\{folder_id} or
+        #     projects/\\{project_id}
+        # @!attribute [rw] notification_category
+        #   @return [::Google::Cloud::EssentialContacts::V1::NotificationCategory]
+        #     Required. The notification category to send the test message for. All
+        #     contacts must be subscribed to this category.
+        class SendTestMessageRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end