google-cloud-service_management-v1 0.1.0

data/proto_docs/google/api/control.rb

@@ -0,0 +1,34 @@
+# 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
+    # Selects and configures the service controller used by the service.  The
+    # service controller handles features like abuse, quota, billing, logging,
+    # monitoring, etc.
+    # @!attribute [rw] environment
+    #   @return [::String]
+    #     The service control environment to use. If empty, no control plane
+    #     feature (like quota and billing) will be enabled.
+    class Control
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/api/documentation.rb

@@ -0,0 +1,164 @@
+# 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
+    # `Documentation` provides the information for describing a service.
+    #
+    # Example:
+    # <pre><code>documentation:
+    #   summary: >
+    #     The Google Calendar API gives access
+    #     to most calendar features.
+    #   pages:
+    #   - name: Overview
+    #     content: &#40;== include google/foo/overview.md ==&#41;
+    #   - name: Tutorial
+    #     content: &#40;== include google/foo/tutorial.md ==&#41;
+    #     subpages;
+    #     - name: Java
+    #       content: &#40;== include google/foo/tutorial_java.md ==&#41;
+    #   rules:
+    #   - selector: google.calendar.Calendar.Get
+    #     description: >
+    #       ...
+    #   - selector: google.calendar.Calendar.Put
+    #     description: >
+    #       ...
+    # </code></pre>
+    # Documentation is provided in markdown syntax. In addition to
+    # standard markdown features, definition lists, tables and fenced
+    # code blocks are supported. Section headers can be provided and are
+    # interpreted relative to the section nesting of the context where
+    # a documentation fragment is embedded.
+    #
+    # Documentation from the IDL is merged with documentation defined
+    # via the config at normalization time, where documentation provided
+    # by config rules overrides IDL provided.
+    #
+    # A number of constructs specific to the API platform are supported
+    # in documentation text.
+    #
+    # In order to reference a proto element, the following
+    # notation can be used:
+    # <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre>
+    # To override the display text used for the link, this can be used:
+    # <pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></pre>
+    # Text can be excluded from doc using the following notation:
+    # <pre><code>&#40;-- internal comment --&#41;</code></pre>
+    #
+    # A few directives are available in documentation. Note that
+    # directives must appear on a single line to be properly
+    # identified. The `include` directive includes a markdown file from
+    # an external source:
+    # <pre><code>&#40;== include path/to/file ==&#41;</code></pre>
+    # The `resource_for` directive marks a message to be the resource of
+    # a collection in REST view. If it is not specified, tools attempt
+    # to infer the resource from the operations in a collection:
+    # <pre><code>&#40;== resource_for v1.shelves.books ==&#41;</code></pre>
+    # The directive `suppress_warning` does not directly affect documentation
+    # and is documented together with service config validation.
+    # @!attribute [rw] summary
+    #   @return [::String]
+    #     A short summary of what the service does. Can only be provided by
+    #     plain text.
+    # @!attribute [rw] pages
+    #   @return [::Array<::Google::Api::Page>]
+    #     The top level pages for the documentation set.
+    # @!attribute [rw] rules
+    #   @return [::Array<::Google::Api::DocumentationRule>]
+    #     A list of documentation rules that apply to individual API elements.
+    #
+    #     **NOTE:** All service configuration rules follow "last one wins" order.
+    # @!attribute [rw] documentation_root_url
+    #   @return [::String]
+    #     The URL to the root of documentation.
+    # @!attribute [rw] overview
+    #   @return [::String]
+    #     Declares a single overview page. For example:
+    #     <pre><code>documentation:
+    #       summary: ...
+    #       overview: &#40;== include overview.md ==&#41;
+    #     </code></pre>
+    #     This is a shortcut for the following declaration (using pages style):
+    #     <pre><code>documentation:
+    #       summary: ...
+    #       pages:
+    #       - name: Overview
+    #         content: &#40;== include overview.md ==&#41;
+    #     </code></pre>
+    #     Note: you cannot specify both `overview` field and `pages` field.
+    class Documentation
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # A documentation rule provides information about individual API elements.
+    # @!attribute [rw] selector
+    #   @return [::String]
+    #     The selector is a comma-separated list of patterns. Each pattern is a
+    #     qualified name of the element which may end in "*", indicating a wildcard.
+    #     Wildcards are only allowed at the end and for a whole component of the
+    #     qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". To
+    #     specify a default for all applicable elements, the whole pattern "*"
+    #     is used.
+    # @!attribute [rw] description
+    #   @return [::String]
+    #     Description of the selected API(s).
+    # @!attribute [rw] deprecation_description
+    #   @return [::String]
+    #     Deprecation description of the selected element(s). It can be provided if an
+    #     element is marked as `deprecated`.
+    class DocumentationRule
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Represents a documentation page. A page can contain subpages to represent
+    # nested documentation set structure.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the page. It will be used as an identity of the page to
+    #     generate URI of the page, text of the link to this page in navigation,
+    #     etc. The full page name (start from the root page name to this page
+    #     concatenated with `.`) can be used as reference to the page in your
+    #     documentation. For example:
+    #     <pre><code>pages:
+    #     - name: Tutorial
+    #       content: &#40;== include tutorial.md ==&#41;
+    #       subpages:
+    #       - name: Java
+    #         content: &#40;== include tutorial_java.md ==&#41;
+    #     </code></pre>
+    #     You can reference `Java` page using Markdown reference link syntax:
+    #     `[Java][Tutorial.Java]`.
+    # @!attribute [rw] content
+    #   @return [::String]
+    #     The Markdown content of the page. You can use <code>&#40;== include \\{path} ==&#41;</code>
+    #     to include content from a Markdown file.
+    # @!attribute [rw] subpages
+    #   @return [::Array<::Google::Api::Page>]
+    #     Subpages of this page. The order of subpages specified here will be
+    #     honored in the generated docset.
+    class Page
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/api/endpoint.rb

