class Google::Cloud::Dataplex::V1::ContentService::Client


ContentService manages Notebook and SQL Scripts for Dataplex.
Client for the ContentService service.
#

def self.configure

Returns:
  • (Client::Configuration) -

Other tags:
    Yieldparam: config -

Other tags:
    Yield: - Configure the Client client.
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Dataplex", "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.rpcs.create_content.timeout = 60.0
    default_config.rpcs.update_content.timeout = 60.0
    default_config.rpcs.delete_content.timeout = 60.0
    default_config.rpcs.get_content.timeout = 60.0
    default_config.rpcs.get_content.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }
    default_config.rpcs.get_iam_policy.timeout = 60.0
    default_config.rpcs.get_iam_policy.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }
    default_config.rpcs.set_iam_policy.timeout = 60.0
    default_config.rpcs.test_iam_permissions.timeout = 60.0
    default_config.rpcs.test_iam_permissions.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }
    default_config.rpcs.list_content.timeout = 60.0
    default_config.rpcs.list_content.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }
    default_config
  end
  yield @configure if block_given?
  @configure
end

def configure

Returns:
  • (Client::Configuration) -

Other tags:
    Yieldparam: config -

Other tags:
    Yield: - Configure the Client client.
def configure
  yield @config if block_given?
  @config
end

def create_content request, options = nil

Other tags:
    Example: Basic example -

Raises:
  • (::Google::Cloud::Error) - if the RPC is aborted.

Returns:
  • (::Google::Cloud::Dataplex::V1::Content) -

Other tags:
    Yieldparam: operation -
    Yieldparam: response -

Other tags:
    Yield: - Access the result along with the RPC operation

Parameters:
  • validate_only (::Boolean) --
  • content (::Google::Cloud::Dataplex::V1::Content, ::Hash) --
  • parent (::String) --
  • options (::Gapic::CallOptions, ::Hash) --
  • request (::Google::Cloud::Dataplex::V1::CreateContentRequest, ::Hash) --

Overloads:
  • create_content(parent: nil, content: nil, validate_only: nil)
  • create_content(request, options = nil)
def create_content request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?
  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::CreateContentRequest
  # 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_content.metadata.to_h
  # Set x-goog-api-client and x-goog-user-project 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::Dataplex::V1::VERSION
  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_content.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_content.retry_policy
  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy
  @content_service_stub.call_rpc :create_content, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

def delete_content request, options = nil

Other tags:
    Example: Basic example -

Raises:
  • (::Google::Cloud::Error) - if the RPC is aborted.

Returns:
  • (::Google::Protobuf::Empty) -

Other tags:
    Yieldparam: operation -
    Yieldparam: response -

Other tags:
    Yield: - Access the result along with the RPC operation

Parameters:
  • name (::String) --
  • options (::Gapic::CallOptions, ::Hash) --
  • request (::Google::Cloud::Dataplex::V1::DeleteContentRequest, ::Hash) --

Overloads:
  • delete_content(name: nil)
  • delete_content(request, options = nil)
def delete_content request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?
  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::DeleteContentRequest
  # 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_content.metadata.to_h
  # Set x-goog-api-client and x-goog-user-project 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::Dataplex::V1::VERSION
  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_content.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_content.retry_policy
  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy
  @content_service_stub.call_rpc :delete_content, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

def get_content request, options = nil

Other tags:
    Example: Basic example -

Raises:
  • (::Google::Cloud::Error) - if the RPC is aborted.

Returns:
  • (::Google::Cloud::Dataplex::V1::Content) -

Other tags:
    Yieldparam: operation -
    Yieldparam: response -

Other tags:
    Yield: - Access the result along with the RPC operation

Parameters:
  • view (::Google::Cloud::Dataplex::V1::GetContentRequest::ContentView) --
  • name (::String) --
  • options (::Gapic::CallOptions, ::Hash) --
  • request (::Google::Cloud::Dataplex::V1::GetContentRequest, ::Hash) --

Overloads:
  • get_content(name: nil, view: nil)
  • get_content(request, options = nil)
def get_content request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?
  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::GetContentRequest
  # 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_content.metadata.to_h
  # Set x-goog-api-client and x-goog-user-project 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::Dataplex::V1::VERSION
  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_content.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_content.retry_policy
  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy
  @content_service_stub.call_rpc :get_content, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

def get_iam_policy request, options = nil

Other tags:
    Example: Basic example -

Raises:
  • (::Google::Cloud::Error) - if the RPC is aborted.

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

Other tags:
    Yieldparam: operation -
    Yieldparam: response -

Other tags:
    Yield: - Access the result along with the RPC operation

