com.google.cloud.scheduler.v1beta1

Class PubsubTarget

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.scheduler.v1beta1.PubsubTarget

All Implemented Interfaces:

PubsubTargetOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PubsubTarget.Builder Pub/Sub target.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ATTRIBUTES_FIELD_NUMBER
static int	DATA_FIELD_NUMBER
static int	TOPIC_NAME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsAttributes(String key) Attributes for PubsubMessage.
boolean	equals(Object obj)
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.
static PubsubTarget	getDefaultInstance()
PubsubTarget	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Parser<PubsubTarget>	getParserForType()
int	getSerializedSize()
String	getTopicName() Required.
ByteString	getTopicNameBytes() Required.
UnknownFieldSet	getUnknownFields()
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected MapField	internalGetMapField(int number)
boolean	isInitialized()
static PubsubTarget.Builder	newBuilder()
static PubsubTarget.Builder	newBuilder(PubsubTarget prototype)
PubsubTarget.Builder	newBuilderForType()
protected PubsubTarget.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static PubsubTarget	parseDelimitedFrom(InputStream input)
static PubsubTarget	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static PubsubTarget	parseFrom(byte[] data)
static PubsubTarget	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static PubsubTarget	parseFrom(ByteBuffer data)
static PubsubTarget	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static PubsubTarget	parseFrom(ByteString data)
static PubsubTarget	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static PubsubTarget	parseFrom(CodedInputStream input)
static PubsubTarget	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static PubsubTarget	parseFrom(InputStream input)
static PubsubTarget	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<PubsubTarget>	parser()
PubsubTarget.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

TOPIC_NAME_FIELD_NUMBER

public static final int TOPIC_NAME_FIELD_NUMBER

See Also:

Constant Field Values

DATA_FIELD_NUMBER

public static final int DATA_FIELD_NUMBER

See Also:

Constant Field Values

ATTRIBUTES_FIELD_NUMBER

public static final int ATTRIBUTES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetMapField

protected MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class GeneratedMessageV3

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

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.

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.

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static PubsubTarget parseFrom(ByteBuffer data)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PubsubTarget parseFrom(ByteBuffer data,
                                     ExtensionRegistryLite extensionRegistry)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PubsubTarget parseFrom(ByteString data)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PubsubTarget parseFrom(ByteString data,
                                     ExtensionRegistryLite extensionRegistry)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PubsubTarget parseFrom(byte[] data)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PubsubTarget parseFrom(byte[] data,
                                     ExtensionRegistryLite extensionRegistry)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PubsubTarget parseFrom(InputStream input)
                              throws IOException

Throws:

IOException

parseFrom

public static PubsubTarget parseFrom(InputStream input,
                                     ExtensionRegistryLite extensionRegistry)
                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static PubsubTarget parseDelimitedFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static PubsubTarget parseDelimitedFrom(InputStream input,
                                              ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

parseFrom

public static PubsubTarget parseFrom(CodedInputStream input)
                              throws IOException

Throws:

IOException

parseFrom

public static PubsubTarget parseFrom(CodedInputStream input,
                                     ExtensionRegistryLite extensionRegistry)
                              throws IOException

Throws:

IOException

newBuilderForType

public PubsubTarget.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static PubsubTarget.Builder newBuilder()

newBuilder

public static PubsubTarget.Builder newBuilder(PubsubTarget prototype)

toBuilder

public PubsubTarget.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected PubsubTarget.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static PubsubTarget getDefaultInstance()

parser

public static Parser<PubsubTarget> parser()

getParserForType

public Parser<PubsubTarget> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public PubsubTarget getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder