google-cloud-web_security_scanner-v1beta 0.1.0

data/lib/google/cloud/websecurityscanner/v1beta/scan_run_error_trace_pb.rb

@@ -0,0 +1,35 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/websecurityscanner/v1beta/scan_run_error_trace.proto
+
+require 'google/protobuf'
+
+require 'google/cloud/websecurityscanner/v1beta/scan_config_error_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/websecurityscanner/v1beta/scan_run_error_trace.proto", :syntax => :proto3) do
+    add_message "google.cloud.websecurityscanner.v1beta.ScanRunErrorTrace" do
+      optional :code, :enum, 1, "google.cloud.websecurityscanner.v1beta.ScanRunErrorTrace.Code"
+      optional :scan_config_error, :message, 2, "google.cloud.websecurityscanner.v1beta.ScanConfigError"
+      optional :most_common_http_error_code, :int32, 3
+    end
+    add_enum "google.cloud.websecurityscanner.v1beta.ScanRunErrorTrace.Code" do
+      value :CODE_UNSPECIFIED, 0
+      value :INTERNAL_ERROR, 1
+      value :SCAN_CONFIG_ISSUE, 2
+      value :AUTHENTICATION_CONFIG_ISSUE, 3
+      value :TIMED_OUT_WHILE_SCANNING, 4
+      value :TOO_MANY_REDIRECTS, 5
+      value :TOO_MANY_HTTP_ERRORS, 6
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module WebSecurityScanner
+      module V1beta
+        ScanRunErrorTrace = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.websecurityscanner.v1beta.ScanRunErrorTrace").msgclass
+        ScanRunErrorTrace::Code = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.websecurityscanner.v1beta.ScanRunErrorTrace.Code").enummodule
+      end
+    end
+  end
+end

data/lib/google/cloud/websecurityscanner/v1beta/scan_run_pb.rb

@@ -0,0 +1,50 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/websecurityscanner/v1beta/scan_run.proto
+
+require 'google/protobuf'
+
+require 'google/api/resource_pb'
+require 'google/cloud/websecurityscanner/v1beta/scan_run_error_trace_pb'
+require 'google/cloud/websecurityscanner/v1beta/scan_run_warning_trace_pb'
+require 'google/protobuf/timestamp_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/websecurityscanner/v1beta/scan_run.proto", :syntax => :proto3) do
+    add_message "google.cloud.websecurityscanner.v1beta.ScanRun" do
+      optional :name, :string, 1
+      optional :execution_state, :enum, 2, "google.cloud.websecurityscanner.v1beta.ScanRun.ExecutionState"
+      optional :result_state, :enum, 3, "google.cloud.websecurityscanner.v1beta.ScanRun.ResultState"
+      optional :start_time, :message, 4, "google.protobuf.Timestamp"
+      optional :end_time, :message, 5, "google.protobuf.Timestamp"
+      optional :urls_crawled_count, :int64, 6
+      optional :urls_tested_count, :int64, 7
+      optional :has_vulnerabilities, :bool, 8
+      optional :progress_percent, :int32, 9
+      optional :error_trace, :message, 10, "google.cloud.websecurityscanner.v1beta.ScanRunErrorTrace"
+      repeated :warning_traces, :message, 11, "google.cloud.websecurityscanner.v1beta.ScanRunWarningTrace"
+    end
+    add_enum "google.cloud.websecurityscanner.v1beta.ScanRun.ExecutionState" do
+      value :EXECUTION_STATE_UNSPECIFIED, 0
+      value :QUEUED, 1
+      value :SCANNING, 2
+      value :FINISHED, 3
+    end
+    add_enum "google.cloud.websecurityscanner.v1beta.ScanRun.ResultState" do
+      value :RESULT_STATE_UNSPECIFIED, 0
+      value :SUCCESS, 1
+      value :ERROR, 2
+      value :KILLED, 3
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module WebSecurityScanner
+      module V1beta
+        ScanRun = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.websecurityscanner.v1beta.ScanRun").msgclass
+        ScanRun::ExecutionState = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.websecurityscanner.v1beta.ScanRun.ExecutionState").enummodule
+        ScanRun::ResultState = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.websecurityscanner.v1beta.ScanRun.ResultState").enummodule
+      end
+    end
+  end
+end

data/lib/google/cloud/websecurityscanner/v1beta/scan_run_warning_trace_pb.rb

