Class: Google::Cloud::Dialogflow::CX::V3::ExportIntentsRequest

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

Overview

The request message for Intents.ExportIntents.

Defined Under Namespace

Modules: DataFormat

Instance Attribute Summary collapse

Instance Attribute Details

#data_format ⇒ ::Google::Cloud::Dialogflow::CX::V3::ExportIntentsRequest::DataFormat

Returns Optional. The data format of the exported intents. If not specified, BLOB is assumed.

Returns:



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/intent.rb', line 451

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

  # Data format of the exported intents.
  module DataFormat
    # Unspecified format. Treated as `BLOB`.
    DATA_FORMAT_UNSPECIFIED = 0

    # Intents will be exported as raw bytes.
    BLOB = 1

    # Intents will be exported in JSON format.
    JSON = 2

    # Intents will be exported in CSV format.
    CSV = 3
  end
end

#intents ⇒ ::Array<::String>

Returns Required. The name of the intents to export. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>.

Returns:

  • (::Array<::String>) —

    Required. The name of the intents to export. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>.



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/intent.rb', line 451

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

  # Data format of the exported intents.
  module DataFormat
    # Unspecified format. Treated as `BLOB`.
    DATA_FORMAT_UNSPECIFIED = 0

    # Intents will be exported as raw bytes.
    BLOB = 1

    # Intents will be exported in JSON format.
    JSON = 2

    # Intents will be exported in CSV format.
    CSV = 3
  end
end

#intents_content_inline ⇒ ::Boolean

Returns Optional. The option to return the serialized intents inline.

Note: The following fields are mutually exclusive: intents_content_inline, intents_uri. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Boolean) —

    Optional. The option to return the serialized intents inline.

    Note: The following fields are mutually exclusive: intents_content_inline, intents_uri. If a field in that set is populated, all other fields in the set will automatically be cleared.



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/intent.rb', line 451

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

  # Data format of the exported intents.
  module DataFormat
    # Unspecified format. Treated as `BLOB`.
    DATA_FORMAT_UNSPECIFIED = 0

    # Intents will be exported as raw bytes.
    BLOB = 1

    # Intents will be exported in JSON format.
    JSON = 2

    # Intents will be exported in CSV format.
    CSV = 3
  end
end

#intents_uri ⇒ ::String

Returns Optional. The Google Cloud Storage URI to export the intents to. The format of this URI must be gs://<bucket-name>/<object-name>.

Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see Dialogflow access control.

Note: The following fields are mutually exclusive: intents_uri, intents_content_inline. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    Optional. The Google Cloud Storage URI to export the intents to. The format of this URI must be gs://<bucket-name>/<object-name>.

    Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see Dialogflow access control.

    Note: The following fields are mutually exclusive: intents_uri, intents_content_inline. If a field in that set is populated, all other fields in the set will automatically be cleared.



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/intent.rb', line 451

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

  # Data format of the exported intents.
  module DataFormat
    # Unspecified format. Treated as `BLOB`.
    DATA_FORMAT_UNSPECIFIED = 0

    # Intents will be exported as raw bytes.
    BLOB = 1

    # Intents will be exported in JSON format.
    JSON = 2

    # Intents will be exported in CSV format.
    CSV = 3
  end
end

#parent ⇒ ::String

Returns Required. The name of the parent agent to export intents. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.

Returns:

  • (::String) —

    Required. The name of the parent agent to export intents. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/intent.rb', line 451

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

  # Data format of the exported intents.
  module DataFormat
    # Unspecified format. Treated as `BLOB`.
    DATA_FORMAT_UNSPECIFIED = 0

    # Intents will be exported as raw bytes.
    BLOB = 1

    # Intents will be exported in JSON format.
    JSON = 2

    # Intents will be exported in CSV format.
    CSV = 3
  end
end