Class Pipeline (1.13.1) 

Pipeline(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A representation of the Pipeline resource.

Attributes
Name Description
name str
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.
create_time google.protobuf.timestamp_pb2.Timestamp
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".
update_time google.protobuf.timestamp_pb2.Timestamp
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".
labels MutableMapping[str, str]
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" }.
uid str
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.
annotations MutableMapping[str, str]
Optional. User-defined annotations. See https://google.aip.dev/128#annotations.
display_name str
Optional. Display name of resource.
destinations MutableSequence[google.cloud.eventarc_v1.types.Pipeline.Destination]
Required. List of destinations to which messages will be forwarded. Currently, exactly one destination is supported per Pipeline.
mediations MutableSequence[google.cloud.eventarc_v1.types.Pipeline.Mediation]
Optional. List of mediation operations to be performed on the message. Currently, only one Transformation operation is allowed in each Pipeline.
crypto_key_name str
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}".
input_payload_format google.cloud.eventarc_v1.types.Pipeline.MessagePayloadFormat
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.
logging_config google.cloud.eventarc_v1.types.LoggingConfig
Optional. Config to control Platform Logging for Pipelines.
retry_policy google.cloud.eventarc_v1.types.Pipeline.RetryPolicy
Optional. The retry policy to use in the pipeline.
etag str
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.

Classes

AnnotationsEntry

AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.
mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

Destination

Destination(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents a target of an invocation over HTTP.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.
mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

Mediation

Mediation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Mediation defines different ways to modify the Pipeline.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

MessagePayloadFormat

MessagePayloadFormat(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents the format of message data.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

RetryPolicy

RetryPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The retry policy configuration for the Pipeline. The pipeline exponentially backs off in case the destination is non responsive or returns a retryable error code. The default semantics are as follows: The backoff starts with a 5 second delay and doubles the delay after each failed attempt (10 seconds, 20 seconds, 40 seconds, etc.). The delay is capped at 60 seconds by default. Please note that if you set the min_retry_delay and max_retry_delay fields to the same value this will make the duration between retries constant.