google-cloud-service_usage-v1 0.1.0

data/lib/google/cloud/service_usage/v1/version.rb

@@ -0,0 +1,28 @@
+# 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 ServiceUsage
+      module V1
+        VERSION = "0.1.0"
+      end
+    end
+  end
+end

data/proto_docs/README.md

@@ -0,0 +1,4 @@
+# Service Usage V1 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/auth.rb

@@ -0,0 +1,247 @@
+# 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
+    # `Authentication` defines the authentication configuration for API methods
+    # provided by an API service.
+    #
+    # Example:
+    #
+    #     name: calendar.googleapis.com
+    #     authentication:
+    #       providers:
+    #       - id: google_calendar_auth
+    #         jwks_uri: https://www.googleapis.com/oauth2/v1/certs
+    #         issuer: https://securetoken.google.com
+    #       rules:
+    #       - selector: "*"
+    #         requirements:
+    #           provider_id: google_calendar_auth
+    #       - selector: google.calendar.Delegate
+    #         oauth:
+    #           canonical_scopes: https://www.googleapis.com/auth/calendar.read
+    # @!attribute [rw] rules
+    #   @return [::Array<::Google::Api::AuthenticationRule>]
+    #     A list of authentication rules that apply to individual API methods.
+    #
+    #     **NOTE:** All service configuration rules follow "last one wins" order.
+    # @!attribute [rw] providers
+    #   @return [::Array<::Google::Api::AuthProvider>]
+    #     Defines a set of authentication providers that a service supports.
+    class Authentication
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Authentication rules for the service.
+    #
+    # By default, if a method has any authentication requirements, every request
+    # must include a valid credential matching one of the requirements.
+    # It's an error to include more than one kind of credential in a single
+    # request.
+    #
+    # If a method doesn't have any auth requirements, request credentials will be
+    # ignored.
+    # @!attribute [rw] selector
+    #   @return [::String]
+    #     Selects the methods to which this rule applies.
+    #
+    #     Refer to {::Google::Api::DocumentationRule#selector selector} for syntax details.
+    # @!attribute [rw] oauth
+    #   @return [::Google::Api::OAuthRequirements]
+    #     The requirements for OAuth credentials.
+    # @!attribute [rw] allow_without_credential
+    #   @return [::Boolean]
+    #     If true, the service accepts API keys without any other credential.
+    #     This flag only applies to HTTP and gRPC requests.
+    # @!attribute [rw] requirements
+    #   @return [::Array<::Google::Api::AuthRequirement>]
+    #     Requirements for additional authentication providers.
+    class AuthenticationRule
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Specifies a location to extract JWT from an API request.
+    # @!attribute [rw] header
+    #   @return [::String]
+    #     Specifies HTTP header name to extract JWT token.
+    # @!attribute [rw] query
+    #   @return [::String]
+    #     Specifies URL query parameter name to extract JWT token.
+    # @!attribute [rw] value_prefix
+    #   @return [::String]
+    #     The value prefix. The value format is "value_prefix\\{token}"
+    #     Only applies to "in" header type. Must be empty for "in" query type.
+    #     If not empty, the header value has to match (case sensitive) this prefix.
+    #     If not matched, JWT will not be extracted. If matched, JWT will be
+    #     extracted after the prefix is removed.
+    #
+    #     For example, for "Authorization: Bearer \\{JWT}",
+    #     value_prefix="Bearer " with a space at the end.
+    class JwtLocation
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Configuration for an authentication provider, including support for
+    # [JSON Web Token
+    # (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
+    # @!attribute [rw] id
+    #   @return [::String]
+    #     The unique identifier of the auth provider. It will be referred to by
+    #     `AuthRequirement.provider_id`.
+    #
+    #     Example: "bookstore_auth".
+    # @!attribute [rw] issuer
+    #   @return [::String]
+    #     Identifies the principal that issued the JWT. See
+    #     https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1
+    #     Usually a URL or an email address.
+    #
+    #     Example: https://securetoken.google.com
+    #     Example: 1234567-compute@developer.gserviceaccount.com
+    # @!attribute [rw] jwks_uri
+    #   @return [::String]
+    #     URL of the provider's public key set to validate signature of the JWT. See
+    #     [OpenID
+    #     Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
+    #     Optional if the key set document:
+    #      - can be retrieved from
+    #        [OpenID
+    #        Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html)
+    #        of the issuer.
+    #      - can be inferred from the email domain of the issuer (e.g. a Google
+    #      service account).
+    #
+    #     Example: https://www.googleapis.com/oauth2/v1/certs
+    # @!attribute [rw] audiences
+    #   @return [::String]
+    #     The list of JWT
+    #     [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
+    #     that are allowed to access. A JWT containing any of these audiences will
+    #     be accepted. When this setting is absent, JWTs with audiences:
+    #       - "https://[service.name]/[google.protobuf.Api.name]"
+    #       - "https://[service.name]/"
+    #     will be accepted.
+    #     For example, if no audiences are in the setting, LibraryService API will
+    #     accept JWTs with the following audiences:
+    #       -
+    #       https://library-example.googleapis.com/google.example.library.v1.LibraryService
+    #       - https://library-example.googleapis.com/
+    #
+    #     Example:
+    #
+    #         audiences: bookstore_android.apps.googleusercontent.com,
+    #                    bookstore_web.apps.googleusercontent.com
+    # @!attribute [rw] authorization_url
+    #   @return [::String]
+    #     Redirect URL if JWT token is required but not present or is expired.
+    #     Implement authorizationUrl of securityDefinitions in OpenAPI spec.
+    # @!attribute [rw] jwt_locations
+    #   @return [::Array<::Google::Api::JwtLocation>]
+    #     Defines the locations to extract the JWT.
+    #
+    #     JWT locations can be either from HTTP headers or URL query parameters.
+    #     The rule is that the first match wins. The checking order is: checking
+    #     all headers first, then URL query parameters.
+    #
+    #     If not specified,  default to use following 3 locations:
+    #        1) Authorization: Bearer
+    #        2) x-goog-iap-jwt-assertion
+    #        3) access_token query parameter
+    #
+    #     Default locations can be specified as followings:
+    #        jwt_locations:
+    #        - header: Authorization
+    #          value_prefix: "Bearer "
+    #        - header: x-goog-iap-jwt-assertion
+    #        - query: access_token
+    class AuthProvider
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # OAuth scopes are a way to define data and permissions on data. For example,
+    # there are scopes defined for "Read-only access to Google Calendar" and
+    # "Access to Cloud Platform". Users can consent to a scope for an application,
+    # giving it permission to access that data on their behalf.
+    #
+    # OAuth scope specifications should be fairly coarse grained; a user will need
+    # to see and understand the text description of what your scope means.
+    #
+    # In most cases: use one or at most two OAuth scopes for an entire family of
+    # products. If your product has multiple APIs, you should probably be sharing
+    # the OAuth scope across all of those APIs.
+    #
+    # When you need finer grained OAuth consent screens: talk with your product
+    # management about how developers will use them in practice.
+    #
+    # Please note that even though each of the canonical scopes is enough for a
+    # request to be accepted and passed to the backend, a request can still fail
+    # due to the backend requiring additional scopes or permissions.
+    # @!attribute [rw] canonical_scopes
+    #   @return [::String]
+    #     The list of publicly documented OAuth scopes that are allowed access. An
+    #     OAuth token containing any of these scopes will be accepted.
+    #
+    #     Example:
+    #
+    #          canonical_scopes: https://www.googleapis.com/auth/calendar,
+    #                            https://www.googleapis.com/auth/calendar.read
+    class OAuthRequirements
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # User-defined authentication requirements, including support for
+    # [JSON Web Token
+    # (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
+    # @!attribute [rw] provider_id
+    #   @return [::String]
+    #     {::Google::Api::AuthProvider#id id} from authentication provider.
+    #
+    #     Example:
+    #
+    #         provider_id: bookstore_auth
+    # @!attribute [rw] audiences
+    #   @return [::String]
+    #     NOTE: This will be deprecated soon, once AuthProvider.audiences is
+    #     implemented and accepted in all the runtime components.
+    #
+    #     The list of JWT
+    #     [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
+    #     that are allowed to access. A JWT containing any of these audiences will
+    #     be accepted. When this setting is absent, only JWTs with audience
+    #     "https://[Service_name][google.api.Service.name]/{::Google::Protobuf::Api#name API_name}"
+    #     will be accepted. For example, if no audiences are in the setting,
+    #     LibraryService API will only accept JWTs with the following audience
+    #     "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
+    #
+    #     Example:
+    #
+    #         audiences: bookstore_android.apps.googleusercontent.com,
+    #                    bookstore_web.apps.googleusercontent.com
+    class AuthRequirement
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/api/documentation.rb

@@ -0,0 +1,170 @@
+# 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
+    # `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] service_root_url
+    #   @return [::String]
+    #     Specifies the service root url if the default one (the service name
+    #     from the yaml file) is not suitable. This can be seen in any fully
+    #     specified service urls as well as sections that show a base that other
+    #     urls are relative to.
+    # @!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". A
+    #     wildcard will match one or more components. 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