pipelines

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

Overview

Name	`pipelines`
Type	Resource
Id	`google.eventarc.pipelines`

Fields

The following fields are returned by SELECT queries:

get
list

Name	Datatype	Description
`name`	`string`	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.
`annotations`	`object`	Optional. User-defined annotations. See https://google.aip.dev/128#annotations.
`createTime`	`string (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".
`cryptoKeyName`	`string`	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}".
`destinations`	`array`	Required. List of destinations to which messages will be forwarded. Currently, exactly one destination is supported per Pipeline.
`displayName`	`string`	Optional. Display name of resource.
`etag`	`string`	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.
`inputPayloadFormat`	`object`	Optional. 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)
`labels`	`object`	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" }.
`loggingConfig`	`object`	Optional. Config to control Platform Logging for Pipelines. (id: LoggingConfig)
`mediations`	`array`	Optional. List of mediation operations to be performed on the message. Currently, only one Transformation operation is allowed in each Pipeline.
`retryPolicy`	`object`	Optional. The retry policy to use in the pipeline. (id: GoogleCloudEventarcV1PipelineRetryPolicy)
`satisfiesPzs`	`boolean`	Output only. Whether or not this Pipeline satisfies the requirements of physical zone separation
`uid`	`string`	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.
`updateTime`	`string (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".

Name	Datatype	Description
`name`	`string`	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.
`annotations`	`object`	Optional. User-defined annotations. See https://google.aip.dev/128#annotations.
`createTime`	`string (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".
`cryptoKeyName`	`string`	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}".
`destinations`	`array`	Required. List of destinations to which messages will be forwarded. Currently, exactly one destination is supported per Pipeline.
`displayName`	`string`	Optional. Display name of resource.
`etag`	`string`	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.
`inputPayloadFormat`	`object`	Optional. 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)
`labels`	`object`	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" }.
`loggingConfig`	`object`	Optional. Config to control Platform Logging for Pipelines. (id: LoggingConfig)
`mediations`	`array`	Optional. List of mediation operations to be performed on the message. Currently, only one Transformation operation is allowed in each Pipeline.
`retryPolicy`	`object`	Optional. The retry policy to use in the pipeline. (id: GoogleCloudEventarcV1PipelineRetryPolicy)
`satisfiesPzs`	`boolean`	Output only. Whether or not this Pipeline satisfies the requirements of physical zone separation
`uid`	`string`	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.
`updateTime`	`string (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:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`projectsId`, `locationsId`, `pipelinesId`		Get a single Pipeline.
`list`	`select`	`projectsId`, `locationsId`	`pageSize`, `orderBy`, `filter`, `pageToken`	List pipelines.
`create`	`insert`	`projectsId`, `locationsId`	`validateOnly`, `pipelineId`	Create a new Pipeline in a particular project and location.
`patch`	`update`	`projectsId`, `locationsId`, `pipelinesId`	`validateOnly`, `allowMissing`, `updateMask`	Update a single pipeline.
`delete`	`delete`	`projectsId`, `locationsId`, `pipelinesId`	`allowMissing`, `validateOnly`, `etag`	Delete 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.

Name	Datatype	Description
`locationsId`	`string`
`pipelinesId`	`string`
`projectsId`	`string`
`allowMissing`	`boolean`
`etag`	`string`
`filter`	`string`
`orderBy`	`string`
`pageSize`	`integer (int32)`
`pageToken`	`string`
`pipelineId`	`string`
`updateMask`	`string (google-fieldmask)`
`validateOnly`	`boolean`

`SELECT` examples

get
list

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
;

List pipelines.

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 pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}'
AND pageToken = '{{ pageToken }}'
;

`INSERT` examples

create
Manifest

Create a new Pipeline in a particular project and location.

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

# Description fields are for documentation purposes
- name: pipelines
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the pipelines resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the pipelines resource.
  - name: annotations
    value: "{{ annotations }}"
    description: |
      Optional. User-defined annotations. See https://google.aip.dev/128#annotations.
  - name: retryPolicy
    description: |
      Optional. The retry policy to use in the pipeline.
    value:
      maxAttempts: {{ maxAttempts }}
      minRetryDelay: "{{ minRetryDelay }}"
      maxRetryDelay: "{{ maxRetryDelay }}"
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Optional. Display name of resource.
  - name: destinations
    description: |
      Required. List of destinations to which messages will be forwarded. Currently, exactly one destination is supported per Pipeline.
    value:
      - workflow: "{{ workflow }}"
        topic: "{{ topic }}"
        networkConfig:
          networkAttachment: "{{ networkAttachment }}"
        messageBus: "{{ messageBus }}"
        httpEndpoint:
          uri: "{{ uri }}"
          messageBindingTemplate: "{{ messageBindingTemplate }}"
        authenticationConfig:
          googleOidc:
            serviceAccount: "{{ serviceAccount }}"
            audience: "{{ audience }}"
          oauthToken:
            scope: "{{ scope }}"
            serviceAccount: "{{ serviceAccount }}"
        outputPayloadFormat:
          avro:
            schemaDefinition: "{{ schemaDefinition }}"
          json: "{{ json }}"
          protobuf:
            schemaDefinition: "{{ schemaDefinition }}"
  - name: loggingConfig
    description: |
      Optional. Config to control Platform Logging for Pipelines.
    value:
      logSeverity: "{{ logSeverity }}"
  - name: cryptoKeyName
    value: "{{ cryptoKeyName }}"
    description: |
      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}".
  - name: labels
    value: "{{ labels }}"
    description: |
      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" }.
  - name: inputPayloadFormat
    description: |
      Optional. 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.
    value:
      avro:
        schemaDefinition: "{{ schemaDefinition }}"
      json: "{{ json }}"
      protobuf:
        schemaDefinition: "{{ schemaDefinition }}"
  - name: mediations
    description: |
      Optional. List of mediation operations to be performed on the message. Currently, only one Transformation operation is allowed in each Pipeline.
    value:
      - transformation:
          transformationTemplate: "{{ transformationTemplate }}"
  - name: name
    value: "{{ name }}"
    description: |
      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.
  - name: validateOnly
    value: {{ validateOnly }}
  - name: pipelineId
    value: "{{ pipelineId }}"

`UPDATE` examples

patch

Update a single pipeline.

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

`DELETE` examples

delete

Delete a single pipeline.

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

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​