Dataplex V1 API - Class Google::Cloud::Dataplex::V1::CatalogService::Client (v1.0.0)

Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::CatalogService::Client.

Client for the CatalogService service.

The primary resources offered by this service are EntryGroups, EntryTypes, AspectTypes, Entry and Aspect which collectively allow a data administrator to organize, manage, secure and catalog data across their organization located across cloud projects in a variety of storage systems including Cloud Storage and BigQuery.

Inherits

  • Object

Includes

Methods

.configure

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

Configure the CatalogService Client class.

See Configuration for a description of the configuration fields.

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

#configure

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

Configure the CatalogService Client instance.

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

See Configuration for a description of the configuration fields.

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

#create_aspect_type

def create_aspect_type(request, options = nil) -> ::Gapic::Operation
def create_aspect_type(parent: nil, aspect_type_id: nil, aspect_type: nil, validate_only: nil) -> ::Gapic::Operation

Creates an AspectType

Overloads 
def create_aspect_type(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_aspect_type via a request object, either of type Google::Cloud::Dataplex::V1::CreateAspectTypeRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::CreateAspectTypeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_aspect_type(parent: nil, aspect_type_id: nil, aspect_type: nil, validate_only: nil) -> ::Gapic::Operation
Pass arguments to create_aspect_type via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
  • aspect_type_id (::String) — Required. AspectType identifier.
  • aspect_type (::Google::Cloud::Dataplex::V1::AspectType, ::Hash) — Required. AspectType Resource
  • validate_only (::Boolean) — Optional. Only validate the request, but do not perform mutations. The default is false.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

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

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

# Call the create_aspect_type method.
result = client.create_aspect_type 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

#create_entry

def create_entry(request, options = nil) -> ::Google::Cloud::Dataplex::V1::Entry
def create_entry(parent: nil, entry_id: nil, entry: nil) -> ::Google::Cloud::Dataplex::V1::Entry

Creates an Entry.

Overloads 
def create_entry(request, options = nil) -> ::Google::Cloud::Dataplex::V1::Entry
Pass arguments to create_entry via a request object, either of type Google::Cloud::Dataplex::V1::CreateEntryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_entry(parent: nil, entry_id: nil, entry: nil) -> ::Google::Cloud::Dataplex::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) — Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.
  • entry_id (::String) — Required. Entry identifier. It has to be unique within an Entry Group.

    Entries corresponding to Google Cloud resources use Entry ID format based on Full Resource Names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a Full Resource Name of the resource without the prefix double slashes in the API Service Name part of Full Resource Name. This allows retrieval of entries using their associated resource name.

    For example if the Full Resource Name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.

    It is also suggested to follow the same convention for entries corresponding to resources from other providers or systems than Google Cloud.

    The maximum size of the field is 4000 characters.

  • entry (::Google::Cloud::Dataplex::V1::Entry, ::Hash) — Required. Entry resource.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

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

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

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

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

#create_entry_group

def create_entry_group(request, options = nil) -> ::Gapic::Operation
def create_entry_group(parent: nil, entry_group_id: nil, entry_group: nil, validate_only: nil) -> ::Gapic::Operation

Creates an EntryGroup

Overloads 
def create_entry_group(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_entry_group via a request object, either of type Google::Cloud::Dataplex::V1::CreateEntryGroupRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_entry_group(parent: nil, entry_group_id: nil, entry_group: nil, validate_only: nil) -> ::Gapic::Operation
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) — Required. The resource name of the entryGroup, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
  • entry_group_id (::String) — Required. EntryGroup identifier.
  • entry_group (::Google::Cloud::Dataplex::V1::EntryGroup, ::Hash) — Required. EntryGroup Resource
  • validate_only (::Boolean) — Optional. Only validate the request, but do not perform mutations. The default is false.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

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

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

# Call the create_entry_group method.
result = client.create_entry_group 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

#create_entry_type

def create_entry_type(request, options = nil) -> ::Gapic::Operation
def create_entry_type(parent: nil, entry_type_id: nil, entry_type: nil, validate_only: nil) -> ::Gapic::Operation

Creates an EntryType

Overloads 
def create_entry_type(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_entry_type via a request object, either of type Google::Cloud::Dataplex::V1::CreateEntryTypeRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::CreateEntryTypeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_entry_type(parent: nil, entry_type_id: nil, entry_type: nil, validate_only: nil) -> ::Gapic::Operation
Pass arguments to create_entry_type via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
  • entry_type_id (::String) — Required. EntryType identifier.
  • entry_type (::Google::Cloud::Dataplex::V1::EntryType, ::Hash) — Required. EntryType Resource
  • validate_only (::Boolean) — Optional. Only validate the request, but do not perform mutations. The default is false.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

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

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

# Call the create_entry_type method.
result = client.create_entry_type 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

#delete_aspect_type

def delete_aspect_type(request, options = nil) -> ::Gapic::Operation
def delete_aspect_type(name: nil, etag: nil) -> ::Gapic::Operation

Deletes a AspectType resource.

Overloads 
def delete_aspect_type(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_aspect_type via a request object, either of type DeleteAspectTypeRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::DeleteAspectTypeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_aspect_type(name: nil, etag: nil) -> ::Gapic::Operation
Pass arguments to delete_aspect_type 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) — Required. The resource name of the AspectType: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.
  • etag (::String) — Optional. If the client provided etag value does not match the current etag value, the DeleteAspectTypeRequest method returns an ABORTED error response
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

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

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

# Call the delete_aspect_type method.
result = client.delete_aspect_type 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

#delete_entry

def delete_entry(request, options = nil) -> ::Google::Cloud::Dataplex::V1::Entry
def delete_entry(name: nil) -> ::Google::Cloud::Dataplex::V1::Entry

Deletes an Entry.

Overloads 
def delete_entry(request, options = nil) -> ::Google::Cloud::Dataplex::V1::Entry
Pass arguments to delete_entry via a request object, either of type DeleteEntryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_entry(name: nil) -> ::Google::Cloud::Dataplex::V1::Entry
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).
Parameter
  • name (::String) — Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

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

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

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

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

#delete_entry_group

def delete_entry_group(request, options = nil) -> ::Gapic::Operation
def delete_entry_group(name: nil, etag: nil) -> ::Gapic::Operation

Deletes a EntryGroup resource.

Overloads 
def delete_entry_group(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_entry_group via a request object, either of type DeleteEntryGroupRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_entry_group(name: nil, etag: nil) -> ::Gapic::Operation
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) — Required. The resource name of the EntryGroup: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}.
  • etag (::String) — Optional. If the client provided etag value does not match the current etag value, the DeleteEntryGroupRequest method returns an ABORTED error response
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

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

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

# Call the delete_entry_group method.
result = client.delete_entry_group 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

#delete_entry_type

def delete_entry_type(request, options = nil) -> ::Gapic::Operation
def delete_entry_type(name: nil, etag: nil) -> ::Gapic::Operation

Deletes a EntryType resource.

Overloads 
def delete_entry_type(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_entry_type via a request object, either of type DeleteEntryTypeRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::DeleteEntryTypeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_entry_type(name: nil, etag: nil) -> ::Gapic::Operation
Pass arguments to delete_entry_type 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) — Required. The resource name of the EntryType: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}.
  • etag (::String) — Optional. If the client provided etag value does not match the current etag value, the DeleteEntryTypeRequest method returns an ABORTED error response
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

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

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

# Call the delete_entry_type method.
result = client.delete_entry_type 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

#get_aspect_type

def get_aspect_type(request, options = nil) -> ::Google::Cloud::Dataplex::V1::AspectType
def get_aspect_type(name: nil) -> ::Google::Cloud::Dataplex::V1::AspectType

Retrieves a AspectType resource.

Overloads 
def get_aspect_type(request, options = nil) -> ::Google::Cloud::Dataplex::V1::AspectType
Pass arguments to get_aspect_type via a request object, either of type GetAspectTypeRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::GetAspectTypeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_aspect_type(name: nil) -> ::Google::Cloud::Dataplex::V1::AspectType
Pass arguments to get_aspect_type via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The resource name of the AspectType: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

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

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

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

