Class: Google::Cloud::Sql::V1beta4::ImportContext

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb

Overview

Database instance import context.

Defined Under Namespace

Classes: SqlBakImportOptions, SqlCsvImportOptions, SqlImportOptions, SqlTdeImportOptions

Instance Attribute Summary collapse

Instance Attribute Details

#bak_import_options ⇒ ::Google::Cloud::Sql::V1beta4::ImportContext::SqlBakImportOptions

Returns Import parameters specific to SQL Server .BAK files.

Returns:



1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
 
# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 1545

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

  # @!attribute [rw] threads
  #   @return [::Google::Protobuf::Int32Value]
  #     Optional. The number of threads to use for parallel import.
  # @!attribute [rw] parallel
  #   @return [::Google::Protobuf::BoolValue]
  #     Optional. Whether or not the import should be parallel.
  # @!attribute [rw] postgres_import_options
  #   @return [::Google::Cloud::Sql::V1beta4::ImportContext::SqlImportOptions::PostgresImportOptions]
  #     Optional. Options for importing from a Cloud SQL for PostgreSQL instance.
  class SqlImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] clean
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. The --clean flag for the pg_restore utility. This flag
    #     applies only if you enabled Cloud SQL to import files in parallel.
    # @!attribute [rw] if_exists
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. The --if-exists flag for the pg_restore utility. This flag
    #     applies only if you enabled Cloud SQL to import files in parallel.
    class PostgresImportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] table
  #   @return [::String]
  #     The table to which CSV data is imported.
  # @!attribute [rw] columns
  #   @return [::Array<::String>]
  #     The columns to which CSV data is imported. If not specified, all columns
  #     of the database table are loaded with CSV data.
  # @!attribute [rw] escape_character
  #   @return [::String]
  #     Specifies the character that should appear before a data character that
  #     needs to be escaped.
  # @!attribute [rw] quote_character
  #   @return [::String]
  #     Specifies the quoting character to be used when a data value is quoted.
  # @!attribute [rw] fields_terminated_by
  #   @return [::String]
  #     Specifies the character that separates columns within each row (line) of
  #     the file.
  # @!attribute [rw] lines_terminated_by
  #   @return [::String]
  #     This is used to separate lines. If a line does not contain all fields,
  #     the rest of the columns are set to their default values.
  class SqlCsvImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] encryption_options
  #   @return [::Google::Cloud::Sql::V1beta4::ImportContext::SqlBakImportOptions::EncryptionOptions]
  # @!attribute [rw] striped
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup set being restored is striped.
  #     Applies only to Cloud SQL for SQL Server.
  # @!attribute [rw] no_recovery
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup importing will restore database
  #     with NORECOVERY option.
  #     Applies only to Cloud SQL for SQL Server.
  # @!attribute [rw] recovery_only
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup importing request will just bring database
  #     online without downloading Bak content only one of "no_recovery" and
  #     "recovery_only" can be true otherwise error will return. Applies only to
  #     Cloud SQL for SQL Server.
  # @!attribute [rw] bak_type
  #   @return [::Google::Cloud::Sql::V1beta4::BakType]
  #     Type of the bak content, FULL or DIFF.
  # @!attribute [rw] stop_at
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The timestamp when the import should stop. This timestamp is in
  #     the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example,
  #     `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT
  #     keyword and applies to Cloud SQL for SQL Server only.
  # @!attribute [rw] stop_at_mark
  #   @return [::String]
  #     Optional. The marked transaction where the import should stop. This field
  #     is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL
  #     Server only.
  class SqlBakImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] cert_path
    #   @return [::String]
    #     Path to the Certificate (.cer) in Cloud Storage, in the form
    #     `gs://bucketName/fileName`. The instance must have write permissions
    #     to the bucket and read access to the file.
    # @!attribute [rw] pvk_path
    #   @return [::String]
    #     Path to the Certificate Private Key (.pvk)  in Cloud Storage, in the
    #     form `gs://bucketName/fileName`. The instance must have write
    #     permissions to the bucket and read access to the file.
    # @!attribute [rw] pvk_password
    #   @return [::String]
    #     Password that encrypts the private key
    # @!attribute [rw] keep_encrypted
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Whether the imported file remains encrypted.
    class EncryptionOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] certificate_path
  #   @return [::String]
  #     Required. Path to the TDE certificate public key
  #     in the form gs://bucketName/fileName.
  #     The instance must have read access to the file.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_path
  #   @return [::String]
  #     Required. Path to the TDE certificate private key
  #     in the form gs://bucketName/fileName.
  #     The instance must have read access to the file.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_password
  #   @return [::String]
  #     Required. Password that encrypts the private key.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Certificate name.
  #     Applicable only for SQL Server instances.
  class SqlTdeImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#csv_import_options ⇒ ::Google::Cloud::Sql::V1beta4::ImportContext::SqlCsvImportOptions

Returns Options for importing data as CSV.

Returns:



1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
 
# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 1545

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

  # @!attribute [rw] threads
  #   @return [::Google::Protobuf::Int32Value]
  #     Optional. The number of threads to use for parallel import.
  # @!attribute [rw] parallel
  #   @return [::Google::Protobuf::BoolValue]
  #     Optional. Whether or not the import should be parallel.
  # @!attribute [rw] postgres_import_options
  #   @return [::Google::Cloud::Sql::V1beta4::ImportContext::SqlImportOptions::PostgresImportOptions]
  #     Optional. Options for importing from a Cloud SQL for PostgreSQL instance.
  class SqlImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] clean
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. The --clean flag for the pg_restore utility. This flag
    #     applies only if you enabled Cloud SQL to import files in parallel.
    # @!attribute [rw] if_exists
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. The --if-exists flag for the pg_restore utility. This flag
    #     applies only if you enabled Cloud SQL to import files in parallel.
    class PostgresImportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] table
  #   @return [::String]
  #     The table to which CSV data is imported.
  # @!attribute [rw] columns
  #   @return [::Array<::String>]
  #     The columns to which CSV data is imported. If not specified, all columns
  #     of the database table are loaded with CSV data.
  # @!attribute [rw] escape_character
  #   @return [::String]
  #     Specifies the character that should appear before a data character that
  #     needs to be escaped.
  # @!attribute [rw] quote_character
  #   @return [::String]
  #     Specifies the quoting character to be used when a data value is quoted.
  # @!attribute [rw] fields_terminated_by
  #   @return [::String]
  #     Specifies the character that separates columns within each row (line) of
  #     the file.
  # @!attribute [rw] lines_terminated_by
  #   @return [::String]
  #     This is used to separate lines. If a line does not contain all fields,
  #     the rest of the columns are set to their default values.
  class SqlCsvImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] encryption_options
  #   @return [::Google::Cloud::Sql::V1beta4::ImportContext::SqlBakImportOptions::EncryptionOptions]
  # @!attribute [rw] striped
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup set being restored is striped.
  #     Applies only to Cloud SQL for SQL Server.
  # @!attribute [rw] no_recovery
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup importing will restore database
  #     with NORECOVERY option.
  #     Applies only to Cloud SQL for SQL Server.
  # @!attribute [rw] recovery_only
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup importing request will just bring database
  #     online without downloading Bak content only one of "no_recovery" and
  #     "recovery_only" can be true otherwise error will return. Applies only to
  #     Cloud SQL for SQL Server.
  # @!attribute [rw] bak_type
  #   @return [::Google::Cloud::Sql::V1beta4::BakType]
  #     Type of the bak content, FULL or DIFF.
  # @!attribute [rw] stop_at
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The timestamp when the import should stop. This timestamp is in
  #     the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example,
  #     `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT
  #     keyword and applies to Cloud SQL for SQL Server only.
  # @!attribute [rw] stop_at_mark
  #   @return [::String]
  #     Optional. The marked transaction where the import should stop. This field
  #     is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL
  #     Server only.
  class SqlBakImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] cert_path
    #   @return [::String]
    #     Path to the Certificate (.cer) in Cloud Storage, in the form
    #     `gs://bucketName/fileName`. The instance must have write permissions
    #     to the bucket and read access to the file.
    # @!attribute [rw] pvk_path
    #   @return [::String]
    #     Path to the Certificate Private Key (.pvk)  in Cloud Storage, in the
    #     form `gs://bucketName/fileName`. The instance must have write
    #     permissions to the bucket and read access to the file.
    # @!attribute [rw] pvk_password
    #   @return [::String]
    #     Password that encrypts the private key
    # @!attribute [rw] keep_encrypted
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Whether the imported file remains encrypted.
    class EncryptionOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] certificate_path
  #   @return [::String]
  #     Required. Path to the TDE certificate public key
  #     in the form gs://bucketName/fileName.
  #     The instance must have read access to the file.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_path
  #   @return [::String]
  #     Required. Path to the TDE certificate private key
  #     in the form gs://bucketName/fileName.
  #     The instance must have read access to the file.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_password
  #   @return [::String]
  #     Required. Password that encrypts the private key.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Certificate name.
  #     Applicable only for SQL Server instances.
  class SqlTdeImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#database ⇒ ::String

Returns The target database for the import. If fileType is SQL, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. For entire instance parallel import operations, the database is overridden by the database name stored in subdirectory name. If fileType is CSV, one database must be specified.

Returns:

  • (::String) —

    The target database for the import. If fileType is SQL, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. For entire instance parallel import operations, the database is overridden by the database name stored in subdirectory name. If fileType is CSV, one database must be specified.



1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
 
# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 1545

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

  # @!attribute [rw] threads
  #   @return [::Google::Protobuf::Int32Value]
  #     Optional. The number of threads to use for parallel import.
  # @!attribute [rw] parallel
  #   @return [::Google::Protobuf::BoolValue]
  #     Optional. Whether or not the import should be parallel.
  # @!attribute [rw] postgres_import_options
  #   @return [::Google::Cloud::Sql::V1beta4::ImportContext::SqlImportOptions::PostgresImportOptions]
  #     Optional. Options for importing from a Cloud SQL for PostgreSQL instance.
  class SqlImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] clean
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. The --clean flag for the pg_restore utility. This flag
    #     applies only if you enabled Cloud SQL to import files in parallel.
    # @!attribute [rw] if_exists
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. The --if-exists flag for the pg_restore utility. This flag
    #     applies only if you enabled Cloud SQL to import files in parallel.
    class PostgresImportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] table
  #   @return [::String]
  #     The table to which CSV data is imported.
  # @!attribute [rw] columns
  #   @return [::Array<::String>]
  #     The columns to which CSV data is imported. If not specified, all columns
  #     of the database table are loaded with CSV data.
  # @!attribute [rw] escape_character
  #   @return [::String]
  #     Specifies the character that should appear before a data character that
  #     needs to be escaped.
  # @!attribute [rw] quote_character
  #   @return [::String]
  #     Specifies the quoting character to be used when a data value is quoted.
  # @!attribute [rw] fields_terminated_by
  #   @return [::String]
  #     Specifies the character that separates columns within each row (line) of
  #     the file.
  # @!attribute [rw] lines_terminated_by
  #   @return [::String]
  #     This is used to separate lines. If a line does not contain all fields,
  #     the rest of the columns are set to their default values.
  class SqlCsvImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] encryption_options
  #   @return [::Google::Cloud::Sql::V1beta4::ImportContext::SqlBakImportOptions::EncryptionOptions]
  # @!attribute [rw] striped
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup set being restored is striped.
  #     Applies only to Cloud SQL for SQL Server.
  # @!attribute [rw] no_recovery
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup importing will restore database
  #     with NORECOVERY option.
  #     Applies only to Cloud SQL for SQL Server.
  # @!attribute [rw] recovery_only
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup importing request will just bring database
  #     online without downloading Bak content only one of "no_recovery" and
  #     "recovery_only" can be true otherwise error will return. Applies only to
  #     Cloud SQL for SQL Server.
  # @!attribute [rw] bak_type
  #   @return [::Google::Cloud::Sql::V1beta4::BakType]
  #     Type of the bak content, FULL or DIFF.
  # @!attribute [rw] stop_at
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The timestamp when the import should stop. This timestamp is in
  #     the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example,
  #     `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT
  #     keyword and applies to Cloud SQL for SQL Server only.
  # @!attribute [rw] stop_at_mark
  #   @return [::String]
  #     Optional. The marked transaction where the import should stop. This field
  #     is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL
  #     Server only.
  class SqlBakImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] cert_path
    #   @return [::String]
    #     Path to the Certificate (.cer) in Cloud Storage, in the form
    #     `gs://bucketName/fileName`. The instance must have write permissions
    #     to the bucket and read access to the file.
    # @!attribute [rw] pvk_path
    #   @return [::String]
    #     Path to the Certificate Private Key (.pvk)  in Cloud Storage, in the
    #     form `gs://bucketName/fileName`. The instance must have write
    #     permissions to the bucket and read access to the file.
    # @!attribute [rw] pvk_password
    #   @return [::String]
    #     Password that encrypts the private key
    # @!attribute [rw] keep_encrypted
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Whether the imported file remains encrypted.
    class EncryptionOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] certificate_path
  #   @return [::String]
  #     Required. Path to the TDE certificate public key
  #     in the form gs://bucketName/fileName.
  #     The instance must have read access to the file.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_path
  #   @return [::String]
  #     Required. Path to the TDE certificate private key
  #     in the form gs://bucketName/fileName.
  #     The instance must have read access to the file.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_password
  #   @return [::String]
  #     Required. Password that encrypts the private key.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Certificate name.
  #     Applicable only for SQL Server instances.
  class SqlTdeImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#file_type ⇒ ::Google::Cloud::Sql::V1beta4::SqlFileType

Returns The file type for the specified uri.

  • SQL: The file contains SQL statements.
  • CSV: The file contains CSV data.
  • BAK: The file contains backup data for a SQL Server instance.

Returns:

  • (::Google::Cloud::Sql::V1beta4::SqlFileType) —

    The file type for the specified uri.

    • SQL: The file contains SQL statements.
    • CSV: The file contains CSV data.
    • BAK: The file contains backup data for a SQL Server instance.


1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
 
# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 1545

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

  # @!attribute [rw] threads
  #   @return [::Google::Protobuf::Int32Value]
  #     Optional. The number of threads to use for parallel import.
  # @!attribute [rw] parallel
  #   @return [::Google::Protobuf::BoolValue]
  #     Optional. Whether or not the import should be parallel.
  # @!attribute [rw] postgres_import_options
  #   @return [::Google::Cloud::Sql::V1beta4::ImportContext::SqlImportOptions::PostgresImportOptions]
  #     Optional. Options for importing from a Cloud SQL for PostgreSQL instance.
  class SqlImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] clean
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. The --clean flag for the pg_restore utility. This flag
    #     applies only if you enabled Cloud SQL to import files in parallel.
    # @!attribute [rw] if_exists
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. The --if-exists flag for the pg_restore utility. This flag
    #     applies only if you enabled Cloud SQL to import files in parallel.
    class PostgresImportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] table
  #   @return [::String]
  #     The table to which CSV data is imported.
  # @!attribute [rw] columns
  #   @return [::Array<::String>]
  #     The columns to which CSV data is imported. If not specified, all columns
  #     of the database table are loaded with CSV data.
  # @!attribute [rw] escape_character
  #   @return [::String]
  #     Specifies the character that should appear before a data character that
  #     needs to be escaped.
  # @!attribute [rw] quote_character
  #   @return [::String]
  #     Specifies the quoting character to be used when a data value is quoted.
  # @!attribute [rw] fields_terminated_by
  #   @return [::String]
  #     Specifies the character that separates columns within each row (line) of
  #     the file.
  # @!attribute [rw] lines_terminated_by
  #   @return [::String]
  #     This is used to separate lines. If a line does not contain all fields,
  #     the rest of the columns are set to their default values.
  class SqlCsvImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] encryption_options
  #   @return [::Google::Cloud::Sql::V1beta4::ImportContext::SqlBakImportOptions::EncryptionOptions]
  # @!attribute [rw] striped
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup set being restored is striped.
  #     Applies only to Cloud SQL for SQL Server.
  # @!attribute [rw] no_recovery
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup importing will restore database
  #     with NORECOVERY option.
  #     Applies only to Cloud SQL for SQL Server.
  # @!attribute [rw] recovery_only
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup importing request will just bring database
  #     online without downloading Bak content only one of "no_recovery" and
  #     "recovery_only" can be true otherwise error will return. Applies only to
  #     Cloud SQL for SQL Server.
  # @!attribute [rw] bak_type
  #   @return [::Google::Cloud::Sql::V1beta4::BakType]
  #     Type of the bak content, FULL or DIFF.
  # @!attribute [rw] stop_at
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The timestamp when the import should stop. This timestamp is in
  #     the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example,
  #     `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT
  #     keyword and applies to Cloud SQL for SQL Server only.
  # @!attribute [rw] stop_at_mark
  #   @return [::String]
  #     Optional. The marked transaction where the import should stop. This field
  #     is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL
  #     Server only.
  class SqlBakImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] cert_path
    #   @return [::String]
    #     Path to the Certificate (.cer) in Cloud Storage, in the form
    #     `gs://bucketName/fileName`. The instance must have write permissions
    #     to the bucket and read access to the file.
    # @!attribute [rw] pvk_path
    #   @return [::String]
    #     Path to the Certificate Private Key (.pvk)  in Cloud Storage, in the
    #     form `gs://bucketName/fileName`. The instance must have write
    #     permissions to the bucket and read access to the file.
    # @!attribute [rw] pvk_password
    #   @return [::String]
    #     Password that encrypts the private key
    # @!attribute [rw] keep_encrypted
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Whether the imported file remains encrypted.
    class EncryptionOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] certificate_path
  #   @return [::String]
  #     Required. Path to the TDE certificate public key
  #     in the form gs://bucketName/fileName.
  #     The instance must have read access to the file.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_path
  #   @return [::String]
  #     Required. Path to the TDE certificate private key
  #     in the form gs://bucketName/fileName.
  #     The instance must have read access to the file.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_password
  #   @return [::String]
  #     Required. Password that encrypts the private key.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Certificate name.
  #     Applicable only for SQL Server instances.
  class SqlTdeImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#import_user ⇒ ::String

Returns The PostgreSQL user for this import operation. PostgreSQL instances only.

Returns:

  • (::String) —

    The PostgreSQL user for this import operation. PostgreSQL instances only.



1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
 
# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 1545

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

  # @!attribute [rw] threads
  #   @return [::Google::Protobuf::Int32Value]
  #     Optional. The number of threads to use for parallel import.
  # @!attribute [rw] parallel
  #   @return [::Google::Protobuf::BoolValue]
  #     Optional. Whether or not the import should be parallel.
  # @!attribute [rw] postgres_import_options
  #   @return [::Google::Cloud::Sql::V1beta4::ImportContext::SqlImportOptions::PostgresImportOptions]
  #     Optional. Options for importing from a Cloud SQL for PostgreSQL instance.
  class SqlImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] clean
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. The --clean flag for the pg_restore utility. This flag
    #     applies only if you enabled Cloud SQL to import files in parallel.
    # @!attribute [rw] if_exists
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. The --if-exists flag for the pg_restore utility. This flag
    #     applies only if you enabled Cloud SQL to import files in parallel.
    class PostgresImportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] table
  #   @return [::String]
  #     The table to which CSV data is imported.
  # @!attribute [rw] columns
  #   @return [::Array<::String>]
  #     The columns to which CSV data is imported. If not specified, all columns
  #     of the database table are loaded with CSV data.
  # @!attribute [rw] escape_character
  #   @return [::String]
  #     Specifies the character that should appear before a data character that
  #     needs to be escaped.
  # @!attribute [rw] quote_character
  #   @return [::String]
  #     Specifies the quoting character to be used when a data value is quoted.
  # @!attribute [rw] fields_terminated_by
  #   @return [::String]
  #     Specifies the character that separates columns within each row (line) of
  #     the file.
  # @!attribute [rw] lines_terminated_by
  #   @return [::String]
  #     This is used to separate lines. If a line does not contain all fields,
  #     the rest of the columns are set to their default values.
  class SqlCsvImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] encryption_options
  #   @return [::Google::Cloud::Sql::V1beta4::ImportContext::SqlBakImportOptions::EncryptionOptions]
  # @!attribute [rw] striped
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup set being restored is striped.
  #     Applies only to Cloud SQL for SQL Server.
  # @!attribute [rw] no_recovery
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup importing will restore database
  #     with NORECOVERY option.
  #     Applies only to Cloud SQL for SQL Server.
  # @!attribute [rw] recovery_only
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup importing request will just bring database
  #     online without downloading Bak content only one of "no_recovery" and
  #     "recovery_only" can be true otherwise error will return. Applies only to
  #     Cloud SQL for SQL Server.
  # @!attribute [rw] bak_type
  #   @return [::Google::Cloud::Sql::V1beta4::BakType]
  #     Type of the bak content, FULL or DIFF.
  # @!attribute [rw] stop_at
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The timestamp when the import should stop. This timestamp is in
  #     the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example,
  #     `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT
  #     keyword and applies to Cloud SQL for SQL Server only.
  # @!attribute [rw] stop_at_mark
  #   @return [::String]
  #     Optional. The marked transaction where the import should stop. This field
  #     is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL
  #     Server only.
  class SqlBakImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] cert_path
    #   @return [::String]
    #     Path to the Certificate (.cer) in Cloud Storage, in the form
    #     `gs://bucketName/fileName`. The instance must have write permissions
    #     to the bucket and read access to the file.
    # @!attribute [rw] pvk_path
    #   @return [::String]
    #     Path to the Certificate Private Key (.pvk)  in Cloud Storage, in the
    #     form `gs://bucketName/fileName`. The instance must have write
    #     permissions to the bucket and read access to the file.
    # @!attribute [rw] pvk_password
    #   @return [::String]
    #     Password that encrypts the private key
    # @!attribute [rw] keep_encrypted
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Whether the imported file remains encrypted.
    class EncryptionOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] certificate_path
  #   @return [::String]
  #     Required. Path to the TDE certificate public key
  #     in the form gs://bucketName/fileName.
  #     The instance must have read access to the file.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_path
  #   @return [::String]
  #     Required. Path to the TDE certificate private key
  #     in the form gs://bucketName/fileName.
  #     The instance must have read access to the file.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_password
  #   @return [::String]
  #     Required. Password that encrypts the private key.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Certificate name.
  #     Applicable only for SQL Server instances.
  class SqlTdeImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#kind ⇒ ::String

Returns This is always sql#importContext.

Returns:

  • (::String) —

    This is always sql#importContext.



1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
 
# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 1545

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

  # @!attribute [rw] threads
  #   @return [::Google::Protobuf::Int32Value]
  #     Optional. The number of threads to use for parallel import.
  # @!attribute [rw] parallel
  #   @return [::Google::Protobuf::BoolValue]
  #     Optional. Whether or not the import should be parallel.
  # @!attribute [rw] postgres_import_options
  #   @return [::Google::Cloud::Sql::V1beta4::ImportContext::SqlImportOptions::PostgresImportOptions]
  #     Optional. Options for importing from a Cloud SQL for PostgreSQL instance.
  class SqlImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] clean
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. The --clean flag for the pg_restore utility. This flag
    #     applies only if you enabled Cloud SQL to import files in parallel.
    # @!attribute [rw] if_exists
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. The --if-exists flag for the pg_restore utility. This flag
    #     applies only if you enabled Cloud SQL to import files in parallel.
    class PostgresImportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] table
  #   @return [::String]
  #     The table to which CSV data is imported.
  # @!attribute [rw] columns
  #   @return [::Array<::String>]
  #     The columns to which CSV data is imported. If not specified, all columns
  #     of the database table are loaded with CSV data.
  # @!attribute [rw] escape_character
  #   @return [::String]
  #     Specifies the character that should appear before a data character that
  #     needs to be escaped.
  # @!attribute [rw] quote_character
  #   @return [::String]
  #     Specifies the quoting character to be used when a data value is quoted.
  # @!attribute [rw] fields_terminated_by
  #   @return [::String]
  #     Specifies the character that separates columns within each row (line) of
  #     the file.
  # @!attribute [rw] lines_terminated_by
  #   @return [::String]
  #     This is used to separate lines. If a line does not contain all fields,
  #     the rest of the columns are set to their default values.
  class SqlCsvImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] encryption_options
  #   @return [::Google::Cloud::Sql::V1beta4::ImportContext::SqlBakImportOptions::EncryptionOptions]
  # @!attribute [rw] striped
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup set being restored is striped.
  #     Applies only to Cloud SQL for SQL Server.
  # @!attribute [rw] no_recovery
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup importing will restore database
  #     with NORECOVERY option.
  #     Applies only to Cloud SQL for SQL Server.
  # @!attribute [rw] recovery_only
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup importing request will just bring database
  #     online without downloading Bak content only one of "no_recovery" and
  #     "recovery_only" can be true otherwise error will return. Applies only to
  #     Cloud SQL for SQL Server.
  # @!attribute [rw] bak_type
  #   @return [::Google::Cloud::Sql::V1beta4::BakType]
  #     Type of the bak content, FULL or DIFF.
  # @!attribute [rw] stop_at
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The timestamp when the import should stop. This timestamp is in
  #     the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example,
  #     `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT
  #     keyword and applies to Cloud SQL for SQL Server only.
  # @!attribute [rw] stop_at_mark
  #   @return [::String]
  #     Optional. The marked transaction where the import should stop. This field
  #     is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL
  #     Server only.
  class SqlBakImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] cert_path
    #   @return [::String]
    #     Path to the Certificate (.cer) in Cloud Storage, in the form
    #     `gs://bucketName/fileName`. The instance must have write permissions
    #     to the bucket and read access to the file.
    # @!attribute [rw] pvk_path
    #   @return [::String]
    #     Path to the Certificate Private Key (.pvk)  in Cloud Storage, in the
    #     form `gs://bucketName/fileName`. The instance must have write
    #     permissions to the bucket and read access to the file.
    # @!attribute [rw] pvk_password
    #   @return [::String]
    #     Password that encrypts the private key
    # @!attribute [rw] keep_encrypted
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Whether the imported file remains encrypted.
    class EncryptionOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] certificate_path
  #   @return [::String]
  #     Required. Path to the TDE certificate public key
  #     in the form gs://bucketName/fileName.
  #     The instance must have read access to the file.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_path
  #   @return [::String]
  #     Required. Path to the TDE certificate private key
  #     in the form gs://bucketName/fileName.
  #     The instance must have read access to the file.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_password
  #   @return [::String]
  #     Required. Password that encrypts the private key.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Certificate name.
  #     Applicable only for SQL Server instances.
  class SqlTdeImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#sql_import_options ⇒ ::Google::Cloud::Sql::V1beta4::ImportContext::SqlImportOptions

Returns Optional. Options for importing data from SQL statements.

Returns:



1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
 
# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 1545

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

  # @!attribute [rw] threads
  #   @return [::Google::Protobuf::Int32Value]
  #     Optional. The number of threads to use for parallel import.
  # @!attribute [rw] parallel
  #   @return [::Google::Protobuf::BoolValue]
  #     Optional. Whether or not the import should be parallel.
  # @!attribute [rw] postgres_import_options
  #   @return [::Google::Cloud::Sql::V1beta4::ImportContext::SqlImportOptions::PostgresImportOptions]
  #     Optional. Options for importing from a Cloud SQL for PostgreSQL instance.
  class SqlImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] clean
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. The --clean flag for the pg_restore utility. This flag
    #     applies only if you enabled Cloud SQL to import files in parallel.
    # @!attribute [rw] if_exists
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. The --if-exists flag for the pg_restore utility. This flag
    #     applies only if you enabled Cloud SQL to import files in parallel.
    class PostgresImportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] table
  #   @return [::String]
  #     The table to which CSV data is imported.
  # @!attribute [rw] columns
  #   @return [::Array<::String>]
  #     The columns to which CSV data is imported. If not specified, all columns
  #     of the database table are loaded with CSV data.
  # @!attribute [rw] escape_character
  #   @return [::String]
  #     Specifies the character that should appear before a data character that
  #     needs to be escaped.
  # @!attribute [rw] quote_character
  #   @return [::String]
  #     Specifies the quoting character to be used when a data value is quoted.
  # @!attribute [rw] fields_terminated_by
  #   @return [::String]
  #     Specifies the character that separates columns within each row (line) of
  #     the file.
  # @!attribute [rw] lines_terminated_by
  #   @return [::String]
  #     This is used to separate lines. If a line does not contain all fields,
  #     the rest of the columns are set to their default values.
  class SqlCsvImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] encryption_options
  #   @return [::Google::Cloud::Sql::V1beta4::ImportContext::SqlBakImportOptions::EncryptionOptions]
  # @!attribute [rw] striped
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup set being restored is striped.
  #     Applies only to Cloud SQL for SQL Server.
  # @!attribute [rw] no_recovery
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup importing will restore database
  #     with NORECOVERY option.
  #     Applies only to Cloud SQL for SQL Server.
  # @!attribute [rw] recovery_only
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup importing request will just bring database
  #     online without downloading Bak content only one of "no_recovery" and
  #     "recovery_only" can be true otherwise error will return. Applies only to
  #     Cloud SQL for SQL Server.
  # @!attribute [rw] bak_type
  #   @return [::Google::Cloud::Sql::V1beta4::BakType]
  #     Type of the bak content, FULL or DIFF.
  # @!attribute [rw] stop_at
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The timestamp when the import should stop. This timestamp is in
  #     the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example,
  #     `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT
  #     keyword and applies to Cloud SQL for SQL Server only.
  # @!attribute [rw] stop_at_mark
  #   @return [::String]
  #     Optional. The marked transaction where the import should stop. This field
  #     is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL
  #     Server only.
  class SqlBakImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] cert_path
    #   @return [::String]
    #     Path to the Certificate (.cer) in Cloud Storage, in the form
    #     `gs://bucketName/fileName`. The instance must have write permissions
    #     to the bucket and read access to the file.
    # @!attribute [rw] pvk_path
    #   @return [::String]
    #     Path to the Certificate Private Key (.pvk)  in Cloud Storage, in the
    #     form `gs://bucketName/fileName`. The instance must have write
    #     permissions to the bucket and read access to the file.
    # @!attribute [rw] pvk_password
    #   @return [::String]
    #     Password that encrypts the private key
    # @!attribute [rw] keep_encrypted
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Whether the imported file remains encrypted.
    class EncryptionOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] certificate_path
  #   @return [::String]
  #     Required. Path to the TDE certificate public key
  #     in the form gs://bucketName/fileName.
  #     The instance must have read access to the file.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_path
  #   @return [::String]
  #     Required. Path to the TDE certificate private key
  #     in the form gs://bucketName/fileName.
  #     The instance must have read access to the file.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_password
  #   @return [::String]
  #     Required. Password that encrypts the private key.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Certificate name.
  #     Applicable only for SQL Server instances.
  class SqlTdeImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#tde_import_options ⇒ ::Google::Cloud::Sql::V1beta4::ImportContext::SqlTdeImportOptions

Returns Optional. Import parameters specific to SQL Server .TDE files Import parameters specific to SQL Server TDE certificates.

Returns:



1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
 
# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 1545

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

  # @!attribute [rw] threads
  #   @return [::Google::Protobuf::Int32Value]
  #     Optional. The number of threads to use for parallel import.
  # @!attribute [rw] parallel
  #   @return [::Google::Protobuf::BoolValue]
  #     Optional. Whether or not the import should be parallel.
  # @!attribute [rw] postgres_import_options
  #   @return [::Google::Cloud::Sql::V1beta4::ImportContext::SqlImportOptions::PostgresImportOptions]
  #     Optional. Options for importing from a Cloud SQL for PostgreSQL instance.
  class SqlImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] clean
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. The --clean flag for the pg_restore utility. This flag
    #     applies only if you enabled Cloud SQL to import files in parallel.
    # @!attribute [rw] if_exists
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. The --if-exists flag for the pg_restore utility. This flag
    #     applies only if you enabled Cloud SQL to import files in parallel.
    class PostgresImportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] table
  #   @return [::String]
  #     The table to which CSV data is imported.
  # @!attribute [rw] columns
  #   @return [::Array<::String>]
  #     The columns to which CSV data is imported. If not specified, all columns
  #     of the database table are loaded with CSV data.
  # @!attribute [rw] escape_character
  #   @return [::String]
  #     Specifies the character that should appear before a data character that
  #     needs to be escaped.
  # @!attribute [rw] quote_character
  #   @return [::String]
  #     Specifies the quoting character to be used when a data value is quoted.
  # @!attribute [rw] fields_terminated_by
  #   @return [::String]
  #     Specifies the character that separates columns within each row (line) of
  #     the file.
  # @!attribute [rw] lines_terminated_by
  #   @return [::String]
  #     This is used to separate lines. If a line does not contain all fields,
  #     the rest of the columns are set to their default values.
  class SqlCsvImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] encryption_options
  #   @return [::Google::Cloud::Sql::V1beta4::ImportContext::SqlBakImportOptions::EncryptionOptions]
  # @!attribute [rw] striped
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup set being restored is striped.
  #     Applies only to Cloud SQL for SQL Server.
  # @!attribute [rw] no_recovery
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup importing will restore database
  #     with NORECOVERY option.
  #     Applies only to Cloud SQL for SQL Server.
  # @!attribute [rw] recovery_only
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup importing request will just bring database
  #     online without downloading Bak content only one of "no_recovery" and
  #     "recovery_only" can be true otherwise error will return. Applies only to
  #     Cloud SQL for SQL Server.
  # @!attribute [rw] bak_type
  #   @return [::Google::Cloud::Sql::V1beta4::BakType]
  #     Type of the bak content, FULL or DIFF.
  # @!attribute [rw] stop_at
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The timestamp when the import should stop. This timestamp is in
  #     the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example,
  #     `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT
  #     keyword and applies to Cloud SQL for SQL Server only.
  # @!attribute [rw] stop_at_mark
  #   @return [::String]
  #     Optional. The marked transaction where the import should stop. This field
  #     is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL
  #     Server only.
  class SqlBakImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] cert_path
    #   @return [::String]
    #     Path to the Certificate (.cer) in Cloud Storage, in the form
    #     `gs://bucketName/fileName`. The instance must have write permissions
    #     to the bucket and read access to the file.
    # @!attribute [rw] pvk_path
    #   @return [::String]
    #     Path to the Certificate Private Key (.pvk)  in Cloud Storage, in the
    #     form `gs://bucketName/fileName`. The instance must have write
    #     permissions to the bucket and read access to the file.
    # @!attribute [rw] pvk_password
    #   @return [::String]
    #     Password that encrypts the private key
    # @!attribute [rw] keep_encrypted
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Whether the imported file remains encrypted.
    class EncryptionOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] certificate_path
  #   @return [::String]
  #     Required. Path to the TDE certificate public key
  #     in the form gs://bucketName/fileName.
  #     The instance must have read access to the file.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_path
  #   @return [::String]
  #     Required. Path to the TDE certificate private key
  #     in the form gs://bucketName/fileName.
  #     The instance must have read access to the file.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_password
  #   @return [::String]
  #     Required. Password that encrypts the private key.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Certificate name.
  #     Applicable only for SQL Server instances.
  class SqlTdeImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#uri ⇒ ::String

Returns Path to the import file in Cloud Storage, in the form gs://bucketName/fileName. Compressed gzip files (.gz) are supported when fileType is SQL. The instance must have write permissions to the bucket and read access to the file.

Returns:

  • (::String) —

    Path to the import file in Cloud Storage, in the form gs://bucketName/fileName. Compressed gzip files (.gz) are supported when fileType is SQL. The instance must have write permissions to the bucket and read access to the file.



1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
 
# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 1545

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

  # @!attribute [rw] threads
  #   @return [::Google::Protobuf::Int32Value]
  #     Optional. The number of threads to use for parallel import.
  # @!attribute [rw] parallel
  #   @return [::Google::Protobuf::BoolValue]
  #     Optional. Whether or not the import should be parallel.
  # @!attribute [rw] postgres_import_options
  #   @return [::Google::Cloud::Sql::V1beta4::ImportContext::SqlImportOptions::PostgresImportOptions]
  #     Optional. Options for importing from a Cloud SQL for PostgreSQL instance.
  class SqlImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] clean
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. The --clean flag for the pg_restore utility. This flag
    #     applies only if you enabled Cloud SQL to import files in parallel.
    # @!attribute [rw] if_exists
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. The --if-exists flag for the pg_restore utility. This flag
    #     applies only if you enabled Cloud SQL to import files in parallel.
    class PostgresImportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] table
  #   @return [::String]
  #     The table to which CSV data is imported.
  # @!attribute [rw] columns
  #   @return [::Array<::String>]
  #     The columns to which CSV data is imported. If not specified, all columns
  #     of the database table are loaded with CSV data.
  # @!attribute [rw] escape_character
  #   @return [::String]
  #     Specifies the character that should appear before a data character that
  #     needs to be escaped.
  # @!attribute [rw] quote_character
  #   @return [::String]
  #     Specifies the quoting character to be used when a data value is quoted.
  # @!attribute [rw] fields_terminated_by
  #   @return [::String]
  #     Specifies the character that separates columns within each row (line) of
  #     the file.
  # @!attribute [rw] lines_terminated_by
  #   @return [::String]
  #     This is used to separate lines. If a line does not contain all fields,
  #     the rest of the columns are set to their default values.
  class SqlCsvImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] encryption_options
  #   @return [::Google::Cloud::Sql::V1beta4::ImportContext::SqlBakImportOptions::EncryptionOptions]
  # @!attribute [rw] striped
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup set being restored is striped.
  #     Applies only to Cloud SQL for SQL Server.
  # @!attribute [rw] no_recovery
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup importing will restore database
  #     with NORECOVERY option.
  #     Applies only to Cloud SQL for SQL Server.
  # @!attribute [rw] recovery_only
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup importing request will just bring database
  #     online without downloading Bak content only one of "no_recovery" and
  #     "recovery_only" can be true otherwise error will return. Applies only to
  #     Cloud SQL for SQL Server.
  # @!attribute [rw] bak_type
  #   @return [::Google::Cloud::Sql::V1beta4::BakType]
  #     Type of the bak content, FULL or DIFF.
  # @!attribute [rw] stop_at
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The timestamp when the import should stop. This timestamp is in
  #     the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example,
  #     `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT
  #     keyword and applies to Cloud SQL for SQL Server only.
  # @!attribute [rw] stop_at_mark
  #   @return [::String]
  #     Optional. The marked transaction where the import should stop. This field
  #     is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL
  #     Server only.
  class SqlBakImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] cert_path
    #   @return [::String]
    #     Path to the Certificate (.cer) in Cloud Storage, in the form
    #     `gs://bucketName/fileName`. The instance must have write permissions
    #     to the bucket and read access to the file.
    # @!attribute [rw] pvk_path
    #   @return [::String]
    #     Path to the Certificate Private Key (.pvk)  in Cloud Storage, in the
    #     form `gs://bucketName/fileName`. The instance must have write
    #     permissions to the bucket and read access to the file.
    # @!attribute [rw] pvk_password
    #   @return [::String]
    #     Password that encrypts the private key
    # @!attribute [rw] keep_encrypted
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Whether the imported file remains encrypted.
    class EncryptionOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] certificate_path
  #   @return [::String]
  #     Required. Path to the TDE certificate public key
  #     in the form gs://bucketName/fileName.
  #     The instance must have read access to the file.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_path
  #   @return [::String]
  #     Required. Path to the TDE certificate private key
  #     in the form gs://bucketName/fileName.
  #     The instance must have read access to the file.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_password
  #   @return [::String]
  #     Required. Password that encrypts the private key.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Certificate name.
  #     Applicable only for SQL Server instances.
  class SqlTdeImportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end