public final class Channel extends GeneratedMessageV3 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
Static Fields
ACTIVATION_TOKEN_FIELD_NUMBER
public static final int ACTIVATION_TOKEN_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CRYPTO_KEY_NAME_FIELD_NUMBER
public static final int CRYPTO_KEY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PROVIDER_FIELD_NUMBER
public static final int PROVIDER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PUBSUB_TOPIC_FIELD_NUMBER
public static final int PUBSUB_TOPIC_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Channel getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Channel.Builder newBuilder()
newBuilder(Channel prototype)
public static Channel.Builder newBuilder(Channel prototype)
| Parameter |
|---|
| Name | Description |
prototype | Channel
|
public static Channel parseDelimitedFrom(InputStream input)
public static Channel parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Channel parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Channel parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Channel parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Channel parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Channel parseFrom(CodedInputStream input)
public static Channel parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Channel parseFrom(InputStream input)
public static Channel parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Channel parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Channel parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Channel> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
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];
| Returns |
|---|
| Type | Description |
String | The activationToken.
|
getActivationTokenBytes()
public 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 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 TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The creation time.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
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) = { ... }
| Returns |
|---|
| Type | Description |
String | The cryptoKeyName.
|
getCryptoKeyNameBytes()
public 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.
|
getDefaultInstanceForType()
public Channel getDefaultInstanceForType()
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 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.
|
getParserForType()
public Parser<Channel> getParserForType()
Overrides
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;
| Returns |
|---|
| Type | Description |
String | The provider.
|
getProviderBytes()
public 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 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 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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
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];
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];
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for state.
|
getTransportCase()
public Channel.TransportCase getTransportCase()
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 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.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getUpdateTime()
public 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 TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public 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 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 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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Channel.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Channel.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Channel.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
