Interface Pipeline.DestinationOrBuilder (1.54.0)

Version 1.54.0

• 1.55.0 (latest)
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.2.4

public static interface Pipeline.DestinationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAuthenticationConfig()

public abstract Pipeline.Destination.AuthenticationConfig 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

.google.cloud.eventarc.v1.Pipeline.Destination.AuthenticationConfig authentication_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Pipeline.Destination.AuthenticationConfig	The authenticationConfig.

getAuthenticationConfigOrBuilder()

public abstract Pipeline.Destination.AuthenticationConfigOrBuilder getAuthenticationConfigOrBuilder()

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

.google.cloud.eventarc.v1.Pipeline.Destination.AuthenticationConfig authentication_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Pipeline.Destination.AuthenticationConfigOrBuilder

getDestinationDescriptorCase()

public abstract Pipeline.Destination.DestinationDescriptorCase getDestinationDescriptorCase()

Returns
Type	Description
Pipeline.Destination.DestinationDescriptorCase

getHttpEndpoint()

public abstract Pipeline.Destination.HttpEndpoint 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

.google.cloud.eventarc.v1.Pipeline.Destination.HttpEndpoint http_endpoint = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Pipeline.Destination.HttpEndpoint	The httpEndpoint.

getHttpEndpointOrBuilder()

public abstract Pipeline.Destination.HttpEndpointOrBuilder getHttpEndpointOrBuilder()

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

.google.cloud.eventarc.v1.Pipeline.Destination.HttpEndpoint http_endpoint = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Pipeline.Destination.HttpEndpointOrBuilder

getMessageBus()

public abstract String 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 message_bus = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The messageBus.

getMessageBusBytes()

public abstract ByteString getMessageBusBytes()

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 message_bus = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for messageBus.

getNetworkConfig()

public abstract Pipeline.Destination.NetworkConfig getNetworkConfig()

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

.google.cloud.eventarc.v1.Pipeline.Destination.NetworkConfig network_config = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Pipeline.Destination.NetworkConfig	The networkConfig.

getNetworkConfigOrBuilder()

public abstract Pipeline.Destination.NetworkConfigOrBuilder getNetworkConfigOrBuilder()

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

.google.cloud.eventarc.v1.Pipeline.Destination.NetworkConfig network_config = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Pipeline.Destination.NetworkConfigOrBuilder

getOutputPayloadFormat()

public abstract Pipeline.MessagePayloadFormat 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.

.google.cloud.eventarc.v1.Pipeline.MessagePayloadFormat output_payload_format = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Pipeline.MessagePayloadFormat	The outputPayloadFormat.

getOutputPayloadFormatOrBuilder()

public abstract Pipeline.MessagePayloadFormatOrBuilder getOutputPayloadFormatOrBuilder()

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.

.google.cloud.eventarc.v1.Pipeline.MessagePayloadFormat output_payload_format = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Pipeline.MessagePayloadFormatOrBuilder

getTopic()

public abstract String getTopic()

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

string topic = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The topic.

getTopicBytes()

public abstract ByteString getTopicBytes()

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

string topic = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for topic.

getWorkflow()

public abstract String 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 workflow = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The workflow.

getWorkflowBytes()

public abstract ByteString getWorkflowBytes()

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 workflow = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for workflow.

hasAuthenticationConfig()

public abstract boolean hasAuthenticationConfig()

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

.google.cloud.eventarc.v1.Pipeline.Destination.AuthenticationConfig authentication_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the authenticationConfig field is set.

hasHttpEndpoint()

public abstract boolean hasHttpEndpoint()

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

.google.cloud.eventarc.v1.Pipeline.Destination.HttpEndpoint http_endpoint = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the httpEndpoint field is set.

hasMessageBus()

public abstract boolean hasMessageBus()

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 message_bus = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
boolean	Whether the messageBus field is set.

hasNetworkConfig()

public abstract boolean hasNetworkConfig()

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

.google.cloud.eventarc.v1.Pipeline.Destination.NetworkConfig network_config = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the networkConfig field is set.

hasOutputPayloadFormat()

public abstract boolean hasOutputPayloadFormat()

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.

.google.cloud.eventarc.v1.Pipeline.MessagePayloadFormat output_payload_format = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the outputPayloadFormat field is set.

hasTopic()

public abstract boolean hasTopic()

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

string topic = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
boolean	Whether the topic field is set.

hasWorkflow()

public abstract boolean hasWorkflow()

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 workflow = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
boolean	Whether the workflow field is set.