Dataplex V1 API - Class Google::Cloud::Dataplex::V1::CatalogService::Rest::ServiceStub (v1.0.1)

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

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

Inherits

  • Object

Methods

#create_aspect_type

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

Baseline implementation for the create_aspect_type REST call

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

#create_entry

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

Baseline implementation for the create_entry REST call

Parameters
  • request_pb (::Google::Cloud::Dataplex::V1::CreateEntryRequest) — 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)

#create_entry_group

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

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_entry_type

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

Baseline implementation for the create_entry_type REST call

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

#delete_aspect_type

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

Baseline implementation for the delete_aspect_type 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::Cloud::Dataplex::V1::Entry

Baseline implementation for the delete_entry REST call

Parameters
  • request_pb (::Google::Cloud::Dataplex::V1::DeleteEntryRequest) — 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)

#delete_entry_group

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

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_entry_type

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

Baseline implementation for the delete_entry_type 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_aspect_type

def get_aspect_type(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dataplex::V1::AspectType

Baseline implementation for the get_aspect_type REST call

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

#get_entry

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

Baseline implementation for the get_entry REST call

Parameters
  • request_pb (::Google::Cloud::Dataplex::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::Dataplex::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_entry_type

def get_entry_type(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dataplex::V1::EntryType

Baseline implementation for the get_entry_type 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_aspect_types

def list_aspect_types(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dataplex::V1::ListAspectTypesResponse

Baseline implementation for the list_aspect_types REST call

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

#list_entries

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

Baseline implementation for the list_entries REST call

Parameters
  • request_pb (::Google::Cloud::Dataplex::V1::ListEntriesRequest) — 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)

#list_entry_groups

def list_entry_groups(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dataplex::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_entry_types

def list_entry_types(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dataplex::V1::ListEntryTypesResponse

Baseline implementation for the list_entry_types REST call

Parameters
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::Dataplex::V1::Entry

Baseline implementation for the lookup_entry REST call

Parameters
  • request_pb (::Google::Cloud::Dataplex::V1::LookupEntryRequest) — 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)

#search_entries

def search_entries(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dataplex::V1::SearchEntriesResponse

Baseline implementation for the search_entries REST call

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

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_aspect_type

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

Baseline implementation for the update_aspect_type 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::Dataplex::V1::Entry

Baseline implementation for the update_entry REST call

Parameters
  • request_pb (::Google::Cloud::Dataplex::V1::UpdateEntryRequest) — 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)

#update_entry_group

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

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_entry_type

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

Baseline implementation for the update_entry_type REST call

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