.TH "GCLOUD_EVENTARC_PIPELINES_CREATE" 1



.SH "NAME"
.HP
gcloud eventarc pipelines create \- create an Eventarc pipeline



.SH "SYNOPSIS"
.HP
\f5gcloud eventarc pipelines create\fR (\fIPIPELINE\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) \fB\-\-destinations\fR=[\fIhttp_endpoint_uri\fR=\fIURI\fR],[\fIhttp_endpoint_message_binding_template\fR=\fIHTTP_ENDPOINT_MESSAGE_BINDING_TEMPLATE\fR],[\fIworkflow\fR=\fIWORKFLOW\fR],[\fImessage_bus\fR=\fIMESSAGE_BUS\fR],[\fIpubsub_topic\fR=\fIPUBSUB_TOPIC\fR],[\fIproject\fR=\fIPROJECT\fR],[\fIlocation\fR=\fILOCATION\fR],[\fInetwork_attachment\fR=\fINETWORK_ATTACHMENT\fR],[\fIgoogle_oidc_authentication_service_account\fR=\fIGOOGLE_OIDC_AUTHENTICATION_SERVICE_ACCOUNT\fR],[\fIgoogle_oidc_authentication_audience\fR=\fIGOOGLE_OIDC_AUTHENTICATION_AUDIENCE\fR],[\fIoauth_token_authentication_service_account\fR=\fIOAUTH_TOKEN_AUTHENTICATION_SERVICE_ACCOUNT\fR],[\fIoauth_token_authentication_scope\fR=\fIOAUTH_TOKEN_AUTHENTICATION_SCOPE\fR],[\fIoutput_payload_format_json\fR=\fIOUTPUT_PAYLOAD_FORMAT_JSON\fR],[\fIoutput_payload_format_avro_schema_definition\fR=\fIOUTPUT_PAYLOAD_FORMAT_AVRO_SCHEMA_DEFINITION\fR],[\fIoutput_payload_format_protobuf_schema_definition\fR=\fIOUTPUT_PAYLOAD_FORMAT_PROTOBUF_SCHEMA_DEFINITION\fR]#[...] [\fB\-\-async\fR] [\fB\-\-crypto\-key\fR=\fICRYPTO_KEY\fR] [\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-logging\-config\fR=\fILOGGING_CONFIG\fR] [\fB\-\-mediations\fR=[\fItransformation_template\fR=\fITRANSFORMATION_TEMPLATE\fR#...]] [\fB\-\-input\-payload\-format\-avro\-schema\-definition\fR=\fIINPUT_PAYLOAD_FORMAT_AVRO_SCHEMA_DEFINITION\fR\ |\ \fB\-\-input\-payload\-format\-json\fR=\fIINPUT_PAYLOAD_FORMAT_JSON\fR\ |\ \fB\-\-input\-payload\-format\-protobuf\-schema\-definition\fR=\fIINPUT_PAYLOAD_FORMAT_PROTOBUF_SCHEMA_DEFINITION\fR] [\fB\-\-max\-retry\-attempts\fR=\fIMAX_RETRY_ATTEMPTS\fR\ \fB\-\-max\-retry\-delay\fR=\fIMAX_RETRY_DELAY\fR\ \fB\-\-min\-retry\-delay\fR=\fIMIN_RETRY_DELAY\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Create an Eventarc pipeline.



.SH "EXAMPLES"

To create a new pipeline \f5my\-pipeline\fR in location \f5us\-central1\fR with
its destination targeting HTTP endpoint URI 'https://example\-endpoint.com',
run:

.RS 2m
$ gcloud eventarc pipelines create my\-pipeline \e
    \-\-location=us\-central1 \e
    \-\-destinations=http_endpoint_uri='https://example\-endpoint.com'
.RE

To create a new pipeline \f5my\-pipeline\fR in location \f5us\-central1\fR with
an HTTP endpoint URI destination and a message binding template, run:

.RS 2m
$ gcloud eventarc pipelines create my\-pipeline \e
    \-\-location=us\-central1 \e
    \-\-destinations=http_endpoint_uri='https://example\-endpoint.com',\e
http_endpoint_message_binding_template='{"headers":
 {"new\-header\-key": "new\-header\-value"}}'
.RE

To create a new pipeline \f5my\-pipeline\fR in location \f5us\-central1\fR with
a Cloud Workflow destination \f5my\-workflow\fR, run:

.RS 2m
$ gcloud eventarc pipelines create my\-pipeline \e
    \-\-location=us\-central1 \-\-destinations=workflow=my\-workflow
.RE

To create a new pipeline \f5my\-pipeline\fR in location \f5us\-central1\fR with
a message bus destination \f5my\-message\-bus\fR, run:

.RS 2m
$ gcloud eventarc pipelines create my\-pipeline \e
    \-\-location=us\-central1 \-\-destinations=message_bus=my\-message\-bus
.RE

To create a new pipeline \f5my\-pipeline\fR in location \f5us\-central1\fR with
a Cloud Pub/Sub Topic destination \f5my\-topic\fR, run:

.RS 2m
$ gcloud eventarc pipelines create my\-pipeline \e
    \-\-location=us\-central1 \-\-destinations=pubsub_topic=my\-topic
.RE

To create a new pipeline \f5my\-pipeline\fR in location \f5us\-central1\fR with
a Cloud Workflow in project \f5example\-project\fR and location \f5us\-east1\fR,
run:

.RS 2m
$ gcloud eventarc pipelines create my\-pipeline \e
    \-\-location=us\-central1 \e
    \-\-destinations=workflow=my\-workflow,project=example\-project,\e
location=us\-east1
.RE

To create a new pipeline \f5my\-pipeline\fR in location \f5us\-central1\fR with
an HTTP endpoint URI destination \f5https://example\-endpoint.com\fR and a
service account
\f5example\-service\-account@example\-project.gserviceaccount.iam.com\fR for
OIDC authentication, run:

.RS 2m
$ gcloud eventarc pipelines create my\-pipeline \e
    \-\-location=us\-central1 \e
    \-\-destinations=http_endpoint_uri='https://example\-endpoint.com',\e
google_oidc_authentication_service_account=example\-service\-account@e\e
xample\-project.gserviceaccount.iam.com
.RE

To create a new pipeline \f5my\-pipeline\fR in location \f5us\-central1\fR with
an HTTP endpoint URI destination \f5https://example\-endpoint.com\fR and a
service account
\f5example\-service\-account@example\-project.gserviceaccount.iam.com\fR for
OIDC authentication with audience \f5https://example.com\fR, run:

.RS 2m
$ gcloud eventarc pipelines create my\-pipeline \e
    \-\-location=us\-central1 \e
    \-\-destinations=http_endpoint_uri='https://example\-endpoint.com',\e
google_oidc_authentication_service_account=example\-service\-account@e\e
xample\-project.gserviceaccount.iam.com,\e
google_oidc_authentication_audience='https://example.com'
.RE

To create a new pipeline \f5my\-pipeline\fR in location \f5us\-central1\fR with
an HTTP endpoint URI destination \f5https://example\-endpoint.com\fR and a
service account
\f5example\-service\-account@example\-project.gserviceaccount.iam.com\fR for
OAuth token authentication, run:

.RS 2m
$ gcloud eventarc pipelines create my\-pipeline \e
    \-\-location=us\-central1 \e
    \-\-destinations=http_endpoint_uri='https://example\-endpoint.com',\e
oauth_token_authentication_service_account=example\-service\-account@e\e
xample\-project.gserviceaccount.iam.com
.RE

To create a new pipeline \f5my\-pipeline\fR in location \f5us\-central1\fR with
an HTTP endpoint URI destination \f5https://example\-endpoint.com\fR and a
service account
\f5example\-service\-account@example\-project.gserviceaccount.iam.com\fR for
OAuth token authentication with scope
\f5https://www.googleapis.com/auth/cloud\-platform\fR, run:

.RS 2m
$ gcloud eventarc pipelines create my\-pipeline \e
    \-\-location=us\-central1 \e
    \-\-destinations=http_endpoint_uri='https://example\-endpoint.com',\e
oauth_token_authentication_service_account=example\-service\-account@e\e
xample\-project.gserviceaccount.iam.com,\e
oauth_token_authentication_scope='https://www.googleapis.com/auth/cl\e
oud\-platform'
.RE

To create a new pipeline \f5my\-pipeline\fR in location \f5us\-central1\fR with
an HTTP endpoint URI destination \f5https://example\-endpoint.com\fR and the
JSON input and output payload formats, run:

.RS 2m
$ gcloud eventarc pipelines create my\-pipeline \e
    \-\-location=us\-central1 \e
    \-\-destinations=http_endpoint_uri='https://example\-endpoint.com',\e
output_payload_format_json= \-\-input\-payload\-format\-json=
.RE

To create a new pipeline \f5my\-pipeline\fR in location \f5us\-central1\fR with
an HTTP endpoint URI destination \f5https://example\-endpoint.com\fR and the
Avro input and output payload formats, run:

.RS 2m
$ gcloud eventarc pipelines create my\-pipeline \e
    \-\-location=us\-central1 \e
    \-\-destinations=http_endpoint_uri='https://example\-endpoint.com',\e
output_payload_format_avro_schema_definition='{"type": "record",
 "name": "my_record", "fields": [{"name": "my_field", "type":
 "string"}]}' \e
    \-\-input\-payload\-format\-avro\-schema\-definition='{"type":
 "record", "name": "my_record", "fields": [{"name": "my_field",
 "type": "string"}]}'
.RE

To create a new pipeline \f5my\-pipeline\fR in location \f5us\-central1\fR with
an HTTP endpoint URI destination \f5https://example\-endpoint.com\fR and the
Protobuf input and output payload formats, run:

.RS 2m
$ gcloud eventarc pipelines create my\-pipeline \e
    \-\-location=us\-central1 \e
    \-\-destinations=http_endpoint_uri='https://example\-endpoint.com',\e
output_payload_format_protobuf_schema_definition='syntax =
 "proto3"; message Location { string home_address = 1; }' \e
    \-\-input\-payload\-format\-protobuf\-schema\-definition='syntax =
 "proto3"; message Location { string home_address = 1; }'
.RE

To create a new pipeline \f5my\-pipeline\fR in location \f5us\-central1\fR with
an HTTP endpoint URI destination \f5https://example\-endpoint.com\fR and a
transformation mediation, run:

.RS 2m
$ gcloud eventarc pipelines create my\-pipeline \e
    \-\-location=us\-central1 \e
    \-\-destinations=http_endpoint_uri='https://example\-endpoint.com'\-\e
\-mediations=transformation_template='message.removeFields(["data.cre\e
dit_card_number","data.ssn"])'
.RE

To create a new pipeline \f5my\-pipeline\fR in location \f5us\-central1\fR with
an HTTP endpoint URI destination \f5https://example\-endpoint.com\fR and a INFO
level logging configuration, run:

.RS 2m
$ gcloud eventarc pipelines create my\-pipeline \e
    \-\-location=us\-central1 \e
    \-\-destinations=http_endpoint_uri='https://example\-endpoint.com'\-\e
\-logging_config=INFO
.RE

To create a new pipeline \f5my\-pipeline\fR in location \f5us\-central1\fR with
an HTTP endpoint URI destination \f5https://example\-endpoint.com\fR and a
custom retry policy, run:

.RS 2m
$ gcloud eventarc pipelines create my\-pipeline \e
    \-\-location=us\-central1 \e
    \-\-destinations=http_endpoint_uri='https://example\-endpoint.com' \e
\-\-max\-retry\-attempts=10 \-\-min\-retry\-delay=2s \-\-max\-retry\-delay=64s
.RE

To create a new pipeline \f5my\-pipeline\fR in location \f5us\-central1\fR with
an HTTP endpoint URI destination \f5https://example\-endpoint.com\fR and a Cloud
KMS CryptoKey, run:

.RS 2m
$ gcloud eventarc pipelines create my\-pipeline \e
    \-\-location=us\-central1 \e
    \-\-destinations=http_endpoint_uri='https://example\-endpoint.com' \e
\-\-crypto\-key=projects/PROJECT_ID/locations/KMS_LOCATION/keyRings/\e
KEYRING/cryptoKeys/KEY
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Pipeline resource \- The pipeline to create. The arguments in this group can be
used to specify the attributes of this resource. (NOTE) Some attributes are not
given arguments in this group but can be set in other ways.

To set the \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5pipeline\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fIPIPELINE\fR

ID of the pipeline or fully qualified identifier for the pipeline.

To set the \f5pipeline\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5pipeline\fR on the command line.
.RE
.sp

This positional argument must be specified if any of the other arguments in this
group are specified.

.TP 2m
\fB\-\-location\fR=\fILOCATION\fR

The location for the Eventarc pipeline, which should be one of the supported
regions. Alternatively, set the [eventarc/location] property.

To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5pipeline\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line;
.IP "\(bu" 2m
set the property \f5eventarc/location\fR.
.RE
.sp


.RE
.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-destinations\fR=[\fIhttp_endpoint_uri\fR=\fIURI\fR],[\fIhttp_endpoint_message_binding_template\fR=\fIHTTP_ENDPOINT_MESSAGE_BINDING_TEMPLATE\fR],[\fIworkflow\fR=\fIWORKFLOW\fR],[\fImessage_bus\fR=\fIMESSAGE_BUS\fR],[\fIpubsub_topic\fR=\fIPUBSUB_TOPIC\fR],[\fIproject\fR=\fIPROJECT\fR],[\fIlocation\fR=\fILOCATION\fR],[\fInetwork_attachment\fR=\fINETWORK_ATTACHMENT\fR],[\fIgoogle_oidc_authentication_service_account\fR=\fIGOOGLE_OIDC_AUTHENTICATION_SERVICE_ACCOUNT\fR],[\fIgoogle_oidc_authentication_audience\fR=\fIGOOGLE_OIDC_AUTHENTICATION_AUDIENCE\fR],[\fIoauth_token_authentication_service_account\fR=\fIOAUTH_TOKEN_AUTHENTICATION_SERVICE_ACCOUNT\fR],[\fIoauth_token_authentication_scope\fR=\fIOAUTH_TOKEN_AUTHENTICATION_SCOPE\fR],[\fIoutput_payload_format_json\fR=\fIOUTPUT_PAYLOAD_FORMAT_JSON\fR],[\fIoutput_payload_format_avro_schema_definition\fR=\fIOUTPUT_PAYLOAD_FORMAT_AVRO_SCHEMA_DEFINITION\fR],[\fIoutput_payload_format_protobuf_schema_definition\fR=\fIOUTPUT_PAYLOAD_FORMAT_PROTOBUF_SCHEMA_DEFINITION\fR]#[...]

