Package com.google.cloud.eventarc.v1

Class Channel

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.eventarc.v1.Channel
All Implemented Interfaces:
ChannelOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Channel extends com.google.protobuf.GeneratedMessage implements ChannelOrBuilder
 A representation of the Channel resource.
 A Channel is a resource on which event providers publish their events.
 The published events are delivered through the transport associated with the
 channel. Note that a channel is associated with exactly one event provider.
Protobuf type google.cloud.eventarc.v1.Channel
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • UID_FIELD_NUMBER

      public static final int UID_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • PROVIDER_FIELD_NUMBER

      public static final int PROVIDER_FIELD_NUMBER
      See Also:

    • PUBSUB_TOPIC_FIELD_NUMBER

      public static final int PUBSUB_TOPIC_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • ACTIVATION_TOKEN_FIELD_NUMBER

      public static final int ACTIVATION_TOKEN_FIELD_NUMBER
      See Also:

    • CRYPTO_KEY_NAME_FIELD_NUMBER

      public static final int CRYPTO_KEY_NAME_FIELD_NUMBER
      See Also:

    • SATISFIES_PZS_FIELD_NUMBER

      public static final int SATISFIES_PZS_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getTransportCase

      public Channel.TransportCase getTransportCase()
      Specified by:
      getTransportCase in interface ChannelOrBuilder

    • getName

      public 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];
      Specified by:
      getName in interface ChannelOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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];
      Specified by:
      getNameBytes in interface ChannelOrBuilder
      Returns:
      The bytes for name.

    • getUid

      public 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];
      Specified by:
      getUid in interface ChannelOrBuilder
      Returns:
      The uid.

    • getUidBytes

      public 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];
      Specified by:
      getUidBytes in interface ChannelOrBuilder
      Returns:
      The bytes for uid.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. The creation time.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface ChannelOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. The creation time.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface ChannelOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The creation time.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface ChannelOrBuilder

    • hasUpdateTime

      public boolean hasUpdateTime()
       Output only. The last-modified time.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdateTime in interface ChannelOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. The last-modified time.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface ChannelOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The last-modified time.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface ChannelOrBuilder

    • getProvider

      public 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;
      Specified by:
      getProvider in interface ChannelOrBuilder
      Returns:
      The provider.

    • getProviderBytes

      public 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;
      Specified by:
      getProviderBytes in interface ChannelOrBuilder
      Returns:
      The bytes for provider.

    • hasPubsubTopic

      public 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];
      Specified by:
      hasPubsubTopic in interface ChannelOrBuilder
      Returns:
      Whether the pubsubTopic field is set.

    • getPubsubTopic

      public 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];
      Specified by:
      getPubsubTopic in interface ChannelOrBuilder
      Returns:
      The pubsubTopic.

    • getPubsubTopicBytes

      public 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];
      Specified by:
      getPubsubTopicBytes in interface ChannelOrBuilder
      Returns:
      The bytes for pubsubTopic.

    • getStateValue

      public int getStateValue()
       Output only. The state of a Channel.
      .google.cloud.eventarc.v1.Channel.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStateValue in interface ChannelOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • getState

      public Channel.State getState()
       Output only. The state of a Channel.
      .google.cloud.eventarc.v1.Channel.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getState in interface ChannelOrBuilder
      Returns:
      The state.

    • getActivationToken

      public 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];
      Specified by:
      getActivationToken in interface ChannelOrBuilder
      Returns:
      The activationToken.

    • getActivationTokenBytes

      public 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];
      Specified by:
      getActivationTokenBytes in interface ChannelOrBuilder
      Returns:
      The bytes for activationToken.

    • getCryptoKeyName

      public 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) = { ... }
      Specified by:
      getCryptoKeyName in interface ChannelOrBuilder
      Returns:
      The cryptoKeyName.

    • getCryptoKeyNameBytes

      public 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) = { ... }
      Specified by:
      getCryptoKeyNameBytes in interface ChannelOrBuilder
      Returns:
      The bytes for cryptoKeyName.

    • getSatisfiesPzs

      public boolean getSatisfiesPzs()
       Output only. Whether or not this Channel satisfies the requirements of
 physical zone separation
      bool satisfies_pzs = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSatisfiesPzs in interface ChannelOrBuilder
      Returns:
      The satisfiesPzs.

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: ChannelOrBuilder
       Optional. Resource labels.
      map<string, string> labels = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsCount in interface ChannelOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       Optional. Resource labels.
      map<string, string> labels = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsLabels in interface ChannelOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface ChannelOrBuilder

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       Optional. Resource labels.
      map<string, string> labels = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsMap in interface ChannelOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       Optional. Resource labels.
      map<string, string> labels = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrDefault in interface ChannelOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       Optional. Resource labels.
      map<string, string> labels = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrThrow in interface ChannelOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Channel parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Channel parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Channel parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Channel parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Channel parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Channel parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Channel parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Channel parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Channel parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Channel parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Channel parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Channel parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Channel.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Channel.Builder newBuilder()

    • newBuilder

      public static Channel.Builder newBuilder(Channel prototype)

    • toBuilder

      public Channel.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Channel.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Channel getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Channel> parser()

    • getParserForType

      public com.google.protobuf.Parser<Channel> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Channel getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder