com.google.pubsub.v1

Class Subscription

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.pubsub.v1.Subscription

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, SubscriptionOrBuilder, java.io.Serializable

public final class Subscription
extends GeneratedMessage
implements SubscriptionOrBuilder

Protobuf type google.pubsub.v1.Subscription

 A subscription resource.
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Subscription.Builder Protobuf type google.pubsub.v1.Subscription

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

GeneratedMessage.ExtendableBuilder<MessageType extends GeneratedMessage.ExtendableMessage,BuilderType extends GeneratedMessage.ExtendableBuilder>, GeneratedMessage.ExtendableMessage<MessageType extends GeneratedMessage.ExtendableMessage>, GeneratedMessage.ExtendableMessageOrBuilder<MessageType extends GeneratedMessage.ExtendableMessage>, GeneratedMessage.FieldAccessorTable, GeneratedMessage.GeneratedExtension<ContainingType extends Message,Type>

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACK_DEADLINE_SECONDS_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	PUSH_CONFIG_FIELD_NUMBER
static int	TOPIC_FIELD_NUMBER

Method Summary

Modifier and Type	Method and Description
int	getAckDeadlineSeconds() This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message.
static Subscription	getDefaultInstance()
Subscription	getDefaultInstanceForType() Get an instance of the type with no fields set.
static Descriptors.Descriptor	getDescriptor()
java.lang.String	getName() The name of the subscription.
ByteString	getNameBytes() The name of the subscription.
Parser<Subscription>	getParserForType() Gets the parser for a message of the same type as this message.
PushConfig	getPushConfig() 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.
int	getSerializedSize() Get the number of bytes required to encode this message.
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.
UnknownFieldSet	getUnknownFields() Get the UnknownFieldSet for this message.
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.
static Subscription.Builder	newBuilder()
static Subscription.Builder	newBuilder(Subscription prototype)
Subscription.Builder	newBuilderForType() Constructs a new builder for a message of the same type as this message.
static Subscription	parseDelimitedFrom(java.io.InputStream input)
static Subscription	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Subscription	parseFrom(byte[] data)
static Subscription	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static Subscription	parseFrom(ByteString data)
static Subscription	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static Subscription	parseFrom(CodedInputStream input)
static Subscription	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static Subscription	parseFrom(java.io.InputStream input)
static Subscription	parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<Subscription>	parser()
Subscription.Builder	toBuilder() Constructs a builder initialized with the current message.
void	writeTo(CodedOutputStream output) Serializes the message and writes it to output.

Methods inherited from class com.google.protobuf.GeneratedMessage

getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, newFileScopedGeneratedExtension, newFileScopedGeneratedExtension, newMessageScopedGeneratedExtension, newMessageScopedGeneratedExtension

Methods inherited from class com.google.protobuf.AbstractMessage

equals, findInitializationErrors, getInitializationErrorString, hashCode, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

TOPIC_FIELD_NUMBER

public static final int TOPIC_FIELD_NUMBER

See Also:

Constant Field Values

PUSH_CONFIG_FIELD_NUMBER

public static final int PUSH_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

ACK_DEADLINE_SECONDS_FIELD_NUMBER

public static final int ACK_DEADLINE_SECONDS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Description copied from interface: MessageOrBuilder

Get the UnknownFieldSet for this message.

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessage

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

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

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

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

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

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

writeTo

public void writeTo(CodedOutputStream output)
             throws java.io.IOException

Description copied from interface: MessageLite

Serializes the message and writes it to output. This does not flush or close the stream.

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessage

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Description copied from interface: MessageLite

Get the number of bytes required to encode this message. The result is only computed on the first call and memoized after that.

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessage

parseFrom

public static Subscription parseFrom(ByteString data)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Subscription parseFrom(ByteString data,
                                     ExtensionRegistryLite extensionRegistry)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Subscription parseFrom(byte[] data)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Subscription parseFrom(byte[] data,
                                     ExtensionRegistryLite extensionRegistry)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Subscription parseFrom(java.io.InputStream input)
                              throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Subscription parseFrom(java.io.InputStream input,
                                     ExtensionRegistryLite extensionRegistry)
                              throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Subscription parseDelimitedFrom(java.io.InputStream input)
                                       throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Subscription parseDelimitedFrom(java.io.InputStream input,
                                              ExtensionRegistryLite extensionRegistry)
                                       throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Subscription parseFrom(CodedInputStream input)
                              throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Subscription parseFrom(CodedInputStream input,
                                     ExtensionRegistryLite extensionRegistry)
                              throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public Subscription.Builder newBuilderForType()

Description copied from interface: MessageLite

Constructs a new builder for a message of the same type as this message.

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static Subscription.Builder newBuilder()

newBuilder

public static Subscription.Builder newBuilder(Subscription prototype)

toBuilder

public Subscription.Builder toBuilder()

Description copied from interface: MessageLite

Constructs a builder initialized with the current message. Use this to derive a new message from the current one.

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

getDefaultInstance

public static Subscription getDefaultInstance()

parser

public static Parser<Subscription> parser()

getParserForType

public Parser<Subscription> getParserForType()

Description copied from interface: MessageLite

Gets the parser for a message of the same type as this message.

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessage

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