The pipeline's destinations. This flag can be repeated to add more destinations
to the list. Currently, only one destination is supported per pipeline. A
destination is specified in a dict format. For more information, see Create an
enrollment to receive events
(https://cloud.google.com/eventarc/advanced/docs/receive\-events/create\-enrollment).

Note: Exactly one of the \f5http_endpoint_uri\fR, \f5workflow\fR,
\f5message_bus\fR, or \f5pubsub_topic\fR keys must be set.

Valid keys are:

.RS 2m
.TP 2m
\fBhttp_endpoint_uri\fR
The URI of the HTTP endpoint. The value must be a RFC2396 URI string. Only HTTPS
protocol is supported. The host can be either a static IP addressable from the
VPC specified by the network config, or an internal DNS hostname of the service
resolvable via Cloud DNS. For example:

.RS 2m
$ gcloud eventarc pipelines create example\-pipeline \e
  \-\-destinations=http_endpoint_uri='https://example.com'
.RE

.TP 2m
\fBhttp_endpoint_message_binding_template\fR
The CEL expression used to construct a new HTTP request to be sent to the final
destination. It can be optionally specified alongside with
\f5http_endpoint_uri\fR. It represents a configuration used to bind a message to
the final HTTP request that will be sent to the destination. If a binding is not
specified, by default the message is treated as a CloudEvent and is mapped to
the HTTP request according to the CloudEvent HTTP Protocol Binding Binary
Content Mode. The pipeline converts the data field of the message to the format
provided in \f5output_payload_format\fR and maps it to the body field of the
result. It also sets the corresponding Content\-Type header to the
\f5output_payload_format\fR type. If the \f5output_payload_format\fR is
unspecified, then the pipeline will treat the data field of the message as
opaque binary data and attach it to the request body as bytes. In this case, the
Content\-Type header will be set to the value of the datacontenttype attribute
set on the incoming CloudEvent message if present, or the
\f5application/octet\-stream\fR MIME type otherwise. The pipeline expects that
the content of the message will adhere to the standard CloudEvent format. If not
then the outgoing message request may fail with a persistent error.

Note: When \f5http_endpoint_uri\fR is not set,
\f5http_endpoint_message_binding_template\fR can't be set.

The result of the CEL expression must be a map of key\-value pairs such that:

1. If a map named \f5headers\fR exists on the result of the expression, then its
key\-value pairs are directly mapped to the HTTP request headers. The headers
values are constructed from the corresponding value type's canonical
representation. If the \f5headers\fR field does not exist, then the resulting
HTTP request will not contain headers.

2. If a field named \f5body\fR exists on the result of the expression, then its
value is directly mapped to the body of the request. If the value of the
\f5body\fR field is of type bytes or string, then it is used as the HTTP request
body as\-is withouth any conversion. If the \f5body\fR field is of any other
type, then it is converted to a JSON string. If the \f5body\fR field does not
exist, then the resulting HTTP request will not contain a body.

3. Any other fields in the resulting expression will be ignored.

The CEL expression may access the incoming CloudEvent message in its definition,
as follows:

1. The \f5data\fR field of the incoming CloudEvent message can be accessed using
the \f5message.data\fR value.

2. Each attribute of the incoming CloudEvent message can be accessed using the
\f5message.<key>\fR value, where <key> is the name of the attribute.

Headers added to the request by previous filters in the chain can be accessed in
the CEL expression using the \f5headers\fR variable. The \f5headers\fR variable
defines a map of key\-value pairs corresponding to the HTTP headers added by
previous mediation steps and not the headers present on the original incoming
request. For example, the following CEL expression can be used to construct a
headers\-only HTTP request by adding an additional header to the headers added
by previous mediations in the pipeline:

.RS 2m
{"headers": headers.merge({"new\-header\-key": "new\-header\-value"})}
.RE

Additionally, the following CEL extension functions can be used in this CEL
expression:

.RS 2m
.IP "\(bu" 2m
\f5toBase64Url\fR: map.toBase64Url() \-> string
.RS 2m
.IP "\(em" 2m
Converts a CelValue to a base64url encoded string.
.RE
.sp

.IP "\(bu" 2m
\f5toJsonString\fR: map.toJsonString() \-> string
.RS 2m
.IP "\(em" 2m
Converts a CelValue to a JSON string.
.RE
.sp

.IP "\(bu" 2m
\f5merge\fR: map1.merge(map2) \-> map3
.RS 2m
.IP "\(em" 2m
Merges the passed CEL map with the existing CEL map the function is applied to.
If the same key exists in both maps, or if the key's value is type map, then
both maps are merged; Otherwise, the value from the passed map is used.
.RE
.sp

.IP "\(bu" 2m
\f5toMap\fR: list(map).toMap() \-> map
.RS 2m
.IP "\(em" 2m
Converts a CEL list of CEL maps to a single CEL map.
.RE
.sp

.IP "\(bu" 2m
\f5toDestinationPayloadFormat\fR: message.data.toDestinationPayloadFormat() \->
string or bytes
.RS 2m
.IP "\(em" 2m
Converts the message data to the destination payload format specified in
\f5output_payload_format\fR. This function is meant to be applied to the
message.data field. If the destination payload format is not set, the function
will return the message data unchanged.
.RE
.sp

.IP "\(bu" 2m
\f5toCloudEventJsonWithPayloadFormat\fR:
message.toCloudEventJsonWithPayloadFormat() \-> map
.RS 2m
.IP "\(em" 2m
Converts a message to the corresponding structure of JSON format for
CloudEvents. This function applies toDestinationPayloadFormat() to the message
data. It also sets the corresponding datacontenttype of the CloudEvent, as
indicated by the \f5output_payload_format\fR field. If
\f5output_payload_format\fR is not set, it will use the existing datacontenttype
on the CloudEvent if present; Otherwise, it leaves the datacontenttype unset.
This function expects that the content of the message will adhere to the
standard CloudEvent format. If it doesn't then this function will fail. The
result is a CEL map that corresponds to the JSON representation of the
CloudEvent. To convert that data to a JSON string it can be chained with the
toJsonString() function.
.RE
.sp

For example:
.RE
.sp

.RS 2m
$ gcloud eventarc pipelines create example\-pipeline \e
\-\-destinations=http_endpoint_uri='https://example.com',\e
http_endpoint_message_binding_template='{"headers":
 headers.merge({"new\-header\-key": "new\-header\-value"}),"body":
 "new\-body"}'
.RE

.TP 2m
\fBworkflow\fR
The destination Workflow ID. For example:

.RS 2m
$ gcloud eventarc pipelines create example\-pipeline \e
  \-\-destinations=workflow=my\-workflow
.RE

.TP 2m
\fBmessage_bus\fR
The destination Message Bus ID. For example:

.RS 2m
$ gcloud eventarc pipelines create example\-pipeline \e
  \-\-destinations=message_bus=my\-message\-bus
.RE

.TP 2m
\fBpubsub_topic\fR
The destination Pub/Sub topic ID. For example:

.RS 2m
$ gcloud eventarc pipelines create example\-pipeline \e
  \-\-destinations=pubsub_topic=my\-topic
.RE

.TP 2m
\fBproject\fR
The project ID of the destination resource. If \f5project\fR is not set, then
the project ID of the pipeline is used. For example:

.RS 2m
$ gcloud eventarc pipelines create example\-pipeline \e
  \-\-destinations=project=example\-project,workflow=my\-workflow
.RE

Note: When \f5http_endpoint_uri\fR is set, \f5project\fR can't be set.

.TP 2m
\fBlocation\fR
The location of the destination resource. If \f5location\fR is not set, then the
location of the pipeline is used. For example:

.RS 2m
$ gcloud eventarc pipelines create example\-pipeline \e
  \-\-destinations=location=us\-east1,workflow=my\-workflow
.RE

Note: When \f5http_endpoint_uri\fR is set, \f5location\fR can't be set.

.TP 2m
\fBnetwork_attachment\fR
The ID of the network attachment that allows access to the consumer VPC. For
example:

.RS 2m
$ gcloud eventarc pipelines create example\-pipeline \e
  \-\-destinations=network_attachment=my\-network\-attachment,\e
http_endpoint_uri='https://example.com'
.RE

Note: \f5network_attachment\fR can only be set when \f5http_endpoint_uri\fR is
set as well.

.TP 2m
\fBgoogle_oidc_authentication_service_account\fR
The service account email used to generate the OIDC token. The token can be used
to invoke Cloud Run and Cloud Run functions destinations or HTTP endpoints that
support Google OIDC. Note that the principal who calls this API must have
\f5iam.serviceAccounts.actAs\fR permission on the service account. For more
information, see Service accounts overview
(https://cloud.google.com/iam/docs/understanding\-service\-accounts). For
example:

.RS 2m
$ gcloud eventarc pipelines create example\-pipeline \e
  \-\-destinations=http_endpoint_uri='https://example.com',\e
google_oidc_authentication_service_account=example\-service\-account@e\e
xample\-project.gserviceaccount.iam.com
.RE

.TP 2m
\fBgoogle_oidc_authentication_audience\fR
The audience claim which identifies the recipient that the JWT is intended for.
If unspecified, the destination URI will be used. For example:

.RS 2m
$ gcloud eventarc pipelines create example\-pipeline \e
  \-\-destinations=http_endpoint_uri='https://example.com',\e
google_oidc_authentication_service_account=example\-service\-account@e\e
xample\-project.gserviceaccount.iam.com,\e
google_oidc_authentication_audience='https://example.com'
.RE

Note: \f5google_oidc_authentication_audience\fR can only be set if
\f5google_oidc_authentication_service_account\fR is set.

.TP 2m
\fBoauth_token_authentication_service_account\fR
The service account email used to generate the OAuth token. OAuth authorization
should generally only be used when calling Google APIs hosted on
*.googleapis.com. Note that the principal who calls this API must have
iam.serviceAccounts.actAs permission in the service account. For more
information, see Service accounts overview
(https://cloud.google.com/iam/docs/understanding\-service\-accounts). For
example:

.RS 2m
$ gcloud eventarc pipelines create example\-pipeline \e
  \-\-destinations=http_endpoint_uri='https://example.com',\e
oauth_token_authentication_service_account=example\-service\-account@e\e
xample\-project.gserviceaccount.iam.com
.RE

.TP 2m
\fBoauth_token_authentication_scope\fR
The scope used to generate the OAuth token. If unspecified,
"https://www.googleapis.com/auth/cloud\-platform" will be used. For example:

.RS 2m
$ gcloud eventarc pipelines create example\-pipeline \e
  \-\-destinations=http_endpoint_uri='https://example.com',\e
oauth_token_authentication_service_account=example\-service\-account@e\e
xample\-project.gserviceaccount.iam.com,\e
oauth_token_authentication_scope=https://www.googleapis.com/auth/\e
cloud\-platform
.RE

Note: At most one of \f5google_oidc_authentication_service_account\fR or
\f5oauth_token_authentication_service_account\fR can be set; and
\f5oauth_token_authentication_scope\fR can only be set if
\f5oauth_token_authentication_service_account\fR is set.

.TP 2m
\fBoutput_payload_format_json\fR
Indicates that the output payload format is JSON. For example:

.RS 2m
$ gcloud eventarc pipelines create example\-pipeline \e
  \-\-destinations=http_endpoint_uri='https://example.com',\e
output_payload_format_json= \-\-input\-payload\-format\-json=
.RE

Note: JSON schemas are not supported. Any value specified by this key is
ignored.

.TP 2m
\fBoutput_payload_format_avro_schema_definition\fR
The schema definition of the Avro output payload format. For example:

.RS 2m
$ gcloud eventarc pipelines create example\-pipeline \e
  \-\-destinations=http_endpoint_uri='https://example.com',\e
output_payload_format_avro_schema_definition='{"type": "record",
 "name": "my_record", "fields": [{"name": "field1", "type":
 "string"}]}' \e
    \-\-input\-payload\-format\-avro\-schema\-definition='{"type":
 "record", "name": "my_record", "fields": [{"name": "field1",
 "type": "string"}]}'
.RE

.TP 2m
\fBoutput_payload_format_protobuf_schema_definition\fR
The schema definition of the Protobuf output payload format. For example:

.RS 2m
$ gcloud eventarc pipelines create example\-pipeline \e
  \-\-destinations=http_endpoint_uri='https://example.com',\e
output_payload_format_protobuf_schema_definition='syntax =
 "proto3"; message Location { string home_address = 1; }' \e
    \-\-input\-payload\-format\-protobuf\-schema\-definition='syntax =
 "proto3"; message Location { string home_address = 1; }'
.RE

Note: If none of the \f5input_payload_format_json\fR,
\f5input_payload_format_avro_schema_definition\fR, or
\f5input_payload_format_protobuf_schema_definition\fR is set, then the message
data is treated as an opaque binary and no output format can be set on the
pipeline through the \f5output_payload_format_json\fR,
\f5output_payload_format_avro_schema_definition\fR, or
\f5output_payload_format_protobuf_schema_definition\fR field. Any mediations on
the pipeline that involve access to the data field will fail as persistent
errors.


.RE
.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.

.TP 2m
\fB\-\-crypto\-key\fR=\fICRYPTO_KEY\fR

Fully qualified name of the crypto key to use for customer\-managed encryption.
If this is unspecified, Google\-managed keys will be used for encryption.

.TP 2m
\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of label KEY=VALUE pairs to add.

Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers. Values must contain
only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase characters, and
numbers.

.TP 2m
\fB\-\-logging\-config\fR=\fILOGGING_CONFIG\fR

The logging config of the pipeline. \fILOGGING_CONFIG\fR must be one of:
\fBNONE\fR, \fBDEBUG\fR, \fBINFO\fR, \fBNOTICE\fR, \fBWARNING\fR, \fBERROR\fR,
\fBCRITICAL\fR, \fBALERT\fR, \fBEMERGENCY\fR.

.TP 2m
\fB\-\-mediations\fR=[\fItransformation_template\fR=\fITRANSFORMATION_TEMPLATE\fR#...]

The different ways to modify the pipeline. Currently, only one mediation is
supported per pipeline.

A mediation is specified in a dict format. Currently, the only valid choice is
\f5transformation_template\fR.

This is the template to apply to transform messages.

For complex transformations, shell parameter processing may fail to parse the
CEL expressions. Please see \f5gcloud topic flags\-file\fR for how to use
https://cloud.google.com/sdk/gcloud/reference/topic/flags\-file feature of
gcloud to pass in CEL expressions.

Examples:

.RS 2m
$ gcloud eventarc pipelines create example\-pipeline \e
    \-\-mediations=transformation_template='message.removeFields(["dat\e
a.credit_card_number","data.ssn"])'
.RE

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-input\-payload\-format\-avro\-schema\-definition\fR=\fIINPUT_PAYLOAD_FORMAT_AVRO_SCHEMA_DEFINITION\fR

The pipeline's input payload Avro schema definition. If this is set, then any
messages not matching this format will be treated as persistent errors.

.TP 2m
\fB\-\-input\-payload\-format\-json\fR=\fIINPUT_PAYLOAD_FORMAT_JSON\fR

The pipeline's input payload format is JSON. If this is set, then any messages
not matching this format will be treated as persistent errors.

.TP 2m
\fB\-\-input\-payload\-format\-protobuf\-schema\-definition\fR=\fIINPUT_PAYLOAD_FORMAT_PROTOBUF_SCHEMA_DEFINITION\fR

The pipeline's input payload Protobuf schema definition. If this is set, then
any messages not matching this format will be treated as persistent errors.

.RE
.RE
.sp
The retry policy configuration for the pipeline. The pipeline exponentially
backs off if the destination is non\-responsive or returns a retryable error
code. The backoff starts with a 1 second delay and doubles the delay after each
failed attempt. The delay is capped at 60 seconds. If the max\-retry\-delay and
min\-retry\-delay are set to the same value, then the duration between retries
is constant.



.RS 2m
.TP 2m
\fB\-\-max\-retry\-attempts\fR=\fIMAX_RETRY_ATTEMPTS\fR

The maximum number of retry attempts. If not set, the default value is 5.

.RS 2m
.TP 2m
\fB\-\-max\-retry\-delay\fR=\fIMAX_RETRY_DELAY\fR

The maximum retry delay in seconds. If not set, the default value is 60.

.TP 2m
\fB\-\-min\-retry\-delay\fR=\fIMIN_RETRY_DELAY\fR

The minimum retry delay in seconds. If not set, the default value is 1.


.RE
.RE
.sp

.SH "GCLOUD WIDE FLAGS"

These flags are available to all commands: \-\-access\-token\-file, \-\-account,
\-\-billing\-project, \-\-configuration, \-\-flags\-file, \-\-flatten,
\-\-format, \-\-help, \-\-impersonate\-service\-account, \-\-log\-http,
\-\-project, \-\-quiet, \-\-trace\-token, \-\-user\-output\-enabled,
\-\-verbosity.

Run \fB$ gcloud help\fR for details.



.SH "NOTES"

This variant is also available:

.RS 2m
$ gcloud beta eventarc pipelines create
.RE