public static final class Channel.Builder extends GeneratedMessageV3.Builder<Channel.Builder> implements ChannelOrBuilderA 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.events.cloud.eventarc.v1.Channel
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Channel.BuilderImplements
ChannelOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Channel.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | |
build()
public Channel build()| Returns | |
|---|---|
| Type | Description |
Channel | |
buildPartial()
public Channel buildPartial()| Returns | |
|---|---|
| Type | Description |
Channel | |
clear()
public Channel.Builder clear()| Returns | |
|---|---|
| Type | Description |
Channel.Builder | |
clearActivationToken()
public Channel.Builder clearActivationToken()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;
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | This builder for chaining. |
clearCreateTime()
public Channel.Builder clearCreateTime()Output only. The creation time.
.google.protobuf.Timestamp create_time = 5;
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | |
clearCryptoKeyName()
public Channel.Builder clearCryptoKeyName() 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;
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Channel.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | |
clearName()
public Channel.Builder clearName() 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;
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Channel.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | |
clearProvider()
public Channel.Builder clearProvider() 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 |
Channel.Builder | This builder for chaining. |
clearPubsubTopic()
public Channel.Builder clearPubsubTopic() 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;
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | This builder for chaining. |
clearState()
public Channel.Builder clearState()Output only. The state of a Channel.
.google.events.cloud.eventarc.v1.Channel.State state = 9;
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | This builder for chaining. |
clearTransport()
public Channel.Builder clearTransport()| Returns | |
|---|---|
| Type | Description |
Channel.Builder | |
clearUid()
public Channel.Builder clearUid()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;
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | This builder for chaining. |
clearUpdateTime()
public Channel.Builder clearUpdateTime()Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 6;
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | |
clone()
public Channel.Builder clone()| Returns | |
|---|---|
| Type | Description |
Channel.Builder | |
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;
| 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;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for activationToken. |
getCreateTime()
public Timestamp getCreateTime()Output only. The creation time.
.google.protobuf.Timestamp create_time = 5;
| Returns | |
|---|---|
| Type | Description |
Timestamp | The createTime. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()Output only. The creation time.
.google.protobuf.Timestamp create_time = 5;
| Returns | |
|---|---|
| Type | Description |
Builder | |
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()Output only. The creation time.
.google.protobuf.Timestamp create_time = 5;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getCryptoKeyName()
public String getCryptoKeyName() 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;
| Returns | |
|---|---|
| Type | Description |
String | The cryptoKeyName. |
getCryptoKeyNameBytes()
public ByteString getCryptoKeyNameBytes() 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;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for cryptoKeyName. |
getDefaultInstanceForType()
public Channel getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Channel | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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;
| 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;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for name. |
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;
| 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;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for pubsubTopic. |
getState()
public Channel.State getState()Output only. The state of a Channel.
.google.events.cloud.eventarc.v1.Channel.State state = 9;
| Returns | |
|---|---|
| Type | Description |
Channel.State | The state. |
getStateValue()
public int getStateValue()Output only. The state of a Channel.
.google.events.cloud.eventarc.v1.Channel.State state = 9;
| Returns | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for state. |
getTransportCase()
public Channel.TransportCase getTransportCase()| Returns | |
|---|---|
| Type | Description |
Channel.TransportCase | |
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;
| 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;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for uid. |
getUpdateTime()
public Timestamp getUpdateTime()Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 6;
| Returns | |
|---|---|
| Type | Description |
Timestamp | The updateTime. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 6;
| Returns | |
|---|---|
| Type | Description |
Builder | |
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 6;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
hasCreateTime()
public boolean hasCreateTime()Output only. The creation time.
.google.protobuf.Timestamp create_time = 5;
| 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;
| 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;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the updateTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeCreateTime(Timestamp value)
public Channel.Builder mergeCreateTime(Timestamp value)Output only. The creation time.
.google.protobuf.Timestamp create_time = 5;
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | |
mergeFrom(Channel other)
public Channel.Builder mergeFrom(Channel other)| Parameter | |
|---|---|
| Name | Description |
other | Channel |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Channel.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public Channel.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Channel.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | |
mergeUpdateTime(Timestamp value)
public Channel.Builder mergeUpdateTime(Timestamp value)Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 6;
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | |
setActivationToken(String value)
public Channel.Builder setActivationToken(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe activationToken to set. |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | This builder for chaining. |
setActivationTokenBytes(ByteString value)
public Channel.Builder setActivationTokenBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for activationToken to set. |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | This builder for chaining. |
setCreateTime(Timestamp value)
public Channel.Builder setCreateTime(Timestamp value)Output only. The creation time.
.google.protobuf.Timestamp create_time = 5;
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | |
setCreateTime(Timestamp.Builder builderForValue)
public Channel.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. The creation time.
.google.protobuf.Timestamp create_time = 5;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | |
setCryptoKeyName(String value)
public Channel.Builder setCryptoKeyName(String value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe cryptoKeyName to set. |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | This builder for chaining. |
setCryptoKeyNameBytes(ByteString value)
public Channel.Builder setCryptoKeyNameBytes(ByteString value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for cryptoKeyName to set. |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Channel.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | |
setName(String value)
public Channel.Builder setName(String value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public Channel.Builder setNameBytes(ByteString value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | This builder for chaining. |
setProvider(String value)
public Channel.Builder setProvider(String value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe provider to set. |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | This builder for chaining. |
setProviderBytes(ByteString value)
public Channel.Builder setProviderBytes(ByteString value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for provider to set. |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | This builder for chaining. |
setPubsubTopic(String value)
public Channel.Builder setPubsubTopic(String value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe pubsubTopic to set. |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | This builder for chaining. |
setPubsubTopicBytes(ByteString value)
public Channel.Builder setPubsubTopicBytes(ByteString value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for pubsubTopic to set. |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Channel.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | |
setState(Channel.State value)
public Channel.Builder setState(Channel.State value)Output only. The state of a Channel.
.google.events.cloud.eventarc.v1.Channel.State state = 9;
| Parameter | |
|---|---|
| Name | Description |
value | Channel.StateThe state to set. |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | This builder for chaining. |
setStateValue(int value)
public Channel.Builder setStateValue(int value)Output only. The state of a Channel.
.google.events.cloud.eventarc.v1.Channel.State state = 9;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for state to set. |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | This builder for chaining. |
setUid(String value)
public Channel.Builder setUid(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe uid to set. |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | This builder for chaining. |
setUidBytes(ByteString value)
public Channel.Builder setUidBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for uid to set. |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Channel.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | |
setUpdateTime(Timestamp value)
public Channel.Builder setUpdateTime(Timestamp value)Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 6;
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | |
setUpdateTime(Timestamp.Builder builderForValue)
public Channel.Builder setUpdateTime(Timestamp.Builder builderForValue)Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 6;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Channel.Builder | |