Class: Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client

Inherits:

Object

Object
Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client

show all

Includes:: Paths

Defined in:: lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb

Overview

REST client for the DataCatalog service.

Data Catalog API service allows you to discover, understand, and manage your data.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

#iam_policy_client ⇒ Google::Iam::V1::IAMPolicy::Rest::Client readonly
Get the associated client for mix-in of the IAMPolicy.
#operations_client ⇒ ::Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Operations readonly
Get the associated client for long-running operations.

Class Method Summary collapse

.configure {|config| ... } ⇒ Client::Configuration
Configure the DataCatalog Client class.

Instance Method Summary collapse

#configure {|config| ... } ⇒ Client::Configuration
Configure the DataCatalog Client instance.
#create_entry(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DataCatalog::V1::Entry
Creates an entry.
#create_entry_group(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DataCatalog::V1::EntryGroup
Creates an entry group.
#create_tag(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DataCatalog::V1::Tag
Creates a tag and assigns it to:.
#create_tag_template(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplate
Creates a tag template.
#create_tag_template_field(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplateField
Creates a field in a tag template.
#delete_entry(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes an existing entry.
#delete_entry_group(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes an entry group.
#delete_tag(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a tag.
#delete_tag_template(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a tag template and all tags that use it.
#delete_tag_template_field(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a field in a tag template and all uses of this field from the tags based on this template.
#get_entry(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DataCatalog::V1::Entry
Gets an entry.
#get_entry_group(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DataCatalog::V1::EntryGroup
Gets an entry group.
#get_iam_policy(request, options = nil) {|result, operation| ... } ⇒ ::Google::Iam::V1::Policy
Gets the access control policy for a resource.
#get_tag_template(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplate
Gets a tag template.
#import_entries(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Operation
Imports entries from a source, such as data previously dumped into a Cloud Storage bucket, into Data Catalog.
#initialize {|config| ... } ⇒ Client constructor
Create a new DataCatalog REST client object.
#list_entries(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Entry>
Lists entries.
#list_entry_groups(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::EntryGroup>
Lists entry groups.
#list_tags(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Tag>
Lists tags assigned to an Entry.
#lookup_entry(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DataCatalog::V1::Entry
Gets an entry by its target resource name.
#modify_entry_contacts(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DataCatalog::V1::Contacts
Modifies contacts, part of the business context of an Entry.
#modify_entry_overview(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DataCatalog::V1::EntryOverview
Modifies entry overview, part of the business context of an Entry.
#reconcile_tags(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Operation
ReconcileTags creates or updates a list of tags on the entry.
#rename_tag_template_field(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplateField
Renames a field in a tag template.
#rename_tag_template_field_enum_value(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplateField
Renames an enum value in a tag template.
#search_catalog(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DataCatalog::V1::SearchCatalogResponse
Searches Data Catalog for multiple resources like entries and tags that match a query.
#set_iam_policy(request, options = nil) {|result, operation| ... } ⇒ ::Google::Iam::V1::Policy
Sets an access control policy for a resource.
#star_entry(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DataCatalog::V1::StarEntryResponse
Marks an Entry as starred by the current user.
#test_iam_permissions(request, options = nil) {|result, operation| ... } ⇒ ::Google::Iam::V1::TestIamPermissionsResponse
Gets your permissions on a resource.
#universe_domain ⇒ String
The effective universe domain.
#unstar_entry(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DataCatalog::V1::UnstarEntryResponse
Marks an Entry as NOT starred by the current user.
#update_entry(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DataCatalog::V1::Entry
Updates an existing entry.
#update_entry_group(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DataCatalog::V1::EntryGroup
Updates an entry group.
#update_tag(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DataCatalog::V1::Tag
Updates an existing tag.
#update_tag_template(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplate
Updates a tag template.
#update_tag_template_field(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplateField
Updates a field in a tag template.

Methods included from Paths

#entry_group_path, #entry_path, #location_path, #tag_path, #tag_template_field_enum_value_path, #tag_template_field_path, #tag_template_path

Constructor Details

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

Create a new DataCatalog REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

(config) —
Configure the DataCatalog client.

Yield Parameters:

config (Client::Configuration)

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 130

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

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

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end

  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @data_catalog_stub = ::Google::Cloud::DataCatalog::V1::DataCatalog::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials
  )

  @iam_policy_client = Google::Iam::V1::IAMPolicy::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @data_catalog_stub.endpoint
    config.universe_domain = @data_catalog_stub.universe_domain
  end
end

Instance Attribute Details

#iam_policy_client ⇒ `Google::Iam::V1::IAMPolicy::Rest::Client` (readonly)

Get the associated client for mix-in of the IAMPolicy.

Returns:

(Google::Iam::V1::IAMPolicy::Rest::Client)



187
188
189

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 187

def iam_policy_client
  @iam_policy_client
end

#operations_client ⇒ `::Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Operations` (readonly)

Get the associated client for long-running operations.

Returns:

(::Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Operations)



180
181
182

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 180

def operations_client
  @operations_client
end

Class Method Details

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

Configure the DataCatalog Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

(config) —
Configure the Client client.

Yield Parameters:

config (Client::Configuration)

Returns:

(Client::Configuration)

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 63

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

    default_config.timeout = 60.0
    default_config.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 8, 13]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

Configure the DataCatalog Client instance.

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

See Configuration for a description of the configuration fields.

Yields:

(config) —
Configure the Client client.

Yield Parameters:

config (Client::Configuration)

Returns:

(Client::Configuration)

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 100

def configure
  yield @config if block_given?
  @config
end

#create_entry(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::Entry` #create_entry(parent: nil, entry_id: nil, entry: nil) ⇒ `::Google::Cloud::DataCatalog::V1::Entry`

Creates an entry.

You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

An entry group can have a maximum of 100,000 entries.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::CreateEntryRequest.new

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

# The returned object is of type Google::Cloud::DataCatalog::V1::Entry.
p result

Overloads:

#create_entry(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::Entry

Pass arguments to create_entry via a request object, either of type CreateEntryRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::CreateEntryRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#create_entry(parent: nil, entry_id: nil, entry: nil) ⇒ ::Google::Cloud::DataCatalog::V1::Entry

Pass arguments to create_entry via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The name of the entry group this entry belongs to.
  
  Note: The entry itself and its child resources might not be stored in the location specified in its name.
- entry_id (::String) (defaults to: nil) —
  Required. The ID of the entry to create.
  
  The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores (_). The maximum size is 64 bytes when encoded in UTF-8.
- entry (::Google::Cloud::DataCatalog::V1::Entry, ::Hash) (defaults to: nil) —
  Required. The entry to create.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::DataCatalog::V1::Entry)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::DataCatalog::V1::Entry)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 869

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::CreateEntryRequest

  # 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
  call_metadata = @config.rpcs.create_entry.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_entry.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_entry.retry_policy

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

  @data_catalog_stub.create_entry request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_entry_group(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::EntryGroup` #create_entry_group(parent: nil, entry_group_id: nil, entry_group: nil) ⇒ `::Google::Cloud::DataCatalog::V1::EntryGroup`

Creates an entry group.

An entry group contains logically related entries together with Cloud Identity and Access Management policies. These policies specify users who can create, edit, and view entries within entry groups.

Data Catalog automatically creates entry groups with names that start with the @ symbol for the following resources:

BigQuery entries (@bigquery)
Pub/Sub topics (@pubsub)
Dataproc Metastore services (@dataproc_metastore_{SERVICE_NAME_HASH})

You can create your own entry groups for Cloud Storage fileset entries and custom entries together with the corresponding IAM policies. User-created entry groups can't contain the @ symbol, it is reserved for automatically created groups.

Entry groups, like entries, can be searched.

A maximum of 10,000 entry groups may be created per organization across all locations.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::CreateEntryGroupRequest.new

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

# The returned object is of type Google::Cloud::DataCatalog::V1::EntryGroup.
p result

Overloads:

#create_entry_group(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::EntryGroup

Pass arguments to create_entry_group via a request object, either of type CreateEntryGroupRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::CreateEntryGroupRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#create_entry_group(parent: nil, entry_group_id: nil, entry_group: nil) ⇒ ::Google::Cloud::DataCatalog::V1::EntryGroup

Pass arguments to create_entry_group via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The names of the project and location that the new entry group belongs to.
  
  Note: The entry group itself and its child resources might not be stored in the location specified in its name.
- entry_group_id (::String) (defaults to: nil) —
  Required. The ID of the entry group to create.
  
  The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
- entry_group (::Google::Cloud::DataCatalog::V1::EntryGroup, ::Hash) (defaults to: nil) —
  The entry group to create. Defaults to empty.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::DataCatalog::V1::EntryGroup)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::DataCatalog::V1::EntryGroup)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 423

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::CreateEntryGroupRequest

  # 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
  call_metadata = @config.rpcs.create_entry_group.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_entry_group.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_entry_group.retry_policy

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

  @data_catalog_stub.create_entry_group request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_tag(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::Tag` #create_tag(parent: nil, tag: nil) ⇒ `::Google::Cloud::DataCatalog::V1::Tag`

Creates a tag and assigns it to:

An Entry if the method name is projects.locations.entryGroups.entries.tags.create.
Or EntryGroupif the method name is projects.locations.entryGroups.tags.create.

Note: The project identified by the parent parameter for the tag and the tag template used to create the tag must be in the same organization.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::CreateTagRequest.new

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

# The returned object is of type Google::Cloud::DataCatalog::V1::Tag.
p result

Overloads:

#create_tag(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::Tag

Pass arguments to create_tag via a request object, either of type CreateTagRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::CreateTagRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#create_tag(parent: nil, tag: nil) ⇒ ::Google::Cloud::DataCatalog::V1::Tag

Pass arguments to create_tag via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The name of the resource to attach this tag to.
  
  Tags can be attached to entries or entry groups. An entry can have up to 1000 attached tags.
  
  Note: The tag and its child resources might not be stored in the location specified in its name.
- tag (::Google::Cloud::DataCatalog::V1::Tag, ::Hash) (defaults to: nil) —
  Required. The tag to create.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::DataCatalog::V1::Tag)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::DataCatalog::V1::Tag)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 2445

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::CreateTagRequest

  # 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
  call_metadata = @config.rpcs.create_tag.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_tag.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_tag.retry_policy

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

  @data_catalog_stub.create_tag request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_tag_template(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplate` #create_tag_template(parent: nil, tag_template_id: nil, tag_template: nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplate`

Creates a tag template.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::CreateTagTemplateRequest.new

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

# The returned object is of type Google::Cloud::DataCatalog::V1::TagTemplate.
p result

Overloads:

#create_tag_template(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplate

Pass arguments to create_tag_template via a request object, either of type CreateTagTemplateRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::CreateTagTemplateRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#create_tag_template(parent: nil, tag_template_id: nil, tag_template: nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplate

Pass arguments to create_tag_template via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The name of the project and the template location region.
- tag_template_id (::String) (defaults to: nil) —
  Required. The ID of the tag template to create.
  
  The ID must contain only lowercase letters (a-z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
- tag_template (::Google::Cloud::DataCatalog::V1::TagTemplate, ::Hash) (defaults to: nil) —
  Required. The tag template to create.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::DataCatalog::V1::TagTemplate)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::DataCatalog::V1::TagTemplate)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 1635

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::CreateTagTemplateRequest

  # 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
  call_metadata = @config.rpcs.create_tag_template.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_tag_template.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_tag_template.retry_policy

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

  @data_catalog_stub.create_tag_template request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_tag_template_field(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplateField` #create_tag_template_field(parent: nil, tag_template_field_id: nil, tag_template_field: nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplateField`

Creates a field in a tag template.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::CreateTagTemplateFieldRequest.new

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

# The returned object is of type Google::Cloud::DataCatalog::V1::TagTemplateField.
p result

Overloads:

#create_tag_template_field(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplateField

Pass arguments to create_tag_template_field via a request object, either of type CreateTagTemplateFieldRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::CreateTagTemplateFieldRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#create_tag_template_field(parent: nil, tag_template_field_id: nil, tag_template_field: nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplateField

Pass arguments to create_tag_template_field via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The name of the project and the template location region.
- tag_template_field_id (::String) (defaults to: nil) —
  Required. The ID of the tag template field to create.
  
  Note: Adding a required field to an existing template is not allowed.
  
  Field IDs can contain letters (both uppercase and lowercase), numbers (0-9), underscores (_) and dashes (-). Field IDs must be at least 1 character long and at most 128 characters long. Field IDs must also be unique within their template.
- tag_template_field (::Google::Cloud::DataCatalog::V1::TagTemplateField, ::Hash) (defaults to: nil) —
  Required. The tag template field to create.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::DataCatalog::V1::TagTemplateField)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::DataCatalog::V1::TagTemplateField)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 1989

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::CreateTagTemplateFieldRequest

  # 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
  call_metadata = @config.rpcs.create_tag_template_field.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_tag_template_field.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_tag_template_field.retry_policy

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

  @data_catalog_stub.create_tag_template_field request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Deletes an existing entry.

You can delete only the entries created by the CreateEntry method.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::DeleteEntryRequest.new

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

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

Overloads:

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

Pass arguments to delete_entry via a request object, either of type Google::Cloud::DataCatalog::V1::DeleteEntryRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::DeleteEntryRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#delete_entry(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_entry via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the entry to delete.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 1069

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::DeleteEntryRequest

  # 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
  call_metadata = @config.rpcs.delete_entry.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_entry.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_entry.retry_policy

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

  @data_catalog_stub.delete_entry request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_entry_group(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_entry_group(name: nil, force: nil) ⇒ `::Google::Protobuf::Empty`

Deletes an entry group.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::DeleteEntryGroupRequest.new

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

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

Overloads:

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

Pass arguments to delete_entry_group via a request object, either of type Google::Cloud::DataCatalog::V1::DeleteEntryGroupRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::DeleteEntryGroupRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#delete_entry_group(name: nil, force: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_entry_group via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the entry group to delete.
- force (::Boolean) (defaults to: nil) —
  Optional. If true, deletes all entries in the entry group.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 677

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::DeleteEntryGroupRequest

  # 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
  call_metadata = @config.rpcs.delete_entry_group.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_entry_group.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_entry_group.retry_policy

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

  @data_catalog_stub.delete_entry_group request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Deletes a tag.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::DeleteTagRequest.new

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

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

Overloads:

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

Pass arguments to delete_tag via a request object, either of type Google::Cloud::DataCatalog::V1::DeleteTagRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::DeleteTagRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#delete_tag(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_tag via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the tag to delete.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 2608

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::DeleteTagRequest

  # 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
  call_metadata = @config.rpcs.delete_tag.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_tag.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_tag.retry_policy

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

  @data_catalog_stub.delete_tag request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_tag_template(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_tag_template(name: nil, force: nil) ⇒ `::Google::Protobuf::Empty`

Deletes a tag template and all tags that use it.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::DeleteTagTemplateRequest.new

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

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

Overloads:

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

Pass arguments to delete_tag_template via a request object, either of type Google::Cloud::DataCatalog::V1::DeleteTagTemplateRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::DeleteTagTemplateRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#delete_tag_template(name: nil, force: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_tag_template via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the tag template to delete.
- force (::Boolean) (defaults to: nil) —
  Required. If true, deletes all tags that use this template.
  
  Currently, true is the only supported value.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 1895

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::DeleteTagTemplateRequest

  # 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
  call_metadata = @config.rpcs.delete_tag_template.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_tag_template.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_tag_template.retry_policy

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

  @data_catalog_stub.delete_tag_template request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_tag_template_field(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_tag_template_field(name: nil, force: nil) ⇒ `::Google::Protobuf::Empty`

Deletes a field in a tag template and all uses of this field from the tags based on this template.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::DeleteTagTemplateFieldRequest.new

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

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

Overloads:

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

Pass arguments to delete_tag_template_field via a request object, either of type Google::Cloud::DataCatalog::V1::DeleteTagTemplateFieldRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::DeleteTagTemplateFieldRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#delete_tag_template_field(name: nil, force: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_tag_template_field via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the tag template field to delete.
- force (::Boolean) (defaults to: nil) —
  Required. If true, deletes this field from any tags that use it.
  
  Currently, true is the only supported value.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 2348

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::DeleteTagTemplateFieldRequest

  # 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
  call_metadata = @config.rpcs.delete_tag_template_field.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_tag_template_field.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_tag_template_field.retry_policy

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

  @data_catalog_stub.delete_tag_template_field request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_entry(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::Entry` #get_entry(name: nil) ⇒ `::Google::Cloud::DataCatalog::V1::Entry`

Gets an entry.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::GetEntryRequest.new

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

# The returned object is of type Google::Cloud::DataCatalog::V1::Entry.
p result

Overloads:

#get_entry(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::Entry

Pass arguments to get_entry via a request object, either of type GetEntryRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::GetEntryRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#get_entry(name: nil) ⇒ ::Google::Cloud::DataCatalog::V1::Entry

Pass arguments to get_entry via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the entry to get.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::DataCatalog::V1::Entry)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::DataCatalog::V1::Entry)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 1147

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::GetEntryRequest

  # 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
  call_metadata = @config.rpcs.get_entry.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_entry.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_entry.retry_policy

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

  @data_catalog_stub.get_entry request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_entry_group(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::EntryGroup` #get_entry_group(name: nil, read_mask: nil) ⇒ `::Google::Cloud::DataCatalog::V1::EntryGroup`

Gets an entry group.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::GetEntryGroupRequest.new

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

# The returned object is of type Google::Cloud::DataCatalog::V1::EntryGroup.
p result

Overloads:

#get_entry_group(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::EntryGroup

Pass arguments to get_entry_group via a request object, either of type GetEntryGroupRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::GetEntryGroupRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#get_entry_group(name: nil, read_mask: nil) ⇒ ::Google::Cloud::DataCatalog::V1::EntryGroup

Pass arguments to get_entry_group via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the entry group to get.
- read_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  The fields to return. If empty or omitted, all fields are returned.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::DataCatalog::V1::EntryGroup)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::DataCatalog::V1::EntryGroup)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 503

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::GetEntryGroupRequest

  # 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
  call_metadata = @config.rpcs.get_entry_group.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_entry_group.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_entry_group.retry_policy

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

  @data_catalog_stub.get_entry_group request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Gets the access control policy for a resource.

May return:

ANOT_FOUND error if the resource doesn't exist or you don't have the permission to view it.
An empty policy if the resource exists but doesn't have a set policy.

Supported resources are:

Tag templates
Entry groups

Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog.

To call this method, you must have the following Google IAM permissions:

datacatalog.tagTemplates.getIamPolicy to get policies on tag templates.
datacatalog.entryGroups.getIamPolicy to get policies on entry groups.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

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

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

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

Overloads:

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

Pass arguments to get_iam_policy via a request object, either of type Iam::V1::GetIamPolicyRequest or an equivalent Hash.
Parameters:
- request (::Google::Iam::V1::GetIamPolicyRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#get_iam_policy(resource: nil, options: nil) ⇒ ::Google::Iam::V1::Policy

Pass arguments to get_iam_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- resource (::String) (defaults to: nil) —
  REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
- options (::Google::Iam::V1::GetPolicyOptions, ::Hash) (defaults to: nil) —
  OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Iam::V1::Policy)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 3177

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
  call_metadata = @config.rpcs.get_iam_policy.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @data_catalog_stub.get_iam_policy request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_tag_template(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplate` #get_tag_template(name: nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplate`

Gets a tag template.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::GetTagTemplateRequest.new

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

# The returned object is of type Google::Cloud::DataCatalog::V1::TagTemplate.
p result

Overloads:

#get_tag_template(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplate

Pass arguments to get_tag_template via a request object, either of type GetTagTemplateRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::GetTagTemplateRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#get_tag_template(name: nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplate

Pass arguments to get_tag_template via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the tag template to get.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::DataCatalog::V1::TagTemplate)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::DataCatalog::V1::TagTemplate)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 1713

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::GetTagTemplateRequest

  # 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
  call_metadata = @config.rpcs.get_tag_template.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_tag_template.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_tag_template.retry_policy

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

  @data_catalog_stub.get_tag_template request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#import_entries(request, options = nil) ⇒ `::Gapic::Operation` #import_entries(parent: nil, gcs_bucket_path: nil, job_id: nil) ⇒ `::Gapic::Operation`

Imports entries from a source, such as data previously dumped into a Cloud Storage bucket, into Data Catalog. Import of entries is a sync operation that reconciles the state of the third-party system with the Data Catalog.

ImportEntries accepts source data snapshots of a third-party system. Snapshot should be delivered as a .wire or base65-encoded .txt file containing a sequence of Protocol Buffer messages of DumpItem type.

ImportEntries returns a [long-running operation] [google.longrunning.Operation] resource that can be queried with Operations.GetOperation to return ImportEntriesMetadata and an ImportEntriesResponse message.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::ImportEntriesRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

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

Pass arguments to import_entries via a request object, either of type ImportEntriesRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::ImportEntriesRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#import_entries(parent: nil, gcs_bucket_path: nil, job_id: nil) ⇒ ::Gapic::Operation

Pass arguments to import_entries via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Target entry group for ingested entries.
- gcs_bucket_path (::String) (defaults to: nil) —
  Path to a Cloud Storage bucket that contains a dump ready for ingestion.
- job_id (::String) (defaults to: nil) —
  Optional. (Optional) Dataplex task job id, if specified will be used as part of ImportEntries LRO ID

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 3381

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::ImportEntriesRequest

  # 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
  call_metadata = @config.rpcs.import_entries.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.import_entries.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.import_entries.retry_policy

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

  @data_catalog_stub.import_entries request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_entries(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Entry>` #list_entries(parent: nil, page_size: nil, page_token: nil, read_mask: nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Entry>`

Lists entries.

Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use SearchCatalog.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::ListEntriesRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DataCatalog::V1::Entry.
  p item
end

Overloads:

#list_entries(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Entry>

Pass arguments to list_entries via a request object, either of type ListEntriesRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::ListEntriesRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#list_entries(parent: nil, page_size: nil, page_token: nil, read_mask: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Entry>

Pass arguments to list_entries via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The name of the entry group that contains the entries to list.
  
  Can be provided in URL format.
- page_size (::Integer) (defaults to: nil) —
  The maximum number of items to return. Default is 10. Maximum limit is
  1. Throws an invalid argument if page_size is more than 1000.
- page_token (::String) (defaults to: nil) —
  Pagination token that specifies the next page to return. If empty, the first page is returned.
- read_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  The fields to return for each entry. If empty or omitted, all fields are returned.
  
  For example, to return a list of entries with only the name field, set read_mask to only one path with the name value.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Entry>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Entry>)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 1374

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::ListEntriesRequest

  # 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
  call_metadata = @config.rpcs.list_entries.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_entries.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_entries.retry_policy

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

  @data_catalog_stub.list_entries request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @data_catalog_stub, :list_entries, "entries", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_entry_groups(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::EntryGroup>` #list_entry_groups(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::EntryGroup>`

Lists entry groups.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::ListEntryGroupsRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DataCatalog::V1::EntryGroup.
  p item
end

Overloads:

#list_entry_groups(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::EntryGroup>

Pass arguments to list_entry_groups via a request object, either of type ListEntryGroupsRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::ListEntryGroupsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#list_entry_groups(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::EntryGroup>

Pass arguments to list_entry_groups via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The name of the location that contains the entry groups to list.
  
  Can be provided as a URL.
- page_size (::Integer) (defaults to: nil) —
  Optional. The maximum number of items to return.
  
  Default is 10. Maximum limit is 1000. Throws an invalid argument if page_size is greater than 1000.
- page_token (::String) (defaults to: nil) —
  Optional. Pagination token that specifies the next page to return. If empty, returns the first page.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::EntryGroup>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::EntryGroup>)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 769

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::ListEntryGroupsRequest

  # 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
  call_metadata = @config.rpcs.list_entry_groups.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_entry_groups.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_entry_groups.retry_policy

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

  @data_catalog_stub.list_entry_groups request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @data_catalog_stub, :list_entry_groups, "entry_groups", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

Lists tags assigned to an Entry. The columns in the response are lowercased.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::ListTagsRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DataCatalog::V1::Tag.
  p item
end

Overloads:

#list_tags(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Tag>

Pass arguments to list_tags via a request object, either of type ListTagsRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::ListTagsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#list_tags(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Tag>

Pass arguments to list_tags via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The name of the Data Catalog resource to list the tags of.
  
  The resource can be an Entry or an EntryGroup (without /entries/{entries} at the end).
- page_size (::Integer) (defaults to: nil) —
  The maximum number of tags to return. Default is 10. Maximum limit is 1000.
- page_token (::String) (defaults to: nil) —
  Pagination token that specifies the next page to return. If empty, the first page is returned.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Tag>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Tag>)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 2701

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::ListTagsRequest

  # 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
  call_metadata = @config.rpcs.list_tags.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_tags.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_tags.retry_policy

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

  @data_catalog_stub.list_tags request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @data_catalog_stub, :list_tags, "tags", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#lookup_entry(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::Entry` #lookup_entry(linked_resource: nil, sql_resource: nil, fully_qualified_name: nil, project: nil, location: nil) ⇒ `::Google::Cloud::DataCatalog::V1::Entry`

Gets an entry by its target resource name.

The resource name comes from the source Google Cloud Platform service.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::LookupEntryRequest.new

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

# The returned object is of type Google::Cloud::DataCatalog::V1::Entry.
p result

Overloads:

#lookup_entry(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::Entry

Pass arguments to lookup_entry via a request object, either of type LookupEntryRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::LookupEntryRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#lookup_entry(linked_resource: nil, sql_resource: nil, fully_qualified_name: nil, project: nil, location: nil) ⇒ ::Google::Cloud::DataCatalog::V1::Entry

Pass arguments to lookup_entry 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:
- linked_resource (::String) (defaults to: nil) —
  The full name of the Google Cloud Platform resource the Data Catalog entry represents. For more information, see Full Resource Name.
  
  Full names are case-sensitive. For example:
  - //bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}
  - //pubsub.googleapis.com/projects/{PROJECT_ID}/topics/{TOPIC_ID}
- sql_resource (::String) (defaults to: nil) —
  The SQL name of the entry. SQL names are case-sensitive.
  
  Examples:
  - pubsub.topic.{PROJECT_ID}.{TOPIC_ID}
  - pubsub.topic.{PROJECT_ID}.`{TOPIC.ID.SEPARATED.WITH.DOTS}`
  - bigquery.table.{PROJECT_ID}.{DATASET_ID}.{TABLE_ID}
  - bigquery.dataset.{PROJECT_ID}.{DATASET_ID}
  - datacatalog.entry.{PROJECT_ID}.{LOCATION_ID}.{ENTRY_GROUP_ID}.{ENTRY_ID}
  Identifiers (*_ID) should comply with the Lexical structure in Standard SQL.
- fully_qualified_name (::String) (defaults to: nil) —
  Fully Qualified Name (FQN) of the resource.
  
  FQNs take two forms:
  - For non-regionalized resources:
  {SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}
  - For regionalized resources:
  {SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}
  
  Example for a DPMS table:
  
  dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}
- project (::String) (defaults to: nil) —
  Project where the lookup should be performed. Required to lookup entry that is not a part of DPMS or DATAPLEX integrated_system using its fully_qualified_name. Ignored in other cases.
- location (::String) (defaults to: nil) —
  Location where the lookup should be performed. Required to lookup entry that is not a part of DPMS or DATAPLEX integrated_system using its fully_qualified_name. Ignored in other cases.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::DataCatalog::V1::Entry)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::DataCatalog::V1::Entry)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 1274

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::LookupEntryRequest

  # 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
  call_metadata = @config.rpcs.lookup_entry.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.lookup_entry.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.lookup_entry.retry_policy

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

  @data_catalog_stub.lookup_entry request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#modify_entry_contacts(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::Contacts` #modify_entry_contacts(name: nil, contacts: nil) ⇒ `::Google::Cloud::DataCatalog::V1::Contacts`

Modifies contacts, part of the business context of an Entry.

To call this method, you must have the datacatalog.entries.updateContacts IAM permission on the corresponding project.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::ModifyEntryContactsRequest.new

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

# The returned object is of type Google::Cloud::DataCatalog::V1::Contacts.
p result

Overloads:

#modify_entry_contacts(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::Contacts

Pass arguments to modify_entry_contacts via a request object, either of type ModifyEntryContactsRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::ModifyEntryContactsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#modify_entry_contacts(name: nil, contacts: nil) ⇒ ::Google::Cloud::DataCatalog::V1::Contacts

Pass arguments to modify_entry_contacts via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The full resource name of the entry.
- contacts (::Google::Cloud::DataCatalog::V1::Contacts, ::Hash) (defaults to: nil) —
  Required. The new value for the Contacts.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::DataCatalog::V1::Contacts)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::DataCatalog::V1::Contacts)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 1543

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::ModifyEntryContactsRequest

  # 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
  call_metadata = @config.rpcs.modify_entry_contacts.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.modify_entry_contacts.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.modify_entry_contacts.retry_policy

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

  @data_catalog_stub.modify_entry_contacts request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#modify_entry_overview(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::EntryOverview` #modify_entry_overview(name: nil, entry_overview: nil) ⇒ `::Google::Cloud::DataCatalog::V1::EntryOverview`

