Google Cloud Eventarc V1 Client - Class Destination (2.1.0)

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 \ Pipeline

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ network_config Google\Cloud\Eventarc\V1\Pipeline\Destination\NetworkConfig

Optional. Network config is used to configure how Pipeline resolves and connects to a destination.
↳ http_endpoint 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
↳ 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 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
↳ output_payload_format 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.

getNetworkConfig

Optional. Network config is used to configure how Pipeline resolves and connects to a destination.

Returns
Type Description
Google\Cloud\Eventarc\V1\Pipeline\Destination\NetworkConfig|null

hasNetworkConfig

clearNetworkConfig

setNetworkConfig

Optional. Network config is used to configure how Pipeline resolves and connects to a destination.

Parameter
Name Description
var Google\Cloud\Eventarc\V1\Pipeline\Destination\NetworkConfig
Returns
Type Description
$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

Returns
Type Description
Google\Cloud\Eventarc\V1\Pipeline\Destination\HttpEndpoint|null

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

Parameter
Name Description
var Google\Cloud\Eventarc\V1\Pipeline\Destination\HttpEndpoint
Returns
Type Description
$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}

Returns
Type Description
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}

Parameter
Name Description
var string
Returns
Type Description
$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}

Returns
Type Description
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}

Parameter
Name Description
var string
Returns
Type Description
$this

getTopic

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

Returns
Type Description
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}

Parameter
Name Description
var string
Returns
Type Description
$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

Returns
Type Description
Google\Cloud\Eventarc\V1\Pipeline\Destination\AuthenticationConfig|null

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

Parameter
Name Description
var Google\Cloud\Eventarc\V1\Pipeline\Destination\AuthenticationConfig
Returns
Type Description
$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.

Returns
Type Description
Google\Cloud\Eventarc\V1\Pipeline\MessagePayloadFormat|null

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.

Parameter
Name Description
var Google\Cloud\Eventarc\V1\Pipeline\MessagePayloadFormat
Returns
Type Description
$this

getDestinationDescriptor

Returns
Type Description
string