Class: Google::Cloud::Dialogflow::V2::Tool::ConnectorTool

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/v2/tool.rb

Overview

A ConnectorTool enabling using Integration Connectors Connections as tools.

Defined Under Namespace

Classes: Action

Instance Attribute Summary collapse

Instance Attribute Details

#actions ⇒ ::Array<::Google::Cloud::Dialogflow::V2::Tool::ConnectorTool::Action>

Returns Required. Actions for the tool to use.

Returns:



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'proto_docs/google/cloud/dialogflow/v2/tool.rb', line 236

class ConnectorTool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration of a Connection operation for the tool to use.
  # @!attribute [rw] connection_action_id
  #   @return [::String]
  #     ID of a Connection action for the tool to use.
  #
  #     Note: The following fields are mutually exclusive: `connection_action_id`, `entity_operation`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] entity_operation
  #   @return [::Google::Cloud::Dialogflow::V2::Tool::ConnectorTool::Action::EntityOperation]
  #     Entity operation configuration for the tool to use.
  #
  #     Note: The following fields are mutually exclusive: `entity_operation`, `connection_action_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] input_fields
  #   @return [::Array<::String>]
  #     Optional. Entity fields to use as inputs for the operation.
  #     If no fields are specified, all fields of the Entity will be used.
  # @!attribute [rw] output_fields
  #   @return [::Array<::String>]
  #     Optional. Entity fields to return from the operation.
  #     If no fields are specified, all fields of the Entity will be returned.
  class Action
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Entity CRUD operation specification.
    # @!attribute [rw] entity_id
    #   @return [::String]
    #     Required. ID of the entity.
    # @!attribute [rw] operation
    #   @return [::Google::Cloud::Dialogflow::V2::Tool::ConnectorTool::Action::EntityOperation::OperationType]
    #     Required. Operation to perform on the entity.
    class EntityOperation
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The operation to perform on the entity.
      module OperationType
        # Operation type unspecified. Invalid, ConnectorTool create/update
        # will fail.
        OPERATION_TYPE_UNSPECIFIED = 0

        # List operation.
        LIST = 1

        # Get operation.
        GET = 2

        # Create operation.
        CREATE = 3

        # Update operation.
        UPDATE = 4

        # Delete operation.
        DELETE = 5
      end
    end
  end
end

#name ⇒ ::String

Returns Required. The full resource name of the referenced Integration Connectors Connection. Format: 'projects//locations//connections/*'.

Returns:

  • (::String) —

    Required. The full resource name of the referenced Integration Connectors Connection. Format: 'projects//locations//connections/*'



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'proto_docs/google/cloud/dialogflow/v2/tool.rb', line 236

class ConnectorTool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration of a Connection operation for the tool to use.
  # @!attribute [rw] connection_action_id
  #   @return [::String]
  #     ID of a Connection action for the tool to use.
  #
  #     Note: The following fields are mutually exclusive: `connection_action_id`, `entity_operation`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] entity_operation
  #   @return [::Google::Cloud::Dialogflow::V2::Tool::ConnectorTool::Action::EntityOperation]
  #     Entity operation configuration for the tool to use.
  #
  #     Note: The following fields are mutually exclusive: `entity_operation`, `connection_action_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] input_fields
  #   @return [::Array<::String>]
  #     Optional. Entity fields to use as inputs for the operation.
  #     If no fields are specified, all fields of the Entity will be used.
  # @!attribute [rw] output_fields
  #   @return [::Array<::String>]
  #     Optional. Entity fields to return from the operation.
  #     If no fields are specified, all fields of the Entity will be returned.
  class Action
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Entity CRUD operation specification.
    # @!attribute [rw] entity_id
    #   @return [::String]
    #     Required. ID of the entity.
    # @!attribute [rw] operation
    #   @return [::Google::Cloud::Dialogflow::V2::Tool::ConnectorTool::Action::EntityOperation::OperationType]
    #     Required. Operation to perform on the entity.
    class EntityOperation
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The operation to perform on the entity.
      module OperationType
        # Operation type unspecified. Invalid, ConnectorTool create/update
        # will fail.
        OPERATION_TYPE_UNSPECIFIED = 0

        # List operation.
        LIST = 1

        # Get operation.
        GET = 2

        # Create operation.
        CREATE = 3

        # Update operation.
        UPDATE = 4

        # Delete operation.
        DELETE = 5
      end
    end
  end
end