google-cloud-bigquery-data_exchange-v1beta1 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb6ca512429a91e96ba8f02e79abaaa1f9d8a8dce411b7506b85e235fdaf955f
-  data.tar.gz: f727a1d1a3a4f3b499d8f4d4172851ef4c75c21e390863ede8b2731394d4da0c
+  metadata.gz: 29577ca693360f2c0f48851e10c0bb8b2b6c07681d34baf3e6993907bd65700b
+  data.tar.gz: d86e60bfa2b1a46d090ac3e976e67b9a88172c245ba0df543e8aea71e926e0ff
 SHA512:
-  metadata.gz: bc17acc0fc11afa749339b916da275737ee2ced1be627f064061053ed6103d5cf5e49df04bd6243f59a57ae6e846553501a5344ac9c41158c0417ce78d144cce
-  data.tar.gz: c6a3a2dc1802abe5669398d8e4c82e35567507999b652a8169973d4401090bbdc5531cc7ce8d0f9daf2cf71f69ee0d5673f5cb0938d115ed4cb3e305ddd6cf43
+  metadata.gz: 8de57f2a83d81f776a66370e748579820d9e0f810237829d1c40ecda2e5e422fc20ff540e0d271a70c20b3003aa6c8690c0e06c20f6000405830b6ec9d1a84b2
+  data.tar.gz: 3701f90e02176bf74d908a30de8716886b7be3bda4d01f2dfec4f59864b7b3a82c93b26f8fba21d382c66a57c65e2fb1849886852e1331daaed4da07c4891283

data/AUTHENTICATION.md

@@ -112,7 +112,7 @@ credentials are discovered.
 To configure your system for this, simply:
 
 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
-2. Authenticate using OAuth 2.0 `$ gcloud auth login`
+2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
 3. Write code as if already authenticated.
 
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK

data/README.md

@@ -1,6 +1,6 @@
 # Ruby Client for the Analytics Hub V1beta1 API
 
-API Client library for the Analytics Hub V1beta1 API
+Exchange data and analytics assets securely and efficiently.
 
 Analytics Hub is a data exchange that allows you to efficiently and securely exchange data assets across organizations to address challenges of data reliability and cost. Curate a library of internal and external assets, including unique datasets like Google Trends, backed by the power of BigQuery.
 
@@ -46,8 +46,8 @@ for general usage information.
 ## Enabling Logging
 
 To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
-or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
+The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
+or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
 that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
 and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
 

data/lib/google/cloud/bigquery/data_exchange/v1beta1/analytics_hub_service/client.rb

@@ -18,6 +18,7 @@
 
 require "google/cloud/errors"
 require "google/cloud/bigquery/dataexchange/v1beta1/dataexchange_pb"
+require "google/cloud/location"
 
 module Google
   module Cloud
@@ -28,11 +29,12 @@ module Google
             ##
             # Client for the AnalyticsHubService service.
             #
-            # The AnalyticsHubService API facilitates data sharing within and across
-            # organizations. It allows data providers to publish Listings --- a
-            # discoverable and searchable SKU representing a dataset. Data consumers can
-            # subscribe to Listings. Upon subscription, AnalyticsHub provisions a "Linked
-            # Datasets" surfacing the data in the consumer's project.
+            # The `AnalyticsHubService` API facilitates data sharing within and across
+            # organizations. It allows data providers to publish listings that reference
+            # shared datasets. With Analytics Hub, users can discover and search for
+            # listings that they have access to. Subscribers can view and subscribe to
+            # listings. When you subscribe to a listing, Analytics Hub creates a linked
+            # dataset in your project.
             #
             class Client
               include Paths
@@ -133,7 +135,7 @@ module Google
                 credentials = @config.credentials
                 # Use self-signed JWT if the endpoint is unchanged from default,
                 # but only if the default endpoint does not have a region prefix.
-                enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
+                enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                                          !@config.endpoint.split(".").first.include?("-")
                 credentials ||= Credentials.default scope: @config.scope,
                                                     enable_self_signed_jwt: enable_self_signed_jwt
@@ -143,6 +145,12 @@ module Google
                 @quota_project_id = @config.quota_project
                 @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
 
+                @location_client = Google::Cloud::Location::Locations::Client.new do |config|
+                  config.credentials = credentials
+                  config.quota_project = @quota_project_id
+                  config.endpoint = @config.endpoint
+                end
+
                 @analytics_hub_service_stub = ::Gapic::ServiceStub.new(
                   ::Google::Cloud::Bigquery::DataExchange::V1beta1::AnalyticsHubService::Stub,
                   credentials:  credentials,
@@ -152,10 +160,17 @@ module Google
                 )
               end
 
+              ##
+              # Get the associated client for mix-in of the Locations.
+              #
+              # @return [Google::Cloud::Location::Locations::Client]
+              #
+              attr_reader :location_client
+
               # Service calls
 
               ##
-              # Lists DataExchanges in a given project and location.
+              # Lists all data exchanges in a given project and location.
               #
               # @overload list_data_exchanges(request, options = nil)
               #   Pass arguments to `list_data_exchanges` via a request object, either of type
@@ -173,7 +188,7 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param parent [::String]
-              #     Required. The parent resource path of the DataExchanges.
+              #     Required. The parent resource path of the data exchanges.
               #     e.g. `projects/myproject/locations/US`.
               #   @param page_size [::Integer]
               #     The maximum number of results to return in a single response page. Leverage
@@ -202,13 +217,11 @@ module Google
               #   # Call the list_data_exchanges method.
               #   result = client.list_data_exchanges request
               #
-              #   # The returned object is of type Gapic::PagedEnumerable. You can
-              #   # iterate over all elements by calling #each, and the enumerable
-              #   # will lazily make API calls to fetch subsequent pages. Other
-              #   # methods are also available for managing paging directly.
-              #   result.each do |response|
+              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+              #   # over elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
               #     # Each element is of type ::Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange.
-              #     p response
+              #     p item
               #   end
               #
               def list_data_exchanges request, options = nil
@@ -254,7 +267,8 @@ module Google
               end
 
               ##
-              # Lists DataExchanges from projects in a given organization and location.
+              # Lists all data exchanges from projects in a given organization and
+              # location.
               #
               # @overload list_org_data_exchanges(request, options = nil)
               #   Pass arguments to `list_org_data_exchanges` via a request object, either of type
@@ -301,13 +315,11 @@ module Google
               #   # Call the list_org_data_exchanges method.
               #   result = client.list_org_data_exchanges request
               #
-              #   # The returned object is of type Gapic::PagedEnumerable. You can
-              #   # iterate over all elements by calling #each, and the enumerable
-              #   # will lazily make API calls to fetch subsequent pages. Other
-              #   # methods are also available for managing paging directly.
-              #   result.each do |response|
+              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+              #   # over elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
               #     # Each element is of type ::Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange.
-              #     p response
+              #     p item
               #   end
               #
               def list_org_data_exchanges request, options = nil
@@ -353,7 +365,7 @@ module Google
               end
 
               ##
-              # Gets details of a single DataExchange.
+              # Gets the details of a data exchange.
               #
               # @overload get_data_exchange(request, options = nil)
               #   Pass arguments to `get_data_exchange` via a request object, either of type
@@ -371,7 +383,7 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param name [::String]
-              #     Required. The resource name of the DataExchange.
+              #     Required. The resource name of the data exchange.
               #     e.g. `projects/myproject/locations/US/dataExchanges/123`.
               #
               # @yield [response, operation] Access the result along with the RPC operation
@@ -439,7 +451,7 @@ module Google
               end
 
               ##
-              # Creates a new DataExchange in a given project and location.
+              # Creates a new data exchange.
               #
               # @overload create_data_exchange(request, options = nil)
               #   Pass arguments to `create_data_exchange` via a request object, either of type
@@ -457,16 +469,16 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param parent [::String]
-              #     Required. The parent resource path of the DataExchange.
+              #     Required. The parent resource path of the data exchange.
               #     e.g. `projects/myproject/locations/US`.
               #   @param data_exchange_id [::String]
-              #     Required. The ID of the DataExchange to create.
+              #     Required. The ID of the data exchange.
               #     Must contain only Unicode letters, numbers (0-9), underscores (_).
               #     Should not use characters that require URL-escaping, or characters
               #     outside of ASCII, spaces.
               #     Max length: 100 bytes.
               #   @param data_exchange [::Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange, ::Hash]
-              #     Required. The DataExchange to create.
+              #     Required. The data exchange to create.
               #
               # @yield [response, operation] Access the result along with the RPC operation
               # @yieldparam response [::Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange]
@@ -533,7 +545,7 @@ module Google
               end
 
               ##
-              # Updates the parameters of a single DataExchange.
+              # Updates an existing data exchange.
               #
               # @overload update_data_exchange(request, options = nil)
               #   Pass arguments to `update_data_exchange` via a request object, either of type
@@ -551,12 +563,11 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
-              #     Required. Field mask is used to specify the fields to be overwritten in the
-              #     DataExchange resource by the update.
-              #     The fields specified in the update_mask are relative to the resource, not
-              #     the full request.
+              #     Required. Field mask specifies the fields to update in the data exchange
+              #     resource. The fields specified in the
+              #     `updateMask` are relative to the resource and are not a full request.
               #   @param data_exchange [::Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange, ::Hash]
-              #     Required. The DataExchange to update.
+              #     Required. The data exchange to update.
               #
               # @yield [response, operation] Access the result along with the RPC operation
               # @yieldparam response [::Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange]
@@ -623,7 +634,7 @@ module Google
               end
 
               ##
-              # Deletes a single DataExchange.
+              # Deletes an existing data exchange.
               #
               # @overload delete_data_exchange(request, options = nil)
               #   Pass arguments to `delete_data_exchange` via a request object, either of type
@@ -641,8 +652,8 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param name [::String]
-              #     Required. Resource name of the DataExchange to delete.
-              #     e.g. `projects/myproject/locations/US/dataExchanges/123`.
+              #     Required. The full name of the data exchange resource that you want to delete.
+              #     For example, `projects/myproject/locations/US/dataExchanges/123`.
               #
               # @yield [response, operation] Access the result along with the RPC operation
               # @yieldparam response [::Google::Protobuf::Empty]
@@ -709,7 +720,7 @@ module Google
               end
 
               ##
-              # Lists Listings in a given project and location.
+              # Lists all listings in a given project and location.
               #
               # @overload list_listings(request, options = nil)
               #   Pass arguments to `list_listings` via a request object, either of type
@@ -756,13 +767,11 @@ module Google
               #   # Call the list_listings method.
               #   result = client.list_listings request
               #
-              #   # The returned object is of type Gapic::PagedEnumerable. You can
-              #   # iterate over all elements by calling #each, and the enumerable
-              #   # will lazily make API calls to fetch subsequent pages. Other
-              #   # methods are also available for managing paging directly.
-              #   result.each do |response|
+              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+              #   # over elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
               #     # Each element is of type ::Google::Cloud::Bigquery::DataExchange::V1beta1::Listing.
-              #     p response
+              #     p item
               #   end
               #
               def list_listings request, options = nil
@@ -808,7 +817,7 @@ module Google
               end
 
               ##
-              # Gets details of a single Listing.
+              # Gets the details of a listing.
               #
               # @overload get_listing(request, options = nil)
               #   Pass arguments to `get_listing` via a request object, either of type
@@ -894,7 +903,7 @@ module Google
               end
 
               ##
-              # Creates a new Listing in a given project and location.
+              # Creates a new listing.
               #
               # @overload create_listing(request, options = nil)
               #   Pass arguments to `create_listing` via a request object, either of type
@@ -915,7 +924,7 @@ module Google
               #     Required. The parent resource path of the listing.
               #     e.g. `projects/myproject/locations/US/dataExchanges/123`.
               #   @param listing_id [::String]
-              #     Required. The ID of the Listing to create.
+              #     Required. The ID of the listing to create.
               #     Must contain only Unicode letters, numbers (0-9), underscores (_).
               #     Should not use characters that require URL-escaping, or characters
               #     outside of ASCII, spaces.
@@ -988,7 +997,7 @@ module Google
               end
 
               ##
-              # Updates the parameters of a single Listing.
+              # Updates an existing listing.
               #
               # @overload update_listing(request, options = nil)
               #   Pass arguments to `update_listing` via a request object, either of type
@@ -1006,10 +1015,9 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
-              #     Required. Field mask is used to specify the fields to be overwritten in the
-              #     Listing resource by the update.
-              #     The fields specified in the update_mask are relative to the resource, not
-              #     the full request.
+              #     Required. Field mask specifies the fields to update in the listing resource. The
+              #     fields specified in the `updateMask` are relative to the resource and are
+              #     not a full request.
               #   @param listing [::Google::Cloud::Bigquery::DataExchange::V1beta1::Listing, ::Hash]
               #     Required. The listing to update.
               #
@@ -1078,8 +1086,7 @@ module Google
               end
 
               ##
-              # Deletes a single Listing, as long as there are no subscriptions
-              # associated with the source of this Listing.
+              # Deletes a listing.
               #
               # @overload delete_listing(request, options = nil)
               #   Pass arguments to `delete_listing` via a request object, either of type
@@ -1165,10 +1172,11 @@ module Google
               end
 
               ##
-              # Subscribes to a single Listing.
+              # Subscribes to a listing.
               #
-              # Data Exchange currently supports one type of Listing: a BigQuery dataset.
-              # Upon subscription to a Listing for a BigQuery dataset, Data Exchange
+              # Currently, with Analytics Hub, you can create listings that
+              # reference only BigQuery datasets.
+              # Upon subscription to a listing for a BigQuery dataset, Analytics Hub
               # creates a linked dataset in the subscriber's project.
               #
               # @overload subscribe_listing(request, options = nil)
@@ -1181,16 +1189,16 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
               #
-              # @overload subscribe_listing(name: nil, destination_dataset: nil)
+              # @overload subscribe_listing(destination_dataset: nil, name: nil)
               #   Pass arguments to `subscribe_listing` via keyword arguments. Note that at
               #   least one keyword argument is required. To specify no parameters, or to keep all
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
-              #   @param name [::String]
-              #     Required. Resource name of the listing to subscribe to.
-              #     e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.
               #   @param destination_dataset [::Google::Cloud::Bigquery::DataExchange::V1beta1::DestinationDataset, ::Hash]
               #     BigQuery destination dataset to create for the subscriber.
+              #   @param name [::String]
+              #     Required. Resource name of the listing that you want to subscribe to.
+              #     e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.
               #
               # @yield [response, operation] Access the result along with the RPC operation
               # @yieldparam response [::Google::Cloud::Bigquery::DataExchange::V1beta1::SubscribeListingResponse]
@@ -1257,7 +1265,7 @@ module Google
               end
 
               ##
-              # Gets the IAM policy for a dataExchange or a listing.
+              # Gets the IAM policy.
               #
               # @overload get_iam_policy(request, options = nil)
               #   Pass arguments to `get_iam_policy` via a request object, either of type
@@ -1346,7 +1354,7 @@ module Google
               end
 
               ##
-              # Sets the IAM policy for a dataExchange or a listing.
+              # Sets the IAM policy.
               #
               # @overload set_iam_policy(request, options = nil)
               #   Pass arguments to `set_iam_policy` via a request object, either of type
@@ -1443,8 +1451,7 @@ module Google
               end
 
               ##
-              # Returns the permissions that a caller has on a specified dataExchange or
-              # listing.
+              # Returns the permissions that a caller has.
               #
               # @overload test_iam_permissions(request, options = nil)
               #   Pass arguments to `test_iam_permissions` via a request object, either of type
@@ -1572,9 +1579,9 @@ module Google
               #    *  (`String`) The path to a service account key file in JSON format
               #    *  (`Hash`) A service account key as a Hash
               #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-              #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+              #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
               #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-              #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+              #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
               #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
               #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
               #    *  (`nil`) indicating no credentials
@@ -1616,7 +1623,9 @@ module Google
               class Configuration
                 extend ::Gapic::Config
 
-                config_attr :endpoint,      "analyticshub.googleapis.com", ::String
+                DEFAULT_ENDPOINT = "analyticshub.googleapis.com"
+
+                config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
                 config_attr :credentials,   nil do |value|
                   allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
                   allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC

data/lib/google/cloud/bigquery/data_exchange/v1beta1/analytics_hub_service.rb

@@ -32,13 +32,14 @@ module Google
       module DataExchange
         module V1beta1
           ##
-          # The AnalyticsHubService API facilitates data sharing within and across
-          # organizations. It allows data providers to publish Listings --- a
-          # discoverable and searchable SKU representing a dataset. Data consumers can
-          # subscribe to Listings. Upon subscription, AnalyticsHub provisions a "Linked
-          # Datasets" surfacing the data in the consumer's project.
+          # The `AnalyticsHubService` API facilitates data sharing within and across
+          # organizations. It allows data providers to publish listings that reference
+          # shared datasets. With Analytics Hub, users can discover and search for
+          # listings that they have access to. Subscribers can view and subscribe to
+          # listings. When you subscribe to a listing, Analytics Hub creates a linked
+          # dataset in your project.
           #
-          # To load this service and instantiate a client:
+          # @example Load this service and instantiate a gRPC client
           #
           #     require "google/cloud/bigquery/data_exchange/v1beta1/analytics_hub_service"
           #     client = ::Google::Cloud::Bigquery::DataExchange::V1beta1::AnalyticsHubService::Client.new

data/lib/google/cloud/bigquery/data_exchange/v1beta1/version.rb

@@ -22,7 +22,7 @@ module Google
     module Bigquery
       module DataExchange
         module V1beta1
-          VERSION = "0.2.0"
+          VERSION = "0.4.0"
         end
       end
     end

data/lib/google/cloud/bigquery/data_exchange/v1beta1.rb

@@ -24,9 +24,9 @@ module Google
     module Bigquery
       module DataExchange
         ##
-        # To load this package, including all its services, and instantiate a client:
+        # API client module.
         #
-        # @example
+        # @example Load this package, including all its services, and instantiate a gRPC client
         #
         #     require "google/cloud/bigquery/data_exchange/v1beta1"
         #     client = ::Google::Cloud::Bigquery::DataExchange::V1beta1::AnalyticsHubService::Client.new