Gets the status of a long-running operation.
***Usage***
Some tools (for example, `run_stream`) return a long-running operation.
You can use this tool to get the status of the operation. It can be called repeatedly until
the operation is complete.
**Parameters**
* `name`: The name of the operation to get.
* `name` should be the name returned by the tool that initiated the operation.
* `name` should be in the format of:
`projects/{project}/locations/{location}/operations/{operation}`.
**Returns**
* An `Operation` object that contains the status of the operation.
* If the operation is not complete, the response will be empty. Do not check more than
every ten seconds.
* If the operation is complete, the response will contain either:
* A `response` field that contains the result of the operation and indicates that it was
successful.
* A `error` field that indicates any errors that occurred during the operation.
Parametersname
Lists connection profiles in a given project and location.
For example:
{
parent: "projects/my-project/locations/us-central1"
create_time_after: 2025-10-02T10:15:33Z
create_time_before: 2025-10-03T00:00:00Z
display_name: bookstore
page_size: 100
}
will return up to 100 connection profiles in `projects/my-project/locations/us-central1`
that were created on or after 2025-10-02T10:15:33 UTC and before 2025-10-03T00:00:00 UTC,
and have "bookstore" in their display name.
ParametersparentrequiredpageSizepageTokendisplayNamecreateTimeAftercreateTimeBefore
Lists streams in a given project and location.
For example:
{
parent: "projects/my-project/locations/us-central1"
create_time_after: 2025-10-02T10:15:33Z
create_time_before: 2025-10-03T00:00:00Z
display_name: bookstore
page_size: 100
running: true
}
will return up to 100 running streams in `projects/my-project/locations/us-central1` that
were created on or after 2025-10-02T10:15:33 UTC and before 2025-10-03T00:00:00 UTC,
and have "bookstore" in their display name.
ParametersfailedparentrequiredrunningpageSizepageTokendisplayNamecreateTimeAftercreateTimeBefore
Get details of the stream specified by the provided resource 'name' parameter.
* The resource 'name' parameter is in the form:
'projects/{project name}/locations/{location}/streams/{stream name}',
for example: 'projects/my-project/locations/us-central1/streams/my-streams'.
Parametersnamerequired
Starts an already created stream, specified by the provided resource 'name' parameter.
**Parameters**
* 'name': The resource name of the stream to start.
* 'name' should be in the format of:
'projects/{project name}/locations/{location}/streams/{stream name}',
for example: 'projects/my-project/locations/us-central1/streams/my-streams'.
* 'force': Whether to run the stream without running prior configuration verification.
The default is 'false'.
**Returns**
* This tool returns a long-running operation. Use the 'get_operation' tool with the
returned operation name to poll its status until it completes. Operation may take
several minutes; do not check more often than every ten seconds.
ParametersnamerequiredforcecdcStrategy
Deletes a stream, specified by the provided resource 'name' parameter.
* The resource 'name' parameter is in the form:
'projects/{project name}/locations/{location}/streams/{stream name}',
for example: 'projects/my-project/locations/us-central1/streams/my-streams'.
* This tool returns a long-running operation. Use the 'get_operation' tool with the
returned operation name to poll its status until it completes. Operation may take
several minutes; do not check more often than every ten seconds.
ParametersnamerequiredrequestId
Lists stream objects in a given stream.
* Parent parameter is in the form 'projects/{project name}/locations/{location}/streams/{stream name}',
for example:
'projects/my-project/locations/us-central1/streams/my-stream'.
* Not all the details of the stream objects are returned.
* To get the full details of a specific stream object, use the 'get_stream_object' tool.
ParametersparentrequiredpageSizepageToken
Get details of the stream object specified by the provided resource 'name' parameter.
* The resource 'name' parameter is in the form:
'projects/{project name}/locations/{location}/streams/{stream name}/objects/{stream object name}',
for example: 'projects/my-project/locations/us-central1/streams/my-stream/objects/my-stream-object'.
Parametersnamerequired
Lookup a stream object by its source object identifier.
**Parameters:**
* The 'parent' parameter is the name of the stream in the form:
'projects/{project name}/locations/{location}/streams/{stream name}',
for example: 'projects/my-project/locations/us-central1/streams/my-stream'.
* The 'source_object_identifier' parameter is the source database object identifier.
Different source databases have different identifier formats. Examples:
* Oracle, PostgreSQL, SQL Server and Spanner databases the identifier is
'schema' and 'table'.
* MySQL databases the identifier is 'database' and 'table'.
ParametersparentrequiredsourceObjectIdentifierrequired
Lists static IP addresses of the provided resource name that need to be allowlisted by the
customer when using the static-IP connectivity method.
Returns up to 100 IP addresses.
* The resource 'name' parameter is in the form 'projects/{project name}/locations/{location}',
for example: 'projects/my-project/locations/us-central1'.
Parametersnamerequired