Eventarc V1 API - Class Google::Cloud::Eventarc::V1::Pipeline (v1.2.0)

Reference documentation and code samples for the Eventarc V1 API class Google::Cloud::Eventarc::V1::Pipeline.

A representation of the Pipeline resource.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#annotations

def annotations() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — Optional. User-defined annotations. See https://google.aip.dev/128#annotations.

#annotations=

def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — Optional. User-defined annotations. See https://google.aip.dev/128#annotations.

Returns

(::Google::Protobuf::Map{::String => ::String}) — Optional. User-defined annotations. See https://google.aip.dev/128#annotations.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

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

#crypto_key_name

def crypto_key_name() -> ::String

Returns

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

#crypto_key_name=

def crypto_key_name=(value) -> ::String

Parameter

value (::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}".

Returns

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

#destinations

def destinations() -> ::Array<::Google::Cloud::Eventarc::V1::Pipeline::Destination>

Returns

(::Array<::Google::Cloud::Eventarc::V1::Pipeline::Destination>) — Required. List of destinations to which messages will be forwarded. Currently, exactly one destination is supported per Pipeline.

#destinations=

def destinations=(value) -> ::Array<::Google::Cloud::Eventarc::V1::Pipeline::Destination>

Parameter

value (::Array<::Google::Cloud::Eventarc::V1::Pipeline::Destination>) — Required. List of destinations to which messages will be forwarded. Currently, exactly one destination is supported per Pipeline.

Returns

(::Array<::Google::Cloud::Eventarc::V1::Pipeline::Destination>) — Required. List of destinations to which messages will be forwarded. Currently, exactly one destination is supported per Pipeline.

#display_name

def display_name() -> ::String

Returns

(::String) — Optional. Display name of resource.

#display_name=

def display_name=(value) -> ::String

Parameter

value (::String) — Optional. Display name of resource.

Returns

(::String) — Optional. Display name of resource.

#etag

def etag() -> ::String

Returns

(::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.

#etag=

def etag=(value) -> ::String

Parameter

value (::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.

Returns

(::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.

#input_payload_format

def input_payload_format() -> ::Google::Cloud::Eventarc::V1::Pipeline::MessagePayloadFormat

Returns

(::Google::Cloud::Eventarc::V1::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.

#input_payload_format=

def input_payload_format=(value) -> ::Google::Cloud::Eventarc::V1::Pipeline::MessagePayloadFormat

Parameter

value (::Google::Cloud::Eventarc::V1::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.

Returns

(::Google::Cloud::Eventarc::V1::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.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — 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" }.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — 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

(::Google::Protobuf::Map{::String => ::String}) — 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" }.

#logging_config

def logging_config() -> ::Google::Cloud::Eventarc::V1::LoggingConfig

Returns

(::Google::Cloud::Eventarc::V1::LoggingConfig) — Optional. Config to control Platform Logging for Pipelines.

#logging_config=

def logging_config=(value) -> ::Google::Cloud::Eventarc::V1::LoggingConfig

Parameter

value (::Google::Cloud::Eventarc::V1::LoggingConfig) — Optional. Config to control Platform Logging for Pipelines.

Returns

(::Google::Cloud::Eventarc::V1::LoggingConfig) — Optional. Config to control Platform Logging for Pipelines.

#mediations

def mediations() -> ::Array<::Google::Cloud::Eventarc::V1::Pipeline::Mediation>

Returns

(::Array<::Google::Cloud::Eventarc::V1::Pipeline::Mediation>) — Optional. List of mediation operations to be performed on the message. Currently, only one Transformation operation is allowed in each Pipeline.

#mediations=

def mediations=(value) -> ::Array<::Google::Cloud::Eventarc::V1::Pipeline::Mediation>

Parameter

value (::Array<::Google::Cloud::Eventarc::V1::Pipeline::Mediation>) — Optional. List of mediation operations to be performed on the message. Currently, only one Transformation operation is allowed in each Pipeline.

Returns

(::Array<::Google::Cloud::Eventarc::V1::Pipeline::Mediation>) — Optional. List of mediation operations to be performed on the message. Currently, only one Transformation operation is allowed in each Pipeline.

#name

def name() -> ::String

Returns

(::String) — 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.

#name=

def name=(value) -> ::String

Parameter

value (::String) — 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

(::String) — 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.

#retry_policy

def retry_policy() -> ::Google::Cloud::Eventarc::V1::Pipeline::RetryPolicy

Returns

(::Google::Cloud::Eventarc::V1::Pipeline::RetryPolicy) — Optional. The retry policy to use in the pipeline.

#retry_policy=

def retry_policy=(value) -> ::Google::Cloud::Eventarc::V1::Pipeline::RetryPolicy

Parameter

value (::Google::Cloud::Eventarc::V1::Pipeline::RetryPolicy) — Optional. The retry policy to use in the pipeline.

Returns

(::Google::Cloud::Eventarc::V1::Pipeline::RetryPolicy) — Optional. The retry policy to use in the pipeline.

#uid

def uid() -> ::String

Returns

(::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.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

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