- NAME
-
- gcloud datastream objects lookup - lookup a Datastream stream object
- SYNOPSIS
-
-
gcloud datastream objects lookup(--salesforce-object-name=SALESFORCE_OBJECT_NAME|--mysql-database=MYSQL_DATABASE--mysql-table=MYSQL_TABLE|--oracle-schema=ORACLE_SCHEMA--oracle-table=ORACLE_TABLE|--postgresql-schema=POSTGRESQL_SCHEMA--postgresql-table=POSTGRESQL_TABLE| [--spanner-table=SPANNER_TABLE:--spanner-schema=SPANNER_SCHEMA] |--sqlserver-schema=SQLSERVER_SCHEMA--sqlserver-table=SQLSERVER_TABLE) (--stream=STREAM:--location=LOCATION) [--endpoint-mode=ENDPOINT_MODE] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
- Lookup a stream object by its source object identifier (e.g. schema.table)
- EXAMPLES
-
To lookup an existing Mysql stream object:
gcloud datastream objects lookup --stream=my-stream --location=us-central1 --mysql-database=my-db --mysql-table=my-tableTo lookup an existing Oracle stream object:
gcloud datastream objects lookup --stream=my-stream --location=us-central1 --oracle-schema=my-schema --oracle-table=my-tableTo lookup an existing PostgreSQL stream object:
gcloud datastream objects lookup --stream=my-stream --location=us-central1 --postgresql-schema=my-schema --postgresql-table=my-tableTo lookup an existing SQL Server stream object:
gcloud datastream objects lookup --stream=my-stream --location=us-central1 --sqlserver-schema=my-schema --sqlserver-table=my-tableTo lookup an existing Salesforce stream object:
gcloud datastream objects lookup --stream=my-stream --location=us-central1 --salesforce-object-name=my-object - REQUIRED FLAGS
-
-
Exactly one of these must be specified:
--salesforce-object-name=SALESFORCE_OBJECT_NAME- Salesforce object name.
--mysql-database=MYSQL_DATABASE-
Mysql database for the object.
This flag argument must be specified if any of the other arguments in this group are specified.
--mysql-table=MYSQL_TABLE-
Mysql table for the object.
This flag argument must be specified if any of the other arguments in this group are specified.
--oracle-schema=ORACLE_SCHEMA-
Oracle schema for the object.
This flag argument must be specified if any of the other arguments in this group are specified.
--oracle-table=ORACLE_TABLE-
Oracle table for the object.
This flag argument must be specified if any of the other arguments in this group are specified.
--postgresql-schema=POSTGRESQL_SCHEMA-
PostgreSQL schema for the object.
This flag argument must be specified if any of the other arguments in this group are specified.
--postgresql-table=POSTGRESQL_TABLE-
PostgreSQL table for the object.
This flag argument must be specified if any of the other arguments in this group are specified.
--spanner-table=SPANNER_TABLE-
Spanner table name.
This flag argument must be specified if any of the other arguments in this group are specified.
--spanner-schema=SPANNER_SCHEMA- Spanner schema name.
--sqlserver-schema=SQLSERVER_SCHEMA-
SQL Server schema for the object.
This flag argument must be specified if any of the other arguments in this group are specified.
--sqlserver-table=SQLSERVER_TABLE-
SQL Server table for the object.
This flag argument must be specified if any of the other arguments in this group are specified.
-
Stream resource - The stream to list objects for. The arguments in this group
can be used to specify the attributes of this resource. (NOTE) Some attributes
are not given arguments in this group but can be set in other ways.
To set the
projectattribute:-
provide the argument
--streamon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
This must be specified.
--stream=STREAM-
ID of the stream or fully qualified identifier for the stream.
To set the
streamattribute:-
provide the argument
--streamon the command line.
This flag argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--location=LOCATION-
The Cloud location for the stream.
To set the
locationattribute:-
provide the argument
--streamon the command line with a fully specified name; -
provide the argument
--locationon the command line.
-
provide the argument
-
provide the argument
-
Exactly one of these must be specified:
- OPTIONAL FLAGS
-
--endpoint-mode=ENDPOINT_MODE-
Specifies endpoint mode for a given command. Regional endpoints provide enhanced
data residency and reliability by ensuring your request is handled entirely
within the specified Google Cloud region. This differs from global endpoints,
which may process parts of the request outside the target region. Overrides the
default
regional/endpoint_modeproperty value for this command invocation.ENDPOINT_MODEmust be one of:global- (Default) Use global rather than regional endpoints.
regional- Only use regional endpoints. An error will be raised if a regional endpoint is not available for a given command.
regional-preferred- Use regional endpoints when available, otherwise use global endpoints. Recommended for most users.
- GCLOUD WIDE FLAGS
-
These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$ gcloud helpfor details. - REGIONAL ENDPOINTS
-
This command supports regional endpoints. To use regional endpoints for this
command, use the
--endpoint-mode=regional-preferredflag. To use regional endpoints by default, run$ gcloud config set regional/endpoint_mode regional-preferred.
gcloud datastream objects lookup
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-06-23 UTC.