class ProjectsLocationsStreamsObjects extends Resource (View source)

The "objects" collection of methods.

Typical usage is:

 $datastreamService = new Google\Service\Datastream(...);
 $objects = $datastreamService->projects_locations_streams_objects;

Methods

get(string $name, array $optParams = [])

Use this method to get details about a stream object. (objects.get)

listProjectsLocationsStreamsObjects(string $parent, array $optParams = [])

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

lookup(string $parent, LookupStreamObjectRequest $postBody, array $optParams = [])

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

startBackfillJob(string $object, StartBackfillJobRequest $postBody, array $optParams = [])

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

stopBackfillJob(string $object, StopBackfillJobRequest $postBody, array $optParams = [])

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

Details

StreamObject get(string $name, array $optParams = [])

Use this method to get details about a stream object. (objects.get)

Parameters

string $name

Required. The name of the stream object resource to get.

array $optParams

Optional parameters.

Return Value

StreamObject

Exceptions

Exception

ListStreamObjectsResponse listProjectsLocationsStreamsObjects(string $parent, array $optParams = [])

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

(objects.listProjectsLocationsStreamsObjects)

Parameters

string $parent

Required. The parent stream that owns the collection of objects.

array $optParams

Optional parameters.

Return Value

ListStreamObjectsResponse

Exceptions

Exception

StreamObject lookup(string $parent, LookupStreamObjectRequest $postBody, array $optParams = [])

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

(objects.lookup)

Parameters

string $parent

Required. The parent stream that owns the collection of objects.

LookupStreamObjectRequest $postBody
array $optParams

Optional parameters.

Return Value

StreamObject

Exceptions

Exception

StartBackfillJobResponse startBackfillJob(string $object, StartBackfillJobRequest $postBody, array $optParams = [])

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

(objects.startBackfillJob)

Parameters

string $object

Required. The name of the stream object resource to start a backfill job for.

StartBackfillJobRequest $postBody
array $optParams

Optional parameters.

Return Value

StartBackfillJobResponse

Exceptions

Exception

StopBackfillJobResponse stopBackfillJob(string $object, StopBackfillJobRequest $postBody, array $optParams = [])

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

(objects.stopBackfillJob)

Parameters

string $object

Required. The name of the stream object resource to stop the backfill job for.

StopBackfillJobRequest $postBody
array $optParams

Optional parameters.

Return Value

StopBackfillJobResponse

Exceptions

Exception