Package com.google.cloud.eventarc.v1
Interface ChannelOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Channel,Channel.Builder
public interface ChannelOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetActivationToken()Output only.com.google.protobuf.ByteStringgetActivationTokenBytes()Output only.com.google.protobuf.TimestampgetCreateTime()Output only.com.google.protobuf.TimestampOrBuildergetCreateTimeOrBuilder()Output only.StringgetCryptoKeyName()Optional.com.google.protobuf.ByteStringgetCryptoKeyNameBytes()Optional.StringgetName()Required.com.google.protobuf.ByteStringgetNameBytes()Required.StringgetProvider()The name of the event provider (e.g.com.google.protobuf.ByteStringgetProviderBytes()The name of the event provider (e.g.StringgetPubsubTopic()Output only.com.google.protobuf.ByteStringgetPubsubTopicBytes()Output only.Channel.StategetState()Output only.intgetStateValue()Output only.Channel.TransportCasegetTransportCase()StringgetUid()Output only.com.google.protobuf.ByteStringgetUidBytes()Output only.com.google.protobuf.TimestampgetUpdateTime()Output only.com.google.protobuf.TimestampOrBuildergetUpdateTimeOrBuilder()Output only.booleanhasCreateTime()Output only.booleanhasPubsubTopic()Output only.booleanhasUpdateTime()Output only.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getName
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:
- The name.
-
getNameBytes
com.google.protobuf.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:
- The bytes for name.
-
getUid
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:
- The uid.
-
getUidBytes
com.google.protobuf.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:
- The bytes for uid.
-
hasCreateTime
boolean hasCreateTime()
Output only. The creation time.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the createTime field is set.
-
getCreateTime
com.google.protobuf.Timestamp getCreateTime()
Output only. The creation time.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The createTime.
-
getCreateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The creation time.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
-
hasUpdateTime
boolean hasUpdateTime()
Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
com.google.protobuf.Timestamp getUpdateTime()
Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
-
getProvider
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:
- The provider.
-
getProviderBytes
com.google.protobuf.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:
- The bytes for provider.
-
hasPubsubTopic
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:
- Whether the pubsubTopic field is set.
-
getPubsubTopic
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:
- The pubsubTopic.
-
getPubsubTopicBytes
com.google.protobuf.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:
- The bytes for pubsubTopic.
-
getStateValue
int getStateValue()
Output only. The state of a Channel.
.google.cloud.eventarc.v1.Channel.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The enum numeric value on the wire for state.
-
getState
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:
- The state.
-
getActivationToken
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:
- The activationToken.
-
getActivationTokenBytes
com.google.protobuf.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:
- The bytes for activationToken.
-
getCryptoKeyName
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:
- The cryptoKeyName.
-
getCryptoKeyNameBytes
com.google.protobuf.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:
- The bytes for cryptoKeyName.
-
getTransportCase
Channel.TransportCase getTransportCase()
-
-