com.google.cloud.bigquery.analyticshub.v1

Class PubSubSubscription

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.bigquery.analyticshub.v1.PubSubSubscription

All Implemented Interfaces:

PubSubSubscriptionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class PubSubSubscription
extends com.google.protobuf.GeneratedMessageV3
implements PubSubSubscriptionOrBuilder

 Defines the destination Pub/Sub subscription.
 If none of `push_config`, `bigquery_config`, `cloud_storage_config`,
 `pubsub_export_config`, or `pubsublite_export_config`
 is set, then the subscriber will pull and ack messages using API methods. At
 most one of these fields may be set.
 

Protobuf type google.cloud.bigquery.analyticshub.v1.PubSubSubscription

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PubSubSubscription.Builder Defines the destination Pub/Sub subscription.

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACK_DEADLINE_SECONDS_FIELD_NUMBER
static int	BIGQUERY_CONFIG_FIELD_NUMBER
static int	CLOUD_STORAGE_CONFIG_FIELD_NUMBER
static int	DEAD_LETTER_POLICY_FIELD_NUMBER
static int	DETACHED_FIELD_NUMBER
static int	ENABLE_EXACTLY_ONCE_DELIVERY_FIELD_NUMBER
static int	ENABLE_MESSAGE_ORDERING_FIELD_NUMBER
static int	EXPIRATION_POLICY_FIELD_NUMBER
static int	FILTER_FIELD_NUMBER
static int	LABELS_FIELD_NUMBER
static int	MESSAGE_RETENTION_DURATION_FIELD_NUMBER
static int	MESSAGE_TRANSFORMS_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	PUSH_CONFIG_FIELD_NUMBER
static int	RETAIN_ACKED_MESSAGES_FIELD_NUMBER
static int	RETRY_POLICY_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, 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 and Description
boolean	containsLabels(String key) Optional.
boolean	equals(Object obj)
int	getAckDeadlineSeconds() Optional.
BigQueryConfig	getBigqueryConfig() Optional.
BigQueryConfigOrBuilder	getBigqueryConfigOrBuilder() Optional.
CloudStorageConfig	getCloudStorageConfig() Optional.
CloudStorageConfigOrBuilder	getCloudStorageConfigOrBuilder() Optional.
DeadLetterPolicy	getDeadLetterPolicy() Optional.
DeadLetterPolicyOrBuilder	getDeadLetterPolicyOrBuilder() Optional.
static PubSubSubscription	getDefaultInstance()
PubSubSubscription	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getDetached() Optional.
boolean	getEnableExactlyOnceDelivery() Optional.
boolean	getEnableMessageOrdering() Optional.
ExpirationPolicy	getExpirationPolicy() Optional.
ExpirationPolicyOrBuilder	getExpirationPolicyOrBuilder() Optional.
String	getFilter() Optional.
com.google.protobuf.ByteString	getFilterBytes() Optional.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Optional.
Map<String,String>	getLabelsMap() Optional.
String	getLabelsOrDefault(String key, String defaultValue) Optional.
String	getLabelsOrThrow(String key) Optional.
com.google.protobuf.Duration	getMessageRetentionDuration() Optional.
com.google.protobuf.DurationOrBuilder	getMessageRetentionDurationOrBuilder() Optional.
MessageTransform	getMessageTransforms(int index) Optional.
int	getMessageTransformsCount() Optional.
List<MessageTransform>	getMessageTransformsList() Optional.
MessageTransformOrBuilder	getMessageTransformsOrBuilder(int index) Optional.
List<? extends MessageTransformOrBuilder>	getMessageTransformsOrBuilderList() Optional.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
com.google.protobuf.Parser<PubSubSubscription>	getParserForType()
PushConfig	getPushConfig() Optional.
PushConfigOrBuilder	getPushConfigOrBuilder() Optional.
boolean	getRetainAckedMessages() Optional.
RetryPolicy	getRetryPolicy() Optional.
RetryPolicyOrBuilder	getRetryPolicyOrBuilder() Optional.
int	getSerializedSize()
boolean	hasBigqueryConfig() Optional.
boolean	hasCloudStorageConfig() Optional.
boolean	hasDeadLetterPolicy() Optional.
boolean	hasExpirationPolicy() Optional.
int	hashCode()
boolean	hasMessageRetentionDuration() Optional.
boolean	hasPushConfig() Optional.
boolean	hasRetryPolicy() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
boolean	isInitialized()
static PubSubSubscription.Builder	newBuilder()
static PubSubSubscription.Builder	newBuilder(PubSubSubscription prototype)
PubSubSubscription.Builder	newBuilderForType()
protected PubSubSubscription.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static PubSubSubscription	parseDelimitedFrom(InputStream input)
static PubSubSubscription	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PubSubSubscription	parseFrom(byte[] data)
static PubSubSubscription	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PubSubSubscription	parseFrom(ByteBuffer data)
static PubSubSubscription	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PubSubSubscription	parseFrom(com.google.protobuf.ByteString data)
static PubSubSubscription	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PubSubSubscription	parseFrom(com.google.protobuf.CodedInputStream input)
static PubSubSubscription	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PubSubSubscription	parseFrom(InputStream input)
static PubSubSubscription	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<PubSubSubscription>	parser()
PubSubSubscription.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, 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

PUSH_CONFIG_FIELD_NUMBER

public static final int PUSH_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

BIGQUERY_CONFIG_FIELD_NUMBER

public static final int BIGQUERY_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

CLOUD_STORAGE_CONFIG_FIELD_NUMBER

public static final int CLOUD_STORAGE_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

RETAIN_ACKED_MESSAGES_FIELD_NUMBER

public static final int RETAIN_ACKED_MESSAGES_FIELD_NUMBER

See Also:

Constant Field Values

MESSAGE_RETENTION_DURATION_FIELD_NUMBER

public static final int MESSAGE_RETENTION_DURATION_FIELD_NUMBER

See Also:

Constant Field Values

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER

See Also:

Constant Field Values

ENABLE_MESSAGE_ORDERING_FIELD_NUMBER

public static final int ENABLE_MESSAGE_ORDERING_FIELD_NUMBER

See Also:

Constant Field Values

EXPIRATION_POLICY_FIELD_NUMBER

public static final int EXPIRATION_POLICY_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

DEAD_LETTER_POLICY_FIELD_NUMBER

public static final int DEAD_LETTER_POLICY_FIELD_NUMBER

See Also:

Constant Field Values

RETRY_POLICY_FIELD_NUMBER

public static final int RETRY_POLICY_FIELD_NUMBER

See Also:

Constant Field Values

DETACHED_FIELD_NUMBER

public static final int DETACHED_FIELD_NUMBER

See Also:

Constant Field Values

ENABLE_EXACTLY_ONCE_DELIVERY_FIELD_NUMBER

public static final int ENABLE_EXACTLY_ONCE_DELIVERY_FIELD_NUMBER

See Also:

Constant Field Values

MESSAGE_TRANSFORMS_FIELD_NUMBER

public static final int MESSAGE_TRANSFORMS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public String getName()

 Required. Name of the subscription.
 Format is `projects/{project}/subscriptions/{sub}`.
 

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getName in interface PubSubSubscriptionOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Required. Name of the subscription.
 Format is `projects/{project}/subscriptions/{sub}`.
 

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getNameBytes in interface PubSubSubscriptionOrBuilder

Returns:

The bytes for name.

hasPushConfig

public boolean hasPushConfig()

 Optional. If push delivery is used with this subscription, this field is
 used to configure it.
 

.google.cloud.bigquery.analyticshub.v1.PushConfig push_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasPushConfig in interface PubSubSubscriptionOrBuilder

Returns:

Whether the pushConfig field is set.

getPushConfig

public PushConfig getPushConfig()

 Optional. If push delivery is used with this subscription, this field is
 used to configure it.
 

.google.cloud.bigquery.analyticshub.v1.PushConfig push_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getPushConfig in interface PubSubSubscriptionOrBuilder

Returns:

The pushConfig.

getPushConfigOrBuilder

public PushConfigOrBuilder getPushConfigOrBuilder()

 Optional. If push delivery is used with this subscription, this field is
 used to configure it.
 

.google.cloud.bigquery.analyticshub.v1.PushConfig push_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getPushConfigOrBuilder in interface PubSubSubscriptionOrBuilder

hasBigqueryConfig

public boolean hasBigqueryConfig()

 Optional. If delivery to BigQuery is used with this subscription, this
 field is used to configure it.
 

.google.cloud.bigquery.analyticshub.v1.BigQueryConfig bigquery_config = 18 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasBigqueryConfig in interface PubSubSubscriptionOrBuilder

Returns:

Whether the bigqueryConfig field is set.

getBigqueryConfig

