Reference documentation and code samples for the Analytics Hub V1 API class Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.
Client for the AnalyticsHubService service.
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.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the AnalyticsHubService Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all AnalyticsHubService clients ::Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.configure do |config| config.timeout = 10.0 end
#configure
def configure() { |config| ... } -> Client::Configuration
Configure the AnalyticsHubService Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
#create_data_exchange
def create_data_exchange(request, options = nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange
def create_data_exchange(parent: nil, data_exchange_id: nil, data_exchange: nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange
Creates a new data exchange.
def create_data_exchange(request, options = nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange
create_data_exchange
via a request object, either of type
CreateDataExchangeRequest or an equivalent Hash.
- request (::Google::Cloud::Bigquery::AnalyticsHub::V1::CreateDataExchangeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def create_data_exchange(parent: nil, data_exchange_id: nil, data_exchange: nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange
create_data_exchange
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).
-
parent (::String) — Required. The parent resource path of the data exchange.
e.g.
projects/myproject/locations/US
. - data_exchange_id (::String) — 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.
- data_exchange (::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange, ::Hash) — Required. The data exchange to create.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigquery/analytics_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigquery::AnalyticsHub::V1::CreateDataExchangeRequest.new # Call the create_data_exchange method. result = client.create_data_exchange request # The returned object is of type Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange. p result
#create_listing
def create_listing(request, options = nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing
def create_listing(parent: nil, listing_id: nil, listing: nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing
Creates a new listing.
def create_listing(request, options = nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing
create_listing
via a request object, either of type
CreateListingRequest or an equivalent Hash.
- request (::Google::Cloud::Bigquery::AnalyticsHub::V1::CreateListingRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def create_listing(parent: nil, listing_id: nil, listing: nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing
create_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).
-
parent (::String) — Required. The parent resource path of the listing.
e.g.
projects/myproject/locations/US/dataExchanges/123
. - listing_id (::String) — 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. Max length: 100 bytes.
- listing (::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing, ::Hash) — Required. The listing to create.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigquery/analytics_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigquery::AnalyticsHub::V1::CreateListingRequest.new # Call the create_listing method. result = client.create_listing request # The returned object is of type Google::Cloud::Bigquery::AnalyticsHub::V1::Listing. p result
#delete_data_exchange
def delete_data_exchange(request, options = nil) -> ::Google::Protobuf::Empty
def delete_data_exchange(name: nil) -> ::Google::Protobuf::Empty
Deletes an existing data exchange.
def delete_data_exchange(request, options = nil) -> ::Google::Protobuf::Empty
delete_data_exchange
via a request object, either of type
DeleteDataExchangeRequest or an equivalent Hash.
- request (::Google::Cloud::Bigquery::AnalyticsHub::V1::DeleteDataExchangeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def delete_data_exchange(name: nil) -> ::Google::Protobuf::Empty
delete_data_exchange
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).
-
name (::String) — Required. The full name of the data exchange resource that you want to
delete. For example,
projects/myproject/locations/US/dataExchanges/123
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigquery/analytics_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigquery::AnalyticsHub::V1::DeleteDataExchangeRequest.new # Call the delete_data_exchange method. result = client.delete_data_exchange request # The returned object is of type Google::Protobuf::Empty. p result
#delete_listing
def delete_listing(request, options = nil) -> ::Google::Protobuf::Empty
def delete_listing(name: nil) -> ::Google::Protobuf::Empty
Deletes a listing.
def delete_listing(request, options = nil) -> ::Google::Protobuf::Empty
delete_listing
via a request object, either of type
DeleteListingRequest or an equivalent Hash.
- request (::Google::Cloud::Bigquery::AnalyticsHub::V1::DeleteListingRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def delete_listing(name: nil) -> ::Google::Protobuf::Empty
delete_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).
-
name (::String) — Required. Resource name of the listing to delete.
e.g.
projects/myproject/locations/US/dataExchanges/123/listings/456
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigquery/analytics_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigquery::AnalyticsHub::V1::DeleteListingRequest.new # Call the delete_listing method. result = client.delete_listing request # The returned object is of type Google::Protobuf::Empty. p result
#delete_subscription
def delete_subscription(request, options = nil) -> ::Gapic::Operation
def delete_subscription(name: nil) -> ::Gapic::Operation
Deletes a subscription.
def delete_subscription(request, options = nil) -> ::Gapic::Operation
delete_subscription
via a request object, either of type
DeleteSubscriptionRequest or an equivalent Hash.
- request (::Google::Cloud::Bigquery::AnalyticsHub::V1::DeleteSubscriptionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def delete_subscription(name: nil) -> ::Gapic::Operation
delete_subscription
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).
- name (::String) — Required. Resource name of the subscription to delete. e.g. projects/123/locations/US/subscriptions/456
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigquery/analytics_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigquery::AnalyticsHub::V1::DeleteSubscriptionRequest.new # Call the delete_subscription method. result = client.delete_subscription request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#get_data_exchange
def get_data_exchange(request, options = nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange
def get_data_exchange(name: nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange
Gets the details of a data exchange.
def get_data_exchange(request, options = nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange
get_data_exchange
via a request object, either of type
GetDataExchangeRequest or an equivalent Hash.
- request (::Google::Cloud::Bigquery::AnalyticsHub::V1::GetDataExchangeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_data_exchange(name: nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange
get_data_exchange
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).
-
name (::String) — Required. The resource name of the data exchange.
e.g.
projects/myproject/locations/US/dataExchanges/123
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigquery/analytics_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigquery::AnalyticsHub::V1::GetDataExchangeRequest.new # Call the get_data_exchange method. result = client.get_data_exchange request # The returned object is of type Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange. p result
#get_iam_policy
def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def get_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy
Gets the IAM policy.
def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
get_iam_policy
via a request object, either of type
Iam::V1::GetIamPolicyRequest or an equivalent Hash.
- request (::Google::Iam::V1::GetIamPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy
get_iam_policy
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).
- resource (::String) — REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
-
options (::Google::Iam::V1::GetPolicyOptions, ::Hash) — OPTIONAL: A
GetPolicyOptions
object for specifying options toGetIamPolicy
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Iam::V1::Policy)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigquery/analytics_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Iam::V1::GetIamPolicyRequest.new # Call the get_iam_policy method. result = client.get_iam_policy request # The returned object is of type Google::Iam::V1::Policy. p result
#get_listing
def get_listing(request, options = nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing
def get_listing(name: nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing
Gets the details of a listing.
def get_listing(request, options = nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing
get_listing
via a request object, either of type
GetListingRequest or an equivalent Hash.
- request (::Google::Cloud::Bigquery::AnalyticsHub::V1::GetListingRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_listing(name: nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing
get_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).
-
name (::String) — Required. The resource name of the listing.
e.g.
projects/myproject/locations/US/dataExchanges/123/listings/456
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigquery/analytics_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigquery::AnalyticsHub::V1::GetListingRequest.new # Call the get_listing method. result = client.get_listing request # The returned object is of type Google::Cloud::Bigquery::AnalyticsHub::V1::Listing. p result
#get_subscription
def get_subscription(request, options = nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription
def get_subscription(name: nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription
Gets the details of a Subscription.
def get_subscription(request, options = nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription
get_subscription
via a request object, either of type
GetSubscriptionRequest or an equivalent Hash.
- request (::Google::Cloud::Bigquery::AnalyticsHub::V1::GetSubscriptionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_subscription(name: nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription
get_subscription
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).
- name (::String) — Required. Resource name of the subscription. e.g. projects/123/locations/US/subscriptions/456
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigquery/analytics_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigquery::AnalyticsHub::V1::GetSubscriptionRequest.new # Call the get_subscription method. result = client.get_subscription request # The returned object is of type Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription. p result
#initialize
def initialize() { |config| ... } -> Client
Create a new AnalyticsHubService client object.
- (config) — Configure the AnalyticsHubService client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.new do |config| config.timeout = 10.0 end
#list_data_exchanges
def list_data_exchanges(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange>
def list_data_exchanges(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange>
Lists all data exchanges in a given project and location.
def list_data_exchanges(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange>
list_data_exchanges
via a request object, either of type
ListDataExchangesRequest or an equivalent Hash.
- request (::Google::Cloud::Bigquery::AnalyticsHub::V1::ListDataExchangesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_data_exchanges(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange>
list_data_exchanges
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).
-
parent (::String) — Required. The parent resource path of the data exchanges.
e.g.
projects/myproject/locations/US
. - page_size (::Integer) — The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
- page_token (::String) — Page token, returned by a previous call, to request the next page of results.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigquery/analytics_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigquery::AnalyticsHub::V1::ListDataExchangesRequest.new # Call the list_data_exchanges method. result = client.list_data_exchanges request # 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::AnalyticsHub::V1::DataExchange. p item end
#list_listings
def list_listings(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing>
def list_listings(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing>
Lists all listings in a given project and location.
def list_listings(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing>
list_listings
via a request object, either of type
ListListingsRequest or an equivalent Hash.
- request (::Google::Cloud::Bigquery::AnalyticsHub::V1::ListListingsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_listings(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing>
list_listings
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).
-
parent (::String) — Required. The parent resource path of the listing.
e.g.
projects/myproject/locations/US/dataExchanges/123
. - page_size (::Integer) — The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
- page_token (::String) — Page token, returned by a previous call, to request the next page of results.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigquery/analytics_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigquery::AnalyticsHub::V1::ListListingsRequest.new # Call the list_listings method. result = client.list_listings request # 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::AnalyticsHub::V1::Listing. p item end
#list_org_data_exchanges
def list_org_data_exchanges(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange>
def list_org_data_exchanges(organization: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange>
Lists all data exchanges from projects in a given organization and location.
def list_org_data_exchanges(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange>
list_org_data_exchanges
via a request object, either of type
ListOrgDataExchangesRequest or an equivalent Hash.
- request (::Google::Cloud::Bigquery::AnalyticsHub::V1::ListOrgDataExchangesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_org_data_exchanges(organization: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange>
list_org_data_exchanges
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).
-
organization (::String) — Required. The organization resource path of the projects containing
DataExchanges. e.g.
organizations/myorg/locations/US
. - page_size (::Integer) — The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
- page_token (::String) — Page token, returned by a previous call, to request the next page of results.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigquery/analytics_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigquery::AnalyticsHub::V1::ListOrgDataExchangesRequest.new # 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 elements, and API calls will be issued to fetch pages as needed. result.each do |item| # Each element is of type ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange. p item end
#list_shared_resource_subscriptions
def list_shared_resource_subscriptions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription>
def list_shared_resource_subscriptions(resource: nil, include_deleted_subscriptions: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription>
Lists all subscriptions on a given Data Exchange or Listing.
def list_shared_resource_subscriptions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription>
list_shared_resource_subscriptions
via a request object, either of type
ListSharedResourceSubscriptionsRequest or an equivalent Hash.
- request (::Google::Cloud::Bigquery::AnalyticsHub::V1::ListSharedResourceSubscriptionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_shared_resource_subscriptions(resource: nil, include_deleted_subscriptions: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription>
list_shared_resource_subscriptions
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).
- resource (::String) — Required. Resource name of the requested target. This resource may be either a Listing or a DataExchange. e.g. projects/123/locations/US/dataExchanges/456 OR e.g. projects/123/locations/US/dataExchanges/456/listings/789
- include_deleted_subscriptions (::Boolean) — If selected, includes deleted subscriptions in the response (up to 63 days after deletion).
- page_size (::Integer) — The maximum number of results to return in a single response page.
- page_token (::String) — Page token, returned by a previous call.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigquery/analytics_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigquery::AnalyticsHub::V1::ListSharedResourceSubscriptionsRequest.new # Call the list_shared_resource_subscriptions method. result = client.list_shared_resource_subscriptions request # 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::AnalyticsHub::V1::Subscription. p item end
#list_subscriptions
def list_subscriptions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription>
def list_subscriptions(parent: nil, filter: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription>
Lists all subscriptions in a given project and location.
def list_subscriptions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription>
list_subscriptions
via a request object, either of type
ListSubscriptionsRequest or an equivalent Hash.
- request (::Google::Cloud::Bigquery::AnalyticsHub::V1::ListSubscriptionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_subscriptions(parent: nil, filter: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription>
list_subscriptions
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).
- parent (::String) — Required. The parent resource path of the subscription. e.g. projects/myproject/locations/US
- filter (::String) — The filter expression may be used to filter by Data Exchange or Listing.
- page_size (::Integer) — The maximum number of results to return in a single response page.
- page_token (::String) — Page token, returned by a previous call.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigquery/analytics_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigquery::AnalyticsHub::V1::ListSubscriptionsRequest.new # Call the list_subscriptions method. result = client.list_subscriptions request # 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::AnalyticsHub::V1::Subscription. p item end
#operations_client
def operations_client() -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Operations
Get the associated client for long-running operations.
#refresh_subscription
def refresh_subscription(request, options = nil) -> ::Gapic::Operation
def refresh_subscription(name: nil) -> ::Gapic::Operation
Refreshes a Subscription to a Data Exchange. A Data Exchange can become stale when a publisher adds or removes data. This is a long-running operation as it may create many linked datasets.
def refresh_subscription(request, options = nil) -> ::Gapic::Operation
refresh_subscription
via a request object, either of type
RefreshSubscriptionRequest or an equivalent Hash.
- request (::Google::Cloud::Bigquery::AnalyticsHub::V1::RefreshSubscriptionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def refresh_subscription(name: nil) -> ::Gapic::Operation
refresh_subscription
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).
-
name (::String) — Required. Resource name of the Subscription to refresh.
e.g.
projects/subscriberproject/locations/US/subscriptions/123
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigquery/analytics_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigquery::AnalyticsHub::V1::RefreshSubscriptionRequest.new # Call the refresh_subscription method. result = client.refresh_subscription request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#revoke_subscription
def revoke_subscription(request, options = nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::RevokeSubscriptionResponse
def revoke_subscription(name: nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::RevokeSubscriptionResponse
Revokes a given subscription.
def revoke_subscription(request, options = nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::RevokeSubscriptionResponse
revoke_subscription
via a request object, either of type
RevokeSubscriptionRequest or an equivalent Hash.
- request (::Google::Cloud::Bigquery::AnalyticsHub::V1::RevokeSubscriptionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def revoke_subscription(name: nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::RevokeSubscriptionResponse
revoke_subscription
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).
- name (::String) — Required. Resource name of the subscription to revoke. e.g. projects/123/locations/US/subscriptions/456
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Bigquery::AnalyticsHub::V1::RevokeSubscriptionResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigquery/analytics_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigquery::AnalyticsHub::V1::RevokeSubscriptionRequest.new # Call the revoke_subscription method. result = client.revoke_subscription request # The returned object is of type Google::Cloud::Bigquery::AnalyticsHub::V1::RevokeSubscriptionResponse. p result
#set_iam_policy
def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy
Sets the IAM policy.
def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
set_iam_policy
via a request object, either of type
Iam::V1::SetIamPolicyRequest or an equivalent Hash.
- request (::Google::Iam::V1::SetIamPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy
set_iam_policy
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).
- resource (::String) — REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
-
policy (::Google::Iam::V1::Policy, ::Hash) — REQUIRED: The complete policy to be applied to the
resource
. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. -
update_mask (::Google::Protobuf::FieldMask, ::Hash) — OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
the fields in the mask will be modified. If no mask is provided, the
following default mask is used:
paths: "bindings, etag"
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Iam::V1::Policy)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigquery/analytics_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Iam::V1::SetIamPolicyRequest.new # Call the set_iam_policy method. result = client.set_iam_policy request # The returned object is of type Google::Iam::V1::Policy. p result
#subscribe_data_exchange
def subscribe_data_exchange(request, options = nil) -> ::Gapic::Operation
def subscribe_data_exchange(name: nil, destination: nil, subscription: nil, subscriber_contact: nil) -> ::Gapic::Operation
Creates a Subscription to a Data Exchange. This is a long-running operation as it will create one or more linked datasets.
def subscribe_data_exchange(request, options = nil) -> ::Gapic::Operation
subscribe_data_exchange
via a request object, either of type
SubscribeDataExchangeRequest or an equivalent Hash.
- request (::Google::Cloud::Bigquery::AnalyticsHub::V1::SubscribeDataExchangeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def subscribe_data_exchange(name: nil, destination: nil, subscription: nil, subscriber_contact: nil) -> ::Gapic::Operation
subscribe_data_exchange
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).
-
name (::String) — Required. Resource name of the Data Exchange.
e.g.
projects/publisherproject/locations/US/dataExchanges/123
-
destination (::String) — Required. The parent resource path of the Subscription.
e.g.
projects/subscriberproject/locations/US
-
subscription (::String) — Required. Name of the subscription to create.
e.g.
subscription1
- subscriber_contact (::String) — Email of the subscriber.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigquery/analytics_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigquery::AnalyticsHub::V1::SubscribeDataExchangeRequest.new # Call the subscribe_data_exchange method. result = client.subscribe_data_exchange request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#subscribe_listing
def subscribe_listing(request, options = nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::SubscribeListingResponse
def subscribe_listing(destination_dataset: nil, name: nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::SubscribeListingResponse
Subscribes to a listing.
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.
def subscribe_listing(request, options = nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::SubscribeListingResponse
subscribe_listing
via a request object, either of type
SubscribeListingRequest or an equivalent Hash.
- request (::Google::Cloud::Bigquery::AnalyticsHub::V1::SubscribeListingRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def subscribe_listing(destination_dataset: nil, name: nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::SubscribeListingResponse
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).
- destination_dataset (::Google::Cloud::Bigquery::AnalyticsHub::V1::DestinationDataset, ::Hash) — BigQuery destination dataset to create for the subscriber.
-
name (::String) — Required. Resource name of the listing that you want to subscribe to.
e.g.
projects/myproject/locations/US/dataExchanges/123/listings/456
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Bigquery::AnalyticsHub::V1::SubscribeListingResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigquery/analytics_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigquery::AnalyticsHub::V1::SubscribeListingRequest.new # Call the subscribe_listing method. result = client.subscribe_listing request # The returned object is of type Google::Cloud::Bigquery::AnalyticsHub::V1::SubscribeListingResponse. p result
#test_iam_permissions
def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
def test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
Returns the permissions that a caller has.
def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
test_iam_permissions
via a request object, either of type
Iam::V1::TestIamPermissionsRequest or an equivalent Hash.
- request (::Google::Iam::V1::TestIamPermissionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
test_iam_permissions
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).
- resource (::String) — REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
-
permissions (::Array<::String>) — The set of permissions to check for the
resource
. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Iam::V1::TestIamPermissionsResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigquery/analytics_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Iam::V1::TestIamPermissionsRequest.new # Call the test_iam_permissions method. result = client.test_iam_permissions request # The returned object is of type Google::Iam::V1::TestIamPermissionsResponse. p result
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)
#update_data_exchange
def update_data_exchange(request, options = nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange
def update_data_exchange(update_mask: nil, data_exchange: nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange
Updates an existing data exchange.
def update_data_exchange(request, options = nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange
update_data_exchange
via a request object, either of type
UpdateDataExchangeRequest or an equivalent Hash.
- request (::Google::Cloud::Bigquery::AnalyticsHub::V1::UpdateDataExchangeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def update_data_exchange(update_mask: nil, data_exchange: nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange
update_data_exchange
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).
-
update_mask (::Google::Protobuf::FieldMask, ::Hash) — 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. - data_exchange (::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange, ::Hash) — Required. The data exchange to update.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigquery/analytics_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigquery::AnalyticsHub::V1::UpdateDataExchangeRequest.new # Call the update_data_exchange method. result = client.update_data_exchange request # The returned object is of type Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange. p result
#update_listing
def update_listing(request, options = nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing
def update_listing(update_mask: nil, listing: nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing
Updates an existing listing.
def update_listing(request, options = nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing
update_listing
via a request object, either of type
UpdateListingRequest or an equivalent Hash.
- request (::Google::Cloud::Bigquery::AnalyticsHub::V1::UpdateListingRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def update_listing(update_mask: nil, listing: nil) -> ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing
update_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).
-
update_mask (::Google::Protobuf::FieldMask, ::Hash) — 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. - listing (::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing, ::Hash) — Required. The listing to update.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigquery/analytics_hub/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigquery::AnalyticsHub::V1::UpdateListingRequest.new # Call the update_listing method. result = client.update_listing request # The returned object is of type Google::Cloud::Bigquery::AnalyticsHub::V1::Listing. p result