Show / Hide Table of Contents

Class Pipeline

A representation of the Pipeline resource.

Inheritance
object
Pipeline
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Eventarc.v1.Data
Assembly: Google.Apis.Eventarc.v1.dll
Syntax
public class Pipeline : IDirectResponseSchema

Properties

Annotations

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

Declaration
[JsonProperty("annotations")]
public virtual IDictionary<string, string> Annotations { get; set; }
Property Value
Type Description
IDictionary<string, string>

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

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

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

CryptoKeyName

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

Declaration
[JsonProperty("cryptoKeyName")]
public virtual string CryptoKeyName { get; set; }
Property Value
Type Description
string

Destinations

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

Declaration
[JsonProperty("destinations")]
public virtual IList<GoogleCloudEventarcV1PipelineDestination> Destinations { get; set; }
Property Value
Type Description
IList<GoogleCloudEventarcV1PipelineDestination>

DisplayName

Optional. Display name of resource.

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

ETag

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.

Declaration
[JsonProperty("etag")]
public virtual string ETag { get; set; }
Property Value
Type Description
string

InputPayloadFormat

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.

Declaration
[JsonProperty("inputPayloadFormat")]
public virtual GoogleCloudEventarcV1PipelineMessagePayloadFormat InputPayloadFormat { get; set; }
Property Value
Type Description
GoogleCloudEventarcV1PipelineMessagePayloadFormat

Labels

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

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

LoggingConfig

Optional. Config to control Platform Logging for Pipelines.

Declaration
[JsonProperty("loggingConfig")]
public virtual LoggingConfig LoggingConfig { get; set; }
Property Value
Type Description
LoggingConfig

Mediations

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

Declaration
[JsonProperty("mediations")]
public virtual IList<GoogleCloudEventarcV1PipelineMediation> Mediations { get; set; }
Property Value
Type Description
IList<GoogleCloudEventarcV1PipelineMediation>

Name

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.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

RetryPolicy

Optional. The retry policy to use in the pipeline.

Declaration
[JsonProperty("retryPolicy")]
public virtual GoogleCloudEventarcV1PipelineRetryPolicy RetryPolicy { get; set; }
Property Value
Type Description
GoogleCloudEventarcV1PipelineRetryPolicy

Uid

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.

Declaration
[JsonProperty("uid")]
public virtual string Uid { get; set; }
Property Value
Type Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

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

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX