Class PubsubTarget (2.15.0)
2.87.0 (latest)
2.85.0
2.83.0
2.82.0
2.80.0
2.78.0
2.76.0
2.75.0
2.74.0
2.73.0
2.72.0
2.70.0
2.68.0
2.67.0
2.64.0
2.63.0
2.62.0
2.60.0
2.59.0
2.58.0
2.57.0
2.56.0
2.55.0
2.54.0
2.53.0
2.52.0
2.51.0
2.49.0
2.48.0
2.47.0
2.46.0
2.45.0
2.44.0
2.43.0
2.42.0
2.41.0
2.40.0
2.39.0
2.37.0
2.36.0
2.35.0
2.34.0
2.33.0
2.32.0
2.31.0
2.30.0
2.29.0
2.28.0
2.27.0
2.24.0
2.23.0
2.22.0
2.21.0
2.20.0
2.19.0
2.18.0
2.17.0
2.16.0
2.15.0
2.14.0
2.13.0
2.12.0
2.11.0
2.9.0
2.8.0
2.7.0
2.6.0
2.5.0
2.4.0
2.3.13
2.2.0
2.1.23
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.v1beta1.PubsubTarget
Static Fields
ATTRIBUTES_FIELD_NUMBER
public static final int ATTRIBUTES_FIELD_NUMBER
Field Value
Type Description
int
DATA_FIELD_NUMBER
public static final int DATA_FIELD_NUMBER
Field Value
Type Description
int
TOPIC_NAME_FIELD_NUMBER
public static final int TOPIC_NAME_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static PubsubTarget getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static PubsubTarget . Builder newBuilder ()
newBuilder(PubsubTarget prototype)
public static PubsubTarget . Builder newBuilder ( PubsubTarget prototype )
public static PubsubTarget parseDelimitedFrom ( InputStream input )
public static PubsubTarget parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static PubsubTarget parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PubsubTarget parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static PubsubTarget parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PubsubTarget parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static PubsubTarget parseFrom ( CodedInputStream input )
public static PubsubTarget parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static PubsubTarget parseFrom ( InputStream input )
public static PubsubTarget parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static PubsubTarget parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PubsubTarget parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<PubsubTarget> parser ()
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
Name Description
keyString
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getAttributes()
public Map<String , String > getAttributes ()
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
Type Description
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;
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;
Returns
Type Description
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
Name Description
keyString
Returns
Type Description
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;
getDefaultInstanceForType()
public PubsubTarget getDefaultInstanceForType ()
getParserForType()
public Parser<PubsubTarget> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
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
Type Description
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
Type Description
ByteString The bytes for topicName.
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Overrides
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField ( int number )
Parameter
Name Description
numberint
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public PubsubTarget . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PubsubTarget . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public PubsubTarget . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-03-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-03-14 UTC."],[],[]]
