Eventarc v1 API - Class Pipeline (2.6.0)

public sealed class Pipeline : IMessage<Pipeline>, IEquatable<Pipeline>, IDeepCloneable<Pipeline>, IBufferMessage, IMessage

Reference documentation and code samples for the Eventarc v1 API class Pipeline.

A representation of the Pipeline resource.

Inheritance

object > Pipeline

Namespace

Google.Cloud.Eventarc.V1

Assembly

Google.Cloud.Eventarc.V1.dll

Constructors

Pipeline()

public Pipeline()

Pipeline(Pipeline)

public Pipeline(Pipeline other)
Parameter
Name Description
other Pipeline

Properties

Annotations

public MapField<string, string> Annotations { get; }

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

Property Value
Type Description
MapFieldstringstring

CreateTime

public Timestamp CreateTime { get; set; }

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".

Property Value
Type Description
Timestamp

CryptoKeyName

public string CryptoKeyName { get; set; }

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}".

Property Value
Type Description
string

CryptoKeyNameAsCryptoKeyName

public CryptoKeyName CryptoKeyNameAsCryptoKeyName { get; set; }

CryptoKeyName-typed view over the CryptoKeyName resource name property.

Property Value
Type Description
CryptoKeyName

Destinations

public RepeatedField<Pipeline.Types.Destination> Destinations { get; }

Required. List of destinations to which messages will be forwarded. Currently, exactly one destination is supported per Pipeline.

Property Value
Type Description
RepeatedFieldPipelineTypesDestination

DisplayName

public string DisplayName { get; set; }

Optional. Display name of resource.

Property Value
Type Description
string

Etag

public string Etag { get; set; }

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.

Property Value
Type Description
string

InputPayloadFormat

public Pipeline.Types.MessagePayloadFormat InputPayloadFormat { get; set; }

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.

Property Value
Type Description
PipelineTypesMessagePayloadFormat

Labels

public MapField<string, string> Labels { get; }

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" }.

Property Value
Type Description
MapFieldstringstring

LoggingConfig

public LoggingConfig LoggingConfig { get; set; }

Optional. Config to control Platform Logging for Pipelines.

Property Value
Type Description
LoggingConfig

Mediations

public RepeatedField<Pipeline.Types.Mediation> Mediations { get; }

Optional. List of mediation operations to be performed on the message. Currently, only one Transformation operation is allowed in each Pipeline.

Property Value
Type Description
RepeatedFieldPipelineTypesMediation

Name

public string Name { get; set; }

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.

Property Value
Type Description
string

PipelineName

public PipelineName PipelineName { get; set; }

PipelineName-typed view over the Name resource name property.

Property Value
Type Description
PipelineName

RetryPolicy

public Pipeline.Types.RetryPolicy RetryPolicy { get; set; }

Optional. The retry policy to use in the pipeline.

Property Value
Type Description
PipelineTypesRetryPolicy

Uid

public string Uid { get; set; }

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.

Property Value
Type Description
string

UpdateTime

public Timestamp UpdateTime { get; set; }

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".

Property Value
Type Description
Timestamp