Class PublishEventsRequest (0.48.0)

public final class PublishEventsRequest extends GeneratedMessageV3 implements PublishEventsRequestOrBuilder

The request message for the PublishEvents method.

Protobuf type google.cloud.eventarc.publishing.v1.PublishEventsRequest

Static Fields

CHANNEL_FIELD_NUMBER

public static final int CHANNEL_FIELD_NUMBER
Field Value
Type Description
int

EVENTS_FIELD_NUMBER

public static final int EVENTS_FIELD_NUMBER
Field Value
Type Description
int

TEXT_EVENTS_FIELD_NUMBER

public static final int TEXT_EVENTS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PublishEventsRequest getDefaultInstance()
Returns
Type Description
PublishEventsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PublishEventsRequest.Builder newBuilder()
Returns
Type Description
PublishEventsRequest.Builder

newBuilder(PublishEventsRequest prototype)

public static PublishEventsRequest.Builder newBuilder(PublishEventsRequest prototype)
Parameter
Name Description
prototype PublishEventsRequest
Returns
Type Description
PublishEventsRequest.Builder

parseDelimitedFrom(InputStream input)

public static PublishEventsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PublishEventsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PublishEventsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PublishEventsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PublishEventsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PublishEventsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PublishEventsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PublishEventsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PublishEventsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PublishEventsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PublishEventsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PublishEventsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PublishEventsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PublishEventsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PublishEventsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PublishEventsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PublishEventsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PublishEventsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PublishEventsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PublishEventsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PublishEventsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PublishEventsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PublishEventsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PublishEventsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PublishEventsRequest> parser()
Returns
Type Description
Parser<PublishEventsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getChannel()

public String getChannel()

The full name of the channel to publish to. For example: projects/{project}/locations/{location}/channels/{channel-id}.

string channel = 1;

Returns
Type Description
String

The channel.

getChannelBytes()

public ByteString getChannelBytes()

The full name of the channel to publish to. For example: projects/{project}/locations/{location}/channels/{channel-id}.

string channel = 1;

Returns
Type Description
ByteString

The bytes for channel.

getDefaultInstanceForType()

public PublishEventsRequest getDefaultInstanceForType()
Returns
Type Description
PublishEventsRequest

getEvents(int index)

public Any getEvents(int index)

The CloudEvents v1.0 events to publish. No other types are allowed. If this field is set, then the text_events fields must not be set.

repeated .google.protobuf.Any events = 2;

Parameter
Name Description
index int
Returns
Type Description
Any

getEventsCount()

public int getEventsCount()

The CloudEvents v1.0 events to publish. No other types are allowed. If this field is set, then the text_events fields must not be set.

repeated .google.protobuf.Any events = 2;

Returns
Type Description
int

getEventsList()

public List<Any> getEventsList()

The CloudEvents v1.0 events to publish. No other types are allowed. If this field is set, then the text_events fields must not be set.

repeated .google.protobuf.Any events = 2;

Returns
Type Description
List<Any>

getEventsOrBuilder(int index)

public AnyOrBuilder getEventsOrBuilder(int index)

The CloudEvents v1.0 events to publish. No other types are allowed. If this field is set, then the text_events fields must not be set.

repeated .google.protobuf.Any events = 2;

Parameter
Name Description
index int
Returns
Type Description
AnyOrBuilder

getEventsOrBuilderList()

public List<? extends AnyOrBuilder> getEventsOrBuilderList()

The CloudEvents v1.0 events to publish. No other types are allowed. If this field is set, then the text_events fields must not be set.

repeated .google.protobuf.Any events = 2;

Returns
Type Description
List<? extends com.google.protobuf.AnyOrBuilder>

getParserForType()

public Parser<PublishEventsRequest> getParserForType()
Returns
Type Description
Parser<PublishEventsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTextEvents(int index)

public String getTextEvents(int index)

The text representation of events to publish. CloudEvent v1.0 in JSON format is the only allowed type. Refer to https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/json-format.md for specification. If this field is set, then the events fields must not be set.

repeated string text_events = 3;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The textEvents at the given index.

getTextEventsBytes(int index)

public ByteString getTextEventsBytes(int index)

The text representation of events to publish. CloudEvent v1.0 in JSON format is the only allowed type. Refer to https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/json-format.md for specification. If this field is set, then the events fields must not be set.

repeated string text_events = 3;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the textEvents at the given index.

getTextEventsCount()

public int getTextEventsCount()

The text representation of events to publish. CloudEvent v1.0 in JSON format is the only allowed type. Refer to https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/json-format.md for specification. If this field is set, then the events fields must not be set.

repeated string text_events = 3;

Returns
Type Description
int

The count of textEvents.

getTextEventsList()

public ProtocolStringList getTextEventsList()

The text representation of events to publish. CloudEvent v1.0 in JSON format is the only allowed type. Refer to https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/json-format.md for specification. If this field is set, then the events fields must not be set.

repeated string text_events = 3;

Returns
Type Description
ProtocolStringList

A list containing the textEvents.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PublishEventsRequest.Builder newBuilderForType()
Returns
Type Description
PublishEventsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PublishEventsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PublishEventsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PublishEventsRequest.Builder toBuilder()
Returns
Type Description
PublishEventsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException