Class Destination (1.55.0)

public final class Destination extends GeneratedMessageV3 implements DestinationOrBuilder

Represents a target of an invocation over HTTP.

Protobuf type google.cloud.eventarc.v1.Destination

Static Fields

CLOUD_FUNCTION_FIELD_NUMBER

public static final int CLOUD_FUNCTION_FIELD_NUMBER
Field Value
Type Description
int

CLOUD_RUN_FIELD_NUMBER

public static final int CLOUD_RUN_FIELD_NUMBER
Field Value
Type Description
int

GKE_FIELD_NUMBER

public static final int GKE_FIELD_NUMBER
Field Value
Type Description
int

HTTP_ENDPOINT_FIELD_NUMBER

public static final int HTTP_ENDPOINT_FIELD_NUMBER
Field Value
Type Description
int

NETWORK_CONFIG_FIELD_NUMBER

public static final int NETWORK_CONFIG_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 Destination getDefaultInstance()
Returns
Type Description
Destination

getDescriptor()

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

newBuilder()

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

newBuilder(Destination prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

getCloudFunction()

public String getCloudFunction()

The Cloud Function resource name. Cloud Functions V1 and V2 are supported. Format: projects/{project}/locations/{location}/functions/{function}

This is a read-only field. Creating Cloud Functions V1/V2 triggers is only supported via the Cloud Functions product. An error will be returned if the user sets this value.

string cloud_function = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The cloudFunction.

getCloudFunctionBytes()

public ByteString getCloudFunctionBytes()

The Cloud Function resource name. Cloud Functions V1 and V2 are supported. Format: projects/{project}/locations/{location}/functions/{function}

This is a read-only field. Creating Cloud Functions V1/V2 triggers is only supported via the Cloud Functions product. An error will be returned if the user sets this value.

string cloud_function = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for cloudFunction.

getCloudRun()

public CloudRun getCloudRun()

Cloud Run fully-managed resource that receives the events. The resource should be in the same project as the trigger.

.google.cloud.eventarc.v1.CloudRun cloud_run = 1;

Returns
Type Description
CloudRun

The cloudRun.

getCloudRunOrBuilder()

public CloudRunOrBuilder getCloudRunOrBuilder()

Cloud Run fully-managed resource that receives the events. The resource should be in the same project as the trigger.

.google.cloud.eventarc.v1.CloudRun cloud_run = 1;

Returns
Type Description
CloudRunOrBuilder

getDefaultInstanceForType()

public Destination getDefaultInstanceForType()
Returns
Type Description
Destination

getDescriptorCase()

public Destination.DescriptorCase getDescriptorCase()
Returns
Type Description
Destination.DescriptorCase

getGke()

public GKE getGke()

A GKE service capable of receiving events. The service should be running in the same project as the trigger.

.google.cloud.eventarc.v1.GKE gke = 3;

Returns
Type Description
GKE

The gke.

getGkeOrBuilder()

public GKEOrBuilder getGkeOrBuilder()

A GKE service capable of receiving events. The service should be running in the same project as the trigger.

.google.cloud.eventarc.v1.GKE gke = 3;

Returns
Type Description
GKEOrBuilder

getHttpEndpoint()

public HttpEndpoint getHttpEndpoint()

An HTTP endpoint destination described by an URI.

.google.cloud.eventarc.v1.HttpEndpoint http_endpoint = 5;

Returns
Type Description
HttpEndpoint

The httpEndpoint.

getHttpEndpointOrBuilder()

public HttpEndpointOrBuilder getHttpEndpointOrBuilder()

An HTTP endpoint destination described by an URI.

.google.cloud.eventarc.v1.HttpEndpoint http_endpoint = 5;

Returns
Type Description
HttpEndpointOrBuilder

getNetworkConfig()

public NetworkConfig getNetworkConfig()

Optional. Network config is used to configure how Eventarc resolves and connect to a destination. This should only be used with HttpEndpoint destination type.

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

Returns
Type Description
NetworkConfig

The networkConfig.

getNetworkConfigOrBuilder()

public NetworkConfigOrBuilder getNetworkConfigOrBuilder()

Optional. Network config is used to configure how Eventarc resolves and connect to a destination. This should only be used with HttpEndpoint destination type.

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

Returns
Type Description
NetworkConfigOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getWorkflow()

public String getWorkflow()

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 trigger. Format: projects/{project}/locations/{location}/workflows/{workflow}

string workflow = 4 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The workflow.

getWorkflowBytes()

public ByteString getWorkflowBytes()

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 trigger. Format: projects/{project}/locations/{location}/workflows/{workflow}

string workflow = 4 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for workflow.

hasCloudFunction()

public boolean hasCloudFunction()

The Cloud Function resource name. Cloud Functions V1 and V2 are supported. Format: projects/{project}/locations/{location}/functions/{function}

This is a read-only field. Creating Cloud Functions V1/V2 triggers is only supported via the Cloud Functions product. An error will be returned if the user sets this value.

string cloud_function = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the cloudFunction field is set.

hasCloudRun()

public boolean hasCloudRun()

Cloud Run fully-managed resource that receives the events. The resource should be in the same project as the trigger.

.google.cloud.eventarc.v1.CloudRun cloud_run = 1;

Returns
Type Description
boolean

Whether the cloudRun field is set.

hasGke()

public boolean hasGke()

A GKE service capable of receiving events. The service should be running in the same project as the trigger.

.google.cloud.eventarc.v1.GKE gke = 3;

Returns
Type Description
boolean

Whether the gke field is set.

hasHttpEndpoint()

public boolean hasHttpEndpoint()

An HTTP endpoint destination described by an URI.

.google.cloud.eventarc.v1.HttpEndpoint http_endpoint = 5;

Returns
Type Description
boolean

Whether the httpEndpoint field is set.

hasNetworkConfig()

public boolean hasNetworkConfig()

Optional. Network config is used to configure how Eventarc resolves and connect to a destination. This should only be used with HttpEndpoint destination type.

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

Returns
Type Description
boolean

Whether the networkConfig field is set.

hasWorkflow()

public boolean hasWorkflow()

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 trigger. Format: projects/{project}/locations/{location}/workflows/{workflow}

string workflow = 4 [(.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 Destination.Builder newBuilderForType()
Returns
Type Description
Destination.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Destination.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
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 Destination.Builder toBuilder()
Returns
Type Description
Destination.Builder

writeTo(CodedOutputStream output)

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