public final class PubSubSubscription extends 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ACK_DEADLINE_SECONDS_FIELD_NUMBER
public static final int ACK_DEADLINE_SECONDS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
BIGQUERY_CONFIG_FIELD_NUMBER
public static final int BIGQUERY_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CLOUD_STORAGE_CONFIG_FIELD_NUMBER
public static final int CLOUD_STORAGE_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DEAD_LETTER_POLICY_FIELD_NUMBER
public static final int DEAD_LETTER_POLICY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DETACHED_FIELD_NUMBER
public static final int DETACHED_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENABLE_EXACTLY_ONCE_DELIVERY_FIELD_NUMBER
public static final int ENABLE_EXACTLY_ONCE_DELIVERY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENABLE_MESSAGE_ORDERING_FIELD_NUMBER
public static final int ENABLE_MESSAGE_ORDERING_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
EXPIRATION_POLICY_FIELD_NUMBER
public static final int EXPIRATION_POLICY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MESSAGE_RETENTION_DURATION_FIELD_NUMBER
public static final int MESSAGE_RETENTION_DURATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int MESSAGE_TRANSFORMS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PUSH_CONFIG_FIELD_NUMBER
public static final int PUSH_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RETAIN_ACKED_MESSAGES_FIELD_NUMBER
public static final int RETAIN_ACKED_MESSAGES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RETRY_POLICY_FIELD_NUMBER
public static final int RETRY_POLICY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static PubSubSubscription getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static PubSubSubscription.Builder newBuilder()
newBuilder(PubSubSubscription prototype)
public static PubSubSubscription.Builder newBuilder(PubSubSubscription prototype)
public static PubSubSubscription parseDelimitedFrom(InputStream input)
public static PubSubSubscription parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static PubSubSubscription parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PubSubSubscription parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static PubSubSubscription parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PubSubSubscription parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PubSubSubscription parseFrom(CodedInputStream input)
public static PubSubSubscription parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PubSubSubscription parseFrom(InputStream input)
public static PubSubSubscription parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static PubSubSubscription parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PubSubSubscription parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<PubSubSubscription> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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];
| Returns |
| Type |
Description |
int |
The ackDeadlineSeconds.
|
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];
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];
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];
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];
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];
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];
getDefaultInstanceForType()
public PubSubSubscription getDefaultInstanceForType()
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];
| Returns |
| Type |
Description |
boolean |
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];
| Returns |
| Type |
Description |
boolean |
The enableExactlyOnceDelivery.
|
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];
| Returns |
| Type |
Description |
boolean |
The enableMessageOrdering.
|
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];
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];
getFilter()
public String getFilter()
Optional. An expression written in the Pub/Sub filter
language. If non-empty,
then only PubsubMessages 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];
| Returns |
| Type |
Description |
String |
The filter.
|
getFilterBytes()
public ByteString getFilterBytes()
Optional. An expression written in the Pub/Sub filter
language. If non-empty,
then only PubsubMessages 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for filter.
|
getLabels() (deprecated)
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
| Returns |
| Type |
Description |
int |
|
getLabelsMap()
public Map<String,String> getLabelsMap()
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
| Returns |
| Type |
Description |
String |
|
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
getMessageRetentionDuration()
public 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];
| Returns |
| Type |
Description |
Duration |
The messageRetentionDuration.
|
getMessageRetentionDurationOrBuilder()
public 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];
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];
| Parameter |
| Name |
Description |
index |
int
|
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];
| Returns |
| Type |
Description |
int |
|
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];
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];
| Parameter |
| Name |
Description |
index |
int
|
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];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.bigquery.analyticshub.v1.MessageTransformOrBuilder> |
|
getName()
Required. Name of the subscription.
Format is projects/{project}/subscriptions/{sub}.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Required. Name of the subscription.
Format is projects/{project}/subscriptions/{sub}.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<PubSubSubscription> getParserForType()
Overrides
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];
| Returns |
| Type |
Description |
PushConfig |
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];
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 in
the past to replay previously-acknowledged messages.
bool retain_acked_messages = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The retainAckedMessages.
|
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];
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];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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];
| Returns |
| Type |
Description |
boolean |
Whether the bigqueryConfig field is set.
|
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];
| Returns |
| Type |
Description |
boolean |
Whether the cloudStorageConfig field is set.
|
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];
| Returns |
| Type |
Description |
boolean |
Whether the deadLetterPolicy field is set.
|
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];
| Returns |
| Type |
Description |
boolean |
Whether the expirationPolicy field is set.
|
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];
| Returns |
| Type |
Description |
boolean |
Whether the messageRetentionDuration field is set.
|
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];
| Returns |
| Type |
Description |
boolean |
Whether the pushConfig field is set.
|
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];
| Returns |
| Type |
Description |
boolean |
Whether the retryPolicy field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public PubSubSubscription.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PubSubSubscription.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public PubSubSubscription.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
