gcloud eventarc pipelines update - update an Eventarc pipeline

gcloud eventarc pipelines update(PIPELINE :--location=LOCATION)[--async][--destinations=[http_endpoint_uri=URI],[http_endpoint_message_binding_template=HTTP_ENDPOINT_MESSAGE_BINDING_TEMPLATE],[workflow=WORKFLOW],[message_bus=MESSAGE_BUS],[pubsub_topic=PUBSUB_TOPIC],[project=PROJECT],[location=LOCATION],[network_attachment=NETWORK_ATTACHMENT],[google_oidc_authentication_service_account=GOOGLE_OIDC_AUTHENTICATION_SERVICE_ACCOUNT],[google_oidc_authentication_audience=GOOGLE_OIDC_AUTHENTICATION_AUDIENCE],[oauth_token_authentication_service_account=OAUTH_TOKEN_AUTHENTICATION_SERVICE_ACCOUNT],[oauth_token_authentication_scope=OAUTH_TOKEN_AUTHENTICATION_SCOPE],[output_payload_format_json=OUTPUT_PAYLOAD_FORMAT_JSON],[output_payload_format_avro_schema_definition=OUTPUT_PAYLOAD_FORMAT_AVRO_SCHEMA_DEFINITION],[output_payload_format_protobuf_schema_definition=OUTPUT_PAYLOAD_FORMAT_PROTOBUF_SCHEMA_DEFINITION]#[…]][--logging-config=LOGGING_CONFIG][--mediations=[transformation_template=TRANSFORMATION_TEMPLATE#…]][--update-labels=[KEY=VALUE,…]][--clear-crypto-key    |--crypto-key=CRYPTO_KEY][--clear-labels    |--remove-labels=[KEY,…]][--input-payload-format-avro-schema-definition=INPUT_PAYLOAD_FORMAT_AVRO_SCHEMA_DEFINITION    |--input-payload-format-json=INPUT_PAYLOAD_FORMAT_JSON    |--input-payload-format-protobuf-schema-definition=INPUT_PAYLOAD_FORMAT_PROTOBUF_SCHEMA_DEFINITION][--max-retry-attempts=MAX_RETRY_ATTEMPTS--max-retry-delay=MAX_RETRY_DELAY--min-retry-delay=MIN_RETRY_DELAY][GCLOUD_WIDE_FLAG …]

Pipeline resource - The pipeline to update. The arguments in this group can beused to specify the attributes of this resource. (NOTE) Some attributes are notgiven arguments in this group but can be set in other ways.

To set theproject attribute:

• provide the argumentpipeline on the command line with a fullyspecified name;
• provide the argument--project on the command line;
• set the propertycore/project.

This must be specified.

PIPELINE

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

To set thepipeline attribute:

• provide the argumentpipeline on the command line.

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

--location=LOCATION

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

To set thelocation attribute:

• provide the argumentpipeline on the command line with a fullyspecified name;
• provide the argument--location on the command line;
• set the propertyeventarc/location.

--async

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

--destinations=[http_endpoint_uri=URI],[http_endpoint_message_binding_template=HTTP_ENDPOINT_MESSAGE_BINDING_TEMPLATE],[workflow=WORKFLOW],[message_bus=MESSAGE_BUS],[pubsub_topic=PUBSUB_TOPIC],[project=PROJECT],[location=LOCATION],[network_attachment=NETWORK_ATTACHMENT],[google_oidc_authentication_service_account=GOOGLE_OIDC_AUTHENTICATION_SERVICE_ACCOUNT],[google_oidc_authentication_audience=GOOGLE_OIDC_AUTHENTICATION_AUDIENCE],[oauth_token_authentication_service_account=OAUTH_TOKEN_AUTHENTICATION_SERVICE_ACCOUNT],[oauth_token_authentication_scope=OAUTH_TOKEN_AUTHENTICATION_SCOPE],[output_payload_format_json=OUTPUT_PAYLOAD_FORMAT_JSON],[output_payload_format_avro_schema_definition=OUTPUT_PAYLOAD_FORMAT_AVRO_SCHEMA_DEFINITION],[output_payload_format_protobuf_schema_definition=OUTPUT_PAYLOAD_FORMAT_PROTOBUF_SCHEMA_DEFINITION]#[…]

The pipeline's destinations. This flag can be repeated to add more destinationsto the list. Currently, only one destination is supported per pipeline. Adestination is specified in a dict format. For more information, seeCreatean enrollment to receive events.

Note: Exactly one of thehttp_endpoint_uri,workflow,message_bus, orpubsub_topic keys must be set.

Valid keys are:

http_endpoint_uri

The URI of the HTTP endpoint. The value must be a RFC2396 URI string. Only HTTPSprotocol is supported. The host can be either a static IP addressable from theVPC specified by the network config, or an internal DNS hostname of the serviceresolvable via Cloud DNS. For example:

gcloudeventarcpipelinescreateexample-pipeline--destinations=http_endpoint_uri='https://example.com'

http_endpoint_message_binding_template

The CEL expression used to construct a new HTTP request to be sent to the finaldestination. It can be optionally specified alongside withhttp_endpoint_uri. It represents a configuration used to bind amessage to the final HTTP request that will be sent to the destination. If abinding is not specified, by default the message is treated as a CloudEvent andis mapped to the HTTP request according to the CloudEvent HTTP Protocol BindingBinary Content Mode. The pipeline converts the data field of the message to theformat provided inoutput_payload_format and maps it to the bodyfield of the result. It also sets the corresponding Content-Type header to theoutput_payload_format type. If theoutput_payload_format is unspecified, then the pipeline will treatthe data field of the message as opaque binary data and attach it to the requestbody as bytes. In this case, the Content-Type header will be set to the value ofthe datacontenttype attribute set on the incoming CloudEvent message if present,or theapplication/octet-stream MIME type otherwise. The pipelineexpects that the content of the message will adhere to the standard CloudEventformat. If not then the outgoing message request may fail with a persistenterror.

Note: Whenhttp_endpoint_uri is not set,http_endpoint_message_binding_template can't be set.

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

1. If a map namedheaders exists on the result of the expression,then its key-value pairs are directly mapped to the HTTP request headers. Theheaders values are constructed from the corresponding value type's canonicalrepresentation. If theheaders field does not exist, then theresulting HTTP request will not contain headers.

2. If a field namedbody exists on the result of the expression,then its value is directly mapped to the body of the request. If the value ofthebody field is of type bytes or string, then it is used as theHTTP request body as-is withouth any conversion. If thebody fieldis of any other type, then it is converted to a JSON string. If thebody field does not exist, then the resulting HTTP request will notcontain 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. Thedata field of the incoming CloudEvent message can beaccessed using themessage.data value.

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

Headers added to the request by previous filters in the chain can be accessed inthe CEL expression using theheaders variable. Theheaders variable defines a map of key-value pairs corresponding tothe HTTP headers added by previous mediation steps and not the headers presenton the original incoming request. For example, the following CEL expression canbe used to construct a headers-only HTTP request by adding an additional headerto the headers added by previous mediations in the pipeline:

{"headers":headers.merge({"new-header-key":"new-header-value"})}

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

• toBase64Url: map.toBase64Url() -> string
  • Converts a CelValue to a base64url encoded string.
• toJsonString: map.toJsonString() -> string
  • Converts a CelValue to a JSON string.
• merge: map1.merge(map2) -> map3
  • 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, thenboth maps are merged; Otherwise, the value from the passed map is used.
• toMap: list(map).toMap() -> map
  • Converts a CEL list of CEL maps to a single CEL map.
• toDestinationPayloadFormat:message.data.toDestinationPayloadFormat() -> string or bytes
  • Converts the message data to the destination payload format specified inoutput_payload_format. This function is meant to be applied to themessage.data field. If the destination payload format is not set, the functionwill return the message data unchanged.
• toCloudEventJsonWithPayloadFormat:message.toCloudEventJsonWithPayloadFormat() -> map
  • Converts a message to the corresponding structure of JSON format forCloudEvents. This function applies toDestinationPayloadFormat() to the messagedata. It also sets the corresponding datacontenttype of the CloudEvent, asindicated by theoutput_payload_format field. Ifoutput_payload_format is not set, it will use the existingdatacontenttype on the CloudEvent if present; Otherwise, it leaves thedatacontenttype unset. This function expects that the content of the messagewill adhere to the standard CloudEvent format. If it doesn't then this functionwill fail. The result is a CEL map that corresponds to the JSON representationof the CloudEvent. To convert that data to a JSON string it can be chained withthe toJsonString() function.

  For example:

gcloudeventarcpipelinescreateexample-pipeline--destinations=http_endpoint_uri='https://example.com',http_endpoint_message_binding_template='{"headers": headers.merge({"new-header-key": "new-header-value"}),"body": "new-body"}'

workflow

The destination Workflow ID. For example:

gcloudeventarcpipelinescreateexample-pipeline--destinations=workflow=my-workflow

message_bus

The destination Message Bus ID. For example:

gcloudeventarcpipelinescreateexample-pipeline--destinations=message_bus=my-message-bus

pubsub_topic

The destination Pub/Sub topic ID. For example:

gcloudeventarcpipelinescreateexample-pipeline--destinations=pubsub_topic=my-topic

project

The project ID of the destination resource. Ifproject is not set,then the project ID of the pipeline is used. For example:

gcloudeventarcpipelinescreateexample-pipeline--destinations=project=example-project,workflow=my-workflow

Note: Whenhttp_endpoint_uri is set,project can't beset.

location

The location of the destination resource. Iflocation is not set,then the location of the pipeline is used. For example:

gcloudeventarcpipelinescreateexample-pipeline--destinations=location=us-east1,workflow=my-workflow

Note: Whenhttp_endpoint_uri is set,location can't beset.

network_attachment

The ID of the network attachment that allows access to the consumer VPC. Forexample:

gcloudeventarcpipelinescreateexample-pipeline--destinations=network_attachment=my-network-attachment,http_endpoint_uri='https://example.com'

Note:network_attachment can only be set whenhttp_endpoint_uri is set as well.

google_oidc_authentication_service_account

The service account email used to generate the OIDC token. The token can be usedto invoke Cloud Run and Cloud Run functions destinations or HTTP endpoints thatsupport Google OIDC. Note that the principal who calls this API must haveiam.serviceAccounts.actAs permission on the service account. Formore information, seeServiceaccounts overview. For example:

gcloudeventarcpipelinescreateexample-pipeline--destinations=http_endpoint_uri='https://example.com',google_oidc_authentication_service_account=example-service-account@example-project.gserviceaccount.iam.com

google_oidc_authentication_audience

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

gcloudeventarcpipelinescreateexample-pipeline--destinations=http_endpoint_uri='https://example.com',google_oidc_authentication_service_account=example-service-account@example-project.gserviceaccount.iam.com,google_oidc_authentication_audience='https://example.com'

Note:google_oidc_authentication_audience can only be set ifgoogle_oidc_authentication_service_account is set.

oauth_token_authentication_service_account

The service account email used to generate the OAuth token. OAuth authorizationshould generally only be used when calling Google APIs hosted on*.googleapis.com. Note that the principal who calls this API must haveiam.serviceAccounts.actAs permission in the service account. For moreinformation, seeServiceaccounts overview. For example:

gcloudeventarcpipelinescreateexample-pipeline--destinations=http_endpoint_uri='https://example.com',oauth_token_authentication_service_account=example-service-account@example-project.gserviceaccount.iam.com

oauth_token_authentication_scope

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

gcloudeventarcpipelinescreateexample-pipeline--destinations=http_endpoint_uri='https://example.com',oauth_token_authentication_service_account=example-service-account@example-project.gserviceaccount.iam.com,oauth_token_authentication_scope=https://www.googleapis.com/auth/\cloud-platform

Note: At most one ofgoogle_oidc_authentication_service_account oroauth_token_authentication_service_account can be set; andoauth_token_authentication_scope can only be set ifoauth_token_authentication_service_account is set.

output_payload_format_json

Indicates that the output payload format is JSON. For example:

gcloudeventarcpipelinescreateexample-pipeline--destinations=http_endpoint_uri='https://example.com',output_payload_format_json=--input-payload-format-json=

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

output_payload_format_avro_schema_definition

The schema definition of the Avro output payload format. For example:

gcloudeventarcpipelinescreateexample-pipeline--destinations=http_endpoint_uri='https://example.com',output_payload_format_avro_schema_definition='{"type": "record", "name": "my_record", "fields": [{"name": "field1", "type": "string"}]}'\--input-payload-format-avro-schema-definition='{"type": "record", "name": "my_record", "fields": [{"name": "field1", "type": "string"}]}'

output_payload_format_protobuf_schema_definition

The schema definition of the Protobuf output payload format. For example:

gcloudeventarcpipelinescreateexample-pipeline--destinations=http_endpoint_uri='https://example.com',output_payload_format_protobuf_schema_definition='syntax = "proto3"; message Location { string home_address = 1; }'\--input-payload-format-protobuf-schema-definition='syntax = "proto3"; message Location { string home_address = 1; }'

Note: If none of theinput_payload_format_json,input_payload_format_avro_schema_definition, orinput_payload_format_protobuf_schema_definition is set, then themessage data is treated as an opaque binary and no output format can be set onthe pipeline through theoutput_payload_format_json,output_payload_format_avro_schema_definition, oroutput_payload_format_protobuf_schema_definition field. Anymediations on the pipeline that involve access to the data field will fail aspersistent errors.

--logging-config=LOGGING_CONFIG

The logging config of the pipeline.LOGGING_CONFIG mustbe one of:NONE,DEBUG,INFO,NOTICE,WARNING,ERROR,CRITICAL,ALERT,EMERGENCY.

--mediations=[transformation_template=TRANSFORMATION_TEMPLATE#…]

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

A mediation is specified in a dict format. Currently, the only valid choice istransformation_template.

This is the template to apply to transform messages.

For complex transformations, shell parameter processing may fail to parse theCEL expressions. Please seegcloud topic flags-filefor how to usehttps://cloud.google.com/sdk/gcloud/reference/topic/flags-filefeature of gcloud to pass in CEL expressions.

Examples:

gcloudeventarcpipelinescreateexample-pipeline--mediations=transformation_template='message.removeFields(["data.credit_card_number","data.ssn"])'

--update-labels=[KEY=VALUE,…]

List of label KEY=VALUE pairs to update. If a label exists, its value ismodified. Otherwise, a new label is created.

Keys must start with a lowercase character and contain only hyphens(-), underscores (_), lowercase characters, andnumbers. Values must contain only hyphens (-), underscores(_), lowercase characters, and numbers.

At most one of these can be specified:

--clear-crypto-key

Remove the previously configured crypto key. The channel will continue to beencrypted using Google-managed keys.

--crypto-key=CRYPTO_KEY

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.

At most one of these can be specified:

--clear-labels

Remove all labels. If--update-labels is also specified then--clear-labels is applied first.

For example, to remove all labels:

gcloudeventarcpipelinesupdate--clear-labels

To remove all existing labels and create two new labels,foo andbaz:

gcloudeventarcpipelinesupdate--clear-labels--update-labelsfoo=bar,baz=qux

--remove-labels=[KEY,…]

List of label keys to remove. If a label does not exist it is silently ignored.If--update-labels is also specified then--update-labels is applied first.

At most one of these can be specified:

--input-payload-format-avro-schema-definition=INPUT_PAYLOAD_FORMAT_AVRO_SCHEMA_DEFINITION

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

--input-payload-format-json=INPUT_PAYLOAD_FORMAT_JSON

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

--input-payload-format-protobuf-schema-definition=INPUT_PAYLOAD_FORMAT_PROTOBUF_SCHEMA_DEFINITION

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

--max-retry-attempts=MAX_RETRY_ATTEMPTS

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

--max-retry-delay=MAX_RETRY_DELAY

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

--min-retry-delay=MIN_RETRY_DELAY

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

Run$gcloud help for details.