Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1321173132.7 KB
projects

Use this method to create a stream.

post/v1/{+parent}/streams

Path parameters

parentstring required

Required. The parent that owns the collection of streams.

Query parameters

forceboolean

Optional. Create the stream without validating it.

requestIdstring

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

streamIdstring

Required. The stream identifier.

validateOnlyboolean

Optional. Only validate the stream, but don't create any resources. The default is false.

Request body

satisfiesPzsboolean

Output only. Reserved for future use.

updateTimestring google-datetime

Output only. The last update time of the stream.

customerManagedEncryptionKeystring

Immutable. A reference to a KMS encryption key. If provided, it will be used to encrypt the data. If left blank, data will be encrypted using an internal Stream-specific encryption key provisioned through KMS.

state'STATE_UNSPECIFIED' | 'NOT_STARTED' | 'RUNNING' | 'PAUSED' | 'MAINTENANCE' | 'FAILED' | 'FAILED_PERMANENTLY' | 'STARTING' | 'DRAINING'

The state of the stream.

createTimestring google-datetime

Output only. The creation time of the stream.

displayNamestring

Required. Display name.

backfillNoneBackfillNoneStrategy

Backfill strategy to disable automatic backfill for the Stream's objects.

labelsobject

Labels.

namestring

Output only. Identifier. The stream's name.

lastRecoveryTimestring google-datetime

Output only. If the stream was recovered, the time of the last recovery. Note: This field is currently experimental.

satisfiesPziboolean

Output only. Reserved for future use.

Response

Successful response