google-cloud-service_usage-v1 0.1.0

data/proto_docs/google/api/usage.rb

@@ -0,0 +1,100 @@
+# 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
+    # Configuration controlling usage of a service.
+    # @!attribute [rw] requirements
+    #   @return [::Array<::String>]
+    #     Requirements that must be satisfied before a consumer project can use the
+    #     service. Each requirement is of the form <service.name>/<requirement-id>;
+    #     for example 'serviceusage.googleapis.com/billing-enabled'.
+    #
+    #     For Google APIs, a Terms of Service requirement must be included here.
+    #     Google Cloud APIs must include "serviceusage.googleapis.com/tos/cloud".
+    #     Other Google APIs should include
+    #     "serviceusage.googleapis.com/tos/universal". Additional ToS can be
+    #     included based on the business needs.
+    # @!attribute [rw] rules
+    #   @return [::Array<::Google::Api::UsageRule>]
+    #     A list of usage rules that apply to individual API methods.
+    #
+    #     **NOTE:** All service configuration rules follow "last one wins" order.
+    # @!attribute [rw] producer_notification_channel
+    #   @return [::String]
+    #     The full resource name of a channel used for sending notifications to the
+    #     service producer.
+    #
+    #     Google Service Management currently only supports
+    #     [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification
+    #     channel. To use Google Cloud Pub/Sub as the channel, this must be the name
+    #     of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format
+    #     documented in https://cloud.google.com/pubsub/docs/overview.
+    class Usage
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Usage configuration rules for the service.
+    #
+    # NOTE: Under development.
+    #
+    #
+    # Use this rule to configure unregistered calls for the service. Unregistered
+    # calls are calls that do not contain consumer project identity.
+    # (Example: calls that do not contain an API key).
+    # By default, API methods do not allow unregistered calls, and each method call
+    # must be identified by a consumer project identity. Use this rule to
+    # allow/disallow unregistered calls.
+    #
+    # Example of an API that wants to allow unregistered calls for entire service.
+    #
+    #     usage:
+    #       rules:
+    #       - selector: "*"
+    #         allow_unregistered_calls: true
+    #
+    # Example of a method that wants to allow unregistered calls.
+    #
+    #     usage:
+    #       rules:
+    #       - selector: "google.example.library.v1.LibraryService.CreateBook"
+    #         allow_unregistered_calls: true
+    # @!attribute [rw] selector
+    #   @return [::String]
+    #     Selects the methods to which this rule applies. Use '*' to indicate all
+    #     methods in all APIs.
+    #
+    #     Refer to {::Google::Api::DocumentationRule#selector selector} for syntax details.
+    # @!attribute [rw] allow_unregistered_calls
+    #   @return [::Boolean]
+    #     If true, the selected method allows unregistered calls, e.g. calls
+    #     that don't identify any user or application.
+    # @!attribute [rw] skip_service_control
+    #   @return [::Boolean]
+    #     If true, the selected method should skip service control and the control
+    #     plane features, such as quota and billing, will not be available.
+    #     This flag is used by Google Cloud Endpoints to bypass checks for internal
+    #     methods, such as service health check methods.
+    class UsageRule
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/longrunning/operations.rb

@@ -0,0 +1,164 @@
+# 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 Longrunning
+    # This resource represents a long-running operation that is the result of a
+    # network API call.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The server-assigned name, which is only unique within the same service that
+    #     originally returns it. If you use the default HTTP mapping, the
+    #     `name` should be a resource name ending with `operations/{unique_id}`.
+    # @!attribute [rw] metadata
+    #   @return [::Google::Protobuf::Any]
+    #     Service-specific metadata associated with the operation.  It typically
+    #     contains progress information and common metadata such as create time.
+    #     Some services might not provide such metadata.  Any method that returns a
+    #     long-running operation should document the metadata type, if any.
+    # @!attribute [rw] done
+    #   @return [::Boolean]
+    #     If the value is `false`, it means the operation is still in progress.
+    #     If `true`, the operation is completed, and either `error` or `response` is
+    #     available.
+    # @!attribute [rw] error
+    #   @return [::Google::Rpc::Status]
+    #     The error result of the operation in case of failure or cancellation.
+    # @!attribute [rw] response
+    #   @return [::Google::Protobuf::Any]
+    #     The normal response of the operation in case of success.  If the original
+    #     method returns no data on success, such as `Delete`, the response is
+    #     `google.protobuf.Empty`.  If the original method is standard
+    #     `Get`/`Create`/`Update`, the response should be the resource.  For other
+    #     methods, the response should have the type `XxxResponse`, where `Xxx`
+    #     is the original method name.  For example, if the original method name
+    #     is `TakeSnapshot()`, the inferred response type is
+    #     `TakeSnapshotResponse`.
+    class Operation
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.GetOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource.
+    class GetOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.ListOperations.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation's parent resource.
+    # @!attribute [rw] filter
+    #   @return [::String]
+    #     The standard list filter.
+    # @!attribute [rw] page_size
+    #   @return [::Integer]
+    #     The standard list page size.
+    # @!attribute [rw] page_token
+    #   @return [::String]
+    #     The standard list page token.
+    class ListOperationsRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The response message for Operations.ListOperations.
+    # @!attribute [rw] operations
+    #   @return [::Array<::Google::Longrunning::Operation>]
+    #     A list of operations that matches the specified filter in the request.
+    # @!attribute [rw] next_page_token
+    #   @return [::String]
+    #     The standard List next-page token.
+    class ListOperationsResponse
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.CancelOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to be cancelled.
+    class CancelOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.DeleteOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to be deleted.
+    class DeleteOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.WaitOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to wait on.
+    # @!attribute [rw] timeout
+    #   @return [::Google::Protobuf::Duration]
+    #     The maximum duration to wait before timing out. If left blank, the wait
+    #     will be at most the time permitted by the underlying HTTP/RPC protocol.
+    #     If RPC context deadline is also specified, the shorter one will be used.
+    class WaitOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # A message representing the message types used by a long-running operation.
+    #
+    # Example:
+    #
+    #   rpc LongRunningRecognize(LongRunningRecognizeRequest)
+    #       returns (google.longrunning.Operation) {
+    #     option (google.longrunning.operation_info) = {
+    #       response_type: "LongRunningRecognizeResponse"
+    #       metadata_type: "LongRunningRecognizeMetadata"
+    #     };
+    #   }
+    # @!attribute [rw] response_type
+    #   @return [::String]
+    #     Required. The message name of the primary return type for this
+    #     long-running operation.
+    #     This type will be used to deserialize the LRO's response.
+    #
+    #     If the response is in a different package from the rpc, a fully-qualified
+    #     message name must be used (e.g. `google.protobuf.Struct`).
+    #
+    #     Note: Altering this value constitutes a breaking change.
+    # @!attribute [rw] metadata_type
+    #   @return [::String]
+    #     Required. The message name of the metadata type for this long-running
+    #     operation.
+    #
+    #     If the response is in a different package from the rpc, a fully-qualified
+    #     message name must be used (e.g. `google.protobuf.Struct`).
+    #
+    #     Note: Altering this value constitutes a breaking change.
+    class OperationInfo
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/protobuf/any.rb

@@ -0,0 +1,141 @@
+# 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 Protobuf
+    # `Any` contains an arbitrary serialized protocol buffer message along with a
+    # URL that describes the type of the serialized message.
+    #
+    # Protobuf library provides support to pack/unpack Any values in the form
+    # of utility functions or additional generated methods of the Any type.
+    #
+    # Example 1: Pack and unpack a message in C++.
+    #
+    #     Foo foo = ...;
+    #     Any any;
+    #     any.PackFrom(foo);
+    #     ...
+    #     if (any.UnpackTo(&foo)) {
+    #       ...
+    #     }
+    #
+    # Example 2: Pack and unpack a message in Java.
+    #
+    #     Foo foo = ...;
+    #     Any any = Any.pack(foo);
+    #     ...
+    #     if (any.is(Foo.class)) {
+    #       foo = any.unpack(Foo.class);
+    #     }
+    #
+    #  Example 3: Pack and unpack a message in Python.
+    #
+    #     foo = Foo(...)
+    #     any = Any()
+    #     any.Pack(foo)
+    #     ...
+    #     if any.Is(Foo.DESCRIPTOR):
+    #       any.Unpack(foo)
+    #       ...
+    #
+    #  Example 4: Pack and unpack a message in Go
+    #
+    #      foo := &pb.Foo{...}
+    #      any, err := anypb.New(foo)
+    #      if err != nil {
+    #        ...
+    #      }
+    #      ...
+    #      foo := &pb.Foo{}
+    #      if err := any.UnmarshalTo(foo); err != nil {
+    #        ...
+    #      }
+    #
+    # The pack methods provided by protobuf library will by default use
+    # 'type.googleapis.com/full.type.name' as the type URL and the unpack
+    # methods only use the fully qualified type name after the last '/'
+    # in the type URL, for example "foo.bar.com/x/y.z" will yield type
+    # name "y.z".
+    #
+    #
+    # JSON
+    # ====
+    # The JSON representation of an `Any` value uses the regular
+    # representation of the deserialized, embedded message, with an
+    # additional field `@type` which contains the type URL. Example:
+    #
+    #     package google.profile;
+    #     message Person {
+    #       string first_name = 1;
+    #       string last_name = 2;
+    #     }
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.profile.Person",
+    #       "firstName": <string>,
+    #       "lastName": <string>
+    #     }
+    #
+    # If the embedded message type is well-known and has a custom JSON
+    # representation, that representation will be embedded adding a field
+    # `value` which holds the custom JSON in addition to the `@type`
+    # field. Example (for message [google.protobuf.Duration][]):
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.protobuf.Duration",
+    #       "value": "1.212s"
+    #     }
+    # @!attribute [rw] type_url
+    #   @return [::String]
+    #     A URL/resource name that uniquely identifies the type of the serialized
+    #     protocol buffer message. This string must contain at least
+    #     one "/" character. The last segment of the URL's path must represent
+    #     the fully qualified name of the type (as in
+    #     `path/google.protobuf.Duration`). The name should be in a canonical form
+    #     (e.g., leading "." is not accepted).
+    #
+    #     In practice, teams usually precompile into the binary all types that they
+    #     expect it to use in the context of Any. However, for URLs which use the
+    #     scheme `http`, `https`, or no scheme, one can optionally set up a type
+    #     server that maps type URLs to message definitions as follows:
+    #
+    #     * If no scheme is provided, `https` is assumed.
+    #     * An HTTP GET on the URL must yield a [google.protobuf.Type][]
+    #       value in binary format, or produce an error.
+    #     * Applications are allowed to cache lookup results based on the
+    #       URL, or have them precompiled into a binary to avoid any
+    #       lookup. Therefore, binary compatibility needs to be preserved
+    #       on changes to types. (Use versioned type names to manage
+    #       breaking changes.)
+    #
+    #     Note: this functionality is not currently available in the official
+    #     protobuf release, and it is not used for type URLs beginning with
+    #     type.googleapis.com.
+    #
+    #     Schemes other than `http`, `https` (or the empty scheme) might be
+    #     used with implementation specific semantics.
+    # @!attribute [rw] value
+    #   @return [::String]
+    #     Must be a valid serialized protocol buffer of the above specified type.
+    class Any
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/protobuf/api.rb

@@ -0,0 +1,194 @@
+# 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 Protobuf
+    # Api is a light-weight descriptor for an API Interface.
+    #
+    # Interfaces are also described as "protocol buffer services" in some contexts,
+    # such as by the "service" keyword in a .proto file, but they are different
+    # from API Services, which represent a concrete implementation of an interface
+    # as opposed to simply a description of methods and bindings. They are also
+    # sometimes simply referred to as "APIs" in other contexts, such as the name of
+    # this message itself. See https://cloud.google.com/apis/design/glossary for
+    # detailed terminology.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The fully qualified name of this interface, including package name
+    #     followed by the interface's simple name.
+    # @!attribute [rw] methods
+    #   @return [::Array<::Google::Protobuf::Method>]
+    #     The methods of this interface, in unspecified order.
+    # @!attribute [rw] options
+    #   @return [::Array<::Google::Protobuf::Option>]
+    #     Any metadata attached to the interface.
+    # @!attribute [rw] version
+    #   @return [::String]
+    #     A version string for this interface. If specified, must have the form
+    #     `major-version.minor-version`, as in `1.10`. If the minor version is
+    #     omitted, it defaults to zero. If the entire version field is empty, the
+    #     major version is derived from the package name, as outlined below. If the
+    #     field is not empty, the version in the package name will be verified to be
+    #     consistent with what is provided here.
+    #
+    #     The versioning schema uses [semantic
+    #     versioning](http://semver.org) where the major version number
+    #     indicates a breaking change and the minor version an additive,
+    #     non-breaking change. Both version numbers are signals to users
+    #     what to expect from different versions, and should be carefully
+    #     chosen based on the product plan.
+    #
+    #     The major version is also reflected in the package name of the
+    #     interface, which must end in `v<major-version>`, as in
+    #     `google.feature.v1`. For major versions 0 and 1, the suffix can
+    #     be omitted. Zero major versions must only be used for
+    #     experimental, non-GA interfaces.
+    # @!attribute [rw] source_context
+    #   @return [::Google::Protobuf::SourceContext]
+    #     Source context for the protocol buffer service represented by this
+    #     message.
+    # @!attribute [rw] mixins
+    #   @return [::Array<::Google::Protobuf::Mixin>]
+    #     Included interfaces. See [Mixin][].
+    # @!attribute [rw] syntax
+    #   @return [::Google::Protobuf::Syntax]
+    #     The source syntax of the service.
+    class Api
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Method represents a method of an API interface.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The simple name of this method.
+    # @!attribute [rw] request_type_url
+    #   @return [::String]
+    #     A URL of the input message type.
+    # @!attribute [rw] request_streaming
+    #   @return [::Boolean]
+    #     If true, the request is streamed.
+    # @!attribute [rw] response_type_url
+    #   @return [::String]
+    #     The URL of the output message type.
+    # @!attribute [rw] response_streaming
+    #   @return [::Boolean]
+    #     If true, the response is streamed.
+    # @!attribute [rw] options
+    #   @return [::Array<::Google::Protobuf::Option>]
+    #     Any metadata attached to the method.
+    # @!attribute [rw] syntax
+    #   @return [::Google::Protobuf::Syntax]
+    #     The source syntax of this method.
+    class Method
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Declares an API Interface to be included in this interface. The including
+    # interface must redeclare all the methods from the included interface, but
+    # documentation and options are inherited as follows:
+    #
+    # - If after comment and whitespace stripping, the documentation
+    #   string of the redeclared method is empty, it will be inherited
+    #   from the original method.
+    #
+    # - Each annotation belonging to the service config (http,
+    #   visibility) which is not set in the redeclared method will be
+    #   inherited.
+    #
+    # - If an http annotation is inherited, the path pattern will be
+    #   modified as follows. Any version prefix will be replaced by the
+    #   version of the including interface plus the [root][] path if
+    #   specified.
+    #
+    # Example of a simple mixin:
+    #
+    #     package google.acl.v1;
+    #     service AccessControl {
+    #       // Get the underlying ACL object.
+    #       rpc GetAcl(GetAclRequest) returns (Acl) {
+    #         option (google.api.http).get = "/v1/{resource=**}:getAcl";
+    #       }
+    #     }
+    #
+    #     package google.storage.v2;
+    #     service Storage {
+    #       rpc GetAcl(GetAclRequest) returns (Acl);
+    #
+    #       // Get a data record.
+    #       rpc GetData(GetDataRequest) returns (Data) {
+    #         option (google.api.http).get = "/v2/{resource=**}";
+    #       }
+    #     }
+    #
+    # Example of a mixin configuration:
+    #
+    #     apis:
+    #     - name: google.storage.v2.Storage
+    #       mixins:
+    #       - name: google.acl.v1.AccessControl
+    #
+    # The mixin construct implies that all methods in `AccessControl` are
+    # also declared with same name and request/response types in
+    # `Storage`. A documentation generator or annotation processor will
+    # see the effective `Storage.GetAcl` method after inheriting
+    # documentation and annotations as follows:
+    #
+    #     service Storage {
+    #       // Get the underlying ACL object.
+    #       rpc GetAcl(GetAclRequest) returns (Acl) {
+    #         option (google.api.http).get = "/v2/{resource=**}:getAcl";
+    #       }
+    #       ...
+    #     }
+    #
+    # Note how the version in the path pattern changed from `v1` to `v2`.
+    #
+    # If the `root` field in the mixin is specified, it should be a
+    # relative path under which inherited HTTP paths are placed. Example:
+    #
+    #     apis:
+    #     - name: google.storage.v2.Storage
+    #       mixins:
+    #       - name: google.acl.v1.AccessControl
+    #         root: acls
+    #
+    # This implies the following inherited HTTP annotation:
+    #
+    #     service Storage {
+    #       // Get the underlying ACL object.
+    #       rpc GetAcl(GetAclRequest) returns (Acl) {
+    #         option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
+    #       }
+    #       ...
+    #     }
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The fully qualified name of the interface which is included.
+    # @!attribute [rw] root
+    #   @return [::String]
+    #     If non-empty specifies a path under which inherited HTTP paths
+    #     are rooted.
+    class Mixin
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end