Interface ChannelOrBuilder (1.17.0)

Version 1.17.0

• 1.53.0 (latest)
• 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 interface ChannelOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getActivationToken()

public abstract String getActivationToken()

Output only. The activation token for the channel. The token must be used by the provider to register the channel for publishing.

string activation_token = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The activationToken.

getActivationTokenBytes()

public abstract ByteString getActivationTokenBytes()

Output only. The activation token for the channel. The token must be used by the provider to register the channel for publishing.

string activation_token = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for activationToken.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The creation time.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The creation time.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getCryptoKeyName()

public abstract String getCryptoKeyName()

Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern projects/*/locations/*/keyRings/*/cryptoKeys/*.

string crypto_key_name = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The cryptoKeyName.

getCryptoKeyNameBytes()

public abstract ByteString getCryptoKeyNameBytes()

Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern projects/*/locations/*/keyRings/*/cryptoKeys/*.

string crypto_key_name = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for cryptoKeyName.

getName()

public abstract String getName()

Required. The resource name of the channel. Must be unique within the location on the project and must be in projects/{project}/locations/{location}/channels/{channel_id} format.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Required. The resource name of the channel. Must be unique within the location on the project and must be in projects/{project}/locations/{location}/channels/{channel_id} format.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for name.

getProvider()

public abstract String getProvider()

The name of the event provider (e.g. Eventarc SaaS partner) associated with the channel. This provider will be granted permissions to publish events to the channel. Format: projects/{project}/locations/{location}/providers/{provider_id}.

string provider = 7;

Returns
Type	Description
String	The provider.

getProviderBytes()

public abstract ByteString getProviderBytes()

The name of the event provider (e.g. Eventarc SaaS partner) associated with the channel. This provider will be granted permissions to publish events to the channel. Format: projects/{project}/locations/{location}/providers/{provider_id}.

string provider = 7;

Returns
Type	Description
ByteString	The bytes for provider.

getPubsubTopic()

public abstract String getPubsubTopic()

Output only. The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: projects/{project}/topics/{topic_id}.

string pubsub_topic = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The pubsubTopic.

getPubsubTopicBytes()

public abstract ByteString getPubsubTopicBytes()

Output only. The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: projects/{project}/topics/{topic_id}.

string pubsub_topic = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for pubsubTopic.

getState()

public abstract Channel.State getState()

Output only. The state of a Channel.

.google.cloud.eventarc.v1.Channel.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Channel.State	The state.

getStateValue()

public abstract int getStateValue()

Output only. The state of a Channel.

.google.cloud.eventarc.v1.Channel.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for state.

getTransportCase()

public abstract Channel.TransportCase getTransportCase()

Returns
Type	Description
Channel.TransportCase

getUid()

public abstract String getUid()

Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The uid.

getUidBytes()

public abstract ByteString getUidBytes()

Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for uid.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The last-modified time.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The last-modified time.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The creation time.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.

hasPubsubTopic()

public abstract boolean hasPubsubTopic()

Output only. The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: projects/{project}/topics/{topic_id}.

string pubsub_topic = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the pubsubTopic field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The last-modified time.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the updateTime field is set.