@@ -0,0 +1,30 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/websecurityscanner/v1beta/scan_run_warning_trace.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/websecurityscanner/v1beta/scan_run_warning_trace.proto", :syntax => :proto3) do
+    add_message "google.cloud.websecurityscanner.v1beta.ScanRunWarningTrace" do
+      optional :code, :enum, 1, "google.cloud.websecurityscanner.v1beta.ScanRunWarningTrace.Code"
+    end
+    add_enum "google.cloud.websecurityscanner.v1beta.ScanRunWarningTrace.Code" do
+      value :CODE_UNSPECIFIED, 0
+      value :INSUFFICIENT_CRAWL_RESULTS, 1
+      value :TOO_MANY_CRAWL_RESULTS, 2
+      value :TOO_MANY_FUZZ_TASKS, 3
+      value :BLOCKED_BY_IAP, 4
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module WebSecurityScanner
+      module V1beta
+        ScanRunWarningTrace = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.websecurityscanner.v1beta.ScanRunWarningTrace").msgclass
+        ScanRunWarningTrace::Code = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.websecurityscanner.v1beta.ScanRunWarningTrace.Code").enummodule
+      end
+    end
+  end
+end

data/lib/google/cloud/websecurityscanner/v1beta/web_security_scanner_pb.rb

@@ -0,0 +1,116 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/websecurityscanner/v1beta/web_security_scanner.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/client_pb'
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/cloud/websecurityscanner/v1beta/crawled_url_pb'
+require 'google/cloud/websecurityscanner/v1beta/finding_pb'
+require 'google/cloud/websecurityscanner/v1beta/finding_type_stats_pb'
+require 'google/cloud/websecurityscanner/v1beta/scan_config_pb'
+require 'google/cloud/websecurityscanner/v1beta/scan_run_pb'
+require 'google/protobuf/empty_pb'
+require 'google/protobuf/field_mask_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/websecurityscanner/v1beta/web_security_scanner.proto", :syntax => :proto3) do
+    add_message "google.cloud.websecurityscanner.v1beta.CreateScanConfigRequest" do
+      optional :parent, :string, 1
+      optional :scan_config, :message, 2, "google.cloud.websecurityscanner.v1beta.ScanConfig"
+    end
+    add_message "google.cloud.websecurityscanner.v1beta.DeleteScanConfigRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.websecurityscanner.v1beta.GetScanConfigRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.websecurityscanner.v1beta.ListScanConfigsRequest" do
+      optional :parent, :string, 1
+      optional :page_token, :string, 2
+      optional :page_size, :int32, 3
+    end
+    add_message "google.cloud.websecurityscanner.v1beta.UpdateScanConfigRequest" do
+      optional :scan_config, :message, 2, "google.cloud.websecurityscanner.v1beta.ScanConfig"
+      optional :update_mask, :message, 3, "google.protobuf.FieldMask"
+    end
+    add_message "google.cloud.websecurityscanner.v1beta.ListScanConfigsResponse" do
+      repeated :scan_configs, :message, 1, "google.cloud.websecurityscanner.v1beta.ScanConfig"
+      optional :next_page_token, :string, 2
+    end
+    add_message "google.cloud.websecurityscanner.v1beta.StartScanRunRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.websecurityscanner.v1beta.GetScanRunRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.websecurityscanner.v1beta.ListScanRunsRequest" do
+      optional :parent, :string, 1
+      optional :page_token, :string, 2
+      optional :page_size, :int32, 3
+    end
+    add_message "google.cloud.websecurityscanner.v1beta.ListScanRunsResponse" do
+      repeated :scan_runs, :message, 1, "google.cloud.websecurityscanner.v1beta.ScanRun"
+      optional :next_page_token, :string, 2
+    end
+    add_message "google.cloud.websecurityscanner.v1beta.StopScanRunRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.websecurityscanner.v1beta.ListCrawledUrlsRequest" do
+      optional :parent, :string, 1
+      optional :page_token, :string, 2
+      optional :page_size, :int32, 3
+    end
+    add_message "google.cloud.websecurityscanner.v1beta.ListCrawledUrlsResponse" do
+      repeated :crawled_urls, :message, 1, "google.cloud.websecurityscanner.v1beta.CrawledUrl"
+      optional :next_page_token, :string, 2
+    end
+    add_message "google.cloud.websecurityscanner.v1beta.GetFindingRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.websecurityscanner.v1beta.ListFindingsRequest" do
+      optional :parent, :string, 1
+      optional :filter, :string, 2
+      optional :page_token, :string, 3
+      optional :page_size, :int32, 4
+    end
+    add_message "google.cloud.websecurityscanner.v1beta.ListFindingsResponse" do
+      repeated :findings, :message, 1, "google.cloud.websecurityscanner.v1beta.Finding"
+      optional :next_page_token, :string, 2
+    end
+    add_message "google.cloud.websecurityscanner.v1beta.ListFindingTypeStatsRequest" do
+      optional :parent, :string, 1
+    end
+    add_message "google.cloud.websecurityscanner.v1beta.ListFindingTypeStatsResponse" do
+      repeated :finding_type_stats, :message, 1, "google.cloud.websecurityscanner.v1beta.FindingTypeStats"
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module WebSecurityScanner
+      module V1beta
+        CreateScanConfigRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.websecurityscanner.v1beta.CreateScanConfigRequest").msgclass
+        DeleteScanConfigRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.websecurityscanner.v1beta.DeleteScanConfigRequest").msgclass
+        GetScanConfigRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.websecurityscanner.v1beta.GetScanConfigRequest").msgclass
+        ListScanConfigsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.websecurityscanner.v1beta.ListScanConfigsRequest").msgclass
+        UpdateScanConfigRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.websecurityscanner.v1beta.UpdateScanConfigRequest").msgclass
+        ListScanConfigsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.websecurityscanner.v1beta.ListScanConfigsResponse").msgclass
+        StartScanRunRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.websecurityscanner.v1beta.StartScanRunRequest").msgclass
+        GetScanRunRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.websecurityscanner.v1beta.GetScanRunRequest").msgclass
+        ListScanRunsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.websecurityscanner.v1beta.ListScanRunsRequest").msgclass
+        ListScanRunsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.websecurityscanner.v1beta.ListScanRunsResponse").msgclass
+        StopScanRunRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.websecurityscanner.v1beta.StopScanRunRequest").msgclass
+        ListCrawledUrlsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.websecurityscanner.v1beta.ListCrawledUrlsRequest").msgclass
+        ListCrawledUrlsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.websecurityscanner.v1beta.ListCrawledUrlsResponse").msgclass
+        GetFindingRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.websecurityscanner.v1beta.GetFindingRequest").msgclass
+        ListFindingsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.websecurityscanner.v1beta.ListFindingsRequest").msgclass
+        ListFindingsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.websecurityscanner.v1beta.ListFindingsResponse").msgclass
+        ListFindingTypeStatsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.websecurityscanner.v1beta.ListFindingTypeStatsRequest").msgclass
+        ListFindingTypeStatsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.websecurityscanner.v1beta.ListFindingTypeStatsResponse").msgclass
+      end
+    end
+  end
+end

data/lib/google/cloud/websecurityscanner/v1beta/web_security_scanner_services_pb.rb

@@ -0,0 +1,73 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/websecurityscanner/v1beta/web_security_scanner.proto for package 'Google.Cloud.WebSecurityScanner.V1beta'
+# Original file comments:
+# Copyright 2019 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
+#
+#     http://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.
+#
+#
+
+require 'grpc'
+require 'google/cloud/websecurityscanner/v1beta/web_security_scanner_pb'
+
+module Google
+  module Cloud
+    module WebSecurityScanner
+      module V1beta
+        module WebSecurityScanner
+          # Cloud Web Security Scanner Service identifies security vulnerabilities in web
+          # applications hosted on Google Cloud Platform. It crawls your application, and
+          # attempts to exercise as many user inputs and event handlers as possible.
+          class Service
+
+            include GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.cloud.websecurityscanner.v1beta.WebSecurityScanner'
+
+            # Creates a new ScanConfig.
+            rpc :CreateScanConfig, ::Google::Cloud::WebSecurityScanner::V1beta::CreateScanConfigRequest, ::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig
+            # Deletes an existing ScanConfig and its child resources.
+            rpc :DeleteScanConfig, ::Google::Cloud::WebSecurityScanner::V1beta::DeleteScanConfigRequest, ::Google::Protobuf::Empty
+            # Gets a ScanConfig.
+            rpc :GetScanConfig, ::Google::Cloud::WebSecurityScanner::V1beta::GetScanConfigRequest, ::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig
+            # Lists ScanConfigs under a given project.
+            rpc :ListScanConfigs, ::Google::Cloud::WebSecurityScanner::V1beta::ListScanConfigsRequest, ::Google::Cloud::WebSecurityScanner::V1beta::ListScanConfigsResponse
+            # Updates a ScanConfig. This method support partial update of a ScanConfig.
+            rpc :UpdateScanConfig, ::Google::Cloud::WebSecurityScanner::V1beta::UpdateScanConfigRequest, ::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig
+            # Start a ScanRun according to the given ScanConfig.
+            rpc :StartScanRun, ::Google::Cloud::WebSecurityScanner::V1beta::StartScanRunRequest, ::Google::Cloud::WebSecurityScanner::V1beta::ScanRun
+            # Gets a ScanRun.
+            rpc :GetScanRun, ::Google::Cloud::WebSecurityScanner::V1beta::GetScanRunRequest, ::Google::Cloud::WebSecurityScanner::V1beta::ScanRun
+            # Lists ScanRuns under a given ScanConfig, in descending order of ScanRun
+            # stop time.
+            rpc :ListScanRuns, ::Google::Cloud::WebSecurityScanner::V1beta::ListScanRunsRequest, ::Google::Cloud::WebSecurityScanner::V1beta::ListScanRunsResponse
+            # Stops a ScanRun. The stopped ScanRun is returned.
+            rpc :StopScanRun, ::Google::Cloud::WebSecurityScanner::V1beta::StopScanRunRequest, ::Google::Cloud::WebSecurityScanner::V1beta::ScanRun
+            # List CrawledUrls under a given ScanRun.
+            rpc :ListCrawledUrls, ::Google::Cloud::WebSecurityScanner::V1beta::ListCrawledUrlsRequest, ::Google::Cloud::WebSecurityScanner::V1beta::ListCrawledUrlsResponse
+            # Gets a Finding.
+            rpc :GetFinding, ::Google::Cloud::WebSecurityScanner::V1beta::GetFindingRequest, ::Google::Cloud::WebSecurityScanner::V1beta::Finding
+            # List Findings under a given ScanRun.
+            rpc :ListFindings, ::Google::Cloud::WebSecurityScanner::V1beta::ListFindingsRequest, ::Google::Cloud::WebSecurityScanner::V1beta::ListFindingsResponse
+            # List all FindingTypeStats under a given ScanRun.
+            rpc :ListFindingTypeStats, ::Google::Cloud::WebSecurityScanner::V1beta::ListFindingTypeStatsRequest, ::Google::Cloud::WebSecurityScanner::V1beta::ListFindingTypeStatsResponse
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

