Dataplex V1 API - Class Google::Cloud::Dataplex::V1::DataplexService::Rest::ServiceStub (v0.12.0)

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

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

Inherits

  • Object

Methods

#cancel_job

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

Baseline implementation for the cancel_job REST call

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

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

Baseline implementation for the create_asset REST call

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

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

Baseline implementation for the create_environment REST call

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

#create_lake

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

Baseline implementation for the create_lake REST call

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

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

Baseline implementation for the create_task REST call

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

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

Baseline implementation for the create_zone REST call

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

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

Baseline implementation for the delete_asset REST call

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

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

Baseline implementation for the delete_environment REST call

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

#delete_lake

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

Baseline implementation for the delete_lake REST call

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

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

Baseline implementation for the delete_task REST call

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

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

Baseline implementation for the delete_zone REST call

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

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

Baseline implementation for the get_asset REST call

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

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

Baseline implementation for the get_environment REST call

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

#get_job

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

Baseline implementation for the get_job REST call

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

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

Baseline implementation for the get_lake REST call

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

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

Baseline implementation for the get_task REST call

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

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

Baseline implementation for the get_zone REST call

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

#initialize

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

#list_asset_actions

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

Baseline implementation for the list_asset_actions REST call

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

#list_assets

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

Baseline implementation for the list_assets REST call

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

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

Baseline implementation for the list_environments REST call

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

#list_jobs

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

Baseline implementation for the list_jobs REST call

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

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

Baseline implementation for the list_lake_actions REST call

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

#list_lakes

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

Baseline implementation for the list_lakes REST call

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

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

Baseline implementation for the list_sessions REST call

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

#list_tasks

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

Baseline implementation for the list_tasks REST call

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

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

Baseline implementation for the list_zone_actions REST call

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

#list_zones

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

Baseline implementation for the list_zones REST call

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

#run_task

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

Baseline implementation for the run_task REST call

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

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

Baseline implementation for the update_asset REST call

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

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

Baseline implementation for the update_environment REST call

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

#update_lake

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

Baseline implementation for the update_lake REST call

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

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

Baseline implementation for the update_task REST call

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

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

Baseline implementation for the update_zone REST call

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