Class PubsubTarget.Builder

  • All Implemented Interfaces:
    PubsubTargetOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    PubsubTarget

    public static final class PubsubTarget.Builder
    extends com.google.protobuf.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 Detail

      • 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.Builder<PubsubTarget.Builder>
      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<PubsubTarget.Builder>
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<PubsubTarget.Builder>
      • clear

        public PubsubTarget.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<PubsubTarget.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<PubsubTarget.Builder>
      • getDefaultInstanceForType

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

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

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

        public PubsubTarget.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<PubsubTarget.Builder>
      • setField

        public PubsubTarget.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<PubsubTarget.Builder>
      • clearField

        public PubsubTarget.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<PubsubTarget.Builder>
      • clearOneof

        public PubsubTarget.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<PubsubTarget.Builder>
      • setRepeatedField

        public PubsubTarget.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     int index,
                                                     Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PubsubTarget.Builder>
      • addRepeatedField

        public PubsubTarget.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PubsubTarget.Builder>
      • mergeFrom

        public PubsubTarget.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PubsubTarget.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<PubsubTarget.Builder>
      • mergeFrom

        public PubsubTarget.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.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 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.
      • 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 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) = { ... }
        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 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) = { ... }
        Returns:
        This builder for chaining.
      • setTopicNameBytes

        public PubsubTarget.Builder setTopicNameBytes​(com.google.protobuf.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](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 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.
      • setData

        public PubsubTarget.Builder setData​(com.google.protobuf.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
      • 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
      • 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​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PubsubTarget.Builder>
      • mergeUnknownFields

        public final PubsubTarget.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PubsubTarget.Builder>