Class PubsubTarget (2.27.0)

public final class PubsubTarget extends GeneratedMessageV3 implements PubsubTargetOrBuilder

Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic.

Protobuf type google.cloud.scheduler.v1.PubsubTarget

Static Fields

ATTRIBUTES_FIELD_NUMBER

public static final int ATTRIBUTES_FIELD_NUMBER
Field Value
TypeDescription
int

DATA_FIELD_NUMBER

public static final int DATA_FIELD_NUMBER
Field Value
TypeDescription
int

TOPIC_NAME_FIELD_NUMBER

public static final int TOPIC_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PubsubTarget getDefaultInstance()
Returns
TypeDescription
PubsubTarget

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static PubsubTarget.Builder newBuilder()
Returns
TypeDescription
PubsubTarget.Builder

newBuilder(PubsubTarget prototype)

public static PubsubTarget.Builder newBuilder(PubsubTarget prototype)
Parameter
NameDescription
prototypePubsubTarget
Returns
TypeDescription
PubsubTarget.Builder

parseDelimitedFrom(InputStream input)

public static PubsubTarget parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PubsubTarget
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PubsubTarget parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PubsubTarget
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PubsubTarget parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PubsubTarget
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PubsubTarget parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PubsubTarget
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PubsubTarget parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PubsubTarget
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PubsubTarget parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PubsubTarget
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PubsubTarget parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PubsubTarget
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PubsubTarget parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PubsubTarget
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PubsubTarget parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PubsubTarget
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PubsubTarget parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PubsubTarget
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PubsubTarget parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PubsubTarget
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PubsubTarget parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PubsubTarget
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<PubsubTarget> parser()
Returns
TypeDescription
Parser<PubsubTarget>

Methods

containsAttributes(String key)

public boolean containsAttributes(String key)

Attributes for PubsubMessage.

Pubsub message must contain either non-empty data, or at least one attribute.

map<string, string> attributes = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAttributes()

public Map<String,String> getAttributes()

Use #getAttributesMap() instead.

Returns
TypeDescription
Map<String,String>

getAttributesCount()

public int getAttributesCount()

Attributes for PubsubMessage.

Pubsub message must contain either non-empty data, or at least one attribute.

map<string, string> attributes = 4;

Returns
TypeDescription
int

getAttributesMap()

public Map<String,String> getAttributesMap()

Attributes for PubsubMessage.

Pubsub message must contain either non-empty data, or at least one attribute.

map<string, string> attributes = 4;

Returns
TypeDescription
Map<String,String>

getAttributesOrDefault(String key, String defaultValue)

public String getAttributesOrDefault(String key, String defaultValue)

Attributes for PubsubMessage.

Pubsub message must contain either non-empty data, or at least one attribute.

map<string, string> attributes = 4;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getAttributesOrThrow(String key)

public String getAttributesOrThrow(String key)

Attributes for PubsubMessage.

Pubsub message must contain either non-empty data, or at least one attribute.

map<string, string> attributes = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getData()

public ByteString getData()

The message payload for PubsubMessage.

Pubsub message must contain either non-empty data, or at least one attribute.

bytes data = 3;

Returns
TypeDescription
ByteString

The data.

getDefaultInstanceForType()

public PubsubTarget getDefaultInstanceForType()
Returns
TypeDescription
PubsubTarget

getParserForType()

public Parser<PubsubTarget> getParserForType()
Returns
TypeDescription
Parser<PubsubTarget>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTopicName()

public String getTopicName()

Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's PublishRequest.name, for example projects/PROJECT_ID/topics/TOPIC_ID.

The topic must be in the same project as the Cloud Scheduler job.

string topic_name = 1 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The topicName.

getTopicNameBytes()

public ByteString getTopicNameBytes()

Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's PublishRequest.name, for example projects/PROJECT_ID/topics/TOPIC_ID.

The topic must be in the same project as the Cloud Scheduler job.

string topic_name = 1 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for topicName.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public PubsubTarget.Builder newBuilderForType()
Returns
TypeDescription
PubsubTarget.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PubsubTarget.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
PubsubTarget.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public PubsubTarget.Builder toBuilder()
Returns
TypeDescription
PubsubTarget.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException