google-cloud-service_usage-v1 1.4.0 → 1.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/google/cloud/service_usage/v1/service_usage/client.rb +20 -3
- data/lib/google/cloud/service_usage/v1/service_usage/operations.rb +32 -4
- data/lib/google/cloud/service_usage/v1/service_usage/rest/operations.rb +12 -1
- data/lib/google/cloud/service_usage/v1/version.rb +1 -1
- data/proto_docs/google/api/field_behavior.rb +85 -0
- data/proto_docs/google/longrunning/operations.rb +18 -0
- metadata +2 -1
    
        checksums.yaml
    CHANGED
    
    | @@ -1,7 +1,7 @@ | |
| 1 1 | 
             
            ---
         | 
| 2 2 | 
             
            SHA256:
         | 
| 3 | 
            -
              metadata.gz:  | 
| 4 | 
            -
              data.tar.gz:  | 
| 3 | 
            +
              metadata.gz: 2f2f48ad83a2b0a41604195bb2f102add0b80409a7942d3c34b523814a8ad39b
         | 
| 4 | 
            +
              data.tar.gz: ca97b2dd15411fb5188d5fc34debdfa9a700fc4aabca42577c8c238ad49a0d03
         | 
| 5 5 | 
             
            SHA512:
         | 
| 6 | 
            -
              metadata.gz:  | 
| 7 | 
            -
              data.tar.gz:  | 
| 6 | 
            +
              metadata.gz: a9d25be9879aade89b7431db60edfb9e92b58629945d7d9af44f2d378af2cbfc8719d4cd57f7b49c01d16a854485b1084be44f3335315149716499377ac9700a
         | 
| 7 | 
            +
              data.tar.gz: 44cb26b6352fd8bc62cfbfe5013e81d78457ce0861ab0f1580d4af297dee3022b234e47ee7bb8eba1d18d8b84b3bbae7ffdc159d7c9636074fe0fc04f0fc9c52
         | 
| @@ -869,8 +869,6 @@ module Google | |
| 869 869 | 
             
                        #   @return [::String,nil]
         | 
| 870 870 | 
             
                        # @!attribute [rw] credentials
         | 
| 871 871 | 
             
                        #   Credentials to send with calls. You may provide any of the following types:
         | 
| 872 | 
            -
                        #    *  (`String`) The path to a service account key file in JSON format
         | 
| 873 | 
            -
                        #    *  (`Hash`) A service account key as a Hash
         | 
| 874 872 | 
             
                        #    *  (`Google::Auth::Credentials`) A googleauth credentials object
         | 
| 875 873 | 
             
                        #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
         | 
| 876 874 | 
             
                        #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
         | 
| @@ -879,7 +877,26 @@ module Google | |
| 879 877 | 
             
                        #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
         | 
| 880 878 | 
             
                        #    *  (`nil`) indicating no credentials
         | 
| 881 879 | 
             
                        #
         | 
| 882 | 
            -
                        #   Warning:  | 
| 880 | 
            +
                        #   @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
         | 
| 881 | 
            +
                        #     is deprecated. Providing an unvalidated credential configuration to
         | 
| 882 | 
            +
                        #     Google APIs can compromise the security of your systems and data.
         | 
| 883 | 
            +
                        #
         | 
| 884 | 
            +
                        #   @example
         | 
| 885 | 
            +
                        #
         | 
| 886 | 
            +
                        #     # The recommended way to provide credentials is to use the `make_creds` method
         | 
| 887 | 
            +
                        #     # on the appropriate credentials class for your environment.
         | 
| 888 | 
            +
                        #
         | 
| 889 | 
            +
                        #     require "googleauth"
         | 
| 890 | 
            +
                        #
         | 
| 891 | 
            +
                        #     credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
         | 
| 892 | 
            +
                        #       json_key_io: ::File.open("/path/to/keyfile.json")
         | 
| 893 | 
            +
                        #     )
         | 
| 894 | 
            +
                        #
         | 
| 895 | 
            +
                        #     client = ::Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.new do |config|
         | 
| 896 | 
            +
                        #       config.credentials = credentials
         | 
| 897 | 
            +
                        #     end
         | 
| 898 | 
            +
                        #
         | 
| 899 | 
            +
                        #   @note Warning: If you accept a credential configuration (JSON file or Hash) from an
         | 
| 883 900 | 
             
                        #   external source for authentication to Google Cloud, you must validate it before
         | 
| 884 901 | 
             
                        #   providing it to a Google API client library. Providing an unvalidated credential
         | 
| 885 902 | 
             
                        #   configuration to Google APIs can compromise the security of your systems and data.
         | 
| @@ -134,7 +134,7 @@ module Google | |
| 134 134 | 
             
                        #   @param options [::Gapic::CallOptions, ::Hash]
         | 
| 135 135 | 
             
                        #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
         | 
| 136 136 | 
             
                        #
         | 
| 137 | 
            -
                        # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
         | 
| 137 | 
            +
                        # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
         | 
| 138 138 | 
             
                        #   Pass arguments to `list_operations` via keyword arguments. Note that at
         | 
| 139 139 | 
             
                        #   least one keyword argument is required. To specify no parameters, or to keep all
         | 
| 140 140 | 
             
                        #   the default parameter values, pass an empty Hash as a request object (see above).
         | 
| @@ -147,6 +147,17 @@ module Google | |
| 147 147 | 
             
                        #     The standard list page size.
         | 
| 148 148 | 
             
                        #   @param page_token [::String]
         | 
| 149 149 | 
             
                        #     The standard list page token.
         | 
| 150 | 
            +
                        #   @param return_partial_success [::Boolean]
         | 
| 151 | 
            +
                        #     When set to `true`, operations that are reachable are returned as normal,
         | 
| 152 | 
            +
                        #     and those that are unreachable are returned in the
         | 
| 153 | 
            +
                        #     [ListOperationsResponse.unreachable] field.
         | 
| 154 | 
            +
                        #
         | 
| 155 | 
            +
                        #     This can only be `true` when reading across collections e.g. when `parent`
         | 
| 156 | 
            +
                        #     is set to `"projects/example/locations/-"`.
         | 
| 157 | 
            +
                        #
         | 
| 158 | 
            +
                        #     This field is not by default supported and will result in an
         | 
| 159 | 
            +
                        #     `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
         | 
| 160 | 
            +
                        #     service or product specific documentation.
         | 
| 150 161 | 
             
                        #
         | 
| 151 162 | 
             
                        # @yield [response, operation] Access the result along with the RPC operation
         | 
| 152 163 | 
             
                        # @yieldparam response [::Gapic::PagedEnumerable<::Gapic::Operation>]
         | 
| @@ -623,8 +634,6 @@ module Google | |
| 623 634 | 
             
                        #   @return [::String,nil]
         | 
| 624 635 | 
             
                        # @!attribute [rw] credentials
         | 
| 625 636 | 
             
                        #   Credentials to send with calls. You may provide any of the following types:
         | 
| 626 | 
            -
                        #    *  (`String`) The path to a service account key file in JSON format
         | 
| 627 | 
            -
                        #    *  (`Hash`) A service account key as a Hash
         | 
| 628 637 | 
             
                        #    *  (`Google::Auth::Credentials`) A googleauth credentials object
         | 
| 629 638 | 
             
                        #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
         | 
| 630 639 | 
             
                        #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
         | 
| @@ -633,7 +642,26 @@ module Google | |
| 633 642 | 
             
                        #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
         | 
| 634 643 | 
             
                        #    *  (`nil`) indicating no credentials
         | 
| 635 644 | 
             
                        #
         | 
| 636 | 
            -
                        #   Warning:  | 
| 645 | 
            +
                        #   @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
         | 
| 646 | 
            +
                        #     is deprecated. Providing an unvalidated credential configuration to
         | 
| 647 | 
            +
                        #     Google APIs can compromise the security of your systems and data.
         | 
| 648 | 
            +
                        #
         | 
| 649 | 
            +
                        #   @example
         | 
| 650 | 
            +
                        #
         | 
| 651 | 
            +
                        #     # The recommended way to provide credentials is to use the `make_creds` method
         | 
| 652 | 
            +
                        #     # on the appropriate credentials class for your environment.
         | 
| 653 | 
            +
                        #
         | 
| 654 | 
            +
                        #     require "googleauth"
         | 
| 655 | 
            +
                        #
         | 
| 656 | 
            +
                        #     credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
         | 
| 657 | 
            +
                        #       json_key_io: ::File.open("/path/to/keyfile.json")
         | 
| 658 | 
            +
                        #     )
         | 
| 659 | 
            +
                        #
         | 
| 660 | 
            +
                        #     client = ::Google::Longrunning::Operations::Client.new do |config|
         | 
| 661 | 
            +
                        #       config.credentials = credentials
         | 
| 662 | 
            +
                        #     end
         | 
| 663 | 
            +
                        #
         | 
| 664 | 
            +
                        #   @note Warning: If you accept a credential configuration (JSON file or Hash) from an
         | 
| 637 665 | 
             
                        #   external source for authentication to Google Cloud, you must validate it before
         | 
| 638 666 | 
             
                        #   providing it to a Google API client library. Providing an unvalidated credential
         | 
| 639 667 | 
             
                        #   configuration to Google APIs can compromise the security of your systems and data.
         | 
| @@ -125,7 +125,7 @@ module Google | |
| 125 125 | 
             
                          #   @param options [::Gapic::CallOptions, ::Hash]
         | 
| 126 126 | 
             
                          #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
         | 
| 127 127 | 
             
                          #
         | 
| 128 | 
            -
                          # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
         | 
| 128 | 
            +
                          # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
         | 
| 129 129 | 
             
                          #   Pass arguments to `list_operations` via keyword arguments. Note that at
         | 
| 130 130 | 
             
                          #   least one keyword argument is required. To specify no parameters, or to keep all
         | 
| 131 131 | 
             
                          #   the default parameter values, pass an empty Hash as a request object (see above).
         | 
| @@ -138,6 +138,17 @@ module Google | |
| 138 138 | 
             
                          #     The standard list page size.
         | 
| 139 139 | 
             
                          #   @param page_token [::String]
         | 
| 140 140 | 
             
                          #     The standard list page token.
         | 
| 141 | 
            +
                          #   @param return_partial_success [::Boolean]
         | 
| 142 | 
            +
                          #     When set to `true`, operations that are reachable are returned as normal,
         | 
| 143 | 
            +
                          #     and those that are unreachable are returned in the
         | 
| 144 | 
            +
                          #     [ListOperationsResponse.unreachable] field.
         | 
| 145 | 
            +
                          #
         | 
| 146 | 
            +
                          #     This can only be `true` when reading across collections e.g. when `parent`
         | 
| 147 | 
            +
                          #     is set to `"projects/example/locations/-"`.
         | 
| 148 | 
            +
                          #
         | 
| 149 | 
            +
                          #     This field is not by default supported and will result in an
         | 
| 150 | 
            +
                          #     `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
         | 
| 151 | 
            +
                          #     service or product specific documentation.
         | 
| 141 152 | 
             
                          # @yield [result, operation] Access the result along with the TransportOperation object
         | 
| 142 153 | 
             
                          # @yieldparam result [::Gapic::Operation]
         | 
| 143 154 | 
             
                          # @yieldparam operation [::Gapic::Rest::TransportOperation]
         | 
| @@ -0,0 +1,85 @@ | |
| 1 | 
            +
            # frozen_string_literal: true
         | 
| 2 | 
            +
             | 
| 3 | 
            +
            # Copyright 2025 Google LLC
         | 
| 4 | 
            +
            #
         | 
| 5 | 
            +
            # Licensed under the Apache License, Version 2.0 (the "License");
         | 
| 6 | 
            +
            # you may not use this file except in compliance with the License.
         | 
| 7 | 
            +
            # You may obtain a copy of the License at
         | 
| 8 | 
            +
            #
         | 
| 9 | 
            +
            #     https://www.apache.org/licenses/LICENSE-2.0
         | 
| 10 | 
            +
            #
         | 
| 11 | 
            +
            # Unless required by applicable law or agreed to in writing, software
         | 
| 12 | 
            +
            # distributed under the License is distributed on an "AS IS" BASIS,
         | 
| 13 | 
            +
            # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
         | 
| 14 | 
            +
            # See the License for the specific language governing permissions and
         | 
| 15 | 
            +
            # limitations under the License.
         | 
| 16 | 
            +
             | 
| 17 | 
            +
            # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
         | 
| 18 | 
            +
             | 
| 19 | 
            +
             | 
| 20 | 
            +
            module Google
         | 
| 21 | 
            +
              module Api
         | 
| 22 | 
            +
                # An indicator of the behavior of a given field (for example, that a field
         | 
| 23 | 
            +
                # is required in requests, or given as output but ignored as input).
         | 
| 24 | 
            +
                # This **does not** change the behavior in protocol buffers itself; it only
         | 
| 25 | 
            +
                # denotes the behavior and may affect how API tooling handles the field.
         | 
| 26 | 
            +
                #
         | 
| 27 | 
            +
                # Note: This enum **may** receive new values in the future.
         | 
| 28 | 
            +
                module FieldBehavior
         | 
| 29 | 
            +
                  # Conventional default for enums. Do not use this.
         | 
| 30 | 
            +
                  FIELD_BEHAVIOR_UNSPECIFIED = 0
         | 
| 31 | 
            +
             | 
| 32 | 
            +
                  # Specifically denotes a field as optional.
         | 
| 33 | 
            +
                  # While all fields in protocol buffers are optional, this may be specified
         | 
| 34 | 
            +
                  # for emphasis if appropriate.
         | 
| 35 | 
            +
                  OPTIONAL = 1
         | 
| 36 | 
            +
             | 
| 37 | 
            +
                  # Denotes a field as required.
         | 
| 38 | 
            +
                  # This indicates that the field **must** be provided as part of the request,
         | 
| 39 | 
            +
                  # and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
         | 
| 40 | 
            +
                  REQUIRED = 2
         | 
| 41 | 
            +
             | 
| 42 | 
            +
                  # Denotes a field as output only.
         | 
| 43 | 
            +
                  # This indicates that the field is provided in responses, but including the
         | 
| 44 | 
            +
                  # field in a request does nothing (the server *must* ignore it and
         | 
| 45 | 
            +
                  # *must not* throw an error as a result of the field's presence).
         | 
| 46 | 
            +
                  OUTPUT_ONLY = 3
         | 
| 47 | 
            +
             | 
| 48 | 
            +
                  # Denotes a field as input only.
         | 
| 49 | 
            +
                  # This indicates that the field is provided in requests, and the
         | 
| 50 | 
            +
                  # corresponding field is not included in output.
         | 
| 51 | 
            +
                  INPUT_ONLY = 4
         | 
| 52 | 
            +
             | 
| 53 | 
            +
                  # Denotes a field as immutable.
         | 
| 54 | 
            +
                  # This indicates that the field may be set once in a request to create a
         | 
| 55 | 
            +
                  # resource, but may not be changed thereafter.
         | 
| 56 | 
            +
                  IMMUTABLE = 5
         | 
| 57 | 
            +
             | 
| 58 | 
            +
                  # Denotes that a (repeated) field is an unordered list.
         | 
| 59 | 
            +
                  # This indicates that the service may provide the elements of the list
         | 
| 60 | 
            +
                  # in any arbitrary  order, rather than the order the user originally
         | 
| 61 | 
            +
                  # provided. Additionally, the list's order may or may not be stable.
         | 
| 62 | 
            +
                  UNORDERED_LIST = 6
         | 
| 63 | 
            +
             | 
| 64 | 
            +
                  # Denotes that this field returns a non-empty default value if not set.
         | 
| 65 | 
            +
                  # This indicates that if the user provides the empty value in a request,
         | 
| 66 | 
            +
                  # a non-empty value will be returned. The user will not be aware of what
         | 
| 67 | 
            +
                  # non-empty value to expect.
         | 
| 68 | 
            +
                  NON_EMPTY_DEFAULT = 7
         | 
| 69 | 
            +
             | 
| 70 | 
            +
                  # Denotes that the field in a resource (a message annotated with
         | 
| 71 | 
            +
                  # google.api.resource) is used in the resource name to uniquely identify the
         | 
| 72 | 
            +
                  # resource. For AIP-compliant APIs, this should only be applied to the
         | 
| 73 | 
            +
                  # `name` field on the resource.
         | 
| 74 | 
            +
                  #
         | 
| 75 | 
            +
                  # This behavior should not be applied to references to other resources within
         | 
| 76 | 
            +
                  # the message.
         | 
| 77 | 
            +
                  #
         | 
| 78 | 
            +
                  # The identifier field of resources often have different field behavior
         | 
| 79 | 
            +
                  # depending on the request it is embedded in (e.g. for Create methods name
         | 
| 80 | 
            +
                  # is optional and unused, while for Update methods it is required). Instead
         | 
| 81 | 
            +
                  # of method-specific annotations, only `IDENTIFIER` is required.
         | 
| 82 | 
            +
                  IDENTIFIER = 8
         | 
| 83 | 
            +
                end
         | 
| 84 | 
            +
              end
         | 
| 85 | 
            +
            end
         | 
| @@ -83,6 +83,18 @@ module Google | |
| 83 83 | 
             
                # @!attribute [rw] page_token
         | 
| 84 84 | 
             
                #   @return [::String]
         | 
| 85 85 | 
             
                #     The standard list page token.
         | 
| 86 | 
            +
                # @!attribute [rw] return_partial_success
         | 
| 87 | 
            +
                #   @return [::Boolean]
         | 
| 88 | 
            +
                #     When set to `true`, operations that are reachable are returned as normal,
         | 
| 89 | 
            +
                #     and those that are unreachable are returned in the
         | 
| 90 | 
            +
                #     [ListOperationsResponse.unreachable] field.
         | 
| 91 | 
            +
                #
         | 
| 92 | 
            +
                #     This can only be `true` when reading across collections e.g. when `parent`
         | 
| 93 | 
            +
                #     is set to `"projects/example/locations/-"`.
         | 
| 94 | 
            +
                #
         | 
| 95 | 
            +
                #     This field is not by default supported and will result in an
         | 
| 96 | 
            +
                #     `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
         | 
| 97 | 
            +
                #     service or product specific documentation.
         | 
| 86 98 | 
             
                class ListOperationsRequest
         | 
| 87 99 | 
             
                  include ::Google::Protobuf::MessageExts
         | 
| 88 100 | 
             
                  extend ::Google::Protobuf::MessageExts::ClassMethods
         | 
| @@ -96,6 +108,12 @@ module Google | |
| 96 108 | 
             
                # @!attribute [rw] next_page_token
         | 
| 97 109 | 
             
                #   @return [::String]
         | 
| 98 110 | 
             
                #     The standard List next-page token.
         | 
| 111 | 
            +
                # @!attribute [rw] unreachable
         | 
| 112 | 
            +
                #   @return [::Array<::String>]
         | 
| 113 | 
            +
                #     Unordered list. Unreachable resources. Populated when the request sets
         | 
| 114 | 
            +
                #     `ListOperationsRequest.return_partial_success` and reads across
         | 
| 115 | 
            +
                #     collections e.g. when attempting to list all resources across all supported
         | 
| 116 | 
            +
                #     locations.
         | 
| 99 117 | 
             
                class ListOperationsResponse
         | 
| 100 118 | 
             
                  include ::Google::Protobuf::MessageExts
         | 
| 101 119 | 
             
                  extend ::Google::Protobuf::MessageExts::ClassMethods
         | 
    
        metadata
    CHANGED
    
    | @@ -1,7 +1,7 @@ | |
| 1 1 | 
             
            --- !ruby/object:Gem::Specification
         | 
| 2 2 | 
             
            name: google-cloud-service_usage-v1
         | 
| 3 3 | 
             
            version: !ruby/object:Gem::Version
         | 
| 4 | 
            -
              version: 1. | 
| 4 | 
            +
              version: 1.5.1
         | 
| 5 5 | 
             
            platform: ruby
         | 
| 6 6 | 
             
            authors:
         | 
| 7 7 | 
             
            - Google LLC
         | 
| @@ -72,6 +72,7 @@ files: | |
| 72 72 | 
             
            - proto_docs/google/api/client.rb
         | 
| 73 73 | 
             
            - proto_docs/google/api/documentation.rb
         | 
| 74 74 | 
             
            - proto_docs/google/api/endpoint.rb
         | 
| 75 | 
            +
            - proto_docs/google/api/field_behavior.rb
         | 
| 75 76 | 
             
            - proto_docs/google/api/label.rb
         | 
| 76 77 | 
             
            - proto_docs/google/api/launch_stage.rb
         | 
| 77 78 | 
             
            - proto_docs/google/api/monitored_resource.rb
         |