Package com.google.cloud.scheduler.v1

Class PubsubTarget

  • All Implemented Interfaces:
    PubsubTargetOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class PubsubTarget
extends com.google.protobuf.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
    See Also:
    Serialized Form

    • Nested Class Summary

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

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

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field 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 Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.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 Pub/Sub'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 com.google.protobuf.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](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 com.google.protobuf.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

      • 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 com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static PubsubTarget parseFrom​(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PubsubTarget parseFrom​(ByteBuffer data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PubsubTarget parseFrom​(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PubsubTarget parseFrom​(com.google.protobuf.ByteString data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PubsubTarget parseFrom​(byte[] data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PubsubTarget parseFrom​(byte[] data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PubsubTarget parseFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException
        Throws:
        IOException

      • newBuilderForType

        public PubsubTarget.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public PubsubTarget.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected PubsubTarget.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static PubsubTarget getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<PubsubTarget> parser()

      • getParserForType

        public com.google.protobuf.Parser<PubsubTarget> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public PubsubTarget getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder