# Copyright 2020 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. require 'google/apis/core/base_service' require 'google/apis/core/json_representation' require 'google/apis/core/hashable' require 'google/apis/errors' module Google module Apis module AnalyticshubV1 # Analytics Hub API # # Exchange data and analytics assets securely and efficiently. # # @example # require 'google/apis/analyticshub_v1' # # Analyticshub = Google::Apis::AnalyticshubV1 # Alias the module # service = Analyticshub::AnalyticsHubService.new # # @see https://cloud.google.com/bigquery/docs/analytics-hub-introduction class AnalyticsHubService < Google::Apis::Core::BaseService # @return [String] # API key. Your API key identifies your project and provides you with API access, # quota, and reports. Required unless you provide an OAuth 2.0 token. attr_accessor :key # @return [String] # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. attr_accessor :quota_user def initialize super('https://analyticshub.googleapis.com/', '', client_name: 'google-apis-analyticshub_v1', client_version: Google::Apis::AnalyticshubV1::GEM_VERSION) @batch_path = 'batch' end # Lists all data exchanges from projects in a given organization and location. # @param [String] organization # Required. The organization resource path of the projects containing # DataExchanges. e.g. `organizations/myorg/locations/US`. # @param [Fixnum] page_size # The maximum number of results to return in a single response page. Leverage # the page tokens to iterate through the entire collection. # @param [String] page_token # Page token, returned by a previous call, to request the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticshubV1::ListOrgDataExchangesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticshubV1::ListOrgDataExchangesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def list_organization_location_data_exchanges(organization, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+organization}/dataExchanges', options) command.response_representation = Google::Apis::AnalyticshubV1::ListOrgDataExchangesResponse::Representation command.response_class = Google::Apis::AnalyticshubV1::ListOrgDataExchangesResponse command.params['organization'] = organization unless organization.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Creates a new data exchange. # @param [String] parent # Required. The parent resource path of the data exchange. e.g. `projects/ # myproject/locations/US`. # @param [Google::Apis::AnalyticshubV1::DataExchange] data_exchange_object # @param [String] data_exchange_id # Required. The ID of the data exchange. Must contain only Unicode letters, # numbers (0-9), underscores (_). Should not use characters that require URL- # escaping, or characters outside of ASCII, spaces. Max length: 100 bytes. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticshubV1::DataExchange] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticshubV1::DataExchange] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def create_project_location_data_exchange(parent, data_exchange_object = nil, data_exchange_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/dataExchanges', options) command.request_representation = Google::Apis::AnalyticshubV1::DataExchange::Representation command.request_object = data_exchange_object command.response_representation = Google::Apis::AnalyticshubV1::DataExchange::Representation command.response_class = Google::Apis::AnalyticshubV1::DataExchange command.params['parent'] = parent unless parent.nil? command.query['dataExchangeId'] = data_exchange_id unless data_exchange_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Deletes an existing data exchange. # @param [String] name # Required. The full name of the data exchange resource that you want to delete. # For example, `projects/myproject/locations/US/dataExchanges/123`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticshubV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticshubV1::Empty] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def delete_project_location_data_exchange(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::AnalyticshubV1::Empty::Representation command.response_class = Google::Apis::AnalyticshubV1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Gets the details of a data exchange. # @param [String] name # Required. The resource name of the data exchange. e.g. `projects/myproject/ # locations/US/dataExchanges/123`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticshubV1::DataExchange] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticshubV1::DataExchange] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def get_project_location_data_exchange(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::AnalyticshubV1::DataExchange::Representation command.response_class = Google::Apis::AnalyticshubV1::DataExchange command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Gets the IAM policy. # @param [String] resource # REQUIRED: The resource for which the policy is being requested. See [Resource # names](https://cloud.google.com/apis/design/resource_names) for the # appropriate value for this field. # @param [Google::Apis::AnalyticshubV1::GetIamPolicyRequest] get_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticshubV1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticshubV1::Policy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def get_data_exchange_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options) command.request_representation = Google::Apis::AnalyticshubV1::GetIamPolicyRequest::Representation command.request_object = get_iam_policy_request_object command.response_representation = Google::Apis::AnalyticshubV1::Policy::Representation command.response_class = Google::Apis::AnalyticshubV1::Policy command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Lists all data exchanges in a given project and location. # @param [String] parent # Required. The parent resource path of the data exchanges. e.g. `projects/ # myproject/locations/US`. # @param [Fixnum] page_size # The maximum number of results to return in a single response page. Leverage # the page tokens to iterate through the entire collection. # @param [String] page_token # Page token, returned by a previous call, to request the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticshubV1::ListDataExchangesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticshubV1::ListDataExchangesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def list_project_location_data_exchanges(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/dataExchanges', options) command.response_representation = Google::Apis::AnalyticshubV1::ListDataExchangesResponse::Representation command.response_class = Google::Apis::AnalyticshubV1::ListDataExchangesResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Lists all subscriptions on a given Data Exchange or Listing. # @param [String] resource # 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 # @param [Boolean] include_deleted_subscriptions # If selected, includes deleted subscriptions in the response (up to 63 days # after deletion). # @param [Fixnum] page_size # The maximum number of results to return in a single response page. # @param [String] page_token # Page token, returned by a previous call. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticshubV1::ListSharedResourceSubscriptionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticshubV1::ListSharedResourceSubscriptionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def list_project_location_data_exchange_subscriptions(resource, include_deleted_subscriptions: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+resource}:listSubscriptions', options) command.response_representation = Google::Apis::AnalyticshubV1::ListSharedResourceSubscriptionsResponse::Representation command.response_class = Google::Apis::AnalyticshubV1::ListSharedResourceSubscriptionsResponse command.params['resource'] = resource unless resource.nil? command.query['includeDeletedSubscriptions'] = include_deleted_subscriptions unless include_deleted_subscriptions.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Updates an existing data exchange. # @param [String] name # Output only. The resource name of the data exchange. e.g. `projects/myproject/ # locations/US/dataExchanges/123`. # @param [Google::Apis::AnalyticshubV1::DataExchange] data_exchange_object # @param [String] update_mask # Required. Field mask specifies the fields to update in the data exchange # resource. The fields specified in the `updateMask` are relative to the # resource and are not a full request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticshubV1::DataExchange] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticshubV1::DataExchange] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def patch_project_location_data_exchange(name, data_exchange_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+name}', options) command.request_representation = Google::Apis::AnalyticshubV1::DataExchange::Representation command.request_object = data_exchange_object command.response_representation = Google::Apis::AnalyticshubV1::DataExchange::Representation command.response_class = Google::Apis::AnalyticshubV1::DataExchange command.params['name'] = name unless name.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Sets the IAM policy. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. See [Resource # names](https://cloud.google.com/apis/design/resource_names) for the # appropriate value for this field. # @param [Google::Apis::AnalyticshubV1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticshubV1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticshubV1::Policy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def set_data_exchange_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options) command.request_representation = Google::Apis::AnalyticshubV1::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::AnalyticshubV1::Policy::Representation command.response_class = Google::Apis::AnalyticshubV1::Policy command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Creates a Subscription to a Data Exchange. This is a long-running operation as # it will create one or more linked datasets. # @param [String] name # Required. Resource name of the Data Exchange. e.g. `projects/publisherproject/ # locations/US/dataExchanges/123` # @param [Google::Apis::AnalyticshubV1::SubscribeDataExchangeRequest] subscribe_data_exchange_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticshubV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticshubV1::Operation] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def subscribe_data_exchange(name, subscribe_data_exchange_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:subscribe', options) command.request_representation = Google::Apis::AnalyticshubV1::SubscribeDataExchangeRequest::Representation command.request_object = subscribe_data_exchange_request_object command.response_representation = Google::Apis::AnalyticshubV1::Operation::Representation command.response_class = Google::Apis::AnalyticshubV1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Returns the permissions that a caller has. # @param [String] resource # REQUIRED: The resource for which the policy detail is being requested. See [ # Resource names](https://cloud.google.com/apis/design/resource_names) for the # appropriate value for this field. # @param [Google::Apis::AnalyticshubV1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticshubV1::TestIamPermissionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticshubV1::TestIamPermissionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def test_data_exchange_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options) command.request_representation = Google::Apis::AnalyticshubV1::TestIamPermissionsRequest::Representation command.request_object = test_iam_permissions_request_object command.response_representation = Google::Apis::AnalyticshubV1::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::AnalyticshubV1::TestIamPermissionsResponse command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Creates a new listing. # @param [String] parent # Required. The parent resource path of the listing. e.g. `projects/myproject/ # locations/US/dataExchanges/123`. # @param [Google::Apis::AnalyticshubV1::Listing] listing_object # @param [String] listing_id # 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. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticshubV1::Listing] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticshubV1::Listing] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def create_project_location_data_exchange_listing(parent, listing_object = nil, listing_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/listings', options) command.request_representation = Google::Apis::AnalyticshubV1::Listing::Representation command.request_object = listing_object command.response_representation = Google::Apis::AnalyticshubV1::Listing::Representation command.response_class = Google::Apis::AnalyticshubV1::Listing command.params['parent'] = parent unless parent.nil? command.query['listingId'] = listing_id unless listing_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Deletes a listing. # @param [String] name # Required. Resource name of the listing to delete. e.g. `projects/myproject/ # locations/US/dataExchanges/123/listings/456`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticshubV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticshubV1::Empty] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def delete_project_location_data_exchange_listing(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::AnalyticshubV1::Empty::Representation command.response_class = Google::Apis::AnalyticshubV1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Gets the details of a listing. # @param [String] name # Required. The resource name of the listing. e.g. `projects/myproject/locations/ # US/dataExchanges/123/listings/456`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticshubV1::Listing] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticshubV1::Listing] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def get_project_location_data_exchange_listing(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::AnalyticshubV1::Listing::Representation command.response_class = Google::Apis::AnalyticshubV1::Listing command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Gets the IAM policy. # @param [String] resource # REQUIRED: The resource for which the policy is being requested. See [Resource # names](https://cloud.google.com/apis/design/resource_names) for the # appropriate value for this field. # @param [Google::Apis::AnalyticshubV1::GetIamPolicyRequest] get_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticshubV1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticshubV1::Policy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def get_listing_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options) command.request_representation = Google::Apis::AnalyticshubV1::GetIamPolicyRequest::Representation command.request_object = get_iam_policy_request_object command.response_representation = Google::Apis::AnalyticshubV1::Policy::Representation command.response_class = Google::Apis::AnalyticshubV1::Policy command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Lists all listings in a given project and location. # @param [String] parent # Required. The parent resource path of the listing. e.g. `projects/myproject/ # locations/US/dataExchanges/123`. # @param [Fixnum] page_size # The maximum number of results to return in a single response page. Leverage # the page tokens to iterate through the entire collection. # @param [String] page_token # Page token, returned by a previous call, to request the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticshubV1::ListListingsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticshubV1::ListListingsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def list_project_location_data_exchange_listings(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/listings', options) command.response_representation = Google::Apis::AnalyticshubV1::ListListingsResponse::Representation command.response_class = Google::Apis::AnalyticshubV1::ListListingsResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Lists all subscriptions on a given Data Exchange or Listing. # @param [String] resource # 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 # @param [Boolean] include_deleted_subscriptions # If selected, includes deleted subscriptions in the response (up to 63 days # after deletion). # @param [Fixnum] page_size # The maximum number of results to return in a single response page. # @param [String] page_token # Page token, returned by a previous call. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticshubV1::ListSharedResourceSubscriptionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticshubV1::ListSharedResourceSubscriptionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def list_project_location_data_exchange_listing_subscriptions(resource, include_deleted_subscriptions: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+resource}:listSubscriptions', options) command.response_representation = Google::Apis::AnalyticshubV1::ListSharedResourceSubscriptionsResponse::Representation command.response_class = Google::Apis::AnalyticshubV1::ListSharedResourceSubscriptionsResponse command.params['resource'] = resource unless resource.nil? command.query['includeDeletedSubscriptions'] = include_deleted_subscriptions unless include_deleted_subscriptions.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Updates an existing listing. # @param [String] name # Output only. The resource name of the listing. e.g. `projects/myproject/ # locations/US/dataExchanges/123/listings/456` # @param [Google::Apis::AnalyticshubV1::Listing] listing_object # @param [String] update_mask # Required. Field mask specifies the fields to update in the listing resource. # The fields specified in the `updateMask` are relative to the resource and are # not a full request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticshubV1::Listing] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticshubV1::Listing] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def patch_project_location_data_exchange_listing(name, listing_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+name}', options) command.request_representation = Google::Apis::AnalyticshubV1::Listing::Representation command.request_object = listing_object command.response_representation = Google::Apis::AnalyticshubV1::Listing::Representation command.response_class = Google::Apis::AnalyticshubV1::Listing command.params['name'] = name unless name.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Sets the IAM policy. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. See [Resource # names](https://cloud.google.com/apis/design/resource_names) for the # appropriate value for this field. # @param [Google::Apis::AnalyticshubV1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticshubV1::Policy] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticshubV1::Policy] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def set_listing_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options) command.request_representation = Google::Apis::AnalyticshubV1::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::AnalyticshubV1::Policy::Representation command.response_class = Google::Apis::AnalyticshubV1::Policy command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # 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. # @param [String] name # Required. Resource name of the listing that you want to subscribe to. e.g. ` # projects/myproject/locations/US/dataExchanges/123/listings/456`. # @param [Google::Apis::AnalyticshubV1::SubscribeListingRequest] subscribe_listing_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticshubV1::SubscribeListingResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticshubV1::SubscribeListingResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def subscribe_listing(name, subscribe_listing_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:subscribe', options) command.request_representation = Google::Apis::AnalyticshubV1::SubscribeListingRequest::Representation command.request_object = subscribe_listing_request_object command.response_representation = Google::Apis::AnalyticshubV1::SubscribeListingResponse::Representation command.response_class = Google::Apis::AnalyticshubV1::SubscribeListingResponse command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Returns the permissions that a caller has. # @param [String] resource # REQUIRED: The resource for which the policy detail is being requested. See [ # Resource names](https://cloud.google.com/apis/design/resource_names) for the # appropriate value for this field. # @param [Google::Apis::AnalyticshubV1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticshubV1::TestIamPermissionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticshubV1::TestIamPermissionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def test_listing_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options) command.request_representation = Google::Apis::AnalyticshubV1::TestIamPermissionsRequest::Representation command.request_object = test_iam_permissions_request_object command.response_representation = Google::Apis::AnalyticshubV1::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::AnalyticshubV1::TestIamPermissionsResponse command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Deletes a subscription. # @param [String] name # Required. Resource name of the subscription to delete. e.g. projects/123/ # locations/US/subscriptions/456 # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticshubV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticshubV1::Operation] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def delete_project_location_subscription(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::AnalyticshubV1::Operation::Representation command.response_class = Google::Apis::AnalyticshubV1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Gets the details of a Subscription. # @param [String] name # Required. Resource name of the subscription. e.g. projects/123/locations/US/ # subscriptions/456 # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticshubV1::Subscription] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticshubV1::Subscription] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def get_project_location_subscription(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::AnalyticshubV1::Subscription::Representation command.response_class = Google::Apis::AnalyticshubV1::Subscription command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Lists all subscriptions in a given project and location. # @param [String] parent # Required. The parent resource path of the subscription. e.g. projects/ # myproject/locations/US # @param [String] filter # The filter expression may be used to filter by Data Exchange or Listing. # @param [Fixnum] page_size # The maximum number of results to return in a single response page. # @param [String] page_token # Page token, returned by a previous call. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticshubV1::ListSubscriptionsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticshubV1::ListSubscriptionsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def list_project_location_subscriptions(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/subscriptions', options) command.response_representation = Google::Apis::AnalyticshubV1::ListSubscriptionsResponse::Representation command.response_class = Google::Apis::AnalyticshubV1::ListSubscriptionsResponse command.params['parent'] = parent unless parent.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # 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. # @param [String] name # Required. Resource name of the Subscription to refresh. e.g. `projects/ # subscriberproject/locations/US/subscriptions/123` # @param [Google::Apis::AnalyticshubV1::RefreshSubscriptionRequest] refresh_subscription_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticshubV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticshubV1::Operation] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def refresh_subscription(name, refresh_subscription_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:refresh', options) command.request_representation = Google::Apis::AnalyticshubV1::RefreshSubscriptionRequest::Representation command.request_object = refresh_subscription_request_object command.response_representation = Google::Apis::AnalyticshubV1::Operation::Representation command.response_class = Google::Apis::AnalyticshubV1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Revokes a given subscription. # @param [String] name # Required. Resource name of the subscription to revoke. e.g. projects/123/ # locations/US/subscriptions/456 # @param [Google::Apis::AnalyticshubV1::RevokeSubscriptionRequest] revoke_subscription_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::AnalyticshubV1::RevokeSubscriptionResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::AnalyticshubV1::RevokeSubscriptionResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def revoke_subscription(name, revoke_subscription_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:revoke', options) command.request_representation = Google::Apis::AnalyticshubV1::RevokeSubscriptionRequest::Representation command.request_object = revoke_subscription_request_object command.response_representation = Google::Apis::AnalyticshubV1::RevokeSubscriptionResponse::Representation command.response_class = Google::Apis::AnalyticshubV1::RevokeSubscriptionResponse command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end protected def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? end end end end end