Sign in

v1

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

Create a new Pipeline in a particular project and location.

post/v1/{+parent}/pipelines

Path parameters

parentstring required

Required. The parent collection in which to add this pipeline.

Query parameters

pipelineIdstring

Required. The user-provided ID to be assigned to the Pipeline. It should match the format ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$.

validateOnlyboolean

Optional. If set, validate the request and preview the review, but do not post it.

Request body

satisfiesPzsboolean

Output only. Whether or not this Pipeline satisfies the requirements of physical zone separation

namestring

Identifier. The resource name of the Pipeline. Must be unique within the location of the project and must be in projects/{project}/locations/{location}/pipelines/{pipeline} format.

cryptoKeyNamestring

Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt the event data. If not set, an internal Google-owned key will be used to encrypt messages. It must match the pattern "projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}".

annotationsobject

Optional. User-defined annotations. See https://google.aip.dev/128#annotations.

etagstring

Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on create requests to ensure that the client has an up-to-date value before proceeding.

updateTimestring google-datetime

Output only. The last-modified time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

createTimestring google-datetime

Output only. The creation time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

uidstring

Output only. Server-assigned unique identifier for the Pipeline. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.

displayNamestring

Optional. Display name of resource.

labelsobject

Optional. User labels attached to the Pipeline that can be used to group resources. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Response

Successful response