objects

Creates, updates, deletes, gets or lists an objects resource.

Overview

Name	objects
Type	Resource
Id	google.datastream.objects

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Output only. Identifier. The object resource's name.
backfillJob	object	The latest backfill job that was initiated for the stream object. (id: BackfillJob)
createTime	string (google-datetime)	Output only. The creation time of the object.
customizationRules	array	Output only. The customization rules for the object. These rules are derived from the parent Stream's rule_sets and represent the intended configuration for the object.
displayName	string	Required. Display name.
errors	array	Output only. Active errors on the object.
sourceObject	object	The object identifier in the data source. (id: SourceObjectIdentifier)
updateTime	string (google-datetime)	Output only. The last update time of the object.

list

Name	Datatype	Description
name	string	Output only. Identifier. The object resource's name.
backfillJob	object	The latest backfill job that was initiated for the stream object. (id: BackfillJob)
createTime	string (google-datetime)	Output only. The creation time of the object.
customizationRules	array	Output only. The customization rules for the object. These rules are derived from the parent Stream's rule_sets and represent the intended configuration for the object.
displayName	string	Required. Display name.
errors	array	Output only. Active errors on the object.
sourceObject	object	The object identifier in the data source. (id: SourceObjectIdentifier)
updateTime	string (google-datetime)	Output only. The last update time of the object.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, streamsId, objectsId		Use this method to get details about a stream object.
list	select	projectsId, locationsId, streamsId	pageSize, pageToken	Use this method to list the objects of a specific stream.
lookup	exec	projectsId, locationsId, streamsId		Use this method to look up a stream object by its source object identifier.
start_backfill_job	exec	projectsId, locationsId, streamsId, objectsId		Use this method to start a backfill job for the specified stream object.
stop_backfill_job	exec	projectsId, locationsId, streamsId, objectsId		Use this method to stop a backfill job for the specified stream object.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
objectsId	string
projectsId	string
streamsId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Use this method to get details about a stream object.

SELECT
name,
backfillJob,
createTime,
customizationRules,
displayName,
errors,
sourceObject,
updateTime
FROM google.datastream.objects
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND streamsId = '{{ streamsId }}' -- required
AND objectsId = '{{ objectsId }}' -- required
;

list

Use this method to list the objects of a specific stream.

SELECT
name,
backfillJob,
createTime,
customizationRules,
displayName,
errors,
sourceObject,
updateTime
FROM google.datastream.objects
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND streamsId = '{{ streamsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

Lifecycle Methods

lookup

Use this method to look up a stream object by its source object identifier.

EXEC google.datastream.objects.lookup 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@streamsId='{{ streamsId }}' --required 
@@json=
'{
"sourceObjectIdentifier": "{{ sourceObjectIdentifier }}"
}'
;

start_backfill_job

Use this method to start a backfill job for the specified stream object.

EXEC google.datastream.objects.start_backfill_job 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@streamsId='{{ streamsId }}' --required, 
@objectsId='{{ objectsId }}' --required 
@@json=
'{
"eventFilter": "{{ eventFilter }}"
}'
;

stop_backfill_job

Use this method to stop a backfill job for the specified stream object.

EXEC google.datastream.objects.stop_backfill_job 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@streamsId='{{ streamsId }}' --required, 
@objectsId='{{ objectsId }}' --required
;