com.google.pubsub.v1

Class Subscription.Builder

java.lang.Object

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

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

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

com.google.pubsub.v1.Subscription.Builder

All Implemented Interfaces:

Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, SubscriptionOrBuilder, java.lang.Cloneable

Enclosing class:

Subscription

public static final class Subscription.Builder
extends GeneratedMessage.Builder<Subscription.Builder>
implements SubscriptionOrBuilder

Protobuf type google.pubsub.v1.Subscription

 A subscription resource.
 

Method Summary

Modifier and Type	Method and Description
Subscription	build() Constructs the message based on the state of the Builder.
Subscription	buildPartial() Like MessageLite.Builder.build(), but does not throw an exception if the message is missing required fields.
Subscription.Builder	clear() Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.
Subscription.Builder	clearAckDeadlineSeconds() This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message.
Subscription.Builder	clearName() The name of the subscription.
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.
int	getAckDeadlineSeconds() This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message.
Subscription	getDefaultInstanceForType() Get an instance of the type with no fields set.
static Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType() Get the message's type's descriptor.
java.lang.String	getName() The name of the subscription.
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.
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.
boolean	isInitialized() Returns true if all required fields in the message and all embedded messages are set, false otherwise.
Subscription.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) Like MessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions.
Subscription.Builder	mergeFrom(Message other) Merge other into the message being built.
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(UnknownFieldSet unknownFields) Merge some unknown fields into the UnknownFieldSet for this message.
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	setName(java.lang.String value) The name of the subscription.
Subscription.Builder	setNameBytes(ByteString value) The name of the subscription.
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	setTopic(java.lang.String value) The name of the topic from which this subscription is receiving messages.
Subscription.Builder	setTopicBytes(ByteString value) The name of the topic from which this subscription is receiving messages.
Subscription.Builder	setUnknownFields(UnknownFieldSet unknownFields) Set the UnknownFieldSet for this message.

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

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, newBuilderForField, setField, setRepeatedField

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

findInitializationErrors, getInitializationErrorString, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, toString

Methods inherited from class java.lang.Object

equals, 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

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

clear

public Subscription.Builder clear()

Description copied from class: GeneratedMessage.Builder

Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessage.Builder<Subscription.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Description copied from interface: Message.Builder

Get the message's type's descriptor. See MessageOrBuilder.getDescriptorForType().

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessage.Builder<Subscription.Builder>

getDefaultInstanceForType

public Subscription getDefaultInstanceForType()

Description copied from interface: MessageLiteOrBuilder

Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from the getDefaultInstance() method of generated message classes in that this method is an abstract method of the MessageLite interface whereas getDefaultInstance() is a static method of a specific class. They return the same thing.

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public Subscription build()

Description copied from interface: MessageLite.Builder

Constructs the message based on the state of the Builder. Subsequent changes to the Builder will not affect the returned message.

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public Subscription buildPartial()

Description copied from interface: MessageLite.Builder

Like MessageLite.Builder.build(), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned. Subsequent changes to the Builder will not affect the returned message.

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

mergeFrom

public Subscription.Builder mergeFrom(Message other)

Description copied from interface: Message.Builder

Merge other into the message being built. other must have the exact same type as this (i.e. getDescriptorForType() == other.getDescriptorForType()). Merging occurs as follows. For each field:
* For singular primitive fields, if the field is set in other, then other's value overwrites the value in this message.
* For singular message fields, if the field is set in other, it is merged into the corresponding sub-message of this message using the same merging rules.
* For repeated fields, the elements in other are concatenated with the elements in this message. * For oneof groups, if the other message has one of the fields set, the group of this message is cleared and replaced by the field of the other message, so that the oneof constraint is preserved. This is equivalent to the Message::MergeFrom method in C++.

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<Subscription.Builder>

mergeFrom

public Subscription.Builder mergeFrom(Subscription other)

isInitialized

public final boolean isInitialized()

Description copied from interface: MessageLiteOrBuilder

Returns true if all required fields in the message and all embedded messages are set, false otherwise.

See also: MessageOrBuilder.getInitializationErrorString()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessage.Builder<Subscription.Builder>

mergeFrom

public Subscription.Builder mergeFrom(CodedInputStream input,
                                      ExtensionRegistryLite extensionRegistry)
                               throws java.io.IOException

Description copied from interface: MessageLite.Builder

Like MessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions. The extensions that you want to be able to parse must be registered in extensionRegistry. Extensions not in the registry will be treated as unknown fields.

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class 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"`.
 

Specified by:

getName in interface SubscriptionOrBuilder

getNameBytes

public 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"`.
 

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"`.
 

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"`.
 

setNameBytes

public Subscription.Builder setNameBytes(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"`.
 

getTopic

public java.lang.String getTopic()

 The name of the topic from which this subscription is receiving messages.
 

Specified by:

getTopic in interface SubscriptionOrBuilder

getTopicBytes

public ByteString getTopicBytes()

 The name of the topic from which this subscription is receiving messages.
 

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.
 

clearTopic

public Subscription.Builder clearTopic()

 The name of the topic from which this subscription is receiving messages.
 

setTopicBytes

public Subscription.Builder setTopicBytes(ByteString value)

 The name of the topic from which this subscription is receiving messages.
 

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.
 

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.
 

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.
 

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.
 

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.
 

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.
 

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.
 

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.
 

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.
 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.
 If this parameter is not set, the default value of 10 seconds is used.
 

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.
 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.
 If this parameter is not set, the default value of 10 seconds is used.
 

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.
 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.
 If this parameter is not set, the default value of 10 seconds is used.
 

setUnknownFields

public final Subscription.Builder setUnknownFields(UnknownFieldSet unknownFields)

Description copied from interface: Message.Builder

Set the UnknownFieldSet for this message.

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessage.Builder<Subscription.Builder>

mergeUnknownFields

public final Subscription.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Description copied from interface: Message.Builder

Merge some unknown fields into the UnknownFieldSet for this message.

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessage.Builder<Subscription.Builder>