Reference documentation and code samples for the Google Cloud Eventarc V1 Client class Pipeline.
A representation of the Pipeline resource.
Generated from protobuf message google.cloud.eventarc.v1.Pipeline
Namespace
Google \ Cloud \ Eventarc \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The resource name of the Pipeline. Must be unique within the location of the project and must be in |
↳ create_time |
Google\Protobuf\Timestamp
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". |
↳ update_time |
Google\Protobuf\Timestamp
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". |
↳ labels |
array|Google\Protobuf\Internal\MapField
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" }. |
↳ uid |
string
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. |
↳ annotations |
array|Google\Protobuf\Internal\MapField
Optional. User-defined annotations. See https://google.aip.dev/128#annotations. |
↳ display_name |
string
Optional. Display name of resource. |
↳ destinations |
array<Pipeline\Destination>
Required. List of destinations to which messages will be forwarded. Currently, exactly one destination is supported per Pipeline. |
↳ mediations |
array<Pipeline\Mediation>
Optional. List of mediation operations to be performed on the message. Currently, only one Transformation operation is allowed in each Pipeline. |
↳ crypto_key_name |
string
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}". |
↳ input_payload_format |
Pipeline\MessagePayloadFormat
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. |
↳ logging_config |
LoggingConfig
Optional. Config to control Platform Logging for Pipelines. |
↳ retry_policy |
Pipeline\RetryPolicy
Optional. The retry policy to use in the pipeline. |
↳ etag |
string
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. |
getName
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
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".
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
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".
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
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".
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
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".
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
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" }.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
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" }.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUid
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUid
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAnnotations
Optional. User-defined annotations. See https://google.aip.dev/128#annotations.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setAnnotations
Optional. User-defined annotations. See https://google.aip.dev/128#annotations.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Optional. Display name of resource.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Optional. Display name of resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDestinations
Required. List of destinations to which messages will be forwarded.
Currently, exactly one destination is supported per Pipeline.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setDestinations
Required. List of destinations to which messages will be forwarded.
Currently, exactly one destination is supported per Pipeline.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Pipeline\Destination>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMediations
Optional. List of mediation operations to be performed on the message.
Currently, only one Transformation operation is allowed in each Pipeline.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setMediations
Optional. List of mediation operations to be performed on the message.
Currently, only one Transformation operation is allowed in each Pipeline.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Pipeline\Mediation>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCryptoKeyName
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}".
| Returns | |
|---|---|
| Type | Description |
string |
|
setCryptoKeyName
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}".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInputPayloadFormat
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.
| Returns | |
|---|---|
| Type | Description |
Pipeline\MessagePayloadFormat|null |
|
hasInputPayloadFormat
clearInputPayloadFormat
setInputPayloadFormat
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Pipeline\MessagePayloadFormat
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLoggingConfig
Optional. Config to control Platform Logging for Pipelines.
| Returns | |
|---|---|
| Type | Description |
LoggingConfig|null |
|
hasLoggingConfig
clearLoggingConfig
setLoggingConfig
Optional. Config to control Platform Logging for Pipelines.
| Parameter | |
|---|---|
| Name | Description |
var |
LoggingConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRetryPolicy
Optional. The retry policy to use in the pipeline.
| Returns | |
|---|---|
| Type | Description |
Pipeline\RetryPolicy|null |
|
hasRetryPolicy
clearRetryPolicy
setRetryPolicy
Optional. The retry policy to use in the pipeline.
| Parameter | |
|---|---|
| Name | Description |
var |
Pipeline\RetryPolicy
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEtag
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEtag
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|