com.google.pubsub.v1

Class Subscription.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

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

com.google.pubsub.v1.Subscription.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SubscriptionOrBuilder, java.lang.Cloneable

Enclosing class:

Subscription

public static final class Subscription.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>
implements SubscriptionOrBuilder

 A subscription resource.
 

Protobuf type google.pubsub.v1.Subscription

Method Summary

Modifier and Type	Method and Description
Subscription.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
Subscription	build()
Subscription	buildPartial()
Subscription.Builder	clear()
Subscription.Builder	clearAckDeadlineSeconds() This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message.
Subscription.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Subscription.Builder	clearName() The name of the subscription.
Subscription.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Subscription.Builder	clearPushConfig() If push delivery is used with this subscription, this field is used to configure it.
Subscription.Builder	clearTopic() The name of the topic from which this subscription is receiving messages.
Subscription.Builder	clone()
int	getAckDeadlineSeconds() This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message.
Subscription	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
java.lang.String	getName() The name of the subscription.
SubscriptionName	getNameAsSubscriptionName()
com.google.protobuf.ByteString	getNameBytes() The name of the subscription.
PushConfig	getPushConfig() If push delivery is used with this subscription, this field is used to configure it.
PushConfig.Builder	getPushConfigBuilder() If push delivery is used with this subscription, this field is used to configure it.
PushConfigOrBuilder	getPushConfigOrBuilder() If push delivery is used with this subscription, this field is used to configure it.
java.lang.String	getTopic() The name of the topic from which this subscription is receiving messages.
TopicNameOneof	getTopicAsTopicNameOneof()
com.google.protobuf.ByteString	getTopicBytes() The name of the topic from which this subscription is receiving messages.
boolean	hasPushConfig() If push delivery is used with this subscription, this field is used to configure it.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Subscription.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Subscription.Builder	mergeFrom(com.google.protobuf.Message other)
Subscription.Builder	mergeFrom(Subscription other)
Subscription.Builder	mergePushConfig(PushConfig value) If push delivery is used with this subscription, this field is used to configure it.
Subscription.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Subscription.Builder	setAckDeadlineSeconds(int value) This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message.
Subscription.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
Subscription.Builder	setName(java.lang.String value) The name of the subscription.
Subscription.Builder	setNameBytes(com.google.protobuf.ByteString value) The name of the subscription.
Subscription.Builder	setNameWithSubscriptionName(SubscriptionName value)
Subscription.Builder	setPushConfig(PushConfig.Builder builderForValue) If push delivery is used with this subscription, this field is used to configure it.
Subscription.Builder	setPushConfig(PushConfig value) If push delivery is used with this subscription, this field is used to configure it.
Subscription.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
Subscription.Builder	setTopic(java.lang.String value) The name of the topic from which this subscription is receiving messages.
Subscription.Builder	setTopicBytes(com.google.protobuf.ByteString value) The name of the topic from which this subscription is receiving messages.
Subscription.Builder	setTopicWithTopicNameOneof(TopicNameOneof value)
Subscription.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

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

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, parseUnknownField

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

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

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

addAll, 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.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>

clear

public Subscription.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<Subscription.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<Subscription.Builder>

getDefaultInstanceForType

public Subscription getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Subscription build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Subscription buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Subscription.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<Subscription.Builder>

setField

public Subscription.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                     java.lang.Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>

clearField

public Subscription.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<Subscription.Builder>

clearOneof

public Subscription.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<Subscription.Builder>

setRepeatedField

public Subscription.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             int index,
                                             java.lang.Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>

addRepeatedField

public Subscription.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             java.lang.Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>

mergeFrom

public Subscription.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<Subscription.Builder>

mergeFrom

public Subscription.Builder mergeFrom(Subscription other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Subscription.Builder>

mergeFrom

public Subscription.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws java.io.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<Subscription.Builder>

Throws:

java.io.IOException

getName

public java.lang.String getName()

 The name of the subscription. It must have the format
 `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
 start with a letter, and contain only letters (`[A-Za-z]`), numbers
 (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
 plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
 in length, and it must not start with `"goog"`.
 

optional string name = 1;

Specified by:

getName in interface SubscriptionOrBuilder

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 The name of the subscription. It must have the format
 `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
 start with a letter, and contain only letters (`[A-Za-z]`), numbers
 (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
 plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
 in length, and it must not start with `"goog"`.
 

optional string name = 1;

Specified by:

getNameBytes in interface SubscriptionOrBuilder

setName

public Subscription.Builder setName(java.lang.String value)

 The name of the subscription. It must have the format
 `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
 start with a letter, and contain only letters (`[A-Za-z]`), numbers
 (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
 plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
 in length, and it must not start with `"goog"`.
 

optional string name = 1;

clearName

public Subscription.Builder clearName()

 The name of the subscription. It must have the format
 `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
 start with a letter, and contain only letters (`[A-Za-z]`), numbers
 (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
 plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
 in length, and it must not start with `"goog"`.
 

optional string name = 1;

setNameBytes

public Subscription.Builder setNameBytes(com.google.protobuf.ByteString value)

 The name of the subscription. It must have the format
 `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
 start with a letter, and contain only letters (`[A-Za-z]`), numbers
 (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
 plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
 in length, and it must not start with `"goog"`.
 

optional string name = 1;

getTopic

public java.lang.String getTopic()

 The name of the topic from which this subscription is receiving messages.
 Format is `projects/{project}/topics/{topic}`.
 The value of this field will be `_deleted-topic_` if the topic has been
 deleted.
 

optional string topic = 2;

Specified by:

getTopic in interface SubscriptionOrBuilder

getTopicBytes

public com.google.protobuf.ByteString getTopicBytes()

 The name of the topic from which this subscription is receiving messages.
 Format is `projects/{project}/topics/{topic}`.
 The value of this field will be `_deleted-topic_` if the topic has been
 deleted.
 

optional string topic = 2;

Specified by:

getTopicBytes in interface SubscriptionOrBuilder

setTopic

public Subscription.Builder setTopic(java.lang.String value)

 The name of the topic from which this subscription is receiving messages.
 Format is `projects/{project}/topics/{topic}`.
 The value of this field will be `_deleted-topic_` if the topic has been
 deleted.
 

optional string topic = 2;

clearTopic

public Subscription.Builder clearTopic()

 The name of the topic from which this subscription is receiving messages.
 Format is `projects/{project}/topics/{topic}`.
 The value of this field will be `_deleted-topic_` if the topic has been
 deleted.
 

optional string topic = 2;

setTopicBytes

public Subscription.Builder setTopicBytes(com.google.protobuf.ByteString value)

 The name of the topic from which this subscription is receiving messages.
 Format is `projects/{project}/topics/{topic}`.
 The value of this field will be `_deleted-topic_` if the topic has been
 deleted.
 

optional string topic = 2;

hasPushConfig

public boolean hasPushConfig()

 If push delivery is used with this subscription, this field is
 used to configure it. An empty `pushConfig` signifies that the subscriber
 will pull and ack messages using API methods.
 

optional .google.pubsub.v1.PushConfig push_config = 4;

Specified by:

hasPushConfig in interface SubscriptionOrBuilder

getPushConfig

public PushConfig getPushConfig()

 If push delivery is used with this subscription, this field is
 used to configure it. An empty `pushConfig` signifies that the subscriber
 will pull and ack messages using API methods.
 

optional .google.pubsub.v1.PushConfig push_config = 4;

Specified by:

getPushConfig in interface SubscriptionOrBuilder

setPushConfig

public Subscription.Builder setPushConfig(PushConfig value)

 If push delivery is used with this subscription, this field is
 used to configure it. An empty `pushConfig` signifies that the subscriber
 will pull and ack messages using API methods.
 

optional .google.pubsub.v1.PushConfig push_config = 4;

setPushConfig

public Subscription.Builder setPushConfig(PushConfig.Builder builderForValue)

 If push delivery is used with this subscription, this field is
 used to configure it. An empty `pushConfig` signifies that the subscriber
 will pull and ack messages using API methods.
 

optional .google.pubsub.v1.PushConfig push_config = 4;

mergePushConfig

public Subscription.Builder mergePushConfig(PushConfig value)

 If push delivery is used with this subscription, this field is
 used to configure it. An empty `pushConfig` signifies that the subscriber
 will pull and ack messages using API methods.
 

optional .google.pubsub.v1.PushConfig push_config = 4;

clearPushConfig

public Subscription.Builder clearPushConfig()

 If push delivery is used with this subscription, this field is
 used to configure it. An empty `pushConfig` signifies that the subscriber
 will pull and ack messages using API methods.
 

optional .google.pubsub.v1.PushConfig push_config = 4;

getPushConfigBuilder

public PushConfig.Builder getPushConfigBuilder()

 If push delivery is used with this subscription, this field is
 used to configure it. An empty `pushConfig` signifies that the subscriber
 will pull and ack messages using API methods.
 

optional .google.pubsub.v1.PushConfig push_config = 4;

getPushConfigOrBuilder

public PushConfigOrBuilder getPushConfigOrBuilder()

 If push delivery is used with this subscription, this field is
 used to configure it. An empty `pushConfig` signifies that the subscriber
 will pull and ack messages using API methods.
 

optional .google.pubsub.v1.PushConfig push_config = 4;

Specified by:

getPushConfigOrBuilder in interface SubscriptionOrBuilder

getAckDeadlineSeconds

public int getAckDeadlineSeconds()

 This value is the maximum time after a subscriber receives a message
 before the subscriber should acknowledge the message. After message
 delivery but before the ack deadline expires and before the message is
 acknowledged, it is an outstanding message and will not be delivered
 again during that time (on a best-effort basis).
 For pull subscriptions, this value is used as the initial value for the ack
 deadline. To override this value for a given message, call
 `ModifyAckDeadline` with the corresponding `ack_id` if using
 pull.
 The minimum custom deadline you can specify is 10 seconds.
 The maximum custom deadline you can specify is 600 seconds (10 minutes).
 If this parameter is 0, a default value of 10 seconds is used.
 For push delivery, this value is also used to set the request timeout for
 the call to the push endpoint.
 If the subscriber never acknowledges the message, the Pub/Sub
 system will eventually redeliver the message.
 

optional int32 ack_deadline_seconds = 5;

Specified by:

getAckDeadlineSeconds in interface SubscriptionOrBuilder

setAckDeadlineSeconds

public Subscription.Builder setAckDeadlineSeconds(int value)

 This value is the maximum time after a subscriber receives a message
 before the subscriber should acknowledge the message. After message
 delivery but before the ack deadline expires and before the message is
 acknowledged, it is an outstanding message and will not be delivered
 again during that time (on a best-effort basis).
 For pull subscriptions, this value is used as the initial value for the ack
 deadline. To override this value for a given message, call
 `ModifyAckDeadline` with the corresponding `ack_id` if using
 pull.
 The minimum custom deadline you can specify is 10 seconds.
 The maximum custom deadline you can specify is 600 seconds (10 minutes).
 If this parameter is 0, a default value of 10 seconds is used.
 For push delivery, this value is also used to set the request timeout for
 the call to the push endpoint.
 If the subscriber never acknowledges the message, the Pub/Sub
 system will eventually redeliver the message.
 

optional int32 ack_deadline_seconds = 5;

clearAckDeadlineSeconds

public Subscription.Builder clearAckDeadlineSeconds()

 This value is the maximum time after a subscriber receives a message
 before the subscriber should acknowledge the message. After message
 delivery but before the ack deadline expires and before the message is
 acknowledged, it is an outstanding message and will not be delivered
 again during that time (on a best-effort basis).
 For pull subscriptions, this value is used as the initial value for the ack
 deadline. To override this value for a given message, call
 `ModifyAckDeadline` with the corresponding `ack_id` if using
 pull.
 The minimum custom deadline you can specify is 10 seconds.
 The maximum custom deadline you can specify is 600 seconds (10 minutes).
 If this parameter is 0, a default value of 10 seconds is used.
 For push delivery, this value is also used to set the request timeout for
 the call to the push endpoint.
 If the subscriber never acknowledges the message, the Pub/Sub
 system will eventually redeliver the message.
 

optional int32 ack_deadline_seconds = 5;

setUnknownFields

public final Subscription.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<Subscription.Builder>

mergeUnknownFields

public final Subscription.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<Subscription.Builder>

setNameWithSubscriptionName

public final Subscription.Builder setNameWithSubscriptionName(SubscriptionName value)

getNameAsSubscriptionName

public final SubscriptionName getNameAsSubscriptionName()

setTopicWithTopicNameOneof

public final Subscription.Builder setTopicWithTopicNameOneof(TopicNameOneof value)

getTopicAsTopicNameOneof

public final TopicNameOneof getTopicAsTopicNameOneof()