Package com.google.cloud.scheduler.v1

Class PubsubTarget

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.scheduler.v1.PubsubTarget
All Implemented Interfaces:
PubsubTargetOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class PubsubTarget extends com.google.protobuf.GeneratedMessage 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:

  • Nested Class Summary

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

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

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

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

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, 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
    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.
    com.google.protobuf.ByteString
    getData()
    The message payload for PubsubMessage.
    static PubsubTarget
    getDefaultInstance()
     
    PubsubTarget
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<PubsubTarget>
    getParserForType()
     
    int
    getSerializedSize()
     
    String
    getTopicName()
    Required.
    com.google.protobuf.ByteString
    getTopicNameBytes()
    Required.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    static PubsubTarget.Builder
    newBuilder()
     
    static PubsubTarget.Builder
    newBuilder(PubsubTarget prototype)
     
    PubsubTarget.Builder
    newBuilderForType()
     
    protected PubsubTarget.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static PubsubTarget
    parseDelimitedFrom(InputStream input)
     
    static PubsubTarget
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PubsubTarget
    parseFrom(byte[] data)
     
    static PubsubTarget
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PubsubTarget
    parseFrom(com.google.protobuf.ByteString data)
     
    static PubsubTarget
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PubsubTarget
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static PubsubTarget
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PubsubTarget
    parseFrom(InputStream input)
     
    static PubsubTarget
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PubsubTarget
    parseFrom(ByteBuffer data)
     
    static PubsubTarget
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<PubsubTarget>
    parser()
     
    PubsubTarget.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    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.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static PubsubTarget parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PubsubTarget parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • 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

    • newBuilder

      public static PubsubTarget.Builder newBuilder()

    • newBuilder

      public static PubsubTarget.Builder newBuilder(PubsubTarget prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

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