# The returned object is of type Google::Cloud::Dataplex::V1::AspectType.
p result

#get_entry

def get_entry(request, options = nil) -> ::Google::Cloud::Dataplex::V1::Entry
def get_entry(name: nil, view: nil, aspect_types: nil, paths: nil) -> ::Google::Cloud::Dataplex::V1::Entry

Gets a single entry.

Overloads 
def get_entry(request, options = nil) -> ::Google::Cloud::Dataplex::V1::Entry
Pass arguments to get_entry via a request object, either of type GetEntryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_entry(name: nil, view: nil, aspect_types: nil, paths: nil) -> ::Google::Cloud::Dataplex::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) — Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
  • view (::Google::Cloud::Dataplex::V1::EntryView) — Optional. View for controlling which parts of an entry are to be returned.
  • aspect_types (::Array<::String>) — Optional. Limits the aspects returned to the provided aspect types. Only works if the CUSTOM view is selected.
  • paths (::Array<::String>) — Optional. Limits the aspects returned to those associated with the provided paths within the Entry. Only works if the CUSTOM view is selected.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

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

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

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

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

#get_entry_group

def get_entry_group(request, options = nil) -> ::Google::Cloud::Dataplex::V1::EntryGroup
def get_entry_group(name: nil) -> ::Google::Cloud::Dataplex::V1::EntryGroup

Retrieves a EntryGroup resource.

Overloads 
def get_entry_group(request, options = nil) -> ::Google::Cloud::Dataplex::V1::EntryGroup
Pass arguments to get_entry_group via a request object, either of type GetEntryGroupRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_entry_group(name: nil) -> ::Google::Cloud::Dataplex::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).
Parameter
  • name (::String) — Required. The resource name of the EntryGroup: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

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

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

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

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

#get_entry_type

def get_entry_type(request, options = nil) -> ::Google::Cloud::Dataplex::V1::EntryType
def get_entry_type(name: nil) -> ::Google::Cloud::Dataplex::V1::EntryType

Retrieves a EntryType resource.

Overloads 
def get_entry_type(request, options = nil) -> ::Google::Cloud::Dataplex::V1::EntryType
Pass arguments to get_entry_type via a request object, either of type GetEntryTypeRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::GetEntryTypeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_entry_type(name: nil) -> ::Google::Cloud::Dataplex::V1::EntryType
Pass arguments to get_entry_type via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The resource name of the EntryType: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

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

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

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

# The returned object is of type Google::Cloud::Dataplex::V1::EntryType.
p result

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client

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

Returns
  • (Google::Iam::V1::IAMPolicy::Client)

#initialize

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

Create a new CatalogService client object.

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

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

#list_aspect_types

def list_aspect_types(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::AspectType>
def list_aspect_types(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::AspectType>

Lists AspectType resources in a project and location.

Overloads 
def list_aspect_types(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::AspectType>
Pass arguments to list_aspect_types via a request object, either of type ListAspectTypesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::ListAspectTypesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_aspect_types(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::AspectType>
Pass arguments to list_aspect_types via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The resource name of the AspectType location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
  • page_size (::Integer) — Optional. Maximum number of AspectTypes to return. The service may return fewer than this value. If unspecified, at most 10 AspectTypes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — Optional. Page token received from a previous ListAspectTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAspectTypes must match the call that provided the page token.
  • filter (::String) — Optional. Filter request. Filters are case-sensitive. The following formats are supported:

    labels.key1 = "value1" labels:key1 name = "value" These restrictions can be coinjoined with AND, OR and NOT conjunctions.

  • order_by (::String) — Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

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

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

# Call the list_aspect_types method.
result = client.list_aspect_types 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::Dataplex::V1::AspectType.
  p item
end

#list_entries

def list_entries(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::Entry>
def list_entries(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::Entry>

Lists entries within an entry group.

Overloads 
def list_entries(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::Entry>
Pass arguments to list_entries via a request object, either of type ListEntriesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_entries(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::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) — Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.
  • page_size (::Integer)
  • page_token (::String) — Optional. The pagination token returned by a previous request.
  • filter (::String) — Optional. A filter on the entries to return. Filters are case-sensitive. The request can be filtered by the following fields: entry_type, entry_source.display_name. The comparison operators are =, !=, <, >, <=, >= (strings are compared according to lexical order) The logical operators AND, OR, NOT can be used in the filter. Wildcard "" can be used, but for entry_type the full project id or number needs to be provided. Example filter expressions: "entry_source.display_name=AnExampleDisplayName" "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type" "entry_type=projects/example-project/locations/us/entryTypes/a OR entry_type=projects/another-project/locations/*" "NOT entry_source.display_name=AnotherExampleDisplayName"
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataplex::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::Dataplex::V1::Entry.
  p item
end

#list_entry_groups

def list_entry_groups(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::EntryGroup>
def list_entry_groups(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::EntryGroup>

Lists EntryGroup resources in a project and location.

Overloads 
def list_entry_groups(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::EntryGroup>
Pass arguments to list_entry_groups via a request object, either of type ListEntryGroupsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_entry_groups(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::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) — Required. The resource name of the entryGroup location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
  • page_size (::Integer) — Optional. Maximum number of EntryGroups to return. The service may return fewer than this value. If unspecified, at most 10 EntryGroups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — Optional. Page token received from a previous ListEntryGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEntryGroups must match the call that provided the page token.
  • filter (::String) — Optional. Filter request.
  • order_by (::String) — Optional. Order by fields for the result.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataplex::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::Dataplex::V1::EntryGroup.
  p item
end

#list_entry_types

def list_entry_types(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::EntryType>
def list_entry_types(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::EntryType>

Lists EntryType resources in a project and location.

Overloads 
def list_entry_types(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::EntryType>
Pass arguments to list_entry_types via a request object, either of type ListEntryTypesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::ListEntryTypesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_entry_types(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::EntryType>
Pass arguments to list_entry_types via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The resource name of the EntryType location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
  • page_size (::Integer) — Optional. Maximum number of EntryTypes to return. The service may return fewer than this value. If unspecified, at most 10 EntryTypes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — Optional. Page token received from a previous ListEntryTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEntryTypes must match the call that provided the page token.
  • filter (::String) — Optional. Filter request. Filters are case-sensitive. The following formats are supported:

    labels.key1 = "value1" labels:key1 name = "value" These restrictions can be coinjoined with AND, OR and NOT conjunctions.

  • order_by (::String) — Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

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

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

# Call the list_entry_types method.
result = client.list_entry_types 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::Dataplex::V1::EntryType.
  p item
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

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

Returns
  • (Google::Cloud::Location::Locations::Client)

#lookup_entry

def lookup_entry(request, options = nil) -> ::Google::Cloud::Dataplex::V1::Entry
def lookup_entry(name: nil, view: nil, aspect_types: nil, paths: nil, entry: nil) -> ::Google::Cloud::Dataplex::V1::Entry

Looks up a single entry.

Overloads 
def lookup_entry(request, options = nil) -> ::Google::Cloud::Dataplex::V1::Entry
Pass arguments to lookup_entry via a request object, either of type LookupEntryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def lookup_entry(name: nil, view: nil, aspect_types: nil, paths: nil, entry: nil) -> ::Google::Cloud::Dataplex::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
  • name (::String) — Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}.
  • view (::Google::Cloud::Dataplex::V1::EntryView) — Optional. View for controlling which parts of an entry are to be returned.
  • aspect_types (::Array<::String>) — Optional. Limits the aspects returned to the provided aspect types. Only works if the CUSTOM view is selected.
  • paths (::Array<::String>) — Optional. Limits the aspects returned to those associated with the provided paths within the Entry. Only works if the CUSTOM view is selected.
  • entry (::String) — Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

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

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

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

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

#operations_client

def operations_client() -> ::Google::Cloud::Dataplex::V1::CatalogService::Operations

Get the associated client for long-running operations.

Returns

#search_entries

def search_entries(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::SearchEntriesResult>
def search_entries(name: nil, query: nil, page_size: nil, page_token: nil, order_by: nil, scope: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::SearchEntriesResult>

Searches for entries matching given query and scope.

Overloads 
def search_entries(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::SearchEntriesResult>
Pass arguments to search_entries via a request object, either of type SearchEntriesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::SearchEntriesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def search_entries(name: nil, query: nil, page_size: nil, page_token: nil, order_by: nil, scope: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::SearchEntriesResult>
Pass arguments to search_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
  • name (::String) — Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}.
  • query (::String) — Required. The query against which entries in scope should be matched.
  • page_size (::Integer) — Optional. Pagination.
  • page_token (::String)
  • order_by (::String) — Optional. Ordering of the results. Supported options to be added later.
  • scope (::String) — Optional. The scope under which the search should be operating. Should either be organizations/
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

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

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

# Call the search_entries method.
result = client.search_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::Dataplex::V1::SearchEntriesResult.
  p item
end

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_aspect_type

def update_aspect_type(request, options = nil) -> ::Gapic::Operation
def update_aspect_type(aspect_type: nil, update_mask: nil, validate_only: nil) -> ::Gapic::Operation

Updates a AspectType resource.

Overloads 
def update_aspect_type(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_aspect_type via a request object, either of type UpdateAspectTypeRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::UpdateAspectTypeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def update_aspect_type(aspect_type: nil, update_mask: nil, validate_only: nil) -> ::Gapic::Operation
Pass arguments to update_aspect_type via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

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

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

# Call the update_aspect_type method.
result = client.update_aspect_type 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

#update_entry

def update_entry(request, options = nil) -> ::Google::Cloud::Dataplex::V1::Entry
def update_entry(entry: nil, update_mask: nil, allow_missing: nil, delete_missing_aspects: nil, aspect_keys: nil) -> ::Google::Cloud::Dataplex::V1::Entry

Updates an Entry.

Overloads 
def update_entry(request, options = nil) -> ::Google::Cloud::Dataplex::V1::Entry
Pass arguments to update_entry via a request object, either of type UpdateEntryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def update_entry(entry: nil, update_mask: nil, allow_missing: nil, delete_missing_aspects: nil, aspect_keys: nil) -> ::Google::Cloud::Dataplex::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::Dataplex::V1::Entry, ::Hash) — Required. Entry resource.
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".

    If the update_mask is empty, all modifiable fields present in the request will be updated.

  • allow_missing (::Boolean) — Optional. If set to true and the entry does not exist, it will be created.
  • delete_missing_aspects (::Boolean) — Optional. If set to true and the aspect_keys specify aspect ranges, any existing aspects from that range not provided in the request will be deleted.
  • aspect_keys (::Array<::String>) — Optional. The map keys of the Aspects which should be modified. Supports the following syntaxes:

    • *@path - matches aspects of all types on the given path

    Existing aspects matching the syntax will not be removed unless delete_missing_aspects is set to true.

    If this field is left empty, it will be treated as specifying exactly those Aspects present in the request.

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

Basic example

require "google/cloud/dataplex/v1"

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

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

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

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

#update_entry_group

def update_entry_group(request, options = nil) -> ::Gapic::Operation
def update_entry_group(entry_group: nil, update_mask: nil, validate_only: nil) -> ::Gapic::Operation

Updates a EntryGroup resource.

Overloads 
def update_entry_group(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_entry_group via a request object, either of type UpdateEntryGroupRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def update_entry_group(entry_group: nil, update_mask: nil, validate_only: nil) -> ::Gapic::Operation
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
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

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

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

# Call the update_entry_group method.
result = client.update_entry_group 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

#update_entry_type

def update_entry_type(request, options = nil) -> ::Gapic::Operation
def update_entry_type(entry_type: nil, update_mask: nil, validate_only: nil) -> ::Gapic::Operation

Updates a EntryType resource.

Overloads 
def update_entry_type(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_entry_type via a request object, either of type UpdateEntryTypeRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataplex::V1::UpdateEntryTypeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def update_entry_type(entry_type: nil, update_mask: nil, validate_only: nil) -> ::Gapic::Operation
Pass arguments to update_entry_type via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dataplex/v1"

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

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

# Call the update_entry_type method.
result = client.update_entry_type 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