Skip to main content

pipelines

Creates, updates, deletes, gets or lists a pipelines resource.

Overview​

Namepipelines
TypeResource
Idgoogle.eventarc.pipelines

Fields​

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringIdentifier. 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.
annotationsobjectOptional. User-defined annotations. See https://google.aip.dev/128#annotations.
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".
cryptoKeyNamestringOptional. 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}".
destinationsarrayRequired. List of destinations to which messages will be forwarded. Currently, exactly one destination is supported per Pipeline.
displayNamestringOptional. Display name of resource.
etagstringOutput 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.
inputPayloadFormatobjectOptional. The payload format expected for the messages received by the Pipeline. If input_payload_format is set then any messages not matching this format will be treated as persistent errors. If input_payload_format is not set, then the message data will be treated as an opaque binary and no output format can be set on the Pipeline through the Pipeline.Destination.output_payload_format field. Any Mediations on the Pipeline that involve access to the data field will fail as persistent errors. (id: GoogleCloudEventarcV1PipelineMessagePayloadFormat)
labelsobjectOptional. 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" }.
loggingConfigobjectOptional. Config to control Platform Logging for Pipelines. (id: LoggingConfig)
mediationsarrayOptional. List of mediation operations to be performed on the message. Currently, only one Transformation operation is allowed in each Pipeline.
retryPolicyobjectOptional. The retry policy to use in the pipeline. (id: GoogleCloudEventarcV1PipelineRetryPolicy)
satisfiesPzsbooleanOutput only. Whether or not this Pipeline satisfies the requirements of physical zone separation
uidstringOutput only. Server-assigned unique identifier for the Pipeline. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
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".

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprojectsId, locationsId, pipelinesIdGet a single Pipeline.
listselectprojectsId, locationsIdpageSize, pageToken, orderBy, filterList pipelines.
createinsertprojectsId, locationsIdpipelineId, validateOnlyCreate a new Pipeline in a particular project and location.
patchupdateprojectsId, locationsId, pipelinesIdupdateMask, allowMissing, validateOnlyUpdate a single pipeline.
deletedeleteprojectsId, locationsId, pipelinesIdetag, allowMissing, validateOnlyDelete a single pipeline.

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.

NameDatatypeDescription
locationsIdstring
pipelinesIdstring
projectsIdstring
allowMissingboolean
etagstring
filterstring
orderBystring
pageSizeinteger (int32)
pageTokenstring
pipelineIdstring
updateMaskstring (google-fieldmask)
validateOnlyboolean

SELECT examples​

Get a single Pipeline.

SELECT
name,
annotations,
createTime,
cryptoKeyName,
destinations,
displayName,
etag,
inputPayloadFormat,
labels,
loggingConfig,
mediations,
retryPolicy,
satisfiesPzs,
uid,
updateTime
FROM google.eventarc.pipelines
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pipelinesId = '{{ pipelinesId }}' -- required;

INSERT examples​

Create a new Pipeline in a particular project and location.

INSERT INTO google.eventarc.pipelines (
data__name,
data__labels,
data__annotations,
data__displayName,
data__destinations,
data__mediations,
data__cryptoKeyName,
data__inputPayloadFormat,
data__loggingConfig,
data__retryPolicy,
projectsId,
locationsId,
pipelineId,
validateOnly
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ annotations }}',
'{{ displayName }}',
'{{ destinations }}',
'{{ mediations }}',
'{{ cryptoKeyName }}',
'{{ inputPayloadFormat }}',
'{{ loggingConfig }}',
'{{ retryPolicy }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ pipelineId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

UPDATE examples​

Update a single pipeline.

UPDATE google.eventarc.pipelines
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__annotations = '{{ annotations }}',
data__displayName = '{{ displayName }}',
data__destinations = '{{ destinations }}',
data__mediations = '{{ mediations }}',
data__cryptoKeyName = '{{ cryptoKeyName }}',
data__inputPayloadFormat = '{{ inputPayloadFormat }}',
data__loggingConfig = '{{ loggingConfig }}',
data__retryPolicy = '{{ retryPolicy }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND pipelinesId = '{{ pipelinesId }}' --required
AND updateMask = '{{ updateMask}}'
AND allowMissing = {{ allowMissing}}
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples​

Delete a single pipeline.

DELETE FROM google.eventarc.pipelines
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND pipelinesId = '{{ pipelinesId }}' --required
AND etag = '{{ etag }}'
AND allowMissing = '{{ allowMissing }}'
AND validateOnly = '{{ validateOnly }}';