Class: Google::Cloud::ContactCenterInsights::V1::ExportInsightsDataRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb

Overview

The request to export insights.

Defined Under Namespace

Modules: WriteDisposition Classes: BigQueryDestination

Instance Attribute Summary collapse

Instance Attribute Details

#big_query_destination ⇒ ::Google::Cloud::ContactCenterInsights::V1::ExportInsightsDataRequest::BigQueryDestination

Returns Specified if sink is a BigQuery table.

Returns:



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 628

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

  # A BigQuery Table Reference.
  # @!attribute [rw] project_id
  #   @return [::String]
  #     A project ID or number. If specified, then export will attempt to
  #     write data to this project instead of the resource project. Otherwise,
  #     the resource project will be used.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Required. The name of the BigQuery dataset that the snapshot result
  #     should be exported to. If this dataset does not exist, the export call
  #     returns an INVALID_ARGUMENT error.
  # @!attribute [rw] table
  #   @return [::String]
  #     The BigQuery table name to which the insights data should be written.
  #     If this table does not exist, the export call returns an INVALID_ARGUMENT
  #     error.
  class BigQueryDestination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the action that occurs if the destination table already exists.
  module WriteDisposition
    # Write disposition is not specified. Defaults to WRITE_TRUNCATE.
    WRITE_DISPOSITION_UNSPECIFIED = 0

    # If the table already exists, BigQuery will overwrite the table data and
    # use the schema from the load.
    WRITE_TRUNCATE = 1

    # If the table already exists, BigQuery will append data to the table.
    WRITE_APPEND = 2
  end
end

#filter ⇒ ::String

Returns A filter to reduce results to a specific subset. Useful for exporting conversations with specific properties.

Returns:

  • (::String) —

    A filter to reduce results to a specific subset. Useful for exporting conversations with specific properties.



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 628

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

  # A BigQuery Table Reference.
  # @!attribute [rw] project_id
  #   @return [::String]
  #     A project ID or number. If specified, then export will attempt to
  #     write data to this project instead of the resource project. Otherwise,
  #     the resource project will be used.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Required. The name of the BigQuery dataset that the snapshot result
  #     should be exported to. If this dataset does not exist, the export call
  #     returns an INVALID_ARGUMENT error.
  # @!attribute [rw] table
  #   @return [::String]
  #     The BigQuery table name to which the insights data should be written.
  #     If this table does not exist, the export call returns an INVALID_ARGUMENT
  #     error.
  class BigQueryDestination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the action that occurs if the destination table already exists.
  module WriteDisposition
    # Write disposition is not specified. Defaults to WRITE_TRUNCATE.
    WRITE_DISPOSITION_UNSPECIFIED = 0

    # If the table already exists, BigQuery will overwrite the table data and
    # use the schema from the load.
    WRITE_TRUNCATE = 1

    # If the table already exists, BigQuery will append data to the table.
    WRITE_APPEND = 2
  end
end

#kms_key ⇒ ::String

Returns A fully qualified KMS key name for BigQuery tables protected by CMEK. Format: projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}.

Returns:

  • (::String) —

    A fully qualified KMS key name for BigQuery tables protected by CMEK. Format: projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 628

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

  # A BigQuery Table Reference.
  # @!attribute [rw] project_id
  #   @return [::String]
  #     A project ID or number. If specified, then export will attempt to
  #     write data to this project instead of the resource project. Otherwise,
  #     the resource project will be used.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Required. The name of the BigQuery dataset that the snapshot result
  #     should be exported to. If this dataset does not exist, the export call
  #     returns an INVALID_ARGUMENT error.
  # @!attribute [rw] table
  #   @return [::String]
  #     The BigQuery table name to which the insights data should be written.
  #     If this table does not exist, the export call returns an INVALID_ARGUMENT
  #     error.
  class BigQueryDestination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the action that occurs if the destination table already exists.
  module WriteDisposition
    # Write disposition is not specified. Defaults to WRITE_TRUNCATE.
    WRITE_DISPOSITION_UNSPECIFIED = 0

    # If the table already exists, BigQuery will overwrite the table data and
    # use the schema from the load.
    WRITE_TRUNCATE = 1

    # If the table already exists, BigQuery will append data to the table.
    WRITE_APPEND = 2
  end
end

#parent ⇒ ::String

Returns Required. The parent resource to export data from.

Returns:

  • (::String) —

    Required. The parent resource to export data from.



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 628

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

  # A BigQuery Table Reference.
  # @!attribute [rw] project_id
  #   @return [::String]
  #     A project ID or number. If specified, then export will attempt to
  #     write data to this project instead of the resource project. Otherwise,
  #     the resource project will be used.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Required. The name of the BigQuery dataset that the snapshot result
  #     should be exported to. If this dataset does not exist, the export call
  #     returns an INVALID_ARGUMENT error.
  # @!attribute [rw] table
  #   @return [::String]
  #     The BigQuery table name to which the insights data should be written.
  #     If this table does not exist, the export call returns an INVALID_ARGUMENT
  #     error.
  class BigQueryDestination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the action that occurs if the destination table already exists.
  module WriteDisposition
    # Write disposition is not specified. Defaults to WRITE_TRUNCATE.
    WRITE_DISPOSITION_UNSPECIFIED = 0

    # If the table already exists, BigQuery will overwrite the table data and
    # use the schema from the load.
    WRITE_TRUNCATE = 1

    # If the table already exists, BigQuery will append data to the table.
    WRITE_APPEND = 2
  end
end

#write_disposition ⇒ ::Google::Cloud::ContactCenterInsights::V1::ExportInsightsDataRequest::WriteDisposition

Returns Options for what to do if the destination table already exists.

Returns:



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 628

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

  # A BigQuery Table Reference.
  # @!attribute [rw] project_id
  #   @return [::String]
  #     A project ID or number. If specified, then export will attempt to
  #     write data to this project instead of the resource project. Otherwise,
  #     the resource project will be used.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Required. The name of the BigQuery dataset that the snapshot result
  #     should be exported to. If this dataset does not exist, the export call
  #     returns an INVALID_ARGUMENT error.
  # @!attribute [rw] table
  #   @return [::String]
  #     The BigQuery table name to which the insights data should be written.
  #     If this table does not exist, the export call returns an INVALID_ARGUMENT
  #     error.
  class BigQueryDestination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the action that occurs if the destination table already exists.
  module WriteDisposition
    # Write disposition is not specified. Defaults to WRITE_TRUNCATE.
    WRITE_DISPOSITION_UNSPECIFIED = 0

    # If the table already exists, BigQuery will overwrite the table data and
    # use the schema from the load.
    WRITE_TRUNCATE = 1

    # If the table already exists, BigQuery will append data to the table.
    WRITE_APPEND = 2
  end
end