com.google.cloud.scheduler.v1beta1

Class PubsubTarget.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<PubsubTarget.Builder>

com.google.cloud.scheduler.v1beta1.PubsubTarget.Builder

All Implemented Interfaces:

PubsubTargetOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, Cloneable

Enclosing class:

PubsubTarget

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.v1beta1.PubsubTarget

Method Summary

Modifier and Type	Method and Description
PubsubTarget.Builder	addRepeatedField(Descriptors.FieldDescriptor field, Object value)
PubsubTarget	build()
PubsubTarget	buildPartial()
PubsubTarget.Builder	clear()
PubsubTarget.Builder	clearAttributes()
PubsubTarget.Builder	clearData() The message payload for PubsubMessage.
PubsubTarget.Builder	clearField(Descriptors.FieldDescriptor field)
PubsubTarget.Builder	clearOneof(Descriptors.OneofDescriptor oneof)
PubsubTarget.Builder	clearTopicName() Required.
PubsubTarget.Builder	clone()
boolean	containsAttributes(String key) Attributes for PubsubMessage.
Map<String,String>	getAttributes() Deprecated.
int	getAttributesCount() Attributes for PubsubMessage.
Map<String,String>	getAttributesMap() Attributes for PubsubMessage.
String	getAttributesOrDefault(String key, String defaultValue) Attributes for PubsubMessage.
String	getAttributesOrThrow(String key) Attributes for PubsubMessage.
ByteString	getData() The message payload for PubsubMessage.
PubsubTarget	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()
Map<String,String>	getMutableAttributes() Deprecated.
String	getTopicName() Required.
ByteString	getTopicNameBytes() Required.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected MapField	internalGetMapField(int number)
protected MapField	internalGetMutableMapField(int number)
boolean	isInitialized()
PubsubTarget.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
PubsubTarget.Builder	mergeFrom(Message other)
PubsubTarget.Builder	mergeFrom(PubsubTarget other)
PubsubTarget.Builder	mergeUnknownFields(UnknownFieldSet unknownFields)
PubsubTarget.Builder	putAllAttributes(Map<String,String> values) Attributes for PubsubMessage.
PubsubTarget.Builder	putAttributes(String key, String value) Attributes for PubsubMessage.
PubsubTarget.Builder	removeAttributes(String key) Attributes for PubsubMessage.
PubsubTarget.Builder	setData(ByteString value) The message payload for PubsubMessage.
PubsubTarget.Builder	setField(Descriptors.FieldDescriptor field, Object value)
PubsubTarget.Builder	setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
PubsubTarget.Builder	setTopicName(String value) Required.
PubsubTarget.Builder	setTopicNameBytes(ByteString value) Required.
PubsubTarget.Builder	setUnknownFields(UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetMapField

protected MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class GeneratedMessageV3.Builder<PubsubTarget.Builder>

internalGetMutableMapField

protected MapField internalGetMutableMapField(int number)

Overrides:

internalGetMutableMapField in class GeneratedMessageV3.Builder<PubsubTarget.Builder>

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<PubsubTarget.Builder>

clear

public PubsubTarget.Builder clear()

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<PubsubTarget.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<PubsubTarget.Builder>

getDefaultInstanceForType

public PubsubTarget getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public PubsubTarget build()

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public PubsubTarget buildPartial()

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone

public PubsubTarget.Builder clone()

Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<PubsubTarget.Builder>

setField

public PubsubTarget.Builder setField(Descriptors.FieldDescriptor field,
                                     Object value)

Specified by:

setField in interface Message.Builder

Overrides:

setField in class GeneratedMessageV3.Builder<PubsubTarget.Builder>

clearField

public PubsubTarget.Builder clearField(Descriptors.FieldDescriptor field)

Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<PubsubTarget.Builder>

clearOneof

public PubsubTarget.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<PubsubTarget.Builder>

setRepeatedField

public PubsubTarget.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                             int index,
                                             Object value)

Specified by:

setRepeatedField in interface Message.Builder

Overrides:

setRepeatedField in class GeneratedMessageV3.Builder<PubsubTarget.Builder>

addRepeatedField

public PubsubTarget.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                             Object value)

Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessageV3.Builder<PubsubTarget.Builder>

mergeFrom

public PubsubTarget.Builder mergeFrom(Message other)

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<PubsubTarget.Builder>

mergeFrom

public PubsubTarget.Builder mergeFrom(PubsubTarget other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<PubsubTarget.Builder>

mergeFrom

public PubsubTarget.Builder mergeFrom(CodedInputStream input,
                                      ExtensionRegistryLite extensionRegistry)
                               throws IOException

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<PubsubTarget.Builder>

Throws:

IOException

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 PubSub's
 [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),
 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) = { ... }

Specified by:

getTopicName in interface PubsubTargetOrBuilder

Returns:

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 PubSub's
 [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),
 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) = { ... }

Specified by:

getTopicNameBytes in interface PubsubTargetOrBuilder

Returns:

The bytes for topicName.

setTopicName

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 PubSub's
 [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),
 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) = { ... }

Parameters:

value - The topicName to set.

Returns:

This builder for chaining.

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 PubSub's
 [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),
 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:

This builder for chaining.

setTopicNameBytes

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 PubSub's
 [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),
 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) = { ... }

Parameters:

value - The bytes for topicName to set.

Returns:

This builder for chaining.

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;

Specified by:

getData in interface PubsubTargetOrBuilder

Returns:

The data.

setData

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;

Parameters:

value - The data to set.

Returns:

This builder for chaining.

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;

Returns:

This builder for chaining.

getAttributesCount

public int getAttributesCount()

Description copied from interface: PubsubTargetOrBuilder

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

map<string, string> attributes = 4;

Specified by:

getAttributesCount in interface PubsubTargetOrBuilder

containsAttributes

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;

Specified by:

containsAttributes in interface PubsubTargetOrBuilder

getAttributes

@Deprecated
public Map<String,String> getAttributes()

Deprecated.

Use getAttributesMap() instead.

Specified by:

getAttributes in interface PubsubTargetOrBuilder

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;

Specified by:

getAttributesMap in interface PubsubTargetOrBuilder

getAttributesOrDefault

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;

Specified by:

getAttributesOrDefault in interface PubsubTargetOrBuilder

getAttributesOrThrow

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;

Specified by:

getAttributesOrThrow in interface PubsubTargetOrBuilder

clearAttributes

public PubsubTarget.Builder clearAttributes()

removeAttributes

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;

getMutableAttributes

@Deprecated
public Map<String,String> getMutableAttributes()

Deprecated.

Use alternate mutation accessors instead.

putAttributes

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;

putAllAttributes

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;

setUnknownFields

public final PubsubTarget.Builder setUnknownFields(UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessageV3.Builder<PubsubTarget.Builder>

mergeUnknownFields

public final PubsubTarget.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessageV3.Builder<PubsubTarget.Builder>