Parameters:
  • options (::Google::Iam::V1::GetPolicyOptions, ::Hash) --
  • resource (::String) --
  • options (::Gapic::CallOptions, ::Hash) --
  • request (::Google::Iam::V1::GetIamPolicyRequest, ::Hash) --

Overloads:
  • get_iam_policy(resource: nil, options: nil)
  • get_iam_policy(request, options = nil)
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 and x-goog-user-project 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::Dataplex::V1::VERSION
  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
  @content_service_stub.call_rpc :get_iam_policy, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

def initialize

Other tags:
    Yieldparam: config -

Other tags:
    Yield: - Configure the ContentService client.
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/dataplex/v1/content_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 == 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
  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
  end
  @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
  end
  @content_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Dataplex::V1::ContentService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

def list_content request, options = nil

Other tags:
    Example: Basic example -

Raises:
  • (::Google::Cloud::Error) - if the RPC is aborted.

Returns:
  • (::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::Content>) -

Other tags:
    Yieldparam: operation -
    Yieldparam: response -

Other tags:
    Yield: - Access the result along with the RPC operation

Parameters:
  • filter (::String) --
  • page_token (::String) --
  • page_size (::Integer) --
  • parent (::String) --
  • options (::Gapic::CallOptions, ::Hash) --
  • request (::Google::Cloud::Dataplex::V1::ListContentRequest, ::Hash) --

Overloads:
  • list_content(parent: nil, page_size: nil, page_token: nil, filter: nil)
  • list_content(request, options = nil)
def list_content request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?
  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::ListContentRequest
  # 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_content.metadata.to_h
  # Set x-goog-api-client and x-goog-user-project 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::Dataplex::V1::VERSION
  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_content.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_content.retry_policy
  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy
  @content_service_stub.call_rpc :list_content, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @content_service_stub, :list_content, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

def set_iam_policy request, options = nil

Other tags:
    Example: Basic example -

Raises:
  • (::Google::Cloud::Error) - if the RPC is aborted.

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

Other tags:
    Yieldparam: operation -
    Yieldparam: response -

Other tags:
    Yield: - Access the result along with the RPC operation

Parameters:
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) --
  • policy (::Google::Iam::V1::Policy, ::Hash) --
  • resource (::String) --
  • options (::Gapic::CallOptions, ::Hash) --
  • request (::Google::Iam::V1::SetIamPolicyRequest, ::Hash) --

Overloads:
  • set_iam_policy(resource: nil, policy: nil, update_mask: nil)
  • set_iam_policy(request, options = nil)
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 and x-goog-user-project 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::Dataplex::V1::VERSION
  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
  @content_service_stub.call_rpc :set_iam_policy, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

def test_iam_permissions request, options = nil

Other tags:
    Example: Basic example -

Raises:
  • (::Google::Cloud::Error) - if the RPC is aborted.

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

Other tags:
    Yieldparam: operation -
    Yieldparam: response -

Other tags:
    Yield: - Access the result along with the RPC operation

Parameters:
  • permissions (::Array<::String>) --
  • resource (::String) --
  • options (::Gapic::CallOptions, ::Hash) --
  • request (::Google::Iam::V1::TestIamPermissionsRequest, ::Hash) --

Overloads:
  • test_iam_permissions(resource: nil, permissions: nil)
  • test_iam_permissions(request, options = nil)
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 and x-goog-user-project 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::Dataplex::V1::VERSION
  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
  @content_service_stub.call_rpc :test_iam_permissions, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

def update_content request, options = nil

Other tags:
    Example: Basic example -

Raises:
  • (::Google::Cloud::Error) - if the RPC is aborted.

Returns:
  • (::Google::Cloud::Dataplex::V1::Content) -

Other tags:
    Yieldparam: operation -
    Yieldparam: response -

Other tags:
    Yield: - Access the result along with the RPC operation

Parameters:
  • validate_only (::Boolean) --
  • content (::Google::Cloud::Dataplex::V1::Content, ::Hash) --
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) --
  • options (::Gapic::CallOptions, ::Hash) --
  • request (::Google::Cloud::Dataplex::V1::UpdateContentRequest, ::Hash) --

Overloads:
  • update_content(update_mask: nil, content: nil, validate_only: nil)
  • update_content(request, options = nil)
def update_content request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?
  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::UpdateContentRequest
  # 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_content.metadata.to_h
  # Set x-goog-api-client and x-goog-user-project 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::Dataplex::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
  header_params = {}
  if request.content&.name
    header_params["content.name"] = request.content.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_content.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_content.retry_policy
  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy
  @content_service_stub.call_rpc :update_content, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end