public BigQueryConfig getBigqueryConfig()

 Optional. If delivery to BigQuery is used with this subscription, this
 field is used to configure it.
 

.google.cloud.bigquery.analyticshub.v1.BigQueryConfig bigquery_config = 18 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getBigqueryConfig in interface PubSubSubscriptionOrBuilder

Returns:

The bigqueryConfig.

getBigqueryConfigOrBuilder

public BigQueryConfigOrBuilder getBigqueryConfigOrBuilder()

 Optional. If delivery to BigQuery is used with this subscription, this
 field is used to configure it.
 

.google.cloud.bigquery.analyticshub.v1.BigQueryConfig bigquery_config = 18 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getBigqueryConfigOrBuilder in interface PubSubSubscriptionOrBuilder

hasCloudStorageConfig

public boolean hasCloudStorageConfig()

 Optional. If delivery to Google Cloud Storage is used with this
 subscription, this field is used to configure it.
 

.google.cloud.bigquery.analyticshub.v1.CloudStorageConfig cloud_storage_config = 22 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasCloudStorageConfig in interface PubSubSubscriptionOrBuilder

Returns:

Whether the cloudStorageConfig field is set.

getCloudStorageConfig

public CloudStorageConfig getCloudStorageConfig()

 Optional. If delivery to Google Cloud Storage is used with this
 subscription, this field is used to configure it.
 

.google.cloud.bigquery.analyticshub.v1.CloudStorageConfig cloud_storage_config = 22 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getCloudStorageConfig in interface PubSubSubscriptionOrBuilder

Returns:

The cloudStorageConfig.

getCloudStorageConfigOrBuilder

public CloudStorageConfigOrBuilder getCloudStorageConfigOrBuilder()

 Optional. If delivery to Google Cloud Storage is used with this
 subscription, this field is used to configure it.
 

.google.cloud.bigquery.analyticshub.v1.CloudStorageConfig cloud_storage_config = 22 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getCloudStorageConfigOrBuilder in interface PubSubSubscriptionOrBuilder

getAckDeadlineSeconds

public int getAckDeadlineSeconds()

 Optional. The approximate amount of time (on a best-effort basis) Pub/Sub
 waits for the subscriber to acknowledge receipt before resending the
 message. In the interval after the message is delivered and before it is
 acknowledged, it is considered to be _outstanding_. During that time
 period, the message will not be redelivered (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
 non-streaming pull or send the `ack_id` in a
 `StreamingModifyAckDeadlineRequest` if using streaming 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.
 

int32 ack_deadline_seconds = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getAckDeadlineSeconds in interface PubSubSubscriptionOrBuilder

Returns:

The ackDeadlineSeconds.

getRetainAckedMessages

public boolean getRetainAckedMessages()

 Optional. Indicates whether to retain acknowledged messages. If true, then
 messages are not expunged from the subscription's backlog, even if they are
 acknowledged, until they fall out of the `message_retention_duration`
 window. This must be true if you would like to [`Seek` to a timestamp]
 (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in
 the past to replay previously-acknowledged messages.
 

bool retain_acked_messages = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRetainAckedMessages in interface PubSubSubscriptionOrBuilder

Returns:

The retainAckedMessages.

hasMessageRetentionDuration

public boolean hasMessageRetentionDuration()

 Optional. How long to retain unacknowledged messages in the subscription's
 backlog, from the moment a message is published. If `retain_acked_messages`
 is true, then this also configures the retention of acknowledged messages,
 and thus configures how far back in time a `Seek` can be done. Defaults to
 7 days. Cannot be more than 31 days or less than 10 minutes.
 

.google.protobuf.Duration message_retention_duration = 8 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasMessageRetentionDuration in interface PubSubSubscriptionOrBuilder

Returns:

Whether the messageRetentionDuration field is set.

getMessageRetentionDuration

public com.google.protobuf.Duration getMessageRetentionDuration()

 Optional. How long to retain unacknowledged messages in the subscription's
 backlog, from the moment a message is published. If `retain_acked_messages`
 is true, then this also configures the retention of acknowledged messages,
 and thus configures how far back in time a `Seek` can be done. Defaults to
 7 days. Cannot be more than 31 days or less than 10 minutes.
 

.google.protobuf.Duration message_retention_duration = 8 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getMessageRetentionDuration in interface PubSubSubscriptionOrBuilder

Returns:

The messageRetentionDuration.

getMessageRetentionDurationOrBuilder

public com.google.protobuf.DurationOrBuilder getMessageRetentionDurationOrBuilder()

 Optional. How long to retain unacknowledged messages in the subscription's
 backlog, from the moment a message is published. If `retain_acked_messages`
 is true, then this also configures the retention of acknowledged messages,
 and thus configures how far back in time a `Seek` can be done. Defaults to
 7 days. Cannot be more than 31 days or less than 10 minutes.
 

.google.protobuf.Duration message_retention_duration = 8 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getMessageRetentionDurationOrBuilder in interface PubSubSubscriptionOrBuilder

getLabelsCount

public int getLabelsCount()

Description copied from interface: PubSubSubscriptionOrBuilder

 Optional. See [Creating and managing
 labels](https://cloud.google.com/pubsub/docs/labels).
 

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getLabelsCount in interface PubSubSubscriptionOrBuilder

containsLabels

public boolean containsLabels(String key)

 Optional. See [Creating and managing
 labels](https://cloud.google.com/pubsub/docs/labels).
 

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

containsLabels in interface PubSubSubscriptionOrBuilder

getLabels

@Deprecated
public Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

Specified by:

getLabels in interface PubSubSubscriptionOrBuilder

getLabelsMap

public Map<String,String> getLabelsMap()

 Optional. See [Creating and managing
 labels](https://cloud.google.com/pubsub/docs/labels).
 

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getLabelsMap in interface PubSubSubscriptionOrBuilder

getLabelsOrDefault

public String getLabelsOrDefault(String key,
                                 String defaultValue)

 Optional. See [Creating and managing
 labels](https://cloud.google.com/pubsub/docs/labels).
 

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getLabelsOrDefault in interface PubSubSubscriptionOrBuilder

getLabelsOrThrow

public String getLabelsOrThrow(String key)

 Optional. See [Creating and managing
 labels](https://cloud.google.com/pubsub/docs/labels).
 

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getLabelsOrThrow in interface PubSubSubscriptionOrBuilder

getEnableMessageOrdering

public boolean getEnableMessageOrdering()

 Optional. If true, messages published with the same `ordering_key` in
 `PubsubMessage` will be delivered to the subscribers in the order in which
 they are received by the Pub/Sub system. Otherwise, they may be delivered
 in any order.
 

bool enable_message_ordering = 10 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getEnableMessageOrdering in interface PubSubSubscriptionOrBuilder

Returns:

The enableMessageOrdering.

hasExpirationPolicy

public boolean hasExpirationPolicy()

 Optional. A policy that specifies the conditions for this subscription's
 expiration. A subscription is considered active as long as any connected
 subscriber is successfully consuming messages from the subscription or is
 issuing operations on the subscription. If `expiration_policy` is not set,
 a *default policy* with `ttl` of 31 days will be used. The minimum allowed
 value for `expiration_policy.ttl` is 1 day. If `expiration_policy` is set,
 but `expiration_policy.ttl` is not set, the subscription never expires.
 

.google.cloud.bigquery.analyticshub.v1.ExpirationPolicy expiration_policy = 11 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasExpirationPolicy in interface PubSubSubscriptionOrBuilder

Returns:

Whether the expirationPolicy field is set.

getExpirationPolicy

public ExpirationPolicy getExpirationPolicy()

 Optional. A policy that specifies the conditions for this subscription's
 expiration. A subscription is considered active as long as any connected
 subscriber is successfully consuming messages from the subscription or is
 issuing operations on the subscription. If `expiration_policy` is not set,
 a *default policy* with `ttl` of 31 days will be used. The minimum allowed
 value for `expiration_policy.ttl` is 1 day. If `expiration_policy` is set,
 but `expiration_policy.ttl` is not set, the subscription never expires.
 

.google.cloud.bigquery.analyticshub.v1.ExpirationPolicy expiration_policy = 11 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getExpirationPolicy in interface PubSubSubscriptionOrBuilder

Returns:

The expirationPolicy.

getExpirationPolicyOrBuilder

public ExpirationPolicyOrBuilder getExpirationPolicyOrBuilder()

 Optional. A policy that specifies the conditions for this subscription's
 expiration. A subscription is considered active as long as any connected
 subscriber is successfully consuming messages from the subscription or is
 issuing operations on the subscription. If `expiration_policy` is not set,
 a *default policy* with `ttl` of 31 days will be used. The minimum allowed
 value for `expiration_policy.ttl` is 1 day. If `expiration_policy` is set,
 but `expiration_policy.ttl` is not set, the subscription never expires.
 

.google.cloud.bigquery.analyticshub.v1.ExpirationPolicy expiration_policy = 11 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getExpirationPolicyOrBuilder in interface PubSubSubscriptionOrBuilder

getFilter

public String getFilter()

 Optional. An expression written in the Pub/Sub [filter
 language](https://cloud.google.com/pubsub/docs/filtering). If non-empty,
 then only `PubsubMessage`s whose `attributes` field matches the filter are
 delivered on this subscription. If empty, then no messages are filtered
 out.
 

string filter = 12 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getFilter in interface PubSubSubscriptionOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 Optional. An expression written in the Pub/Sub [filter
 language](https://cloud.google.com/pubsub/docs/filtering). If non-empty,
 then only `PubsubMessage`s whose `attributes` field matches the filter are
 delivered on this subscription. If empty, then no messages are filtered
 out.
 

string filter = 12 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getFilterBytes in interface PubSubSubscriptionOrBuilder

Returns:

The bytes for filter.

hasDeadLetterPolicy

public boolean hasDeadLetterPolicy()

 Optional. A policy that specifies the conditions for dead lettering
 messages in this subscription. If dead_letter_policy is not set, dead
 lettering is disabled.

 The Pub/Sub service account associated with this subscriptions's
 parent project (i.e.,
 service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
 permission to Acknowledge() messages on this subscription.
 

.google.cloud.bigquery.analyticshub.v1.DeadLetterPolicy dead_letter_policy = 13 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasDeadLetterPolicy in interface PubSubSubscriptionOrBuilder

Returns:

Whether the deadLetterPolicy field is set.

getDeadLetterPolicy

public DeadLetterPolicy getDeadLetterPolicy()

 Optional. A policy that specifies the conditions for dead lettering
 messages in this subscription. If dead_letter_policy is not set, dead
 lettering is disabled.

 The Pub/Sub service account associated with this subscriptions's
 parent project (i.e.,
 service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
 permission to Acknowledge() messages on this subscription.
 

.google.cloud.bigquery.analyticshub.v1.DeadLetterPolicy dead_letter_policy = 13 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDeadLetterPolicy in interface PubSubSubscriptionOrBuilder

Returns:

The deadLetterPolicy.

getDeadLetterPolicyOrBuilder

public DeadLetterPolicyOrBuilder getDeadLetterPolicyOrBuilder()

 Optional. A policy that specifies the conditions for dead lettering
 messages in this subscription. If dead_letter_policy is not set, dead
 lettering is disabled.

 The Pub/Sub service account associated with this subscriptions's
 parent project (i.e.,
 service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
 permission to Acknowledge() messages on this subscription.
 

.google.cloud.bigquery.analyticshub.v1.DeadLetterPolicy dead_letter_policy = 13 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDeadLetterPolicyOrBuilder in interface PubSubSubscriptionOrBuilder

hasRetryPolicy

public boolean hasRetryPolicy()

 Optional. A policy that specifies how Pub/Sub retries message delivery for
 this subscription.

 If not set, the default retry policy is applied. This generally implies
 that messages will be retried as soon as possible for healthy subscribers.
 RetryPolicy will be triggered on NACKs or acknowledgement deadline
 exceeded events for a given message.
 

.google.cloud.bigquery.analyticshub.v1.RetryPolicy retry_policy = 14 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasRetryPolicy in interface PubSubSubscriptionOrBuilder

Returns:

Whether the retryPolicy field is set.

getRetryPolicy

public RetryPolicy getRetryPolicy()

 Optional. A policy that specifies how Pub/Sub retries message delivery for
 this subscription.

 If not set, the default retry policy is applied. This generally implies
 that messages will be retried as soon as possible for healthy subscribers.
 RetryPolicy will be triggered on NACKs or acknowledgement deadline
 exceeded events for a given message.
 

.google.cloud.bigquery.analyticshub.v1.RetryPolicy retry_policy = 14 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRetryPolicy in interface PubSubSubscriptionOrBuilder

Returns:

The retryPolicy.

getRetryPolicyOrBuilder

public RetryPolicyOrBuilder getRetryPolicyOrBuilder()

 Optional. A policy that specifies how Pub/Sub retries message delivery for
 this subscription.

 If not set, the default retry policy is applied. This generally implies
 that messages will be retried as soon as possible for healthy subscribers.
 RetryPolicy will be triggered on NACKs or acknowledgement deadline
 exceeded events for a given message.
 

.google.cloud.bigquery.analyticshub.v1.RetryPolicy retry_policy = 14 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRetryPolicyOrBuilder in interface PubSubSubscriptionOrBuilder

getDetached

public boolean getDetached()

 Optional. Indicates whether the subscription is detached from its topic.
 Detached subscriptions don't receive messages from their topic and don't
 retain any backlog. `Pull` and `StreamingPull` requests will return
 FAILED_PRECONDITION. If the subscription is a push subscription, pushes to
 the endpoint will not be made.
 

bool detached = 15 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDetached in interface PubSubSubscriptionOrBuilder

Returns:

The detached.

getEnableExactlyOnceDelivery

public boolean getEnableExactlyOnceDelivery()

 Optional. If true, Pub/Sub provides the following guarantees for the
 delivery of a message with a given value of `message_id` on this
 subscription:

 * The message sent to a subscriber is guaranteed not to be resent
 before the message's acknowledgement deadline expires.
 * An acknowledged message will not be resent to a subscriber.

 Note that subscribers may still receive multiple copies of a message
 when `enable_exactly_once_delivery` is true if the message was published
 multiple times by a publisher client. These copies are  considered distinct
 by Pub/Sub and have distinct `message_id` values.
 

bool enable_exactly_once_delivery = 16 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getEnableExactlyOnceDelivery in interface PubSubSubscriptionOrBuilder

Returns:

The enableExactlyOnceDelivery.

getMessageTransformsList

public List<MessageTransform> getMessageTransformsList()

 Optional. Transforms to be applied to messages before they are delivered to
 subscribers. Transforms are applied in the order specified.
 

repeated .google.cloud.bigquery.analyticshub.v1.MessageTransform message_transforms = 25 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getMessageTransformsList in interface PubSubSubscriptionOrBuilder

getMessageTransformsOrBuilderList

public List<? extends MessageTransformOrBuilder> getMessageTransformsOrBuilderList()

 Optional. Transforms to be applied to messages before they are delivered to
 subscribers. Transforms are applied in the order specified.
 

repeated .google.cloud.bigquery.analyticshub.v1.MessageTransform message_transforms = 25 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getMessageTransformsOrBuilderList in interface PubSubSubscriptionOrBuilder

getMessageTransformsCount

public int getMessageTransformsCount()

 Optional. Transforms to be applied to messages before they are delivered to
 subscribers. Transforms are applied in the order specified.
 

repeated .google.cloud.bigquery.analyticshub.v1.MessageTransform message_transforms = 25 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getMessageTransformsCount in interface PubSubSubscriptionOrBuilder

getMessageTransforms

public MessageTransform getMessageTransforms(int index)

 Optional. Transforms to be applied to messages before they are delivered to
 subscribers. Transforms are applied in the order specified.
 

repeated .google.cloud.bigquery.analyticshub.v1.MessageTransform message_transforms = 25 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getMessageTransforms in interface PubSubSubscriptionOrBuilder

getMessageTransformsOrBuilder

public MessageTransformOrBuilder getMessageTransformsOrBuilder(int index)

 Optional. Transforms to be applied to messages before they are delivered to
 subscribers. Transforms are applied in the order specified.
 

repeated .google.cloud.bigquery.analyticshub.v1.MessageTransform message_transforms = 25 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getMessageTransformsOrBuilder in interface PubSubSubscriptionOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

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

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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 PubSubSubscription parseFrom(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PubSubSubscription parseFrom(ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PubSubSubscription parseFrom(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PubSubSubscription parseFrom(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PubSubSubscription parseFrom(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PubSubSubscription parseFrom(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PubSubSubscription parseFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static PubSubSubscription parseDelimitedFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static PubSubSubscription parseFrom(com.google.protobuf.CodedInputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

public static PubSubSubscription parseFrom(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

newBuilderForType

public PubSubSubscription.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static PubSubSubscription.Builder newBuilder()

newBuilder

public static PubSubSubscription.Builder newBuilder(PubSubSubscription prototype)

toBuilder

public PubSubSubscription.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected PubSubSubscription.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static PubSubSubscription getDefaultInstance()

parser

public static com.google.protobuf.Parser<PubSubSubscription> parser()

getParserForType

public com.google.protobuf.Parser<PubSubSubscription> 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.GeneratedMessageV3

getDefaultInstanceForType

public PubSubSubscription getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder