google-cloud-service_management-v1 0.1.0

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

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

data/proto_docs/README.md

@@ -0,0 +1,4 @@
+# Service Management API 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,192 @@
+# 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
+    # `Authentication` defines the authentication configuration for an API.
+    #
+    # Example for an API targeted for external use:
+    #
+    #     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
+    # @!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.
+    # @!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
+
+    # Configuration for an anthentication 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, only JWTs with audience
+    #     "https://{::Google::Api::Service#name 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
+    # @!attribute [rw] authorization_url
+    #   @return [::String]
+    #     Redirect URL if JWT token is required but no present or is expired.
+    #     Implement authorizationUrl of securityDefinitions in OpenAPI spec.
+    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://{::Google::Api::Service#name 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/backend.rb

@@ -0,0 +1,55 @@
+# 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
+    # `Backend` defines the backend configuration for a service.
+    # @!attribute [rw] rules
+    #   @return [::Array<::Google::Api::BackendRule>]
+    #     A list of API backend rules that apply to individual API methods.
+    #
+    #     **NOTE:** All service configuration rules follow "last one wins" order.
+    class Backend
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # A backend rule provides configuration for an individual API element.
+    # @!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] address
+    #   @return [::String]
+    #     The address of the API backend.
+    # @!attribute [rw] deadline
+    #   @return [::Float]
+    #     The number of seconds to wait for a response from a request.  The default
+    #     deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds.
+    # @!attribute [rw] min_deadline
+    #   @return [::Float]
+    #     Minimum deadline in seconds needed for this method. Calls having deadline
+    #     value lower than this will be rejected.
+    class BackendRule
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/api/billing.rb

@@ -0,0 +1,69 @@
+# 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
+    # Billing related configuration of the service.
+    #
+    # The following example shows how to configure monitored resources and metrics
+    # for billing:
+    #
+    #     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.
+    #     metrics:
+    #     - name: library.googleapis.com/book/borrowed_count
+    #       metric_kind: DELTA
+    #       value_type: INT64
+    #     billing:
+    #       consumer_destinations:
+    #       - monitored_resource: library.googleapis.com/branch
+    #         metrics:
+    #         - library.googleapis.com/book/borrowed_count
+    # @!attribute [rw] consumer_destinations
+    #   @return [::Array<::Google::Api::Billing::BillingDestination>]
+    #     Billing configurations for sending metrics to the consumer project.
+    #     There can be multiple consumer destinations per service, each one must have
+    #     a different monitored resource type. A metric can be used in at most
+    #     one consumer destination.
+    class Billing
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # Configuration of a specific billing destination (Currently only support
+      # bill against consumer project).
+      # @!attribute [rw] monitored_resource
+      #   @return [::String]
+      #     The monitored resource type. The type must be defined in
+      #     {::Google::Api::Service#monitored_resources Service.monitored_resources} section.
+      # @!attribute [rw] metrics
+      #   @return [::Array<::String>]
+      #     Names of the metrics to report to this billing destination.
+      #     Each name must be defined in {::Google::Api::Service#metrics Service.metrics} section.
+      class BillingDestination
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+    end
+  end
+end

data/proto_docs/google/api/config_change.rb

@@ -0,0 +1,89 @@
+# 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
+    # Output generated from semantically comparing two versions of a service
+    # configuration.
+    #
+    # Includes detailed information about a field that have changed with
+    # applicable advice about potential consequences for the change, such as
+    # backwards-incompatibility.
+    # @!attribute [rw] element
+    #   @return [::String]
+    #     Object hierarchy path to the change, with levels separated by a '.'
+    #     character. For repeated fields, an applicable unique identifier field is
+    #     used for the index (usually selector, name, or id). For maps, the term
+    #     'key' is used. If the field has no unique identifier, the numeric index
+    #     is used.
+    #     Examples:
+    #     - visibility.rules[selector=="google.LibraryService.CreateBook"].restriction
+    #     - quota.metric_rules[selector=="google"].metric_costs[key=="reads"].value
+    #     - logging.producer_destinations[0]
+    # @!attribute [rw] old_value
+    #   @return [::String]
+    #     Value of the changed object in the old Service configuration,
+    #     in JSON format. This field will not be populated if ChangeType == ADDED.
+    # @!attribute [rw] new_value
+    #   @return [::String]
+    #     Value of the changed object in the new Service configuration,
+    #     in JSON format. This field will not be populated if ChangeType == REMOVED.
+    # @!attribute [rw] change_type
+    #   @return [::Google::Api::ChangeType]
+    #     The type for this change, either ADDED, REMOVED, or MODIFIED.
+    # @!attribute [rw] advices
+    #   @return [::Array<::Google::Api::Advice>]
+    #     Collection of advice provided for this change, useful for determining the
+    #     possible impact of this change.
+    class ConfigChange
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Generated advice about this change, used for providing more
+    # information about how a change will affect the existing service.
+    # @!attribute [rw] description
+    #   @return [::String]
+    #     Useful description for why this advice was applied and what actions should
+    #     be taken to mitigate any implied risks.
+    class Advice
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Classifies set of possible modifications to an object in the service
+    # configuration.
+    module ChangeType
+      # No value was provided.
+      CHANGE_TYPE_UNSPECIFIED = 0
+
+      # The changed object exists in the 'new' service configuration, but not
+      # in the 'old' service configuration.
+      ADDED = 1
+
+      # The changed object exists in the 'old' service configuration, but not
+      # in the 'new' service configuration.
+      REMOVED = 2
+
+      # The changed object exists in both service configurations, but its value
+      # is different.
+      MODIFIED = 3
+    end
+  end
+end

data/proto_docs/google/api/context.rb

@@ -0,0 +1,67 @@
+# 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
+    # `Context` defines which contexts an API requests.
+    #
+    # Example:
+    #
+    #     context:
+    #       rules:
+    #       - selector: "*"
+    #         requested:
+    #         - google.rpc.context.ProjectContext
+    #         - google.rpc.context.OriginContext
+    #
+    # The above specifies that all methods in the API request
+    # `google.rpc.context.ProjectContext` and
+    # `google.rpc.context.OriginContext`.
+    #
+    # Available context types are defined in package
+    # `google.rpc.context`.
+    # @!attribute [rw] rules
+    #   @return [::Array<::Google::Api::ContextRule>]
+    #     A list of RPC context rules that apply to individual API methods.
+    #
+    #     **NOTE:** All service configuration rules follow "last one wins" order.
+    class Context
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # A context rule provides information about the context for an individual API
+    # element.
+    # @!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] requested
+    #   @return [::Array<::String>]
+    #     A list of full type names of requested contexts.
+    # @!attribute [rw] provided
+    #   @return [::Array<::String>]
+    #     A list of full type names of provided contexts.
+    class ContextRule
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end