@@ -0,0 +1,70 @@
+# 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
+    # `Endpoint` describes a network endpoint that serves a set of APIs.
+    # A service may expose any number of endpoints, and all endpoints share the
+    # same service configuration, such as quota configuration and monitoring
+    # configuration.
+    #
+    # Example service configuration:
+    #
+    #     name: library-example.googleapis.com
+    #     endpoints:
+    #       # Below entry makes 'google.example.library.v1.Library'
+    #       # API be served from endpoint address library-example.googleapis.com.
+    #       # It also allows HTTP OPTIONS calls to be passed to the backend, for
+    #       # it to decide whether the subsequent cross-origin request is
+    #       # allowed to proceed.
+    #     - name: library-example.googleapis.com
+    #       allow_cors: true
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The canonical name of this endpoint.
+    # @!attribute [rw] aliases
+    #   @return [::Array<::String>]
+    #     DEPRECATED: This field is no longer supported. Instead of using aliases,
+    #     please specify multiple {::Google::Api::Endpoint google.api.Endpoint} for each of the intended
+    #     aliases.
+    #
+    #     Additional names that this endpoint will be hosted on.
+    # @!attribute [rw] features
+    #   @return [::Array<::String>]
+    #     The list of features enabled on this endpoint.
+    # @!attribute [rw] target
+    #   @return [::String]
+    #     The specification of an Internet routable address of API frontend that will
+    #     handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary).
+    #     It should be either a valid IPv4 address or a fully-qualified domain name.
+    #     For example, "8.8.8.8" or "myservice.appspot.com".
+    # @!attribute [rw] allow_cors
+    #   @return [::Boolean]
+    #     Allowing
+    #     [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka
+    #     cross-domain traffic, would allow the backends served from this endpoint to
+    #     receive and respond to HTTP OPTIONS requests. The response will be used by
+    #     the browser to determine whether the subsequent cross-origin request is
+    #     allowed to proceed.
+    class Endpoint
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

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/label.rb

