Analytics Hub V1beta1 API - Class Google::Cloud::Bigquery::DataExchange::V1beta1::AnalyticsHubService::Client (v0.1.0)

Reference documentation and code samples for the Analytics Hub V1beta1 API class Google::Cloud::Bigquery::DataExchange::V1beta1::AnalyticsHubService::Client.

Client for the AnalyticsHubService service.

The AnalyticsHubService API facilitates data sharing within and across organizations. It allows data providers to publish Listings --- a discoverable and searchable SKU representing a dataset. Data consumers can subscribe to Listings. Upon subscription, AnalyticsHub provisions a "Linked Datasets" surfacing the data in the consumer's project.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the AnalyticsHubService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all AnalyticsHubService clients
::Google::Cloud::Bigquery::DataExchange::V1beta1::AnalyticsHubService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the AnalyticsHubService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_data_exchange

def create_data_exchange(request, options = nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange
def create_data_exchange(parent: nil, data_exchange_id: nil, data_exchange: nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange

Creates a new DataExchange in a given project and location.

Overloads 
def create_data_exchange(request, options = nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange
Pass arguments to create_data_exchange via a request object, either of type CreateDataExchangeRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Bigquery::DataExchange::V1beta1::CreateDataExchangeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_data_exchange(parent: nil, data_exchange_id: nil, data_exchange: nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::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) — Required. The parent resource path of the DataExchange. e.g. projects/myproject/locations/US.
  • data_exchange_id (::String) — Required. The ID of the DataExchange to create. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces. Max length: 100 bytes.
  • data_exchange (::Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange, ::Hash) — Required. The DataExchange to create.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/bigquery/data_exchange/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::DataExchange::V1beta1::AnalyticsHubService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataExchange::V1beta1::CreateDataExchangeRequest.new

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

# The returned object is of type Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange.
p result

#create_listing

def create_listing(request, options = nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::Listing
def create_listing(parent: nil, listing_id: nil, listing: nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::Listing

Creates a new Listing in a given project and location.

Overloads 
def create_listing(request, options = nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::Listing
Pass arguments to create_listing via a request object, either of type CreateListingRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Bigquery::DataExchange::V1beta1::CreateListingRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_listing(parent: nil, listing_id: nil, listing: nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::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) — Required. The parent resource path of the listing. e.g. projects/myproject/locations/US/dataExchanges/123.
  • listing_id (::String) — Required. The ID of the Listing to create. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces. Max length: 100 bytes.
  • listing (::Google::Cloud::Bigquery::DataExchange::V1beta1::Listing, ::Hash) — Required. The listing to create.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/bigquery/data_exchange/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::DataExchange::V1beta1::AnalyticsHubService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataExchange::V1beta1::CreateListingRequest.new

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

# The returned object is of type Google::Cloud::Bigquery::DataExchange::V1beta1::Listing.
p result

#delete_data_exchange

def delete_data_exchange(request, options = nil) -> ::Google::Protobuf::Empty
def delete_data_exchange(name: nil) -> ::Google::Protobuf::Empty

Deletes a single DataExchange.

Overloads 
def 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::DataExchange::V1beta1::DeleteDataExchangeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_data_exchange(name: nil) -> ::Google::Protobuf::Empty
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).
Parameter
  • name (::String) — Required. Resource name of the DataExchange to delete. e.g. projects/myproject/locations/US/dataExchanges/123.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/bigquery/data_exchange/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::DataExchange::V1beta1::AnalyticsHubService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataExchange::V1beta1::DeleteDataExchangeRequest.new

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

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

#delete_listing

def delete_listing(request, options = nil) -> ::Google::Protobuf::Empty
def delete_listing(name: nil) -> ::Google::Protobuf::Empty

Deletes a single Listing, as long as there are no subscriptions associated with the source of this Listing.

Overloads 
def 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::DataExchange::V1beta1::DeleteListingRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_listing(name: nil) -> ::Google::Protobuf::Empty
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).
Parameter
  • name (::String) — Required. Resource name of the listing to delete. e.g. projects/myproject/locations/US/dataExchanges/123/listings/456.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/bigquery/data_exchange/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::DataExchange::V1beta1::AnalyticsHubService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataExchange::V1beta1::DeleteListingRequest.new

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

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

#get_data_exchange

def get_data_exchange(request, options = nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange
def get_data_exchange(name: nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange

Gets details of a single DataExchange.

Overloads 
def get_data_exchange(request, options = nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange
Pass arguments to get_data_exchange via a request object, either of type GetDataExchangeRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Bigquery::DataExchange::V1beta1::GetDataExchangeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_data_exchange(name: nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::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).
Parameter
  • name (::String) — Required. The resource name of the DataExchange. e.g. projects/myproject/locations/US/dataExchanges/123.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/bigquery/data_exchange/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::DataExchange::V1beta1::AnalyticsHubService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataExchange::V1beta1::GetDataExchangeRequest.new

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

# The returned object is of type Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange.
p result

#get_iam_policy

def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def get_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy

Gets the IAM policy for a dataExchange or a listing.

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy
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) — REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
  • options (::Google::Iam::V1::GetPolicyOptions, ::Hash) — OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/bigquery/data_exchange/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::DataExchange::V1beta1::AnalyticsHubService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::GetIamPolicyRequest.new

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

# The returned object is of type Google::Iam::V1::Policy.
p result

#get_listing

def get_listing(request, options = nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::Listing
def get_listing(name: nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::Listing

Gets details of a single Listing.

Overloads 
def get_listing(request, options = nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::Listing
Pass arguments to get_listing via a request object, either of type GetListingRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Bigquery::DataExchange::V1beta1::GetListingRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_listing(name: nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::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).
Parameter
  • name (::String) — 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
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/bigquery/data_exchange/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::DataExchange::V1beta1::AnalyticsHubService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataExchange::V1beta1::GetListingRequest.new

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

# The returned object is of type Google::Cloud::Bigquery::DataExchange::V1beta1::Listing.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new AnalyticsHubService client object.

Yields
  • (config) — Configure the AnalyticsHubService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Bigquery::DataExchange::V1beta1::AnalyticsHubService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Bigquery::DataExchange::V1beta1::AnalyticsHubService::Client.new do |config|
  config.timeout = 10.0
end

#list_data_exchanges

def list_data_exchanges(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange>
def list_data_exchanges(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange>

Lists DataExchanges in a given project and location.

Overloads 
def list_data_exchanges(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange>
Pass arguments to list_data_exchanges via a request object, either of type ListDataExchangesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Bigquery::DataExchange::V1beta1::ListDataExchangesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_data_exchanges(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataExchange::V1beta1::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) — Required. The parent resource path of the DataExchanges. e.g. projects/myproject/locations/US.
  • page_size (::Integer) — The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
  • page_token (::String) — Page token, returned by a previous call, to request the next page of results.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/bigquery/data_exchange/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::DataExchange::V1beta1::AnalyticsHubService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataExchange::V1beta1::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 all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange.
  p response
end

#list_listings

def list_listings(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataExchange::V1beta1::Listing>
def list_listings(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataExchange::V1beta1::Listing>

Lists Listings in a given project and location.

Overloads 
def list_listings(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataExchange::V1beta1::Listing>
Pass arguments to list_listings via a request object, either of type ListListingsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Bigquery::DataExchange::V1beta1::ListListingsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_listings(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataExchange::V1beta1::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) — Required. The parent resource path of the listing. e.g. projects/myproject/locations/US/dataExchanges/123.
  • page_size (::Integer) — The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
  • page_token (::String) — Page token, returned by a previous call, to request the next page of results.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/bigquery/data_exchange/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::DataExchange::V1beta1::AnalyticsHubService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataExchange::V1beta1::ListListingsRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::Bigquery::DataExchange::V1beta1::Listing.
  p response
end

#list_org_data_exchanges

def list_org_data_exchanges(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange>
def list_org_data_exchanges(organization: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange>

Lists DataExchanges from projects in a given organization and location.

Overloads 
def list_org_data_exchanges(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange>
Pass arguments to list_org_data_exchanges via a request object, either of type ListOrgDataExchangesRequest or an equivalent Hash.
Parameters 
def list_org_data_exchanges(organization: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataExchange::V1beta1::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) — Required. The organization resource path of the projects containing DataExchanges. e.g. organizations/myorg/locations/US.
  • page_size (::Integer) — The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
  • page_token (::String) — Page token, returned by a previous call, to request the next page of results.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/bigquery/data_exchange/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::DataExchange::V1beta1::AnalyticsHubService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataExchange::V1beta1::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 all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange.
  p response
end

#set_iam_policy

def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy

Sets the IAM policy for a dataExchange or a listing.

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy
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) — REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
  • policy (::Google::Iam::V1::Policy, ::Hash) — REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:

    paths: "bindings, etag"

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/bigquery/data_exchange/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::DataExchange::V1beta1::AnalyticsHubService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::SetIamPolicyRequest.new

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

# The returned object is of type Google::Iam::V1::Policy.
p result

#subscribe_listing

def subscribe_listing(request, options = nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::SubscribeListingResponse
def subscribe_listing(name: nil, destination_dataset: nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::SubscribeListingResponse

Subscribes to a single Listing.

Data Exchange currently supports one type of Listing: a BigQuery dataset. Upon subscription to a Listing for a BigQuery dataset, Data Exchange creates a linked dataset in the subscriber's project.

Overloads 
def subscribe_listing(request, options = nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::SubscribeListingResponse
Pass arguments to subscribe_listing via a request object, either of type SubscribeListingRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Bigquery::DataExchange::V1beta1::SubscribeListingRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def subscribe_listing(name: nil, destination_dataset: nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::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
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/bigquery/data_exchange/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::DataExchange::V1beta1::AnalyticsHubService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataExchange::V1beta1::SubscribeListingRequest.new

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

# The returned object is of type Google::Cloud::Bigquery::DataExchange::V1beta1::SubscribeListingResponse.
p result

#test_iam_permissions

def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
def test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse

Returns the permissions that a caller has on a specified dataExchange or listing.

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
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) — REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
  • permissions (::Array<::String>) — The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/bigquery/data_exchange/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::DataExchange::V1beta1::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

#update_data_exchange

def update_data_exchange(request, options = nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange
def update_data_exchange(update_mask: nil, data_exchange: nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange

Updates the parameters of a single DataExchange.

Overloads 
def update_data_exchange(request, options = nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange
Pass arguments to update_data_exchange via a request object, either of type UpdateDataExchangeRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Bigquery::DataExchange::V1beta1::UpdateDataExchangeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def update_data_exchange(update_mask: nil, data_exchange: nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::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
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/bigquery/data_exchange/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::DataExchange::V1beta1::AnalyticsHubService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataExchange::V1beta1::UpdateDataExchangeRequest.new

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

# The returned object is of type Google::Cloud::Bigquery::DataExchange::V1beta1::DataExchange.
p result

#update_listing

def update_listing(request, options = nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::Listing
def update_listing(update_mask: nil, listing: nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::Listing

Updates the parameters of a single Listing.

Overloads 
def update_listing(request, options = nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::Listing
Pass arguments to update_listing via a request object, either of type UpdateListingRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Bigquery::DataExchange::V1beta1::UpdateListingRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def update_listing(update_mask: nil, listing: nil) -> ::Google::Cloud::Bigquery::DataExchange::V1beta1::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
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/bigquery/data_exchange/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::DataExchange::V1beta1::AnalyticsHubService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataExchange::V1beta1::UpdateListingRequest.new

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

# The returned object is of type Google::Cloud::Bigquery::DataExchange::V1beta1::Listing.
p result