Pipeline

import type { Pipeline } from "https://googleapis.deno.dev/v1/eventarc:v1.ts";

A representation of the Pipeline resource.

interface Pipeline {

annotations?: {

[key: string]: string;

};

readonly createTime?: Date;

cryptoKeyName?: string;

destinations?: GoogleCloudEventarcV1PipelineDestination[];

displayName?: string;

readonly etag?: string;

inputPayloadFormat?: GoogleCloudEventarcV1PipelineMessagePayloadFormat;

labels?: {

[key: string]: string;

};

loggingConfig?: LoggingConfig;

mediations?: GoogleCloudEventarcV1PipelineMediation[];

name?: string;

retryPolicy?: GoogleCloudEventarcV1PipelineRetryPolicy;

readonly satisfiesPzs?: boolean;

readonly uid?: string;

readonly updateTime?: Date;

}

§Properties

annotations?: {

[key: string]: string;

}

[src]

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

readonly createTime?: Date

[src]

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

[src]

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?: GoogleCloudEventarcV1PipelineDestination[]

[src]

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

displayName?: string

[src]

Optional. Display name of resource.

readonly etag?: string

[src]

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?: GoogleCloudEventarcV1PipelineMessagePayloadFormat

[src]

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.

labels?: {

[key: string]: string;

}

[src]

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?: LoggingConfig

[src]

Optional. Config to control Platform Logging for Pipelines.

mediations?: GoogleCloudEventarcV1PipelineMediation[]

[src]

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

name?: string

[src]

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.

retryPolicy?: GoogleCloudEventarcV1PipelineRetryPolicy

[src]

Optional. The retry policy to use in the pipeline.

readonly satisfiesPzs?: boolean

[src]

Output only. Whether or not this Pipeline satisfies the requirements of physical zone separation

readonly uid?: string

[src]

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.

readonly updateTime?: Date

[src]

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