--- title: "POST /v1/{+parent}/streams" method: POST path: "/v1/{+parent}/streams" tags: ["projects"] --- # POST /v1/{+parent}/streams `POST /v1/{+parent}/streams` Use this method to create a stream. ## Path parameters - `parent` string, required ## Query parameters - `force` boolean - `requestId` string - `streamId` string - `validateOnly` boolean ## Request body - Stream — A resource representing streaming data from a source to a destination. - `errors` Error[] — Output only. Errors on the Stream. - `reason` string — A title that explains the reason for the error. - `errorUuid` string — A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses. - `message` string — A message containing more information about the error that occurred. - `errorTime` string, google-datetime — The time when the error occurred. - `details` object — Additional information about the error. - `satisfiesPzs` boolean — Output only. Reserved for future use. - `destinationConfig` DestinationConfig — The configuration of the stream destination. - `gcsDestinationConfig` GcsDestinationConfig — Google Cloud Storage destination configuration - `path` string — Path inside the Cloud Storage bucket to write data to. - `fileRotationInterval` string, google-duration — The maximum duration for which new events are added before a file is closed and a new file is created. Values within the range of 15-60 seconds are allowed. - `jsonFileFormat` JsonFileFormat — JSON file format configuration. - `schemaFileFormat` 'SCHEMA_FILE_FORMAT_UNSPECIFIED' | 'NO_SCHEMA_FILE' | 'AVRO_SCHEMA_FILE' — The schema file format along JSON data files. - `compression` 'JSON_COMPRESSION_UNSPECIFIED' | 'NO_COMPRESSION' | 'GZIP' — Compression of the loaded JSON file. - `fileRotationMb` integer — The maximum file size to be saved in the bucket. - `avroFileFormat` AvroFileFormat — AVRO file format configuration. - `destinationConnectionProfile` string — Required. Destination connection profile resource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}` - `bigqueryDestinationConfig` BigQueryDestinationConfig — BigQuery destination configuration - `sourceHierarchyDatasets` SourceHierarchyDatasets — Destination datasets are created so that hierarchy of the destination data objects matches the source hierarchy. - `datasetTemplate` DatasetTemplate — Dataset template used for dynamic dataset creation. - `location` string — Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. - `kmsKeyName` string — Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. i.e. projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{cryptoKey}. See https://cloud.google.com/bigquery/docs/customer-managed-encryption for more information. - `datasetIdPrefix` string — If supplied, every created dataset will have its name prefixed by the provided value. The prefix and name will be separated by an underscore. i.e. _. - `projectId` string — Optional. The project id of the BigQuery dataset. If not specified, the project will be inferred from the stream resource. - `appendOnly` AppendOnly — AppendOnly mode defines that all changes to a table will be written to the destination table. - `singleTargetDataset` SingleTargetDataset — A single target dataset to which all data will be streamed. - `datasetId` string — The dataset ID of the target dataset. DatasetIds allowed characters: https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#datasetreference. - `merge` Merge — Merge mode defines that all changes to a table will be merged at the destination table. - `blmtConfig` BlmtConfig — The configuration for BLMT. - `fileFormat` 'FILE_FORMAT_UNSPECIFIED' | 'PARQUET' — Required. The file format. - `bucket` string — Required. The Cloud Storage bucket name. - `tableFormat` 'TABLE_FORMAT_UNSPECIFIED' | 'ICEBERG' — Required. The table format. - `rootPath` string — The root path inside the Cloud Storage bucket. - `connectionName` string — Required. The bigquery connection. Format: `{project}.{location}.{name}` - `dataFreshness` string, google-duration — The guaranteed data freshness (in seconds) when querying tables created by the stream. Editing this field will only affect new tables created in the future, but existing tables will not be impacted. Lower values mean that queries will return fresher data, but may result in higher cost. - `updateTime` string, google-datetime — Output only. The last update time of the stream. - `customerManagedEncryptionKey` string — Immutable. A reference to a KMS encryption key. If provided, it will be used to encrypt the data. If left blank, data will be encrypted using an internal Stream-specific encryption key provisioned through KMS. - `ruleSets` RuleSet[] — Optional. Rule sets to apply to the stream. - `customizationRules` CustomizationRule[] — Required. List of customization rules to apply. - `bigqueryClustering` BigQueryClustering — BigQuery clustering configuration. - `columns` string[] — Required. Column names to set as clustering columns. - `bigqueryPartitioning` BigQueryPartitioning — BigQuery partitioning configuration. - `ingestionTimePartition` IngestionTimePartition — Ingestion time partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time - `partitioningTimeGranularity` 'PARTITIONING_TIME_GRANULARITY_UNSPECIFIED' | 'PARTITIONING_TIME_GRANULARITY_HOUR' | 'PARTITIONING_TIME_GRANULARITY_DAY' | 'PARTITIONING_TIME_GRANULARITY_MONTH' | 'PARTITIONING_TIME_GRANULARITY_YEAR' — Optional. Partition granularity - `requirePartitionFilter` boolean — Optional. If true, queries over the table require a partition filter. - `integerRangePartition` IntegerRangePartition — Integer range partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#integer_range - `start` string, int64 — Required. The starting value for range partitioning (inclusive). - `column` string — Required. The partitioning column. - `end` string, int64 — Required. The ending value for range partitioning (exclusive). - `interval` string, int64 — Required. The interval of each range within the partition. - `timeUnitPartition` TimeUnitPartition — Time unit column partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#date_timestamp_partitioned_tables - `partitioningTimeGranularity` 'PARTITIONING_TIME_GRANULARITY_UNSPECIFIED' | 'PARTITIONING_TIME_GRANULARITY_HOUR' | 'PARTITIONING_TIME_GRANULARITY_DAY' | 'PARTITIONING_TIME_GRANULARITY_MONTH' | 'PARTITIONING_TIME_GRANULARITY_YEAR' — Optional. Partition granularity. - `column` string — Required. The partitioning column. - `objectFilter` ObjectFilter — Object filter to apply the rules to. - `sourceObjectIdentifier` SourceObjectIdentifier — Represents an identifier of an object in the data source. - `salesforceIdentifier` SalesforceObjectIdentifier — Salesforce data source object identifier. - `objectName` string — Required. The object name. - `oracleIdentifier` OracleObjectIdentifier — Oracle data source object identifier. - `schema` string — Required. The schema name. - `table` string — Required. The table name. - `postgresqlIdentifier` PostgresqlObjectIdentifier — PostgreSQL data source object identifier. - `table` string — Required. The table name. - `schema` string — Required. The schema name. - `mongodbIdentifier` MongodbObjectIdentifier — MongoDB data source object identifier. - `database` string — Required. The database name. - `collection` string — Required. The collection name. - `spannerIdentifier` SpannerObjectIdentifier — Spanner data source object identifier. - `table` string — Required. The table name. - `schema` string — Optional. The schema name. - `mysqlIdentifier` MysqlObjectIdentifier — Mysql data source object identifier. - `database` string — Required. The database name. - `table` string — Required. The table name. - `sqlServerIdentifier` SqlServerObjectIdentifier — SQLServer data source object identifier. - `schema` string — Required. The schema name. - `table` string — Required. The table name. - `sourceConfig` SourceConfig — The configuration of the stream source. - `serviceNowSourceConfig` ServiceNowSourceConfig — Configuration for syncing data from a ServiceNow source. - `includeObjects` SourceCatalog — Source catalog. - `objects` SourceObject[] — Optional. Source objects in the catalog. - `properties` SourceProperty[] — Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. - `propertyName` string — Required. The property name. - `properties` SourceProperty[] — Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. - `primaryKey` boolean — Optional. Whether or not the property is a primary key. - `objectName` string — Required. The object name. - `excludeObjects` SourceCatalog — Source catalog. - `objects` SourceObject[] — Optional. Source objects in the catalog. - `properties` SourceProperty[] — Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. - `propertyName` string — Required. The property name. - `properties` SourceProperty[] — Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. - `primaryKey` boolean — Optional. Whether or not the property is a primary key. - `objectName` string — Required. The object name. - `pollingInterval` string, google-duration — Required. Incremental sync polling interval for all objects. If not set, a default value of `5 minutes` is used. The duration must be from `5 minutes` to `24 hours`, inclusive. - `oracleSourceConfig` OracleSourceConfig — Configuration for syncing data from an Oracle source. - `excludeObjects` OracleRdbms — Oracle database structure. - `oracleSchemas` OracleSchema[] — Oracle schemas/databases in the database server. - `oracleTables` OracleTable[] — Tables in the schema. - `oracleColumns` OracleColumn[] — Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything. - … - `table` string — The table name. - `schema` string — The schema name. - `maxConcurrentBackfillTasks` integer — Maximum number of concurrent backfill tasks. The number should be non-negative. If not set (or set to 0), the system's default value is used. - `maxConcurrentCdcTasks` integer — Maximum number of concurrent CDC tasks. The number should be non-negative. If not set (or set to 0), the system's default value is used. - `includeObjects` OracleRdbms — Oracle database structure. - `oracleSchemas` OracleSchema[] — Oracle schemas/databases in the database server. - `oracleTables` OracleTable[] — Tables in the schema. - `oracleColumns` OracleColumn[] — Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything. - … - `table` string — The table name. - `schema` string — The schema name. - `binaryLogParser` BinaryLogParser — Configuration to use Binary Log Parser CDC technique. - `oracleAsmLogFileAccess` OracleAsmLogFileAccess — Configuration to use Oracle ASM to access the log files. - `logFileDirectories` LogFileDirectories — Configuration to specify the Oracle directories to access the log files. - `archivedLogDirectory` string — Required. Oracle directory for archived logs. - `onlineLogDirectory` string — Required. Oracle directory for online logs. - `streamLargeObjects` StreamLargeObjects — Configuration to stream large object values. - `logMiner` LogMiner — Configuration to use LogMiner CDC method. - `dropLargeObjects` DropLargeObjects — Configuration to drop large object values. - `salesforceSourceConfig` SalesforceSourceConfig — Configuration for syncing data from a Salesforce source. - `includeObjects` SalesforceOrg — Salesforce organization structure. - `objects` SalesforceObject[] — Salesforce objects in the database server. - `objectName` string — The object name. - `fields` SalesforceField[] — Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. - `dataType` string — The data type. - `nillable` boolean — Indicates whether the field can accept nil values. - `name` string — The field name. - `excludeObjects` SalesforceOrg — Salesforce organization structure. - `objects` SalesforceObject[] — Salesforce objects in the database server. - `objectName` string — The object name. - `fields` SalesforceField[] — Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. - `dataType` string — The data type. - `nillable` boolean — Indicates whether the field can accept nil values. - `name` string — The field name. - `pollingInterval` string, google-duration — Required. Salesforce objects polling interval. The interval at which new changes will be polled for each object. The duration must be from `5 minutes` to `24 hours`, inclusive. - `mysqlSourceConfig` MysqlSourceConfig — Configuration for syncing data from a MySQL source. - `gtid` Gtid — Use GTID based replication. - `includeObjects` MysqlRdbms — MySQL database structure - `mysqlDatabases` MysqlDatabase[] — Mysql databases on the server - `database` string — The database name. - `mysqlTables` MysqlTable[] — Tables in the database. - `table` string — The table name. - `mysqlColumns` MysqlColumn[] — MySQL columns in the database. When unspecified as part of include/exclude objects, includes/excludes everything. - … - `maxConcurrentCdcTasks` integer — Maximum number of concurrent CDC tasks. The number should be non negative. If not set (or set to 0), the system's default value will be used. - `excludeObjects` MysqlRdbms — MySQL database structure - `mysqlDatabases` MysqlDatabase[] — Mysql databases on the server - `database` string — The database name. - `mysqlTables` MysqlTable[] — Tables in the database. - `table` string — The table name. - `mysqlColumns` MysqlColumn[] — MySQL columns in the database. When unspecified as part of include/exclude objects, includes/excludes everything. - … - `maxConcurrentBackfillTasks` integer — Maximum number of concurrent backfill tasks. The number should be non negative. If not set (or set to 0), the system's default value will be used. - `binaryLogPosition` BinaryLogPosition — Use Binary log position based replication. - `dataverseSourceConfig` DataverseSourceConfig — Configuration for syncing data from a Dataverse source. - `excludeObjects` SourceCatalog — Source catalog. - `objects` SourceObject[] — Optional. Source objects in the catalog. - `properties` SourceProperty[] — Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. - `propertyName` string — Required. The property name. - `properties` SourceProperty[] — Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. - `primaryKey` boolean — Optional. Whether or not the property is a primary key. - `objectName` string — Required. The object name. - `pollingInterval` string, google-duration — Required. Incremental sync polling interval for all objects. If not set, a default value of `5 minutes` is used. The duration must be from `5 minutes` to `24 hours`, inclusive. - `includeObjects` SourceCatalog — Source catalog. - `objects` SourceObject[] — Optional. Source objects in the catalog. - `properties` SourceProperty[] — Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. - `propertyName` string — Required. The property name. - `properties` SourceProperty[] — Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. - `primaryKey` boolean — Optional. Whether or not the property is a primary key. - `objectName` string — Required. The object name. - `sqlServerSourceConfig` SqlServerSourceConfig — Configuration for syncing data from a SQLServer source. - `maxConcurrentCdcTasks` integer — Max concurrent CDC tasks. - `includeObjects` SqlServerRdbms — SQLServer database structure. - `schemas` SqlServerSchema[] — SQLServer schemas in the database server. - `schema` string — The schema name. - `tables` SqlServerTable[] — Tables in the schema. - `table` string — The table name. - `columns` SqlServerColumn[] — SQLServer columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything. - … - `excludeObjects` SqlServerRdbms — SQLServer database structure. - `schemas` SqlServerSchema[] — SQLServer schemas in the database server. - `schema` string — The schema name. - `tables` SqlServerTable[] — Tables in the schema. - `table` string — The table name. - `columns` SqlServerColumn[] — SQLServer columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything. - … - `maxConcurrentBackfillTasks` integer — Max concurrent backfill tasks. - `transactionLogs` SqlServerTransactionLogs — Configuration to use Transaction Logs CDC read method. - `changeTables` SqlServerChangeTables — Configuration to use Change Tables CDC read method. - `sourceConnectionProfile` string — Required. Source connection profile resource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}` - `postgresqlSourceConfig` PostgresqlSourceConfig — Configuration for syncing data from a PostgreSQL source. - `replicationSlot` string — Required. Immutable. The name of the logical replication slot that's configured with the pgoutput plugin. - `publication` string — Required. The name of the publication that includes the set of all tables that are defined in the stream's include_objects. - `includeObjects` PostgresqlRdbms — PostgreSQL database structure. - `postgresqlSchemas` PostgresqlSchema[] — PostgreSQL schemas in the database server. - `postgresqlTables` PostgresqlTable[] — Tables in the schema. - `postgresqlColumns` PostgresqlColumn[] — PostgreSQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything. - … - `table` string — The table name. - `schema` string — The schema name. - `excludeObjects` PostgresqlRdbms — PostgreSQL database structure. - `postgresqlSchemas` PostgresqlSchema[] — PostgreSQL schemas in the database server. - `postgresqlTables` PostgresqlTable[] — Tables in the schema. - `postgresqlColumns` PostgresqlColumn[] — PostgreSQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything. - … - `table` string — The table name. - `schema` string — The schema name. - `maxConcurrentBackfillTasks` integer — Maximum number of concurrent backfill tasks. The number should be non negative. If not set (or set to 0), the system's default value will be used. - `mongodbSourceConfig` MongodbSourceConfig — Configuration for syncing data from a MongoDB source. - `includeObjects` MongodbCluster — MongoDB Cluster structure. - `databases` MongodbDatabase[] — MongoDB databases in the cluster. - `database` string — The database name. - `collections` MongodbCollection[] — Collections in the database. - `fields` MongodbField[] — Fields in the collection. - … - `collection` string — The collection name. - `jsonMode` 'MONGODB_JSON_MODE_UNSPECIFIED' | 'STRICT' | 'CANONICAL' — Optional. MongoDB JSON mode to use for the stream. - `excludeObjects` MongodbCluster — MongoDB Cluster structure. - `databases` MongodbDatabase[] — MongoDB databases in the cluster. - `database` string — The database name. - `collections` MongodbCollection[] — Collections in the database. - `fields` MongodbField[] — Fields in the collection. - … - `collection` string — The collection name. - `maxConcurrentBackfillTasks` integer — Optional. Maximum number of concurrent backfill tasks. The number should be non-negative and less than or equal to 50. If not set (or set to 0), the system's default value is used - `salesforceMarketingCloudSourceConfig` SalesforceMarketingCloudSourceConfig — Configuration for syncing data from a Salesforce Marketing Cloud source. - `includeObjects` SourceCatalog — Source catalog. - `objects` SourceObject[] — Optional. Source objects in the catalog. - `properties` SourceProperty[] — Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. - `propertyName` string — Required. The property name. - `properties` SourceProperty[] — Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. - `primaryKey` boolean — Optional. Whether or not the property is a primary key. - `objectName` string — Required. The object name. - `excludeObjects` SourceCatalog — Source catalog. - `objects` SourceObject[] — Optional. Source objects in the catalog. - `properties` SourceProperty[] — Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. - `propertyName` string — Required. The property name. - `properties` SourceProperty[] — Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. - `primaryKey` boolean — Optional. Whether or not the property is a primary key. - `objectName` string — Required. The object name. - `pollingInterval` string, google-duration — Required. Incremental sync polling interval for all objects. If not set, a default value of `5 minutes` is used. The duration must be from `5 minutes` to `24 hours`, inclusive. - `fullRefreshPollingInterval` string, google-duration — Required. Specifies the polling interval for a full refresh of objects that do not support incremental sync. If not set, a default value of 24 hours is used. The duration must be between 1 and 24 hours, inclusive. - `spannerSourceConfig` SpannerSourceConfig — Configuration for syncing data from a Spanner source. - `fgacRole` string — Optional. The FGAC role to use for the stream. - `backfillDataBoostEnabled` boolean — Optional. Whether to use Data Boost for Spanner backfills. Defaults to false if not set. - `maxConcurrentBackfillTasks` integer — Optional. Maximum number of concurrent backfill tasks. - `excludeObjects` SpannerDatabase — Spanner database structure. - `schemas` SpannerSchema[] — Optional. Spanner schemas in the database. - `tables` SpannerTable[] — Optional. Spanner tables in the schema. - `columns` SpannerColumn[] — Optional. Spanner columns in the table. - … - `table` string — Required. The table name. - `schema` string — Required. The schema name. - `includeObjects` SpannerDatabase — Spanner database structure. - `schemas` SpannerSchema[] — Optional. Spanner schemas in the database. - `tables` SpannerTable[] — Optional. Spanner tables in the schema. - `columns` SpannerColumn[] — Optional. Spanner columns in the table. - … - `table` string — Required. The table name. - `schema` string — Required. The schema name. - `changeStreamName` string — Required. Immutable. The change stream name to use for the stream. - `spannerRpcPriority` 'SPANNER_RPC_PRIORITY_UNSPECIFIED' | 'LOW' | 'MEDIUM' | 'HIGH' — Optional. The RPC priority to use for the stream. - `maxConcurrentCdcTasks` integer — Optional. Maximum number of concurrent CDC tasks. - `state` 'STATE_UNSPECIFIED' | 'NOT_STARTED' | 'RUNNING' | 'PAUSED' | 'MAINTENANCE' | 'FAILED' | 'FAILED_PERMANENTLY' | 'STARTING' | 'DRAINING' — The state of the stream. - `createTime` string, google-datetime — Output only. The creation time of the stream. - `displayName` string — Required. Display name. - `backfillNone` BackfillNoneStrategy — Backfill strategy to disable automatic backfill for the Stream's objects. - `labels` object — Labels. - `name` string — Output only. Identifier. The stream's name. - `backfillAll` BackfillAllStrategy — Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded. - `spannerExcludedObjects` SpannerDatabase — Spanner database structure. - `schemas` SpannerSchema[] — Optional. Spanner schemas in the database. - `tables` SpannerTable[] — Optional. Spanner tables in the schema. - `columns` SpannerColumn[] — Optional. Spanner columns in the table. - `ordinalPosition` string, int64 — Optional. The ordinal position of the column in the table. - `isPrimaryKey` boolean — Optional. Whether or not the column is a primary key. - `column` string — Required. The column name. - `dataType` string — Optional. Spanner data type. - `table` string — Required. The table name. - `schema` string — Required. The schema name. - `sqlServerExcludedObjects` SqlServerRdbms — SQLServer database structure. - `schemas` SqlServerSchema[] — SQLServer schemas in the database server. - `schema` string — The schema name. - `tables` SqlServerTable[] — Tables in the schema. - `table` string — The table name. - `columns` SqlServerColumn[] — SQLServer columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything. - `length` integer — Column length. - `scale` integer — Column scale. - `primaryKey` boolean — Whether or not the column represents a primary key. - `dataType` string — The SQLServer data type. - `precision` integer — Column precision. - `ordinalPosition` integer — The ordinal position of the column in the table. - `nullable` boolean — Whether or not the column can accept a null value. - `column` string — The column name. - `saasExcludedObjects` SourceCatalog — Source catalog. - `objects` SourceObject[] — Optional. Source objects in the catalog. - `properties` SourceProperty[] — Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. - `propertyName` string — Required. The property name. - `properties` SourceProperty[] — Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. - `primaryKey` boolean — Optional. Whether or not the property is a primary key. - `objectName` string — Required. The object name. - `salesforceExcludedObjects` SalesforceOrg — Salesforce organization structure. - `objects` SalesforceObject[] — Salesforce objects in the database server. - `objectName` string — The object name. - `fields` SalesforceField[] — Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing. - `dataType` string — The data type. - `nillable` boolean — Indicates whether the field can accept nil values. - `name` string — The field name. - `mongodbExcludedObjects` MongodbCluster — MongoDB Cluster structure. - `databases` MongodbDatabase[] — MongoDB databases in the cluster. - `database` string — The database name. - `collections` MongodbCollection[] — Collections in the database. - `fields` MongodbField[] — Fields in the collection. - `field` string — The field name. - `collection` string — The collection name. - `mysqlExcludedObjects` MysqlRdbms — MySQL database structure - `mysqlDatabases` MysqlDatabase[] — Mysql databases on the server - `database` string — The database name. - `mysqlTables` MysqlTable[] — Tables in the database. - `table` string — The table name. - `mysqlColumns` MysqlColumn[] — MySQL columns in the database. When unspecified as part of include/exclude objects, includes/excludes everything. - `column` string — The column name. - `nullable` boolean — Whether or not the column can accept a null value. - `ordinalPosition` integer — The ordinal position of the column in the table. - `collation` string — Column collation. - `primaryKey` boolean — Whether or not the column represents a primary key. - `scale` integer — Column scale. - `precision` integer — Column precision. - `dataType` string — The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html - `length` integer — Column length. - `oracleExcludedObjects` OracleRdbms — Oracle database structure. - `oracleSchemas` OracleSchema[] — Oracle schemas/databases in the database server. - `oracleTables` OracleTable[] — Tables in the schema. - `oracleColumns` OracleColumn[] — Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything. - `encoding` string — Column encoding. - `scale` integer — Column scale. - `primaryKey` boolean — Whether or not the column represents a primary key. - `nullable` boolean — Whether or not the column can accept a null value. - `column` string — The column name. - `ordinalPosition` integer — The ordinal position of the column in the table. - `dataType` string — The Oracle data type. - `length` integer — Column length. - `precision` integer — Column precision. - `table` string — The table name. - `schema` string — The schema name. - `postgresqlExcludedObjects` PostgresqlRdbms — PostgreSQL database structure. - `postgresqlSchemas` PostgresqlSchema[] — PostgreSQL schemas in the database server. - `postgresqlTables` PostgresqlTable[] — Tables in the schema. - `postgresqlColumns` PostgresqlColumn[] — PostgreSQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything. - `dataType` string — The PostgreSQL data type. - `length` integer — Column length. - `scale` integer — Column scale. - `primaryKey` boolean — Whether or not the column represents a primary key. - `nullable` boolean — Whether or not the column can accept a null value. - `column` string — The column name. - `precision` integer — Column precision. - `ordinalPosition` integer — The ordinal position of the column in the table. - `table` string — The table name. - `schema` string — The schema name. - `lastRecoveryTime` string, google-datetime — Output only. If the stream was recovered, the time of the last recovery. Note: This field is currently experimental. - `satisfiesPzi` boolean — Output only. Reserved for future use. ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/datastream.md) · [All operations](https://skmtc.net/google/apis/datastream/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/datastream/versions/f9da70538976/schema)