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

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

Represents a target of an invocation over HTTP.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#authentication_config

def authentication_config() -> ::Google::Cloud::Eventarc::V1::Pipeline::Destination::AuthenticationConfig
Returns
  • (::Google::Cloud::Eventarc::V1::Pipeline::Destination::AuthenticationConfig) — Optional. An authentication config used to authenticate message requests, such that destinations can verify the source. For example, this can be used with private GCP destinations that require GCP credentials to access like Cloud Run. This field is optional and should be set only by users interested in authenticated push

#authentication_config=

def authentication_config=(value) -> ::Google::Cloud::Eventarc::V1::Pipeline::Destination::AuthenticationConfig
Parameter
  • value (::Google::Cloud::Eventarc::V1::Pipeline::Destination::AuthenticationConfig) — Optional. An authentication config used to authenticate message requests, such that destinations can verify the source. For example, this can be used with private GCP destinations that require GCP credentials to access like Cloud Run. This field is optional and should be set only by users interested in authenticated push
Returns
  • (::Google::Cloud::Eventarc::V1::Pipeline::Destination::AuthenticationConfig) — Optional. An authentication config used to authenticate message requests, such that destinations can verify the source. For example, this can be used with private GCP destinations that require GCP credentials to access like Cloud Run. This field is optional and should be set only by users interested in authenticated push

#http_endpoint

def http_endpoint() -> ::Google::Cloud::Eventarc::V1::Pipeline::Destination::HttpEndpoint
Returns
  • (::Google::Cloud::Eventarc::V1::Pipeline::Destination::HttpEndpoint) — Optional. An HTTP endpoint destination described by an URI. If a DNS FQDN is provided as the endpoint, Pipeline will create a peering zone to the consumer VPC and forward DNS requests to the VPC specified by network config to resolve the service endpoint. See: https://cloud.google.com/dns/docs/zones/zones-overview#peering_zones

    Note: The following fields are mutually exclusive: http_endpoint, workflow, message_bus, topic. If a field in that set is populated, all other fields in the set will automatically be cleared.

#http_endpoint=

def http_endpoint=(value) -> ::Google::Cloud::Eventarc::V1::Pipeline::Destination::HttpEndpoint
Parameter
  • value (::Google::Cloud::Eventarc::V1::Pipeline::Destination::HttpEndpoint) — Optional. An HTTP endpoint destination described by an URI. If a DNS FQDN is provided as the endpoint, Pipeline will create a peering zone to the consumer VPC and forward DNS requests to the VPC specified by network config to resolve the service endpoint. See: https://cloud.google.com/dns/docs/zones/zones-overview#peering_zones

    Note: The following fields are mutually exclusive: http_endpoint, workflow, message_bus, topic. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Eventarc::V1::Pipeline::Destination::HttpEndpoint) — Optional. An HTTP endpoint destination described by an URI. If a DNS FQDN is provided as the endpoint, Pipeline will create a peering zone to the consumer VPC and forward DNS requests to the VPC specified by network config to resolve the service endpoint. See: https://cloud.google.com/dns/docs/zones/zones-overview#peering_zones

    Note: The following fields are mutually exclusive: http_endpoint, workflow, message_bus, topic. If a field in that set is populated, all other fields in the set will automatically be cleared.

#message_bus

def message_bus() -> ::String
Returns
  • (::String) — Optional. The resource name of the Message Bus to which events should be published. The Message Bus resource should exist in the same project as the Pipeline. Format: projects/{project}/locations/{location}/messageBuses/{message_bus}

    Note: The following fields are mutually exclusive: message_bus, http_endpoint, workflow, topic. If a field in that set is populated, all other fields in the set will automatically be cleared.

#message_bus=

def message_bus=(value) -> ::String
Parameter
  • value (::String) — Optional. The resource name of the Message Bus to which events should be published. The Message Bus resource should exist in the same project as the Pipeline. Format: projects/{project}/locations/{location}/messageBuses/{message_bus}

    Note: The following fields are mutually exclusive: message_bus, http_endpoint, workflow, topic. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Optional. The resource name of the Message Bus to which events should be published. The Message Bus resource should exist in the same project as the Pipeline. Format: projects/{project}/locations/{location}/messageBuses/{message_bus}

    Note: The following fields are mutually exclusive: message_bus, http_endpoint, workflow, topic. If a field in that set is populated, all other fields in the set will automatically be cleared.

#network_config

def network_config() -> ::Google::Cloud::Eventarc::V1::Pipeline::Destination::NetworkConfig
Returns

#network_config=

def network_config=(value) -> ::Google::Cloud::Eventarc::V1::Pipeline::Destination::NetworkConfig
Parameter
Returns

#output_payload_format

def output_payload_format() -> ::Google::Cloud::Eventarc::V1::Pipeline::MessagePayloadFormat
Returns
  • (::Google::Cloud::Eventarc::V1::Pipeline::MessagePayloadFormat) — Optional. The message format before it is delivered to the destination. If not set, the message will be delivered in the format it was originally delivered to the Pipeline. This field can only be set if Pipeline.input_payload_format is also set.

#output_payload_format=

def output_payload_format=(value) -> ::Google::Cloud::Eventarc::V1::Pipeline::MessagePayloadFormat
Parameter
  • value (::Google::Cloud::Eventarc::V1::Pipeline::MessagePayloadFormat) — Optional. The message format before it is delivered to the destination. If not set, the message will be delivered in the format it was originally delivered to the Pipeline. This field can only be set if Pipeline.input_payload_format is also set.
Returns
  • (::Google::Cloud::Eventarc::V1::Pipeline::MessagePayloadFormat) — Optional. The message format before it is delivered to the destination. If not set, the message will be delivered in the format it was originally delivered to the Pipeline. This field can only be set if Pipeline.input_payload_format is also set.

#topic

def topic() -> ::String
Returns
  • (::String) — Optional. The resource name of the Pub/Sub topic to which events should be published. Format: projects/{project}/locations/{location}/topics/{topic}

    Note: The following fields are mutually exclusive: topic, http_endpoint, workflow, message_bus. If a field in that set is populated, all other fields in the set will automatically be cleared.

#topic=

def topic=(value) -> ::String
Parameter
  • value (::String) — Optional. The resource name of the Pub/Sub topic to which events should be published. Format: projects/{project}/locations/{location}/topics/{topic}

    Note: The following fields are mutually exclusive: topic, http_endpoint, workflow, message_bus. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Optional. The resource name of the Pub/Sub topic to which events should be published. Format: projects/{project}/locations/{location}/topics/{topic}

    Note: The following fields are mutually exclusive: topic, http_endpoint, workflow, message_bus. If a field in that set is populated, all other fields in the set will automatically be cleared.

#workflow

def workflow() -> ::String
Returns
  • (::String) — Optional. The resource name of the Workflow whose Executions are triggered by the events. The Workflow resource should be deployed in the same project as the Pipeline. Format: projects/{project}/locations/{location}/workflows/{workflow}

    Note: The following fields are mutually exclusive: workflow, http_endpoint, message_bus, topic. If a field in that set is populated, all other fields in the set will automatically be cleared.

#workflow=

def workflow=(value) -> ::String
Parameter
  • value (::String) — Optional. The resource name of the Workflow whose Executions are triggered by the events. The Workflow resource should be deployed in the same project as the Pipeline. Format: projects/{project}/locations/{location}/workflows/{workflow}

    Note: The following fields are mutually exclusive: workflow, http_endpoint, message_bus, topic. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Optional. The resource name of the Workflow whose Executions are triggered by the events. The Workflow resource should be deployed in the same project as the Pipeline. Format: projects/{project}/locations/{location}/workflows/{workflow}

    Note: The following fields are mutually exclusive: workflow, http_endpoint, message_bus, topic. If a field in that set is populated, all other fields in the set will automatically be cleared.