Class PubSubSubscription
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
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
@Generated
public final class PubSubSubscription
extends com.google.protobuf.GeneratedMessage
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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classDefines the destination Pub/Sub subscription.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsLabels(String key) Optional.booleancontainsTags(String key) Optional.booleanintOptional.Optional.Optional.Optional.Optional.Optional.Optional.static PubSubSubscriptionstatic final com.google.protobuf.Descriptors.DescriptorbooleanOptional.booleanOptional.booleanOptional.Optional.Optional.Optional.com.google.protobuf.ByteStringOptional.Deprecated.intOptional.Optional.getLabelsOrDefault(String key, String defaultValue) Optional.getLabelsOrThrow(String key) Optional.com.google.protobuf.DurationOptional.com.google.protobuf.DurationOrBuilderOptional.getMessageTransforms(int index) Optional.intOptional.Optional.getMessageTransformsOrBuilder(int index) Optional.List<? extends MessageTransformOrBuilder>Optional.getName()Required.com.google.protobuf.ByteStringRequired.com.google.protobuf.Parser<PubSubSubscription>Optional.Optional.booleanOptional.Optional.Optional.intgetTags()Deprecated.intOptional.Optional.getTagsOrDefault(String key, String defaultValue) Optional.getTagsOrThrow(String key) Optional.booleanOptional.booleanOptional.booleanOptional.booleanOptional.inthashCode()booleanOptional.booleanOptional.booleanOptional.protected com.google.protobuf.GeneratedMessage.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) final booleanstatic PubSubSubscription.Builderstatic PubSubSubscription.BuildernewBuilder(PubSubSubscription prototype) protected PubSubSubscription.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static PubSubSubscriptionparseDelimitedFrom(InputStream input) static PubSubSubscriptionparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PubSubSubscriptionparseFrom(byte[] data) static PubSubSubscriptionparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PubSubSubscriptionparseFrom(com.google.protobuf.ByteString data) static PubSubSubscriptionparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PubSubSubscriptionparseFrom(com.google.protobuf.CodedInputStream input) static PubSubSubscriptionparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PubSubSubscriptionparseFrom(InputStream input) static PubSubSubscriptionparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PubSubSubscriptionparseFrom(ByteBuffer data) static PubSubSubscriptionparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<PubSubSubscription>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
PUSH_CONFIG_FIELD_NUMBER
public static final int PUSH_CONFIG_FIELD_NUMBER- See Also:
-
BIGQUERY_CONFIG_FIELD_NUMBER
public static final int BIGQUERY_CONFIG_FIELD_NUMBER- See Also:
-
CLOUD_STORAGE_CONFIG_FIELD_NUMBER
public static final int CLOUD_STORAGE_CONFIG_FIELD_NUMBER- See Also:
-
ACK_DEADLINE_SECONDS_FIELD_NUMBER
public static final int ACK_DEADLINE_SECONDS_FIELD_NUMBER- See Also:
-
RETAIN_ACKED_MESSAGES_FIELD_NUMBER
public static final int RETAIN_ACKED_MESSAGES_FIELD_NUMBER- See Also:
-
MESSAGE_RETENTION_DURATION_FIELD_NUMBER
public static final int MESSAGE_RETENTION_DURATION_FIELD_NUMBER- See Also:
-
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER- See Also:
-
ENABLE_MESSAGE_ORDERING_FIELD_NUMBER
public static final int ENABLE_MESSAGE_ORDERING_FIELD_NUMBER- See Also:
-
EXPIRATION_POLICY_FIELD_NUMBER
public static final int EXPIRATION_POLICY_FIELD_NUMBER- See Also:
-
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER- See Also:
-
DEAD_LETTER_POLICY_FIELD_NUMBER
public static final int DEAD_LETTER_POLICY_FIELD_NUMBER- See Also:
-
RETRY_POLICY_FIELD_NUMBER
public static final int RETRY_POLICY_FIELD_NUMBER- See Also:
-
DETACHED_FIELD_NUMBER
public static final int DETACHED_FIELD_NUMBER- See Also:
-
ENABLE_EXACTLY_ONCE_DELIVERY_FIELD_NUMBER
public static final int ENABLE_EXACTLY_ONCE_DELIVERY_FIELD_NUMBER- See Also:
-
MESSAGE_TRANSFORMS_FIELD_NUMBER
public static final int MESSAGE_TRANSFORMS_FIELD_NUMBER- See Also:
-
TAGS_FIELD_NUMBER
public static final int TAGS_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getName
Required. Name of the subscription. Format is `projects/{project}/subscriptions/{sub}`.string name = 1 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getNamein interfacePubSubSubscriptionOrBuilder- 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:
getNameBytesin interfacePubSubSubscriptionOrBuilder- 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:
hasPushConfigin interfacePubSubSubscriptionOrBuilder- Returns:
- Whether the pushConfig field is set.
-
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:
getPushConfigin interfacePubSubSubscriptionOrBuilder- Returns:
- The pushConfig.
-
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:
getPushConfigOrBuilderin interfacePubSubSubscriptionOrBuilder
-
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:
hasBigqueryConfigin interfacePubSubSubscriptionOrBuilder- Returns:
- Whether the bigqueryConfig field is set.
-
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:
getBigqueryConfigin interfacePubSubSubscriptionOrBuilder- Returns:
- The bigqueryConfig.
-
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:
getBigqueryConfigOrBuilderin interfacePubSubSubscriptionOrBuilder
-
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:
hasCloudStorageConfigin interfacePubSubSubscriptionOrBuilder- Returns:
- Whether the cloudStorageConfig field is set.
-
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:
getCloudStorageConfigin interfacePubSubSubscriptionOrBuilder- Returns:
- The cloudStorageConfig.
-
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:
getCloudStorageConfigOrBuilderin interfacePubSubSubscriptionOrBuilder
-
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:
getAckDeadlineSecondsin interfacePubSubSubscriptionOrBuilder- 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:
getRetainAckedMessagesin interfacePubSubSubscriptionOrBuilder- 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:
hasMessageRetentionDurationin interfacePubSubSubscriptionOrBuilder- 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:
getMessageRetentionDurationin interfacePubSubSubscriptionOrBuilder- 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:
getMessageRetentionDurationOrBuilderin interfacePubSubSubscriptionOrBuilder
-
getLabelsCount
public int getLabelsCount()Description copied from interface:PubSubSubscriptionOrBuilderOptional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getLabelsCountin interfacePubSubSubscriptionOrBuilder
-
containsLabels
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:
containsLabelsin interfacePubSubSubscriptionOrBuilder
-
getLabels
Deprecated.UsegetLabelsMap()instead.- Specified by:
getLabelsin interfacePubSubSubscriptionOrBuilder
-
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:
getLabelsMapin interfacePubSubSubscriptionOrBuilder
-
getLabelsOrDefault
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:
getLabelsOrDefaultin interfacePubSubSubscriptionOrBuilder
-
getLabelsOrThrow
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:
getLabelsOrThrowin interfacePubSubSubscriptionOrBuilder
-
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:
getEnableMessageOrderingin interfacePubSubSubscriptionOrBuilder- 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:
hasExpirationPolicyin interfacePubSubSubscriptionOrBuilder- Returns:
- Whether the expirationPolicy field is set.
-
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:
getExpirationPolicyin interfacePubSubSubscriptionOrBuilder- Returns:
- The expirationPolicy.
-
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:
getExpirationPolicyOrBuilderin interfacePubSubSubscriptionOrBuilder
-
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:
getFilterin interfacePubSubSubscriptionOrBuilder- 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:
getFilterBytesin interfacePubSubSubscriptionOrBuilder- 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:
hasDeadLetterPolicyin interfacePubSubSubscriptionOrBuilder- Returns:
- Whether the deadLetterPolicy field is set.
-
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:
getDeadLetterPolicyin interfacePubSubSubscriptionOrBuilder- Returns:
- The deadLetterPolicy.
-
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:
getDeadLetterPolicyOrBuilderin interfacePubSubSubscriptionOrBuilder
-
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:
hasRetryPolicyin interfacePubSubSubscriptionOrBuilder- Returns:
- Whether the retryPolicy field is set.
-
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:
getRetryPolicyin interfacePubSubSubscriptionOrBuilder- Returns:
- The retryPolicy.
-
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:
getRetryPolicyOrBuilderin interfacePubSubSubscriptionOrBuilder
-
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:
getDetachedin interfacePubSubSubscriptionOrBuilder- 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:
getEnableExactlyOnceDeliveryin interfacePubSubSubscriptionOrBuilder- Returns:
- The enableExactlyOnceDelivery.
-
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:
getMessageTransformsListin interfacePubSubSubscriptionOrBuilder
-
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:
getMessageTransformsOrBuilderListin interfacePubSubSubscriptionOrBuilder
-
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:
getMessageTransformsCountin interfacePubSubSubscriptionOrBuilder
-
getMessageTransforms
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:
getMessageTransformsin interfacePubSubSubscriptionOrBuilder
-
getMessageTransformsOrBuilder
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:
getMessageTransformsOrBuilderin interfacePubSubSubscriptionOrBuilder
-
getTagsCount
public int getTagsCount()Description copied from interface:PubSubSubscriptionOrBuilderOptional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
map<string, string> tags = 26 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];- Specified by:
getTagsCountin interfacePubSubSubscriptionOrBuilder
-
containsTags
Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
map<string, string> tags = 26 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];- Specified by:
containsTagsin interfacePubSubSubscriptionOrBuilder
-
getTags
Deprecated.UsegetTagsMap()instead.- Specified by:
getTagsin interfacePubSubSubscriptionOrBuilder
-
getTagsMap
Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
map<string, string> tags = 26 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];- Specified by:
getTagsMapin interfacePubSubSubscriptionOrBuilder
-
getTagsOrDefault
Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
map<string, string> tags = 26 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];- Specified by:
getTagsOrDefaultin interfacePubSubSubscriptionOrBuilder
-
getTagsOrThrow
Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
map<string, string> tags = 26 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];- Specified by:
getTagsOrThrowin interfacePubSubSubscriptionOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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
- Throws:
IOException
-
parseFrom
public static PubSubSubscription parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- 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
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected PubSubSubscription.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-