1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Datastream
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsStreams

ProjectsLocationsStreams

class ProjectsLocationsStreams extends Resource (View source)

The "streams" collection of methods.

Typical usage is:

 $datastreamService = new Google\Service\Datastream(...);
 $streams = $datastreamService->projects_locations_streams;

Methods

Operation
create(string $parent, Stream $postBody, array $optParams = [])

Use this method to create a stream. (streams.create)

Operation
delete(string $name, array $optParams = [])

Use this method to delete a stream. (streams.delete)

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

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

ListStreamsResponse
listProjectsLocationsStreams(string $parent, array $optParams = [])

Use this method to list streams in a project and location.

Operation
patch(string $name, Stream $postBody, array $optParams = [])

Use this method to update the configuration of a stream. (streams.patch)

Operation
run(string $name, RunStreamRequest $postBody, array $optParams = [])

Use this method to start, resume or recover a stream with a non default CDC strategy. NOTE: This feature is currently experimental. (streams.run)

Details

at line 61
Operation create(string $parent, Stream $postBody, array $optParams = [])

Use this method to create a stream. (streams.create)

Parameters

string $parent

Required. The parent that owns the collection of streams.
Stream $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 87
Operation delete(string $name, array $optParams = [])

Use this method to delete a stream. (streams.delete)

Parameters

string $name

Required. The name of the stream resource to delete.
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 101
Stream get(string $name, array $optParams = [])

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

Parameters

string $name

Required. The name of the stream resource to get.
array $optParams

Optional parameters.

Return Value

Stream

Exceptions

Exception

at line 127
ListStreamsResponse listProjectsLocationsStreams(string $parent, array $optParams = [])

Use this method to list streams in a project and location.

(streams.listProjectsLocationsStreams)

Parameters

string $parent

Required. The parent that owns the collection of streams.
array $optParams

Optional parameters.

Return Value

ListStreamsResponse

Exceptions

Exception

at line 162
Operation patch(string $name, Stream $postBody, array $optParams = [])

Use this method to update the configuration of a stream. (streams.patch)

Parameters

string $name

Output only. The stream's name.
Stream $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 179
Operation run(string $name, RunStreamRequest $postBody, array $optParams = [])

Use this method to start, resume or recover a stream with a non default CDC strategy. NOTE: This feature is currently experimental. (streams.run)

Parameters

string $name

Required. Name of the stream resource to start, in the format: projects/{project_id}/locations/{location}/streams/{stream_name}
RunStreamRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception