Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::Documents::Rest::ServiceStub (v0.28.0)

Version 0.28.0

• 1.2.0 (latest)
• 1.1.1
• 1.0.0
• 0.34.0
• 0.33.0
• 0.32.2
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.1
• 0.16.0
• 0.15.2
• 0.14.0
• 0.13.0
• 0.12.0

Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::Documents::Rest::ServiceStub.

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

Inherits

• Object

Methods

#create_document

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

Baseline implementation for the create_document REST call

Parameters

• request_pb (::Google::Cloud::Dialogflow::V2::CreateDocumentRequest) — 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::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#delete_document

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

Baseline implementation for the delete_document REST call

Parameters

• request_pb (::Google::Cloud::Dialogflow::V2::DeleteDocumentRequest) — 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::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#export_document

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

Baseline implementation for the export_document REST call

Parameters

• request_pb (::Google::Cloud::Dialogflow::V2::ExportDocumentRequest) — 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::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_document

def get_document(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::V2::Document

Baseline implementation for the get_document REST call

Parameters

• request_pb (::Google::Cloud::Dialogflow::V2::GetDocumentRequest) — 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::Dialogflow::V2::Document)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Dialogflow::V2::Document) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#import_documents

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

Baseline implementation for the import_documents REST call

Parameters

• request_pb (::Google::Cloud::Dialogflow::V2::ImportDocumentsRequest) — 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::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#initialize

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

Returns

• (ServiceStub) — a new instance of ServiceStub

#list_documents

def list_documents(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::V2::ListDocumentsResponse

Baseline implementation for the list_documents REST call

Parameters

• request_pb (::Google::Cloud::Dialogflow::V2::ListDocumentsRequest) — 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::Dialogflow::V2::ListDocumentsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Dialogflow::V2::ListDocumentsResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#reload_document

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

Baseline implementation for the reload_document REST call

Parameters

• request_pb (::Google::Cloud::Dialogflow::V2::ReloadDocumentRequest) — 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::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#update_document

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

Baseline implementation for the update_document REST call

Parameters

• request_pb (::Google::Cloud::Dialogflow::V2::UpdateDocumentRequest) — 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::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)