@@ -0,0 +1,49 @@
+# 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 description of a label.
+    # @!attribute [rw] key
+    #   @return [::String]
+    #     The label key.
+    # @!attribute [rw] value_type
+    #   @return [::Google::Api::LabelDescriptor::ValueType]
+    #     The type of data that can be assigned to the label.
+    # @!attribute [rw] description
+    #   @return [::String]
+    #     A human-readable description for the label.
+    class LabelDescriptor
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # Value types that can be used as label values.
+      module ValueType
+        # A variable-length string. This is the default.
+        STRING = 0
+
+        # Boolean; true or false.
+        BOOL = 1
+
+        # A 64-bit signed integer.
+        INT64 = 2
+      end
+    end
+  end
+end

data/proto_docs/google/api/log.rb

@@ -0,0 +1,54 @@
+# 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 description of a log type. Example in YAML format:
+    #
+    #     - name: library.googleapis.com/activity_history
+    #       description: The history of borrowing and returning library items.
+    #       display_name: Activity
+    #       labels:
+    #       - key: /customer_id
+    #         description: Identifier of a library customer
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the log. It must be less than 512 characters long and can
+    #     include the following characters: upper- and lower-case alphanumeric
+    #     characters [A-Za-z0-9], and punctuation characters including
+    #     slash, underscore, hyphen, period [/_-.].
+    # @!attribute [rw] labels
+    #   @return [::Array<::Google::Api::LabelDescriptor>]
+    #     The set of labels that are available to describe a specific log entry.
+    #     Runtime requests that contain labels not specified here are
+    #     considered invalid.
+    # @!attribute [rw] description
+    #   @return [::String]
+    #     A human-readable description of this log. This information appears in
+    #     the documentation and can contain details.
+    # @!attribute [rw] display_name
+    #   @return [::String]
+    #     The human-readable name for this log. This information appears on
+    #     the user interface and should be concise.
+    class LogDescriptor
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/api/logging.rb

@@ -0,0 +1,85 @@
+# 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
+    # Logging configuration of the service.
+    #
+    # The following example shows how to configure logs to be sent to the
+    # producer and consumer projects. In the example, the `activity_history`
+    # log is sent to both the producer and consumer projects, whereas the
+    # `purchase_history` log is only sent to the producer project.
+    #
+    #     monitored_resources:
+    #     - type: library.googleapis.com/branch
+    #       labels:
+    #       - key: /city
+    #         description: The city where the library branch is located in.
+    #       - key: /name
+    #         description: The name of the branch.
+    #     logs:
+    #     - name: activity_history
+    #       labels:
+    #       - key: /customer_id
+    #     - name: purchase_history
+    #     logging:
+    #       producer_destinations:
+    #       - monitored_resource: library.googleapis.com/branch
+    #         logs:
+    #         - activity_history
+    #         - purchase_history
+    #       consumer_destinations:
+    #       - monitored_resource: library.googleapis.com/branch
+    #         logs:
+    #         - activity_history
+    # @!attribute [rw] producer_destinations
+    #   @return [::Array<::Google::Api::Logging::LoggingDestination>]
+    #     Logging configurations for sending logs to the producer project.
+    #     There can be multiple producer destinations, each one must have a
+    #     different monitored resource type. A log can be used in at most
+    #     one producer destination.
+    # @!attribute [rw] consumer_destinations
+    #   @return [::Array<::Google::Api::Logging::LoggingDestination>]
+    #     Logging configurations for sending logs to the consumer project.
+    #     There can be multiple consumer destinations, each one must have a
+    #     different monitored resource type. A log can be used in at most
+    #     one consumer destination.
+    class Logging
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # Configuration of a specific logging destination (the producer project
+      # or the consumer project).
+      # @!attribute [rw] monitored_resource
+      #   @return [::String]
+      #     The monitored resource type. The type must be defined in the
+      #     {::Google::Api::Service#monitored_resources Service.monitored_resources} section.
+      # @!attribute [rw] logs
+      #   @return [::Array<::String>]
+      #     Names of the logs to be sent to this destination. Each name must
+      #     be defined in the {::Google::Api::Service#logs Service.logs} section. If the log name is
+      #     not a domain scoped name, it will be automatically prefixed with
+      #     the service name followed by "/".
+      class LoggingDestination
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+    end
+  end
+end