Modifies entry overview, part of the business context of an Entry.

To call this method, you must have the datacatalog.entries.updateOverview IAM permission on the corresponding project.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::ModifyEntryOverviewRequest.new

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

# The returned object is of type Google::Cloud::DataCatalog::V1::EntryOverview.
p result

Overloads:

#modify_entry_overview(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::EntryOverview

Pass arguments to modify_entry_overview via a request object, either of type ModifyEntryOverviewRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::ModifyEntryOverviewRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#modify_entry_overview(name: nil, entry_overview: nil) ⇒ ::Google::Cloud::DataCatalog::V1::EntryOverview

Pass arguments to modify_entry_overview via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The full resource name of the entry.
- entry_overview (::Google::Cloud::DataCatalog::V1::EntryOverview, ::Hash) (defaults to: nil) —
  Required. The new value for the Entry Overview.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::DataCatalog::V1::EntryOverview)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::DataCatalog::V1::EntryOverview)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 1459

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::ModifyEntryOverviewRequest

  # 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
  call_metadata = @config.rpcs.modify_entry_overview.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.modify_entry_overview.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.modify_entry_overview.retry_policy

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

  @data_catalog_stub.modify_entry_overview request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#reconcile_tags(request, options = nil) ⇒ `::Gapic::Operation` #reconcile_tags(parent: nil, tag_template: nil, force_delete_missing: nil, tags: nil) ⇒ `::Gapic::Operation`

ReconcileTags creates or updates a list of tags on the entry. If the ReconcileTagsRequest.force_delete_missing parameter is set, the operation deletes tags not included in the input tag list.

ReconcileTags returns a [long-running operation] [google.longrunning.Operation] resource that can be queried with Operations.GetOperation to return [ReconcileTagsMetadata] [google.cloud.datacatalog.v1.ReconcileTagsMetadata] and a [ReconcileTagsResponse] [google.cloud.datacatalog.v1.ReconcileTagsResponse] message.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::ReconcileTagsRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

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

Pass arguments to reconcile_tags via a request object, either of type ReconcileTagsRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::ReconcileTagsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#reconcile_tags(parent: nil, tag_template: nil, force_delete_missing: nil, tags: nil) ⇒ ::Gapic::Operation

Pass arguments to reconcile_tags via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Name of Entry to be tagged.
- tag_template (::String) (defaults to: nil) —
  Required. The name of the tag template, which is used for reconciliation.
- force_delete_missing (::Boolean) (defaults to: nil) —
  If set to true, deletes entry tags related to a tag template not listed in the tags source from an entry. If set to false, unlisted tags are retained.
- tags (::Array<::Google::Cloud::DataCatalog::V1::Tag, ::Hash>) (defaults to: nil) —
  A list of tags to apply to an entry. A tag can specify a tag template, which must be the template specified in the ReconcileTagsRequest. The sole entry and each of its columns must be mentioned at most once.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Operation)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 2810

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::ReconcileTagsRequest

  # 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
  call_metadata = @config.rpcs.reconcile_tags.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.reconcile_tags.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.reconcile_tags.retry_policy

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

  @data_catalog_stub.reconcile_tags request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#rename_tag_template_field(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplateField` #rename_tag_template_field(name: nil, new_tag_template_field_id: nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplateField`

Renames a field in a tag template.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::RenameTagTemplateFieldRequest.new

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

# The returned object is of type Google::Cloud::DataCatalog::V1::TagTemplateField.
p result

Overloads:

#rename_tag_template_field(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplateField

Pass arguments to rename_tag_template_field via a request object, either of type RenameTagTemplateFieldRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::RenameTagTemplateFieldRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#rename_tag_template_field(name: nil, new_tag_template_field_id: nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplateField

Pass arguments to rename_tag_template_field via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the tag template field.
- new_tag_template_field_id (::String) (defaults to: nil) —
  Required. The new ID of this tag template field. For example, my_new_field.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::DataCatalog::V1::TagTemplateField)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::DataCatalog::V1::TagTemplateField)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 2178

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::RenameTagTemplateFieldRequest

  # 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
  call_metadata = @config.rpcs.rename_tag_template_field.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.rename_tag_template_field.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.rename_tag_template_field.retry_policy

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

  @data_catalog_stub.rename_tag_template_field request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#rename_tag_template_field_enum_value(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplateField` #rename_tag_template_field_enum_value(name: nil, new_enum_value_display_name: nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplateField`

Renames an enum value in a tag template.

Within a single enum field, enum values must be unique.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::RenameTagTemplateFieldEnumValueRequest.new

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

# The returned object is of type Google::Cloud::DataCatalog::V1::TagTemplateField.
p result

Overloads:

#rename_tag_template_field_enum_value(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplateField

Pass arguments to rename_tag_template_field_enum_value via a request object, either of type RenameTagTemplateFieldEnumValueRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::RenameTagTemplateFieldEnumValueRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#rename_tag_template_field_enum_value(name: nil, new_enum_value_display_name: nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplateField

Pass arguments to rename_tag_template_field_enum_value via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the enum field value.
- new_enum_value_display_name (::String) (defaults to: nil) —
  Required. The new display name of the enum value. For example, my_new_enum_value.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::DataCatalog::V1::TagTemplateField)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::DataCatalog::V1::TagTemplateField)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 2261

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::RenameTagTemplateFieldEnumValueRequest

  # 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
  call_metadata = @config.rpcs.rename_tag_template_field_enum_value.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.rename_tag_template_field_enum_value.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.rename_tag_template_field_enum_value.retry_policy

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

  @data_catalog_stub.rename_tag_template_field_enum_value request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#search_catalog(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::SearchCatalogResponse` #search_catalog(scope: nil, query: nil, page_size: nil, page_token: nil, order_by: nil, admin_search: nil) ⇒ `::Google::Cloud::DataCatalog::V1::SearchCatalogResponse`

Searches Data Catalog for multiple resources like entries and tags that match a query.

This is a Custom Method that doesn't return all information on a resource, only its ID and high level fields. To get more information, you can subsequently call specific get methods.

Note: Data Catalog search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries.

For more information, see Data Catalog search syntax.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::SearchCatalogRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DataCatalog::V1::SearchCatalogResult.
  p item
end

Overloads:

#search_catalog(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::SearchCatalogResponse

Pass arguments to search_catalog via a request object, either of type SearchCatalogRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::SearchCatalogRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#search_catalog(scope: nil, query: nil, page_size: nil, page_token: nil, order_by: nil, admin_search: nil) ⇒ ::Google::Cloud::DataCatalog::V1::SearchCatalogResponse

Pass arguments to search_catalog 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:
- scope (::Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope, ::Hash) (defaults to: nil) —
  Required. The scope of this search request.
  
  The scope is invalid if include_org_ids, include_project_ids are empty AND include_gcp_public_datasets is set to false. In this case, the request returns an error.
- query (::String) (defaults to: nil) —
  Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see Data Catalog search syntax.
  
  An empty query string returns all data assets (in the specified scope) that you have access to.
  
  A query string can be a simple xyz or qualified by predicates:
  - name:x
  - column:y
  - description:z
- page_size (::Integer) (defaults to: nil) —
  Upper bound on the number of results you can get in a single response.
  
  Can't be negative or 0, defaults to 10 in this case. The maximum number is 1000. If exceeded, throws an "invalid argument" exception.
- page_token (::String) (defaults to: nil) —
  Optional. Pagination token that, if specified, returns the next page of search results. If empty, returns the first page.
  
  This token is returned in the SearchCatalogResponse.next_page_token field of the response to a previous SearchCatalogRequest call.
- order_by (::String) (defaults to: nil) —
  Specifies the order of results.
  
  Currently supported case-sensitive values are:
  - relevance that can only be descending
  - last_modified_timestamp [asc|desc] with descending (desc) as default
  - default that can only be descending
  Search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries. If you are experiencing recall issues and you don't have to fetch the results in any specific order, consider setting this parameter to default.
  
  If this parameter is omitted, it defaults to the descending relevance.
- admin_search (::Boolean) (defaults to: nil) —
  Optional. If set, use searchAll permission granted on organizations from include_org_ids and projects from include_project_ids instead of the fine grained per resource permissions when filtering the search results. The only allowed order_by criteria for admin_search mode is default. Using this flags guarantees a full recall of the search results.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::DataCatalog::V1::SearchCatalogResponse)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::DataCatalog::V1::SearchCatalogResponse)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 307

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::SearchCatalogRequest

  # 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
  call_metadata = @config.rpcs.search_catalog.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.search_catalog.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.search_catalog.retry_policy

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

  @data_catalog_stub.search_catalog request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Sets an access control policy for a resource. Replaces any existing policy.

Supported resources are:

Tag templates
Entry groups

Note: This method sets policies only within Data Catalog and can't be used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources synced with the Data Catalog.

To call this method, you must have the following Google IAM permissions:

datacatalog.tagTemplates.setIamPolicy to set policies on tag templates.
datacatalog.entryGroups.setIamPolicy to set policies on entry groups.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

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

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

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

Overloads:

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

Pass arguments to set_iam_policy via a request object, either of type Iam::V1::SetIamPolicyRequest or an equivalent Hash.
Parameters:
- request (::Google::Iam::V1::SetIamPolicyRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#set_iam_policy(resource: nil, policy: nil, update_mask: nil) ⇒ ::Google::Iam::V1::Policy

Pass arguments to set_iam_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- resource (::String) (defaults to: nil) —
  REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
- policy (::Google::Iam::V1::Policy, ::Hash) (defaults to: nil) —
  REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:
  
  paths: "bindings, etag"

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Iam::V1::Policy)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 3075

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
  call_metadata = @config.rpcs.set_iam_policy.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @data_catalog_stub.set_iam_policy request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#star_entry(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::StarEntryResponse` #star_entry(name: nil) ⇒ `::Google::Cloud::DataCatalog::V1::StarEntryResponse`

Marks an Entry as starred by the current user. Starring information is private to each user.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::StarEntryRequest.new

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

# The returned object is of type Google::Cloud::DataCatalog::V1::StarEntryResponse.
p result

Overloads:

#star_entry(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::StarEntryResponse

Pass arguments to star_entry via a request object, either of type StarEntryRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::StarEntryRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#star_entry(name: nil) ⇒ ::Google::Cloud::DataCatalog::V1::StarEntryResponse

Pass arguments to star_entry via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the entry to mark as starred.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::DataCatalog::V1::StarEntryResponse)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::DataCatalog::V1::StarEntryResponse)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 2890

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::StarEntryRequest

  # 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
  call_metadata = @config.rpcs.star_entry.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.star_entry.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.star_entry.retry_policy

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

  @data_catalog_stub.star_entry request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Gets your permissions on a resource.

Returns an empty set of permissions if the resource doesn't exist.

Supported resources are:

Tag templates
Entry groups

Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog.

No Google IAM permissions are required to call this method.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

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

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

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

Overloads:

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

Pass arguments to test_iam_permissions via a request object, either of type Iam::V1::TestIamPermissionsRequest or an equivalent Hash.
Parameters:
- request (::Google::Iam::V1::TestIamPermissionsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#test_iam_permissions(resource: nil, permissions: nil) ⇒ ::Google::Iam::V1::TestIamPermissionsResponse

Pass arguments to test_iam_permissions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- resource (::String) (defaults to: nil) —
  REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
- permissions (::Array<::String>) (defaults to: nil) —
  The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Iam::V1::TestIamPermissionsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 3274

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
  call_metadata = @config.rpcs.test_iam_permissions.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @data_catalog_stub.test_iam_permissions request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ `String`

The effective universe domain

Returns:

(String)



110
111
112

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 110

def universe_domain
  @data_catalog_stub.universe_domain
end

#unstar_entry(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::UnstarEntryResponse` #unstar_entry(name: nil) ⇒ `::Google::Cloud::DataCatalog::V1::UnstarEntryResponse`

Marks an Entry as NOT starred by the current user. Starring information is private to each user.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::UnstarEntryRequest.new

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

# The returned object is of type Google::Cloud::DataCatalog::V1::UnstarEntryResponse.
p result

Overloads:

#unstar_entry(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::UnstarEntryResponse

Pass arguments to unstar_entry via a request object, either of type UnstarEntryRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::UnstarEntryRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#unstar_entry(name: nil) ⇒ ::Google::Cloud::DataCatalog::V1::UnstarEntryResponse

Pass arguments to unstar_entry via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the entry to mark as not starred.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::DataCatalog::V1::UnstarEntryResponse)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::DataCatalog::V1::UnstarEntryResponse)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 2969

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::UnstarEntryRequest

  # 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
  call_metadata = @config.rpcs.unstar_entry.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.unstar_entry.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.unstar_entry.retry_policy

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

  @data_catalog_stub.unstar_entry request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_entry(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::Entry` #update_entry(entry: nil, update_mask: nil) ⇒ `::Google::Cloud::DataCatalog::V1::Entry`

Updates an existing entry.

You must enable the Data Catalog API in the project identified by the entry.name parameter. For more information, see Data Catalog resource project.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::UpdateEntryRequest.new

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

# The returned object is of type Google::Cloud::DataCatalog::V1::Entry.
p result

Overloads:

#update_entry(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::Entry

Pass arguments to update_entry via a request object, either of type UpdateEntryRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::UpdateEntryRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#update_entry(entry: nil, update_mask: nil) ⇒ ::Google::Cloud::DataCatalog::V1::Entry

Pass arguments to update_entry 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:
- entry (::Google::Cloud::DataCatalog::V1::Entry, ::Hash) (defaults to: nil) —
  Required. Updates for the entry. The name field must be set.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Names of fields whose values to overwrite on an entry.
  
  If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.
  
  You can modify only the fields listed below.
  
  For entries with type DATA_STREAM:
  - schema
  For entries with type FILESET:
  - schema
  - display_name
  - description
  - gcs_fileset_spec
  - gcs_fileset_spec.file_patterns
  For entries with user_specified_type:
  - schema
  - display_name
  - description
  - user_specified_type
  - user_specified_system
  - linked_resource
  - source_system_timestamps

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::DataCatalog::V1::Entry)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::DataCatalog::V1::Entry)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 982

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::UpdateEntryRequest

  # 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
  call_metadata = @config.rpcs.update_entry.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_entry.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_entry.retry_policy

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

  @data_catalog_stub.update_entry request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_entry_group(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::EntryGroup` #update_entry_group(entry_group: nil, update_mask: nil) ⇒ `::Google::Cloud::DataCatalog::V1::EntryGroup`

Updates an entry group.

You must enable the Data Catalog API in the project identified by the entry_group.name parameter. For more information, see Data Catalog resource project.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::UpdateEntryGroupRequest.new

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

# The returned object is of type Google::Cloud::DataCatalog::V1::EntryGroup.
p result

Overloads:

#update_entry_group(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::EntryGroup

Pass arguments to update_entry_group via a request object, either of type UpdateEntryGroupRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::UpdateEntryGroupRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#update_entry_group(entry_group: nil, update_mask: nil) ⇒ ::Google::Cloud::DataCatalog::V1::EntryGroup

Pass arguments to update_entry_group 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:
- entry_group (::Google::Cloud::DataCatalog::V1::EntryGroup, ::Hash) (defaults to: nil) —
  Required. Updates for the entry group. The name field must be set.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Names of fields whose values to overwrite on an entry group.
  
  If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::DataCatalog::V1::EntryGroup)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::DataCatalog::V1::EntryGroup)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 592

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::UpdateEntryGroupRequest

  # 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
  call_metadata = @config.rpcs.update_entry_group.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_entry_group.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_entry_group.retry_policy

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

  @data_catalog_stub.update_entry_group request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_tag(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::Tag` #update_tag(tag: nil, update_mask: nil) ⇒ `::Google::Cloud::DataCatalog::V1::Tag`

Updates an existing tag.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::UpdateTagRequest.new

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

# The returned object is of type Google::Cloud::DataCatalog::V1::Tag.
p result

Overloads:

#update_tag(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::Tag

Pass arguments to update_tag via a request object, either of type UpdateTagRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::UpdateTagRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#update_tag(tag: nil, update_mask: nil) ⇒ ::Google::Cloud::DataCatalog::V1::Tag

Pass arguments to update_tag 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:
- tag (::Google::Cloud::DataCatalog::V1::Tag, ::Hash) (defaults to: nil) —
  Required. The updated tag. The "name" field must be set.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Names of fields whose values to overwrite on a tag. Currently, a tag has the only modifiable field with the name fields.
  
  In general, if this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::DataCatalog::V1::Tag)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::DataCatalog::V1::Tag)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 2530

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::UpdateTagRequest

  # 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
  call_metadata = @config.rpcs.update_tag.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_tag.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_tag.retry_policy

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

  @data_catalog_stub.update_tag request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_tag_template(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplate` #update_tag_template(tag_template: nil, update_mask: nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplate`

Updates a tag template.

You can't update template fields with this method. These fields are separate resources with their own create, update, and delete methods.

You must enable the Data Catalog API in the project identified by the tag_template.name parameter. For more information, see Data Catalog resource project.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::UpdateTagTemplateRequest.new

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

# The returned object is of type Google::Cloud::DataCatalog::V1::TagTemplate.
p result

Overloads:

#update_tag_template(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplate

Pass arguments to update_tag_template via a request object, either of type UpdateTagTemplateRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::UpdateTagTemplateRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#update_tag_template(tag_template: nil, update_mask: nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplate

Pass arguments to update_tag_template via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- tag_template (::Google::Cloud::DataCatalog::V1::TagTemplate, ::Hash) (defaults to: nil) —
  Required. The template to update. The name field must be set.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Names of fields whose values to overwrite on a tag template. Currently, only display_name and is_publicly_readable can be overwritten.
  
  If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.
  
  Note: Updating the is_publicly_readable field may require up to 12 hours to take effect in search results.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::DataCatalog::V1::TagTemplate)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::DataCatalog::V1::TagTemplate)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 1809

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::UpdateTagTemplateRequest

  # 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
  call_metadata = @config.rpcs.update_tag_template.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_tag_template.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_tag_template.retry_policy

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

  @data_catalog_stub.update_tag_template request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_tag_template_field(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplateField` #update_tag_template_field(name: nil, tag_template_field: nil, update_mask: nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplateField`

Updates a field in a tag template.

You can't update the field type with this method.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Examples:

Basic example

require "google/cloud/data_catalog/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DataCatalog::V1::UpdateTagTemplateFieldRequest.new

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

# The returned object is of type Google::Cloud::DataCatalog::V1::TagTemplateField.
p result

Overloads:

#update_tag_template_field(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplateField

Pass arguments to update_tag_template_field via a request object, either of type UpdateTagTemplateFieldRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::DataCatalog::V1::UpdateTagTemplateFieldRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#update_tag_template_field(name: nil, tag_template_field: nil, update_mask: nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplateField

Pass arguments to update_tag_template_field via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the tag template field.
- tag_template_field (::Google::Cloud::DataCatalog::V1::TagTemplateField, ::Hash) (defaults to: nil) —
  Required. The template to update.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Optional. Names of fields whose values to overwrite on an individual field of a tag template. The following fields are modifiable:
  - display_name
  - type.enum_type
  - is_required
  If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied with one exception: when updating an enum type, the provided values are merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted or renamed.
  
  Additionally, updating a template field from optional to required is not allowed.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::DataCatalog::V1::TagTemplateField)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::DataCatalog::V1::TagTemplateField)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb', line 2093

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::UpdateTagTemplateFieldRequest

  # 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
  call_metadata = @config.rpcs.update_tag_template_field.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::DataCatalog::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_tag_template_field.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_tag_template_field.retry_policy

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

  @data_catalog_stub.update_tag_template_field request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

Class: Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Client

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

Constructor Details

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

Instance Attribute Details

#iam_policy_client ⇒ Google::Iam::V1::IAMPolicy::Rest::Client (readonly)

#operations_client ⇒ ::Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Operations (readonly)

Class Method Details

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

Instance Method Details

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

#create_entry(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::Entry #create_entry(parent: nil, entry_id: nil, entry: nil) ⇒ ::Google::Cloud::DataCatalog::V1::Entry

#create_entry_group(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::EntryGroup #create_entry_group(parent: nil, entry_group_id: nil, entry_group: nil) ⇒ ::Google::Cloud::DataCatalog::V1::EntryGroup

#create_tag(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::Tag #create_tag(parent: nil, tag: nil) ⇒ ::Google::Cloud::DataCatalog::V1::Tag

#create_tag_template(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplate #create_tag_template(parent: nil, tag_template_id: nil, tag_template: nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplate

#create_tag_template_field(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplateField #create_tag_template_field(parent: nil, tag_template_field_id: nil, tag_template_field: nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplateField

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

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

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

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

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

#get_entry(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::Entry #get_entry(name: nil) ⇒ ::Google::Cloud::DataCatalog::V1::Entry

#get_entry_group(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::EntryGroup #get_entry_group(name: nil, read_mask: nil) ⇒ ::Google::Cloud::DataCatalog::V1::EntryGroup

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

#get_tag_template(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplate #get_tag_template(name: nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplate

#import_entries(request, options = nil) ⇒ ::Gapic::Operation #import_entries(parent: nil, gcs_bucket_path: nil, job_id: nil) ⇒ ::Gapic::Operation

#list_entries(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Entry> #list_entries(parent: nil, page_size: nil, page_token: nil, read_mask: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Entry>

#list_entry_groups(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::EntryGroup> #list_entry_groups(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::EntryGroup>

#list_tags(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Tag> #list_tags(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Tag>

#lookup_entry(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::Entry #lookup_entry(linked_resource: nil, sql_resource: nil, fully_qualified_name: nil, project: nil, location: nil) ⇒ ::Google::Cloud::DataCatalog::V1::Entry

#modify_entry_contacts(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::Contacts #modify_entry_contacts(name: nil, contacts: nil) ⇒ ::Google::Cloud::DataCatalog::V1::Contacts

#modify_entry_overview(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::EntryOverview #modify_entry_overview(name: nil, entry_overview: nil) ⇒ ::Google::Cloud::DataCatalog::V1::EntryOverview

#reconcile_tags(request, options = nil) ⇒ ::Gapic::Operation #reconcile_tags(parent: nil, tag_template: nil, force_delete_missing: nil, tags: nil) ⇒ ::Gapic::Operation

#rename_tag_template_field(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplateField #rename_tag_template_field(name: nil, new_tag_template_field_id: nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplateField

#rename_tag_template_field_enum_value(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplateField #rename_tag_template_field_enum_value(name: nil, new_enum_value_display_name: nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplateField

#search_catalog(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::SearchCatalogResponse #search_catalog(scope: nil, query: nil, page_size: nil, page_token: nil, order_by: nil, admin_search: nil) ⇒ ::Google::Cloud::DataCatalog::V1::SearchCatalogResponse

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

#star_entry(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::StarEntryResponse #star_entry(name: nil) ⇒ ::Google::Cloud::DataCatalog::V1::StarEntryResponse

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

#universe_domain ⇒ String

#unstar_entry(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::UnstarEntryResponse #unstar_entry(name: nil) ⇒ ::Google::Cloud::DataCatalog::V1::UnstarEntryResponse

#update_entry(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::Entry #update_entry(entry: nil, update_mask: nil) ⇒ ::Google::Cloud::DataCatalog::V1::Entry

#update_entry_group(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::EntryGroup #update_entry_group(entry_group: nil, update_mask: nil) ⇒ ::Google::Cloud::DataCatalog::V1::EntryGroup

#update_tag(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::Tag #update_tag(tag: nil, update_mask: nil) ⇒ ::Google::Cloud::DataCatalog::V1::Tag

#update_tag_template(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplate #update_tag_template(tag_template: nil, update_mask: nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplate

#update_tag_template_field(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplateField #update_tag_template_field(name: nil, tag_template_field: nil, update_mask: nil) ⇒ ::Google::Cloud::DataCatalog::V1::TagTemplateField

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

#iam_policy_client ⇒ `Google::Iam::V1::IAMPolicy::Rest::Client` (readonly)

#operations_client ⇒ `::Google::Cloud::DataCatalog::V1::DataCatalog::Rest::Operations` (readonly)

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

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

#create_entry(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::Entry` #create_entry(parent: nil, entry_id: nil, entry: nil) ⇒ `::Google::Cloud::DataCatalog::V1::Entry`

#create_entry_group(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::EntryGroup` #create_entry_group(parent: nil, entry_group_id: nil, entry_group: nil) ⇒ `::Google::Cloud::DataCatalog::V1::EntryGroup`

#create_tag(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::Tag` #create_tag(parent: nil, tag: nil) ⇒ `::Google::Cloud::DataCatalog::V1::Tag`

#create_tag_template(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplate` #create_tag_template(parent: nil, tag_template_id: nil, tag_template: nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplate`

#create_tag_template_field(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplateField` #create_tag_template_field(parent: nil, tag_template_field_id: nil, tag_template_field: nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplateField`

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

#delete_entry_group(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_entry_group(name: nil, force: nil) ⇒ `::Google::Protobuf::Empty`

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

#delete_tag_template(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_tag_template(name: nil, force: nil) ⇒ `::Google::Protobuf::Empty`

#delete_tag_template_field(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_tag_template_field(name: nil, force: nil) ⇒ `::Google::Protobuf::Empty`

#get_entry(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::Entry` #get_entry(name: nil) ⇒ `::Google::Cloud::DataCatalog::V1::Entry`

#get_entry_group(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::EntryGroup` #get_entry_group(name: nil, read_mask: nil) ⇒ `::Google::Cloud::DataCatalog::V1::EntryGroup`

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

#get_tag_template(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplate` #get_tag_template(name: nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplate`

#import_entries(request, options = nil) ⇒ `::Gapic::Operation` #import_entries(parent: nil, gcs_bucket_path: nil, job_id: nil) ⇒ `::Gapic::Operation`

#list_entries(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Entry>` #list_entries(parent: nil, page_size: nil, page_token: nil, read_mask: nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Entry>`

#list_entry_groups(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::EntryGroup>` #list_entry_groups(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::EntryGroup>`

#list_tags(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Tag>` #list_tags(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Tag>`

#lookup_entry(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::Entry` #lookup_entry(linked_resource: nil, sql_resource: nil, fully_qualified_name: nil, project: nil, location: nil) ⇒ `::Google::Cloud::DataCatalog::V1::Entry`

#modify_entry_contacts(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::Contacts` #modify_entry_contacts(name: nil, contacts: nil) ⇒ `::Google::Cloud::DataCatalog::V1::Contacts`

#modify_entry_overview(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::EntryOverview` #modify_entry_overview(name: nil, entry_overview: nil) ⇒ `::Google::Cloud::DataCatalog::V1::EntryOverview`

#reconcile_tags(request, options = nil) ⇒ `::Gapic::Operation` #reconcile_tags(parent: nil, tag_template: nil, force_delete_missing: nil, tags: nil) ⇒ `::Gapic::Operation`

#rename_tag_template_field(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplateField` #rename_tag_template_field(name: nil, new_tag_template_field_id: nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplateField`

#rename_tag_template_field_enum_value(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplateField` #rename_tag_template_field_enum_value(name: nil, new_enum_value_display_name: nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplateField`

#search_catalog(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::SearchCatalogResponse` #search_catalog(scope: nil, query: nil, page_size: nil, page_token: nil, order_by: nil, admin_search: nil) ⇒ `::Google::Cloud::DataCatalog::V1::SearchCatalogResponse`

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

#star_entry(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::StarEntryResponse` #star_entry(name: nil) ⇒ `::Google::Cloud::DataCatalog::V1::StarEntryResponse`

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

#universe_domain ⇒ `String`

#unstar_entry(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::UnstarEntryResponse` #unstar_entry(name: nil) ⇒ `::Google::Cloud::DataCatalog::V1::UnstarEntryResponse`

#update_entry(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::Entry` #update_entry(entry: nil, update_mask: nil) ⇒ `::Google::Cloud::DataCatalog::V1::Entry`

#update_entry_group(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::EntryGroup` #update_entry_group(entry_group: nil, update_mask: nil) ⇒ `::Google::Cloud::DataCatalog::V1::EntryGroup`

#update_tag(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::Tag` #update_tag(tag: nil, update_mask: nil) ⇒ `::Google::Cloud::DataCatalog::V1::Tag`

#update_tag_template(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplate` #update_tag_template(tag_template: nil, update_mask: nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplate`

#update_tag_template_field(request, options = nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplateField` #update_tag_template_field(name: nil, tag_template_field: nil, update_mask: nil) ⇒ `::Google::Cloud::DataCatalog::V1::TagTemplateField`