BigQuery Data Transfer Service V1 API - Class Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Rest::ServiceStub (v1.0.3)

Reference documentation and code samples for the BigQuery Data Transfer Service V1 API class Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Rest::ServiceStub.

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

Inherits

Object

Methods

#check_valid_creds

def check_valid_creds(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Bigquery::DataTransfer::V1::CheckValidCredsResponse

Baseline implementation for the check_valid_creds REST call

Parameters

request_pb (::Google::Cloud::Bigquery::DataTransfer::V1::CheckValidCredsRequest) — 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::Cloud::Bigquery::DataTransfer::V1::CheckValidCredsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Bigquery::DataTransfer::V1::CheckValidCredsResponse) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#create_transfer_config

def create_transfer_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig

Baseline implementation for the create_transfer_config REST call

Parameters

request_pb (::Google::Cloud::Bigquery::DataTransfer::V1::CreateTransferConfigRequest) — 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::Cloud::Bigquery::DataTransfer::V1::TransferConfig)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#delete_transfer_config

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

Baseline implementation for the delete_transfer_config REST call

Parameters

request_pb (::Google::Cloud::Bigquery::DataTransfer::V1::DeleteTransferConfigRequest) — 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::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Protobuf::Empty) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#delete_transfer_run

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

Baseline implementation for the delete_transfer_run REST call

Parameters

request_pb (::Google::Cloud::Bigquery::DataTransfer::V1::DeleteTransferRunRequest) — 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::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Protobuf::Empty) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns

(String)

#enroll_data_sources

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

Baseline implementation for the enroll_data_sources REST call

Parameters

request_pb (::Google::Cloud::Bigquery::DataTransfer::V1::EnrollDataSourcesRequest) — 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::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Protobuf::Empty) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#get_data_source

def get_data_source(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Bigquery::DataTransfer::V1::DataSource

Baseline implementation for the get_data_source REST call

Parameters

request_pb (::Google::Cloud::Bigquery::DataTransfer::V1::GetDataSourceRequest) — 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::Cloud::Bigquery::DataTransfer::V1::DataSource)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Bigquery::DataTransfer::V1::DataSource) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#get_transfer_config

def get_transfer_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig

Baseline implementation for the get_transfer_config REST call

Parameters

request_pb (::Google::Cloud::Bigquery::DataTransfer::V1::GetTransferConfigRequest) — 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::Cloud::Bigquery::DataTransfer::V1::TransferConfig)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#get_transfer_run

def get_transfer_run(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Bigquery::DataTransfer::V1::TransferRun

Baseline implementation for the get_transfer_run REST call

Parameters

request_pb (::Google::Cloud::Bigquery::DataTransfer::V1::GetTransferRunRequest) — 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::Cloud::Bigquery::DataTransfer::V1::TransferRun)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Bigquery::DataTransfer::V1::TransferRun) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#initialize

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

Returns

(ServiceStub) — a new instance of ServiceStub

#list_data_sources

def list_data_sources(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Bigquery::DataTransfer::V1::ListDataSourcesResponse

Baseline implementation for the list_data_sources REST call

Parameters

request_pb (::Google::Cloud::Bigquery::DataTransfer::V1::ListDataSourcesRequest) — 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::Cloud::Bigquery::DataTransfer::V1::ListDataSourcesResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Bigquery::DataTransfer::V1::ListDataSourcesResponse) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#list_transfer_configs

def list_transfer_configs(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferConfigsResponse

Baseline implementation for the list_transfer_configs REST call

Parameters

request_pb (::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferConfigsRequest) — 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::Cloud::Bigquery::DataTransfer::V1::ListTransferConfigsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferConfigsResponse) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#list_transfer_logs

def list_transfer_logs(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferLogsResponse

Baseline implementation for the list_transfer_logs REST call

Parameters

request_pb (::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferLogsRequest) — 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::Cloud::Bigquery::DataTransfer::V1::ListTransferLogsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferLogsResponse) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#list_transfer_runs

def list_transfer_runs(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferRunsResponse

Baseline implementation for the list_transfer_runs REST call

Parameters

request_pb (::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferRunsRequest) — 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::Cloud::Bigquery::DataTransfer::V1::ListTransferRunsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferRunsResponse) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#schedule_transfer_runs

def schedule_transfer_runs(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Bigquery::DataTransfer::V1::ScheduleTransferRunsResponse

Baseline implementation for the schedule_transfer_runs REST call

Parameters

request_pb (::Google::Cloud::Bigquery::DataTransfer::V1::ScheduleTransferRunsRequest) — 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::Cloud::Bigquery::DataTransfer::V1::ScheduleTransferRunsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Bigquery::DataTransfer::V1::ScheduleTransferRunsResponse) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#start_manual_transfer_runs

def start_manual_transfer_runs(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Bigquery::DataTransfer::V1::StartManualTransferRunsResponse

Baseline implementation for the start_manual_transfer_runs REST call

Parameters

request_pb (::Google::Cloud::Bigquery::DataTransfer::V1::StartManualTransferRunsRequest) — 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::Cloud::Bigquery::DataTransfer::V1::StartManualTransferRunsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Bigquery::DataTransfer::V1::StartManualTransferRunsResponse) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#unenroll_data_sources

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

Baseline implementation for the unenroll_data_sources REST call

Parameters

request_pb (::Google::Cloud::Bigquery::DataTransfer::V1::UnenrollDataSourcesRequest) — 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::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Protobuf::Empty) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)

#update_transfer_config

def update_transfer_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig

Baseline implementation for the update_transfer_config REST call

Parameters

request_pb (::Google::Cloud::Bigquery::DataTransfer::V1::UpdateTransferConfigRequest) — 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::Cloud::Bigquery::DataTransfer::V1::TransferConfig)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig) — A result object deserialized from the server's reply

Raises

(::ArgumentError)