Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::Fulfillments::Rest::Client (v0.29.0)

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

REST client for the Fulfillments service.

Service for managing Fulfillments.

Inherits

  • Object

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the Fulfillments Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Example
# Modify the configuration for all Fulfillments clients
::Google::Cloud::Dialogflow::V2::Fulfillments::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the Fulfillments Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter

#get_fulfillment

def get_fulfillment(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::Fulfillment
def get_fulfillment(name: nil) -> ::Google::Cloud::Dialogflow::V2::Fulfillment

Retrieves the fulfillment.

Overloads
def get_fulfillment(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::Fulfillment
Pass arguments to get_fulfillment via a request object, either of type GetFulfillmentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::V2::GetFulfillmentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def get_fulfillment(name: nil) -> ::Google::Cloud::Dialogflow::V2::Fulfillment
Pass arguments to get_fulfillment via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the fulfillment. Format: projects/<Project ID>/agent/fulfillment.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/dialogflow/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dialogflow::V2::Fulfillments::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::V2::GetFulfillmentRequest.new

# Call the get_fulfillment method.
result = client.get_fulfillment request

# The returned object is of type Google::Cloud::Dialogflow::V2::Fulfillment.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new Fulfillments REST client object.

Yields
  • (config) — Configure the Fulfillments client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example
# Create a client using the default configuration
client = ::Google::Cloud::Dialogflow::V2::Fulfillments::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Dialogflow::V2::Fulfillments::Rest::Client.new do |config|
  config.timeout = 10.0
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Rest::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Rest::Client)

#update_fulfillment

def update_fulfillment(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::Fulfillment
def update_fulfillment(fulfillment: nil, update_mask: nil) -> ::Google::Cloud::Dialogflow::V2::Fulfillment

Updates the fulfillment.

Overloads
def update_fulfillment(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::Fulfillment
Pass arguments to update_fulfillment via a request object, either of type UpdateFulfillmentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::V2::UpdateFulfillmentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def update_fulfillment(fulfillment: nil, update_mask: nil) -> ::Google::Cloud::Dialogflow::V2::Fulfillment
Pass arguments to update_fulfillment via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/dialogflow/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dialogflow::V2::Fulfillments::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::V2::UpdateFulfillmentRequest.new

# Call the update_fulfillment method.
result = client.update_fulfillment request

# The returned object is of type Google::Cloud::Dialogflow::V2::Fulfillment.
p result