public static final class PubsubTarget.Builder extends GeneratedMessageV3.Builder<PubsubTarget.Builder> 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PubsubTarget.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public PubsubTarget build()
buildPartial()
public PubsubTarget buildPartial()
clear()
public PubsubTarget.Builder clear()
Overrides
clearAttributes()
public PubsubTarget.Builder clearAttributes()
clearData()
public PubsubTarget.Builder clearData()
The message payload for PubsubMessage.
Pubsub message must contain either non-empty data, or at least one
attribute.
bytes data = 3;
clearField(Descriptors.FieldDescriptor field)
public PubsubTarget.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public PubsubTarget.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearTopicName()
public PubsubTarget.Builder clearTopicName()
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) = { ... }
clone()
public PubsubTarget.Builder clone()
Overrides
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 |
key |
String
|
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 |
key |
String
|
| 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()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getMutableAttributes()
public Map<String,String> getMutableAttributes()
Use alternate mutation accessors instead.
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.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
| Name |
Description |
number |
int
|
Overrides
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)
| Parameter |
| Name |
Description |
number |
int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(PubsubTarget other)
public PubsubTarget.Builder mergeFrom(PubsubTarget other)
public PubsubTarget.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public PubsubTarget.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PubsubTarget.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
putAllAttributes(Map<String,String> values)
public PubsubTarget.Builder putAllAttributes(Map<String,String> values)
Attributes for PubsubMessage.
Pubsub message must contain either non-empty data, or at least one
attribute.
map<string, string> attributes = 4;
putAttributes(String key, String value)
public PubsubTarget.Builder putAttributes(String key, String value)
Attributes for PubsubMessage.
Pubsub message must contain either non-empty data, or at least one
attribute.
map<string, string> attributes = 4;
removeAttributes(String key)
public PubsubTarget.Builder removeAttributes(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 |
key |
String
|
setData(ByteString value)
public PubsubTarget.Builder setData(ByteString value)
The message payload for PubsubMessage.
Pubsub message must contain either non-empty data, or at least one
attribute.
bytes data = 3;
| Parameter |
| Name |
Description |
value |
ByteString
The data to set.
|
setField(Descriptors.FieldDescriptor field, Object value)
public PubsubTarget.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PubsubTarget.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setTopicName(String value)
public PubsubTarget.Builder setTopicName(String value)
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) = { ... }
| Parameter |
| Name |
Description |
value |
String
The topicName to set.
|
setTopicNameBytes(ByteString value)
public PubsubTarget.Builder setTopicNameBytes(ByteString value)
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) = { ... }
| Parameter |
| Name |
Description |
value |
ByteString
The bytes for topicName to set.
|
setUnknownFields(UnknownFieldSet unknownFields)
public final PubsubTarget.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
