Class Pipeline.Destination (1.76.0) 

public static final class Pipeline.Destination extends GeneratedMessageV3 implements Pipeline.DestinationOrBuilder

Represents a target of an invocation over HTTP.

Protobuf type google.cloud.eventarc.v1.Pipeline.Destination

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Pipeline.Destination

Static Fields

AUTHENTICATION_CONFIG_FIELD_NUMBER

public static final int AUTHENTICATION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

HTTP_ENDPOINT_FIELD_NUMBER

public static final int HTTP_ENDPOINT_FIELD_NUMBER
Field Value
Type Description
int

MESSAGE_BUS_FIELD_NUMBER

public static final int MESSAGE_BUS_FIELD_NUMBER
Field Value
Type Description
int

NETWORK_CONFIG_FIELD_NUMBER

public static final int NETWORK_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

OUTPUT_PAYLOAD_FORMAT_FIELD_NUMBER

public static final int OUTPUT_PAYLOAD_FORMAT_FIELD_NUMBER
Field Value
Type Description
int

TOPIC_FIELD_NUMBER

public static final int TOPIC_FIELD_NUMBER
Field Value
Type Description
int

WORKFLOW_FIELD_NUMBER

public static final int WORKFLOW_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Pipeline.Destination getDefaultInstance()
Returns
Type Description
Pipeline.Destination

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Pipeline.Destination.Builder newBuilder()
Returns
Type Description
Pipeline.Destination.Builder

newBuilder(Pipeline.Destination prototype)

public static Pipeline.Destination.Builder newBuilder(Pipeline.Destination prototype)
Parameter
Name Description
prototype Pipeline.Destination
Returns
Type Description
Pipeline.Destination.Builder

parseDelimitedFrom(InputStream input)

public static Pipeline.Destination parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Pipeline.Destination
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Pipeline.Destination parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline.Destination
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Pipeline.Destination parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Pipeline.Destination
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Pipeline.Destination parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline.Destination
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Pipeline.Destination parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Pipeline.Destination
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Pipeline.Destination parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline.Destination
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Pipeline.Destination parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Pipeline.Destination
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Pipeline.Destination parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline.Destination
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Pipeline.Destination parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Pipeline.Destination
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Pipeline.Destination parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline.Destination
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Pipeline.Destination parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Pipeline.Destination
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Pipeline.Destination parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline.Destination
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Pipeline.Destination> parser()
Returns
Type Description
Parser<Destination>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAuthenticationConfig()

public 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 Google Cloud destinations that require Google Cloud credentials for 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 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 Google Cloud destinations that require Google Cloud credentials for 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

getDefaultInstanceForType()

public Pipeline.Destination getDefaultInstanceForType()
Returns
Type Description
Pipeline.Destination

getDestinationDescriptorCase()

public Pipeline.Destination.DestinationDescriptorCase getDestinationDescriptorCase()
Returns
Type Description
Pipeline.Destination.DestinationDescriptorCase

getHttpEndpoint()

public 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 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 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 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 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 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 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 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

getParserForType()

public Parser<Pipeline.Destination> getParserForType()
Returns
Type Description
Parser<Destination>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTopic()

public 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 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 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 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 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 Google Cloud destinations that require Google Cloud credentials for 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 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 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 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 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 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 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Pipeline.Destination.Builder newBuilderForType()
Returns
Type Description
Pipeline.Destination.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Pipeline.Destination.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Pipeline.Destination.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Pipeline.Destination.Builder toBuilder()
Returns
Type Description
Pipeline.Destination.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException