Data Catalog V1 API - Class Google::Cloud::DataCatalog::V1::DataCatalog::Rest::ServiceStub (v1.2.0)

Reference documentation and code samples for the Data Catalog V1 API class Google::Cloud::DataCatalog::V1::DataCatalog::Rest::ServiceStub.

REST service stub for the DataCatalog service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Inherits

  • Object

Methods

#create_entry

def create_entry(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::Entry

Baseline implementation for the create_entry REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_entry_group

def create_entry_group(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::EntryGroup

Baseline implementation for the create_entry_group REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_tag

def create_tag(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::Tag

Baseline implementation for the create_tag REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_tag_template

def create_tag_template(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::TagTemplate

Baseline implementation for the create_tag_template REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_tag_template_field

def create_tag_template_field(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::TagTemplateField

Baseline implementation for the create_tag_template_field REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_entry

def delete_entry(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_entry REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_entry_group

def delete_entry_group(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_entry_group REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_tag

def delete_tag(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_tag REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_tag_template

def delete_tag_template(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_tag_template REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_tag_template_field

def delete_tag_template_field(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_tag_template_field REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns
  • (String)

#get_entry

def get_entry(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::Entry

Baseline implementation for the get_entry REST call

Parameters
  • request_pb (::Google::Cloud::DataCatalog::V1::GetEntryRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_entry_group

def get_entry_group(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::EntryGroup

Baseline implementation for the get_entry_group REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_iam_policy

def get_iam_policy(request_pb, options = nil) { |result, operation| ... } -> ::Google::Iam::V1::Policy

Baseline implementation for the get_iam_policy REST call

Parameters
  • request_pb (::Google::Iam::V1::GetIamPolicyRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
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) — A result object deserialized from the server's reply
Raises
  • (::ArgumentError)

#get_tag_template

def get_tag_template(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::TagTemplate

Baseline implementation for the get_tag_template REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#import_entries

def import_entries(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the import_entries REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#initialize

def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub
Returns

#list_entries

def list_entries(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::ListEntriesResponse

Baseline implementation for the list_entries REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_entry_groups

def list_entry_groups(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::ListEntryGroupsResponse

Baseline implementation for the list_entry_groups REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_tags

def list_tags(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::ListTagsResponse

Baseline implementation for the list_tags REST call

Parameters
  • request_pb (::Google::Cloud::DataCatalog::V1::ListTagsRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#lookup_entry

def lookup_entry(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::Entry

Baseline implementation for the lookup_entry REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#modify_entry_contacts

def modify_entry_contacts(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::Contacts

Baseline implementation for the modify_entry_contacts REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#modify_entry_overview

def modify_entry_overview(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::EntryOverview

Baseline implementation for the modify_entry_overview REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#reconcile_tags

def reconcile_tags(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the reconcile_tags REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#rename_tag_template_field

def rename_tag_template_field(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::TagTemplateField

Baseline implementation for the rename_tag_template_field REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#rename_tag_template_field_enum_value

def rename_tag_template_field_enum_value(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::TagTemplateField

Baseline implementation for the rename_tag_template_field_enum_value REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#retrieve_config

def retrieve_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::OrganizationConfig

Baseline implementation for the retrieve_config REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#retrieve_effective_config

def retrieve_effective_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::MigrationConfig

Baseline implementation for the retrieve_effective_config REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#search_catalog

def search_catalog(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::SearchCatalogResponse

Baseline implementation for the search_catalog REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#set_config

def set_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::MigrationConfig

Baseline implementation for the set_config REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#set_iam_policy

def set_iam_policy(request_pb, options = nil) { |result, operation| ... } -> ::Google::Iam::V1::Policy

Baseline implementation for the set_iam_policy REST call

Parameters
  • request_pb (::Google::Iam::V1::SetIamPolicyRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
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) — A result object deserialized from the server's reply
Raises
  • (::ArgumentError)

#star_entry

def star_entry(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::StarEntryResponse

Baseline implementation for the star_entry REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#test_iam_permissions

def test_iam_permissions(request_pb, options = nil) { |result, operation| ... } -> ::Google::Iam::V1::TestIamPermissionsResponse

Baseline implementation for the test_iam_permissions REST call

Parameters
  • request_pb (::Google::Iam::V1::TestIamPermissionsRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
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) — A result object deserialized from the server's reply
Raises
  • (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#unstar_entry

def unstar_entry(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::UnstarEntryResponse

Baseline implementation for the unstar_entry REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#update_entry

def update_entry(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::Entry

Baseline implementation for the update_entry REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#update_entry_group

def update_entry_group(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::EntryGroup

Baseline implementation for the update_entry_group REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#update_tag

def update_tag(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::Tag

Baseline implementation for the update_tag REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#update_tag_template

def update_tag_template(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::TagTemplate

Baseline implementation for the update_tag_template REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#update_tag_template_field

def update_tag_template_field(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::DataCatalog::V1::TagTemplateField

Baseline implementation for the update_tag_template_field REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)