data/proto_docs/README.md

@@ -0,0 +1,4 @@
+# Web Security Scanner V1beta Protocol Buffer Documentation
+
+These files are for the YARD documentation of the generated protobuf files.
+They are not intended to be required or loaded at runtime.

data/proto_docs/google/api/field_behavior.rb

@@ -0,0 +1,59 @@
+# 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 Api
+    # An indicator of the behavior of a given field (for example, that a field
+    # is required in requests, or given as output but ignored as input).
+    # This **does not** change the behavior in protocol buffers itself; it only
+    # denotes the behavior and may affect how API tooling handles the field.
+    #
+    # Note: This enum **may** receive new values in the future.
+    module FieldBehavior
+      # Conventional default for enums. Do not use this.
+      FIELD_BEHAVIOR_UNSPECIFIED = 0
+
+      # Specifically denotes a field as optional.
+      # While all fields in protocol buffers are optional, this may be specified
+      # for emphasis if appropriate.
+      OPTIONAL = 1
+
+      # Denotes a field as required.
+      # This indicates that the field **must** be provided as part of the request,
+      # and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
+      REQUIRED = 2
+
+      # Denotes a field as output only.
+      # This indicates that the field is provided in responses, but including the
+      # field in a request does nothing (the server *must* ignore it and
+      # *must not* throw an error as a result of the field's presence).
+      OUTPUT_ONLY = 3
+
+      # Denotes a field as input only.
+      # This indicates that the field is provided in requests, and the
+      # corresponding field is not included in output.
+      INPUT_ONLY = 4
+
+      # Denotes a field as immutable.
+      # This indicates that the field may be set once in a request to create a
+      # resource, but may not be changed thereafter.
+      IMMUTABLE = 5
+    end
+  end
+end

data/proto_docs/google/api/resource.rb

@@ -0,0 +1,283 @@
+# 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 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