Reference documentation and code samples for the Google Cloud Eventarc V1 Client class Destination.
Represents a target of an invocation over HTTP.
Generated from protobuf message google.cloud.eventarc.v1.Pipeline.Destination
Namespace
Google \ Cloud \ Eventarc \ V1 \ PipelineMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ network_config
Destination\NetworkConfig
Optional. Network config is used to configure how Pipeline resolves and connects to a destination.
↳ http_endpoint
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
↳ workflow
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}
↳ message_bus
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}
↳ topic
string
Optional. The resource name of the Pub/Sub topic to which events should be published. Format: projects/{project}/locations/{location}/topics/{topic}
↳ authentication_config
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
↳ output_payload_format
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.
getNetworkConfig
Optional. Network config is used to configure how Pipeline resolves and connects to a destination.
hasNetworkConfig
clearNetworkConfig
setNetworkConfig
Optional. Network config is used to configure how Pipeline resolves and connects to a destination.
$this
getHttpEndpoint
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
hasHttpEndpoint
setHttpEndpoint
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
$this
getWorkflow
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}
string
hasWorkflow
setWorkflow
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}
var
string
$this
getMessageBus
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}
string
hasMessageBus
setMessageBus
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}
var
string
$this
getTopic
Optional. The resource name of the Pub/Sub topic to which events should
be published. Format: projects/{project}/locations/{location}/topics/{topic}
string
hasTopic
setTopic
Optional. The resource name of the Pub/Sub topic to which events should
be published. Format: projects/{project}/locations/{location}/topics/{topic}
var
string
$this
getAuthenticationConfig
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
hasAuthenticationConfig
clearAuthenticationConfig
setAuthenticationConfig
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
$this
getOutputPayloadFormat
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.
hasOutputPayloadFormat
clearOutputPayloadFormat
setOutputPayloadFormat
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.
$this
getDestinationDescriptor
string
