Class: Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client

Inherits:

Object

• Object
• Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client

Includes:

Paths

Defined in:

lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb

Overview

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.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary

• #operations_client ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Operations readonly

  Get the associated client for long-running operations.

Class Method Summary

• .configure {|config| ... } ⇒ Client::Configuration

  Configure the AnalyticsHubService Client class.

Instance Method Summary

• #approve_query_template(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate

  Approves a query template.

• #configure {|config| ... } ⇒ Client::Configuration

  Configure the AnalyticsHubService Client instance.

• #create_data_exchange(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange

  Creates a new data exchange.

• #create_listing(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing

  Creates a new listing.

• #create_query_template(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate

  Creates a new QueryTemplate.

• #delete_data_exchange(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty

  Deletes an existing data exchange.

• #delete_listing(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty

  Deletes a listing.

• #delete_query_template(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty

  Deletes a query template.

• #delete_subscription(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation

  Deletes a subscription.

• #get_data_exchange(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange

  Gets the details of a data exchange.

• #get_iam_policy(request, options = nil) {|response, operation| ... } ⇒ ::Google::Iam::V1::Policy

  Gets the IAM policy.

• #get_listing(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing

  Gets the details of a listing.

• #get_query_template(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate

  Gets a QueryTemplate.

• #get_subscription(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription

  Gets the details of a Subscription.

• #initialize {|config| ... } ⇒ Client constructor

  Create a new AnalyticsHubService client object.

• #list_data_exchanges(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange>

  Lists all data exchanges in a given project and location.

• #list_listings(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing>

  Lists all listings in a given project and location.

• #list_org_data_exchanges(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange>

  Lists all data exchanges from projects in a given organization and location.

• #list_query_templates(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate>

  Lists all QueryTemplates in a given project and location.

• #list_shared_resource_subscriptions(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription>

  Lists all subscriptions on a given Data Exchange or Listing.

• #list_subscriptions(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription>

  Lists all subscriptions in a given project and location.

• #logger ⇒ Logger

  The logger used for request/response debug logging.

• #refresh_subscription(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation

  Refreshes a Subscription to a Data Exchange.

• #revoke_subscription(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::RevokeSubscriptionResponse

  Revokes a given subscription.

• #set_iam_policy(request, options = nil) {|response, operation| ... } ⇒ ::Google::Iam::V1::Policy

  Sets the IAM policy.

• #submit_query_template(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate

  Submits a query template for approval.

• #subscribe_data_exchange(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation

  Creates a Subscription to a Data Clean Room.

• #subscribe_listing(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::SubscribeListingResponse

  Subscribes to a listing.

• #test_iam_permissions(request, options = nil) {|response, operation| ... } ⇒ ::Google::Iam::V1::TestIamPermissionsResponse

  Returns the permissions that a caller has.

• #universe_domain ⇒ String

  The effective universe domain.

• #update_data_exchange(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange

  Updates an existing data exchange.

• #update_listing(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing

  Updates an existing listing.

• #update_query_template(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate

  Updates an existing QueryTemplate.

Methods included from Paths

#data_exchange_path, #dataset_path, #listing_path, #location_path, #managed_service_path, #query_template_path, #routine_path, #subscription_path, #table_path, #topic_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new AnalyticsHubService client object.

Examples:

# 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

Yields:

• (config) —

  Configure the AnalyticsHubService client.

Yield Parameters:

• config (Client::Configuration)

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 135

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/bigquery/analyticshub/v1/analyticshub_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  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.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @analytics_hub_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @analytics_hub_service_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Instance Attribute Details

#operations_client ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Operations (readonly)

Get the associated client for long-running operations.

Returns:

• (::Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Operations)

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 198

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the AnalyticsHubService Client class.

See Configuration for a description of the configuration fields.

Examples:

# Modify the configuration for all AnalyticsHubService clients
::Google::Cloud::Bigquery::AnalyticsHub::V1::AnalyticsHubService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

• (config) —

  Configure the Client client.

Yield Parameters:

• config (Client::Configuration)

Returns:

• (Client::Configuration)

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 68

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Bigquery", "AnalyticsHub", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 60.0
    default_config.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#approve_query_template(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate #approve_query_template(name: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate

Approves a query template.

Examples:

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::ApproveQueryTemplateRequest.new

# Call the approve_query_template method.
result = client.approve_query_template request

# The returned object is of type Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate.
p result

Overloads:

• #approve_query_template(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate

  Pass arguments to approve_query_template via a request object, either of type Google::Cloud::Bigquery::AnalyticsHub::V1::ApproveQueryTemplateRequest or an equivalent Hash.

  Parameters:

  • request (::Google::Cloud::Bigquery::AnalyticsHub::V1::ApproveQueryTemplateRequest, ::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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #approve_query_template(name: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate

  Pass arguments to approve_query_template 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).

  Parameters:

  • name (::String) (defaults to: nil) —

    Required. The resource path of the QueryTemplate. e.g. projects/myproject/locations/us/dataExchanges/123/queryTemplates/myqueryTemplate.

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 2869

def approve_query_template request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::AnalyticsHub::V1::ApproveQueryTemplateRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.approve_query_template.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.approve_query_template.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.approve_query_template.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :approve_query_template, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#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 configure.

See Configuration for a description of the configuration fields.

Yields:

• (config) —

  Configure the Client client.

Yield Parameters:

• config (Client::Configuration)

Returns:

• (Client::Configuration)

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 105

def configure
  yield @config if block_given?
  @config
end

#create_data_exchange(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange #create_data_exchange(parent: nil, data_exchange_id: nil, data_exchange: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange

Creates a new data exchange.

Examples:

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

Overloads:

• #create_data_exchange(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange

  Pass arguments to create_data_exchange via a request object, either of type CreateDataExchangeRequest or an equivalent Hash.

  Parameters:

  • 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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #create_data_exchange(parent: nil, data_exchange_id: nil, data_exchange: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange

  Pass arguments to 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).

  Parameters:

  • parent (::String) (defaults to: nil) —

    Required. The parent resource path of the data exchange. e.g. projects/myproject/locations/us.

  • data_exchange_id (::String) (defaults to: nil) —

    Required. The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Max length: 100 bytes.

  • data_exchange (::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange, ::Hash) (defaults to: nil) —

    Required. The data exchange to create.

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 545

def create_data_exchange request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::AnalyticsHub::V1::CreateDataExchangeRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_data_exchange.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_data_exchange.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_data_exchange.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :create_data_exchange, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_listing(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing #create_listing(parent: nil, listing_id: nil, listing: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing

Creates a new listing.

Examples:

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

Overloads:

• #create_listing(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing

  Pass arguments to create_listing via a request object, either of type CreateListingRequest or an equivalent Hash.

  Parameters:

  • 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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #create_listing(parent: nil, listing_id: nil, listing: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing

  Pass arguments to 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).

  Parameters:

  • parent (::String) (defaults to: nil) —

    Required. The parent resource path of the listing. e.g. projects/myproject/locations/us/dataExchanges/123.

  • listing_id (::String) (defaults to: nil) —

    Required. The ID of the listing to create. Must contain only Unicode letters, numbers (0-9), underscores (_). Max length: 100 bytes.

  • listing (::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing, ::Hash) (defaults to: nil) —

    Required. The listing to create.

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 996

def create_listing request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::AnalyticsHub::V1::CreateListingRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_listing.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_listing.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_listing.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :create_listing, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_query_template(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate #create_query_template(parent: nil, query_template_id: nil, query_template: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate

Creates a new QueryTemplate

Examples:

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::CreateQueryTemplateRequest.new

# Call the create_query_template method.
result = client.create_query_template request

# The returned object is of type Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate.
p result

Overloads:

• #create_query_template(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate

  Pass arguments to create_query_template via a request object, either of type CreateQueryTemplateRequest or an equivalent Hash.

  Parameters:

  • request (::Google::Cloud::Bigquery::AnalyticsHub::V1::CreateQueryTemplateRequest, ::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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #create_query_template(parent: nil, query_template_id: nil, query_template: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate

  Pass arguments to create_query_template 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).

  Parameters:

  • parent (::String) (defaults to: nil) —

    Required. The parent resource path of the QueryTemplate. e.g. projects/myproject/locations/us/dataExchanges/123/queryTemplates/myQueryTemplate.

  • query_template_id (::String) (defaults to: nil) —

    Required. The ID of the QueryTemplate to create. Must contain only Unicode letters, numbers (0-9), underscores (_). Max length: 100 bytes.

  • query_template (::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate, ::Hash) (defaults to: nil) —

    Required. The QueryTemplate to create.

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 2334

def create_query_template request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::AnalyticsHub::V1::CreateQueryTemplateRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_query_template.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_query_template.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_query_template.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :create_query_template, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_data_exchange(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_data_exchange(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes an existing data exchange.

Examples:

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

Overloads:

• #delete_data_exchange(request, options = nil) ⇒ ::Google::Protobuf::Empty

  Pass arguments to delete_data_exchange via a request object, either of type DeleteDataExchangeRequest or an equivalent Hash.

  Parameters:

  • 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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #delete_data_exchange(name: nil) ⇒ ::Google::Protobuf::Empty

  Pass arguments to 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).

  Parameters:

  • name (::String) (defaults to: nil) —

    Required. The full name of the data exchange resource that you want to delete. For example, projects/myproject/locations/us/dataExchanges/123.

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Google::Protobuf::Empty)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Google::Protobuf::Empty)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 720

def delete_data_exchange request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::AnalyticsHub::V1::DeleteDataExchangeRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_data_exchange.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_data_exchange.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_data_exchange.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :delete_data_exchange, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_listing(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_listing(name: nil, delete_commercial: nil) ⇒ ::Google::Protobuf::Empty

Deletes a listing.

Examples:

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

Overloads:

• #delete_listing(request, options = nil) ⇒ ::Google::Protobuf::Empty

  Pass arguments to delete_listing via a request object, either of type DeleteListingRequest or an equivalent Hash.

  Parameters:

  • 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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #delete_listing(name: nil, delete_commercial: nil) ⇒ ::Google::Protobuf::Empty

  Pass arguments to 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).

  Parameters:

  • name (::String) (defaults to: nil) —

    Required. Resource name of the listing to delete. e.g. projects/myproject/locations/us/dataExchanges/123/listings/456.

  • delete_commercial (::Boolean) (defaults to: nil) —

    Optional. If the listing is commercial then this field must be set to true, otherwise a failure is thrown. This acts as a safety guard to avoid deleting commercial listings accidentally.

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Google::Protobuf::Empty)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Google::Protobuf::Empty)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 1175

def delete_listing request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::AnalyticsHub::V1::DeleteListingRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_listing.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_listing.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_listing.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :delete_listing, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_query_template(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_query_template(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a query template.

Examples:

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::DeleteQueryTemplateRequest.new

# Call the delete_query_template method.
result = client.delete_query_template request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

• #delete_query_template(request, options = nil) ⇒ ::Google::Protobuf::Empty

  Pass arguments to delete_query_template via a request object, either of type DeleteQueryTemplateRequest or an equivalent Hash.

  Parameters:

  • request (::Google::Cloud::Bigquery::AnalyticsHub::V1::DeleteQueryTemplateRequest, ::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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #delete_query_template(name: nil) ⇒ ::Google::Protobuf::Empty

  Pass arguments to delete_query_template 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).

  Parameters:

  • name (::String) (defaults to: nil) —

    Required. The resource path of the QueryTemplate. e.g. projects/myproject/locations/us/dataExchanges/123/queryTemplates/myqueryTemplate.

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Google::Protobuf::Empty)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Google::Protobuf::Empty)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 2695

def delete_query_template request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::AnalyticsHub::V1::DeleteQueryTemplateRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_query_template.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_query_template.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_query_template.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :delete_query_template, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_subscription(request, options = nil) ⇒ ::Gapic::Operation #delete_subscription(name: nil) ⇒ ::Gapic::Operation

Deletes a subscription.

Examples:

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

Overloads:

• #delete_subscription(request, options = nil) ⇒ ::Gapic::Operation

  Pass arguments to delete_subscription via a request object, either of type DeleteSubscriptionRequest or an equivalent Hash.

  Parameters:

  • 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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #delete_subscription(name: nil) ⇒ ::Gapic::Operation

  Pass arguments to 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).

  Parameters:

  • name (::String) (defaults to: nil) —

    Required. Resource name of the subscription to delete. e.g. projects/123/locations/us/subscriptions/456

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Gapic::Operation)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Gapic::Operation)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 1962

def delete_subscription request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::AnalyticsHub::V1::DeleteSubscriptionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_subscription.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_subscription.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_subscription.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :delete_subscription, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_data_exchange(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange #get_data_exchange(name: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange

Gets the details of a data exchange.

Examples:

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

Overloads:

• #get_data_exchange(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange

  Pass arguments to get_data_exchange via a request object, either of type GetDataExchangeRequest or an equivalent Hash.

  Parameters:

  • 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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #get_data_exchange(name: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange

  Pass arguments to 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).

  Parameters:

  • name (::String) (defaults to: nil) —

    Required. The resource name of the data exchange. e.g. projects/myproject/locations/us/dataExchanges/123.

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 453

def get_data_exchange request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::AnalyticsHub::V1::GetDataExchangeRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_data_exchange.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_data_exchange.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_data_exchange.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :get_data_exchange, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_iam_policy(request, options = nil) ⇒ ::Google::Iam::V1::Policy #get_iam_policy(resource: nil, options: nil) ⇒ ::Google::Iam::V1::Policy

Gets the IAM policy.

Examples:

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

Overloads:

• #get_iam_policy(request, options = nil) ⇒ ::Google::Iam::V1::Policy

  Pass arguments to get_iam_policy via a request object, either of type Iam::V1::GetIamPolicyRequest or an equivalent Hash.

  Parameters:

  • 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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #get_iam_policy(resource: nil, options: nil) ⇒ ::Google::Iam::V1::Policy

  Pass arguments to 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).

  Parameters:

  • resource (::String) (defaults to: nil) —

    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) (defaults to: nil) —

    OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Google::Iam::V1::Policy)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Google::Iam::V1::Policy)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 2053

def get_iam_policy request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::GetIamPolicyRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_iam_policy.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.resource
    header_params["resource"] = request.resource
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_iam_policy.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_iam_policy.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :get_iam_policy, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_listing(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing #get_listing(name: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing

Gets the details of a listing.

Examples:

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

Overloads:

• #get_listing(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing

  Pass arguments to get_listing via a request object, either of type GetListingRequest or an equivalent Hash.

  Parameters:

  • 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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #get_listing(name: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing

  Pass arguments to 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).

  Parameters:

  • name (::String) (defaults to: nil) —

    Required. The resource name of the listing. e.g. projects/myproject/locations/us/dataExchanges/123/listings/456.

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 904

def get_listing request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::AnalyticsHub::V1::GetListingRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_listing.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_listing.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_listing.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :get_listing, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_query_template(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate #get_query_template(name: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate

Gets a QueryTemplate

Examples:

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::GetQueryTemplateRequest.new

# Call the get_query_template method.
result = client.get_query_template request

# The returned object is of type Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate.
p result

Overloads:

• #get_query_template(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate

  Pass arguments to get_query_template via a request object, either of type GetQueryTemplateRequest or an equivalent Hash.

  Parameters:

  • request (::Google::Cloud::Bigquery::AnalyticsHub::V1::GetQueryTemplateRequest, ::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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #get_query_template(name: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate

  Pass arguments to get_query_template 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).

  Parameters:

  • name (::String) (defaults to: nil) —

    Required. The parent resource path of the QueryTemplate. e.g. projects/myproject/locations/us/dataExchanges/123/queryTemplates/myqueryTemplate.

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 2421

def get_query_template request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::AnalyticsHub::V1::GetQueryTemplateRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_query_template.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_query_template.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_query_template.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :get_query_template, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_subscription(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription #get_subscription(name: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription

Gets the details of a Subscription.

Examples:

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

Overloads:

• #get_subscription(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription

  Pass arguments to get_subscription via a request object, either of type GetSubscriptionRequest or an equivalent Hash.

  Parameters:

  • 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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #get_subscription(name: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription

  Pass arguments to 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).

  Parameters:

  • name (::String) (defaults to: nil) —

    Required. Resource name of the subscription. e.g. projects/123/locations/us/subscriptions/456

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 1566

def get_subscription request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::AnalyticsHub::V1::GetSubscriptionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_subscription.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_subscription.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_subscription.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :get_subscription, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_data_exchanges(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange> #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.

Examples:

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

Overloads:

• #list_data_exchanges(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange>

  Pass arguments to list_data_exchanges via a request object, either of type ListDataExchangesRequest or an equivalent Hash.

  Parameters:

  • 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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #list_data_exchanges(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange>

  Pass arguments to 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).

  Parameters:

  • parent (::String) (defaults to: nil) —

    Required. The parent resource path of the data exchanges. e.g. projects/myproject/locations/us.

  • page_size (::Integer) (defaults to: nil) —

    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) (defaults to: nil) —

    Page token, returned by a previous call, to request the next page of results.

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange>)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange>)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 266

def list_data_exchanges request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::AnalyticsHub::V1::ListDataExchangesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_data_exchanges.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_data_exchanges.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_data_exchanges.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :list_data_exchanges, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @analytics_hub_service_stub, :list_data_exchanges, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_listings(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing> #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.

Examples:

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

Overloads:

• #list_listings(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing>

  Pass arguments to list_listings via a request object, either of type ListListingsRequest or an equivalent Hash.

  Parameters:

  • 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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #list_listings(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing>

  Pass arguments to 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).

  Parameters:

  • parent (::String) (defaults to: nil) —

    Required. The parent resource path of the listing. e.g. projects/myproject/locations/us/dataExchanges/123.

  • page_size (::Integer) (defaults to: nil) —

    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) (defaults to: nil) —

    Page token, returned by a previous call, to request the next page of results.

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing>)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing>)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 816

def list_listings request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::AnalyticsHub::V1::ListListingsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_listings.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_listings.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_listings.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :list_listings, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @analytics_hub_service_stub, :list_listings, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_org_data_exchanges(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange> #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.

Examples:

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

Overloads:

• #list_org_data_exchanges(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange>

  Pass arguments to list_org_data_exchanges via a request object, either of type ListOrgDataExchangesRequest or an equivalent Hash.

  Parameters:

  • 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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #list_org_data_exchanges(organization: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange>

  Pass arguments to 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).

  Parameters:

  • organization (::String) (defaults to: nil) —

    Required. The organization resource path of the projects containing DataExchanges. e.g. organizations/myorg/locations/us.

  • page_size (::Integer) (defaults to: nil) —

    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) (defaults to: nil) —

    Page token, returned by a previous call, to request the next page of results.

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange>)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange>)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 365

def list_org_data_exchanges request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::AnalyticsHub::V1::ListOrgDataExchangesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_org_data_exchanges.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.organization
    header_params["organization"] = request.organization
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_org_data_exchanges.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_org_data_exchanges.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :list_org_data_exchanges, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @analytics_hub_service_stub, :list_org_data_exchanges, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_query_templates(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate> #list_query_templates(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate>

Lists all QueryTemplates in a given project and location.

Examples:

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::ListQueryTemplatesRequest.new

# Call the list_query_templates method.
result = client.list_query_templates 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::QueryTemplate.
  p item
end

Overloads:

• #list_query_templates(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate>

  Pass arguments to list_query_templates via a request object, either of type ListQueryTemplatesRequest or an equivalent Hash.

  Parameters:

  • request (::Google::Cloud::Bigquery::AnalyticsHub::V1::ListQueryTemplatesRequest, ::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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #list_query_templates(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate>

  Pass arguments to list_query_templates 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).

  Parameters:

  • parent (::String) (defaults to: nil) —

    Required. The parent resource path of the QueryTemplates. e.g. projects/myproject/locations/us/dataExchanges/123.

  • page_size (::Integer) (defaults to: nil) —

    Optional. 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) (defaults to: nil) —

    Optional. Page token, returned by a previous call, to request the next page of results.

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate>)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate>)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 2517

def list_query_templates request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::AnalyticsHub::V1::ListQueryTemplatesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_query_templates.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_query_templates.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_query_templates.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :list_query_templates, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @analytics_hub_service_stub, :list_query_templates, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_shared_resource_subscriptions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription> #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.

Examples:

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

Overloads:

• #list_shared_resource_subscriptions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription>

  Pass arguments to list_shared_resource_subscriptions via a request object, either of type ListSharedResourceSubscriptionsRequest or an equivalent Hash.

  Parameters:

  • 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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #list_shared_resource_subscriptions(resource: nil, include_deleted_subscriptions: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription>

  Pass arguments to 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).

  Parameters:

  • resource (::String) (defaults to: nil) —

    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) (defaults to: nil) —

    If selected, includes deleted subscriptions in the response (up to 63 days after deletion).

  • page_size (::Integer) (defaults to: nil) —

    The maximum number of results to return in a single response page.

  • page_token (::String) (defaults to: nil) —

    Page token, returned by a previous call.

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription>)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription>)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 1777

def list_shared_resource_subscriptions request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::AnalyticsHub::V1::ListSharedResourceSubscriptionsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_shared_resource_subscriptions.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.resource
    header_params["resource"] = request.resource
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_shared_resource_subscriptions.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_shared_resource_subscriptions.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :list_shared_resource_subscriptions, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @analytics_hub_service_stub, :list_shared_resource_subscriptions, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_subscriptions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription> #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.

Examples:

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

Overloads:

• #list_subscriptions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription>

  Pass arguments to list_subscriptions via a request object, either of type ListSubscriptionsRequest or an equivalent Hash.

  Parameters:

  • 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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #list_subscriptions(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription>

  Pass arguments to 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).

  Parameters:

  • parent (::String) (defaults to: nil) —

    Required. The parent resource path of the subscription. e.g. projects/myproject/locations/us

  • filter (::String) (defaults to: nil) —

    An expression for filtering the results of the request. Eligible fields for filtering are:

    • listing
    • data_exchange

    Alternatively, a literal wrapped in double quotes may be provided. This will be checked for an exact match against both fields above.

    In all cases, the full Data Exchange or Listing resource name must be provided. Some example of using filters:

    • data_exchange="projects/myproject/locations/us/dataExchanges/123"
    • listing="projects/123/locations/us/dataExchanges/456/listings/789"
    • "projects/myproject/locations/us/dataExchanges/123"
  • page_size (::Integer) (defaults to: nil) —

    The maximum number of results to return in a single response page.

  • page_token (::String) (defaults to: nil) —

    Page token, returned by a previous call.

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription>)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription>)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 1676

def list_subscriptions request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::AnalyticsHub::V1::ListSubscriptionsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_subscriptions.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_subscriptions.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_subscriptions.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :list_subscriptions, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @analytics_hub_service_stub, :list_subscriptions, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

• (Logger)

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 205

def logger
  @analytics_hub_service_stub.logger
end

#refresh_subscription(request, options = nil) ⇒ ::Gapic::Operation #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.

Examples:

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

Overloads:

• #refresh_subscription(request, options = nil) ⇒ ::Gapic::Operation

  Pass arguments to refresh_subscription via a request object, either of type RefreshSubscriptionRequest or an equivalent Hash.

  Parameters:

  • 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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #refresh_subscription(name: nil) ⇒ ::Gapic::Operation

  Pass arguments to 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).

  Parameters:

  • name (::String) (defaults to: nil) —

    Required. Resource name of the Subscription to refresh. e.g. projects/subscriberproject/locations/us/subscriptions/123

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Gapic::Operation)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Gapic::Operation)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 1478

def refresh_subscription request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::AnalyticsHub::V1::RefreshSubscriptionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.refresh_subscription.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.refresh_subscription.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.refresh_subscription.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :refresh_subscription, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#revoke_subscription(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::RevokeSubscriptionResponse #revoke_subscription(name: nil, revoke_commercial: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::RevokeSubscriptionResponse

Revokes a given subscription.

Examples:

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

Overloads:

• #revoke_subscription(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::RevokeSubscriptionResponse

  Pass arguments to revoke_subscription via a request object, either of type RevokeSubscriptionRequest or an equivalent Hash.

  Parameters:

  • 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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #revoke_subscription(name: nil, revoke_commercial: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::RevokeSubscriptionResponse

  Pass arguments to 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).

  Parameters:

  • name (::String) (defaults to: nil) —

    Required. Resource name of the subscription to revoke. e.g. projects/123/locations/us/subscriptions/456

  • revoke_commercial (::Boolean) (defaults to: nil) —

    Optional. If the subscription is commercial then this field must be set to true, otherwise a failure is thrown. This acts as a safety guard to avoid revoking commercial subscriptions accidentally.

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Google::Cloud::Bigquery::AnalyticsHub::V1::RevokeSubscriptionResponse)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Google::Cloud::Bigquery::AnalyticsHub::V1::RevokeSubscriptionResponse)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 1869

def revoke_subscription request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::AnalyticsHub::V1::RevokeSubscriptionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.revoke_subscription.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.revoke_subscription.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.revoke_subscription.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :revoke_subscription, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_iam_policy(request, options = nil) ⇒ ::Google::Iam::V1::Policy #set_iam_policy(resource: nil, policy: nil, update_mask: nil) ⇒ ::Google::Iam::V1::Policy

Sets the IAM policy.

Examples:

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

Overloads:

• #set_iam_policy(request, options = nil) ⇒ ::Google::Iam::V1::Policy

  Pass arguments to set_iam_policy via a request object, either of type Iam::V1::SetIamPolicyRequest or an equivalent Hash.

  Parameters:

  • 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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #set_iam_policy(resource: nil, policy: nil, update_mask: nil) ⇒ ::Google::Iam::V1::Policy

  Pass arguments to 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).

  Parameters:

  • resource (::String) (defaults to: nil) —

    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) (defaults to: nil) —

    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) (defaults to: nil) —

    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"

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Google::Iam::V1::Policy)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Google::Iam::V1::Policy)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 2150

def set_iam_policy request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::SetIamPolicyRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.set_iam_policy.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.resource
    header_params["resource"] = request.resource
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.set_iam_policy.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.set_iam_policy.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :set_iam_policy, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#submit_query_template(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate #submit_query_template(name: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate

Submits a query template for approval.

Examples:

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::SubmitQueryTemplateRequest.new

# Call the submit_query_template method.
result = client.submit_query_template request

# The returned object is of type Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate.
p result

Overloads:

• #submit_query_template(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate

  Pass arguments to submit_query_template via a request object, either of type SubmitQueryTemplateRequest or an equivalent Hash.

  Parameters:

  • request (::Google::Cloud::Bigquery::AnalyticsHub::V1::SubmitQueryTemplateRequest, ::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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #submit_query_template(name: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate

  Pass arguments to submit_query_template 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).

  Parameters:

  • name (::String) (defaults to: nil) —

    Required. The resource path of the QueryTemplate. e.g. projects/myproject/locations/us/dataExchanges/123/queryTemplates/myqueryTemplate.

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 2782

def submit_query_template request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::AnalyticsHub::V1::SubmitQueryTemplateRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.submit_query_template.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.submit_query_template.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.submit_query_template.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :submit_query_template, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#subscribe_data_exchange(request, options = nil) ⇒ ::Gapic::Operation #subscribe_data_exchange(name: nil, destination: nil, destination_dataset: nil, subscription: nil, subscriber_contact: nil) ⇒ ::Gapic::Operation

Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets. Throws a Bad Request error if the Data Exchange does not contain any listings.

Examples:

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

Overloads:

• #subscribe_data_exchange(request, options = nil) ⇒ ::Gapic::Operation

  Pass arguments to subscribe_data_exchange via a request object, either of type SubscribeDataExchangeRequest or an equivalent Hash.

  Parameters:

  • 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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #subscribe_data_exchange(name: nil, destination: nil, destination_dataset: nil, subscription: nil, subscriber_contact: nil) ⇒ ::Gapic::Operation

  Pass arguments to 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).

  Parameters:

  • name (::String) (defaults to: nil) —

    Required. Resource name of the Data Exchange. e.g. projects/publisherproject/locations/us/dataExchanges/123

  • destination (::String) (defaults to: nil) —

    Required. The parent resource path of the Subscription. e.g. projects/subscriberproject/locations/us

  • destination_dataset (::Google::Cloud::Bigquery::AnalyticsHub::V1::DestinationDataset, ::Hash) (defaults to: nil) —

    Optional. BigQuery destination dataset to create for the subscriber.

  • subscription (::String) (defaults to: nil) —

    Required. Name of the subscription to create. e.g. subscription1

  • subscriber_contact (::String) (defaults to: nil) —

    Email of the subscriber.

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Gapic::Operation)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Gapic::Operation)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 1381

def subscribe_data_exchange request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::AnalyticsHub::V1::SubscribeDataExchangeRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.subscribe_data_exchange.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.subscribe_data_exchange.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.subscribe_data_exchange.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :subscribe_data_exchange, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#subscribe_listing(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::SubscribeListingResponse #subscribe_listing(destination_dataset: nil, destination_pubsub_subscription: 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.

Examples:

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

Overloads:

• #subscribe_listing(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::SubscribeListingResponse

  Pass arguments to subscribe_listing via a request object, either of type SubscribeListingRequest or an equivalent Hash.

  Parameters:

  • 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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #subscribe_listing(destination_dataset: nil, destination_pubsub_subscription: nil, name: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::SubscribeListingResponse

  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).

  Parameters:

  • destination_dataset (::Google::Cloud::Bigquery::AnalyticsHub::V1::DestinationDataset, ::Hash) (defaults to: nil) —

    Input only. BigQuery destination dataset to create for the subscriber.

    Note: The following parameters are mutually exclusive: destination_dataset, destination_pubsub_subscription. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

  • destination_pubsub_subscription (::Google::Cloud::Bigquery::AnalyticsHub::V1::DestinationPubSubSubscription, ::Hash) (defaults to: nil) —

    Input only. Destination Pub/Sub subscription to create for the subscriber.

    Note: The following parameters are mutually exclusive: destination_pubsub_subscription, destination_dataset. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

  • name (::String) (defaults to: nil) —

    Required. Resource name of the listing that you want to subscribe to. e.g. projects/myproject/locations/us/dataExchanges/123/listings/456.

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Google::Cloud::Bigquery::AnalyticsHub::V1::SubscribeListingResponse)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Google::Cloud::Bigquery::AnalyticsHub::V1::SubscribeListingResponse)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 1275

def subscribe_listing request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::AnalyticsHub::V1::SubscribeListingRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.subscribe_listing.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.subscribe_listing.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.subscribe_listing.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :subscribe_listing, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#test_iam_permissions(request, options = nil) ⇒ ::Google::Iam::V1::TestIamPermissionsResponse #test_iam_permissions(resource: nil, permissions: nil) ⇒ ::Google::Iam::V1::TestIamPermissionsResponse

Returns the permissions that a caller has.

Examples:

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

Overloads:

• #test_iam_permissions(request, options = nil) ⇒ ::Google::Iam::V1::TestIamPermissionsResponse

  Pass arguments to test_iam_permissions via a request object, either of type Iam::V1::TestIamPermissionsRequest or an equivalent Hash.

  Parameters:

  • 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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #test_iam_permissions(resource: nil, permissions: nil) ⇒ ::Google::Iam::V1::TestIamPermissionsResponse

  Pass arguments to 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).

  Parameters:

  • resource (::String) (defaults to: nil) —

    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>) (defaults to: nil) —

    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.

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Google::Iam::V1::TestIamPermissionsResponse)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Google::Iam::V1::TestIamPermissionsResponse)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 2241

def test_iam_permissions request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::TestIamPermissionsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.test_iam_permissions.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.resource
    header_params["resource"] = request.resource
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.test_iam_permissions.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.test_iam_permissions.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :test_iam_permissions, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

• (String)

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 115

def universe_domain
  @analytics_hub_service_stub.universe_domain
end

#update_data_exchange(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange #update_data_exchange(update_mask: nil, data_exchange: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange

Updates an existing data exchange.

Examples:

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

Overloads:

• #update_data_exchange(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange

  Pass arguments to update_data_exchange via a request object, either of type UpdateDataExchangeRequest or an equivalent Hash.

  Parameters:

  • 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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #update_data_exchange(update_mask: nil, data_exchange: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange

  Pass arguments to 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).

  Parameters:

  • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

    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) (defaults to: nil) —

    Required. The data exchange to update.

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 634

def update_data_exchange request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::AnalyticsHub::V1::UpdateDataExchangeRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_data_exchange.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.data_exchange&.name
    header_params["data_exchange.name"] = request.data_exchange.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_data_exchange.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_data_exchange.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :update_data_exchange, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_listing(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing #update_listing(update_mask: nil, listing: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing

Updates an existing listing.

Examples:

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

Overloads:

• #update_listing(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing

  Pass arguments to update_listing via a request object, either of type UpdateListingRequest or an equivalent Hash.

  Parameters:

  • 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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #update_listing(update_mask: nil, listing: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing

  Pass arguments to 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).

  Parameters:

  • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

    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) (defaults to: nil) —

    Required. The listing to update.

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 1085

def update_listing request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::AnalyticsHub::V1::UpdateListingRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_listing.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.listing&.name
    header_params["listing.name"] = request.listing.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_listing.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_listing.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :update_listing, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_query_template(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate #update_query_template(update_mask: nil, query_template: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate

Updates an existing QueryTemplate

Examples:

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::UpdateQueryTemplateRequest.new

# Call the update_query_template method.
result = client.update_query_template request

# The returned object is of type Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate.
p result

Overloads:

• #update_query_template(request, options = nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate

  Pass arguments to update_query_template via a request object, either of type UpdateQueryTemplateRequest or an equivalent Hash.

  Parameters:

  • request (::Google::Cloud::Bigquery::AnalyticsHub::V1::UpdateQueryTemplateRequest, ::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) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #update_query_template(update_mask: nil, query_template: nil) ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate

  Pass arguments to update_query_template 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).

  Parameters:

  • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

    Optional. Field mask specifies the fields to update in the query template resource. The fields specified in the updateMask are relative to the resource and are not a full request.

  • query_template (::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate, ::Hash) (defaults to: nil) —

    Required. The QueryTemplate to update.

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/bigquery/analytics_hub/v1/analytics_hub_service/client.rb', line 2608

def update_query_template request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::AnalyticsHub::V1::UpdateQueryTemplateRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_query_template.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Bigquery::AnalyticsHub::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.query_template&.name
    header_params["query_template.name"] = request.query_template.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_query_template.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_query_template.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_hub_service_stub.call_rpc :update_query_template, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end