- 0.61.0 (latest)
- 0.60.0
- 0.59.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public static final class PubSubSubscription.Builder extends GeneratedMessageV3.Builder<PubSubSubscription.Builder> 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PubSubSubscription.BuilderImplements
PubSubSubscriptionOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllMessageTransforms(Iterable<? extends MessageTransform> values)
public PubSubSubscription.Builder addAllMessageTransforms(Iterable<? extends MessageTransform> values)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 |
values |
Iterable<? extends com.google.cloud.bigquery.analyticshub.v1.MessageTransform> |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
addMessageTransforms(MessageTransform value)
public PubSubSubscription.Builder addMessageTransforms(MessageTransform value)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 |
value |
MessageTransform |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
addMessageTransforms(MessageTransform.Builder builderForValue)
public PubSubSubscription.Builder addMessageTransforms(MessageTransform.Builder builderForValue)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 |
builderForValue |
MessageTransform.Builder |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
addMessageTransforms(int index, MessageTransform value)
public PubSubSubscription.Builder addMessageTransforms(int index, MessageTransform value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
MessageTransform |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
addMessageTransforms(int index, MessageTransform.Builder builderForValue)
public PubSubSubscription.Builder addMessageTransforms(int index, MessageTransform.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
MessageTransform.Builder |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
addMessageTransformsBuilder()
public MessageTransform.Builder addMessageTransformsBuilder()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 |
MessageTransform.Builder |
|
addMessageTransformsBuilder(int index)
public MessageTransform.Builder addMessageTransformsBuilder(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 |
| Returns | |
|---|---|
| Type | Description |
MessageTransform.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PubSubSubscription.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
build()
public PubSubSubscription build()| Returns | |
|---|---|
| Type | Description |
PubSubSubscription |
|
buildPartial()
public PubSubSubscription buildPartial()| Returns | |
|---|---|
| Type | Description |
PubSubSubscription |
|
clear()
public PubSubSubscription.Builder clear()| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
clearAckDeadlineSeconds()
public PubSubSubscription.Builder clearAckDeadlineSeconds()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 |
PubSubSubscription.Builder |
This builder for chaining. |
clearBigqueryConfig()
public PubSubSubscription.Builder clearBigqueryConfig()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 |
PubSubSubscription.Builder |
|
clearCloudStorageConfig()
public PubSubSubscription.Builder clearCloudStorageConfig()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 |
PubSubSubscription.Builder |
|
clearDeadLetterPolicy()
public PubSubSubscription.Builder clearDeadLetterPolicy()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 |
PubSubSubscription.Builder |
|
clearDetached()
public PubSubSubscription.Builder clearDetached() 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 |
PubSubSubscription.Builder |
This builder for chaining. |
clearEnableExactlyOnceDelivery()
public PubSubSubscription.Builder clearEnableExactlyOnceDelivery() 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_deliveryis true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinctmessage_idvalues.
bool enable_exactly_once_delivery = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
This builder for chaining. |
clearEnableMessageOrdering()
public PubSubSubscription.Builder clearEnableMessageOrdering() 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 |
PubSubSubscription.Builder |
This builder for chaining. |
clearExpirationPolicy()
public PubSubSubscription.Builder clearExpirationPolicy() 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 |
PubSubSubscription.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public PubSubSubscription.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
clearFilter()
public PubSubSubscription.Builder clearFilter() 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 |
PubSubSubscription.Builder |
This builder for chaining. |
clearLabels()
public PubSubSubscription.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
clearMessageRetentionDuration()
public PubSubSubscription.Builder clearMessageRetentionDuration() 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 |
PubSubSubscription.Builder |
|
clearMessageTransforms()
public PubSubSubscription.Builder clearMessageTransforms()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 |
PubSubSubscription.Builder |
|
clearName()
public PubSubSubscription.Builder clearName() Required. Name of the subscription.
Format is projects/{project}/subscriptions/{sub}.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public PubSubSubscription.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
clearPushConfig()
public PubSubSubscription.Builder clearPushConfig()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 |
PubSubSubscription.Builder |
|
clearRetainAckedMessages()
public PubSubSubscription.Builder clearRetainAckedMessages() 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 |
PubSubSubscription.Builder |
This builder for chaining. |
clearRetryPolicy()
public PubSubSubscription.Builder clearRetryPolicy()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 |
PubSubSubscription.Builder |
|
clone()
public PubSubSubscription.Builder clone()| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
containsLabels(String key)
public boolean containsLabels(String key)Optional. See Creating and managing labels.
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
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];
| Returns | |
|---|---|
| Type | Description |
BigQueryConfig |
The bigqueryConfig. |
getBigqueryConfigBuilder()
public BigQueryConfig.Builder getBigqueryConfigBuilder()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 |
BigQueryConfig.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
BigQueryConfigOrBuilder |
|
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];
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfig |
The cloudStorageConfig. |
getCloudStorageConfigBuilder()
public CloudStorageConfig.Builder getCloudStorageConfigBuilder()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 |
CloudStorageConfig.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
CloudStorageConfigOrBuilder |
|
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];
| Returns | |
|---|---|
| Type | Description |
DeadLetterPolicy |
The deadLetterPolicy. |
getDeadLetterPolicyBuilder()
public DeadLetterPolicy.Builder getDeadLetterPolicyBuilder()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 |
DeadLetterPolicy.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
DeadLetterPolicyOrBuilder |
|
getDefaultInstanceForType()
public PubSubSubscription getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
PubSubSubscription |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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_deliveryis true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinctmessage_idvalues.
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];
| Returns | |
|---|---|
| Type | Description |
ExpirationPolicy |
The expirationPolicy. |
getExpirationPolicyBuilder()
public ExpirationPolicy.Builder getExpirationPolicyBuilder() 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 |
ExpirationPolicy.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
ExpirationPolicyOrBuilder |
|
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()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
public int getLabelsCount()Optional. See Creating and managing labels.
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getLabelsMap()
public Map<String,String> getLabelsMap()Optional. See Creating and managing labels.
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)Optional. See Creating and managing labels.
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)Optional. See Creating and managing labels.
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
| 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. |
getMessageRetentionDurationBuilder()
public Duration.Builder getMessageRetentionDurationBuilder() 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 |
Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getMessageTransforms(int index)
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 |
| Returns | |
|---|---|
| Type | Description |
MessageTransform |
|
getMessageTransformsBuilder(int index)
public MessageTransform.Builder getMessageTransformsBuilder(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 |
| Returns | |
|---|---|
| Type | Description |
MessageTransform.Builder |
|
getMessageTransformsBuilderList()
public List<MessageTransform.Builder> getMessageTransformsBuilderList()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<Builder> |
|
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];
| Returns | |
|---|---|
| Type | Description |
int |
|
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];
| Returns | |
|---|---|
| Type | Description |
List<MessageTransform> |
|
getMessageTransformsOrBuilder(int index)
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 |
| Returns | |
|---|---|
| Type | Description |
MessageTransformOrBuilder |
|
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];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.bigquery.analyticshub.v1.MessageTransformOrBuilder> |
|
getMutableLabels() (deprecated)
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getName()
public String 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. |
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. |
getPushConfigBuilder()
public PushConfig.Builder getPushConfigBuilder()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.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
PushConfigOrBuilder |
|
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];
| Returns | |
|---|---|
| Type | Description |
RetryPolicy |
The retryPolicy. |
getRetryPolicyBuilder()
public RetryPolicy.Builder getRetryPolicyBuilder()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 |
RetryPolicy.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
RetryPolicyOrBuilder |
|
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeBigqueryConfig(BigQueryConfig value)
public PubSubSubscription.Builder mergeBigqueryConfig(BigQueryConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
BigQueryConfig |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
mergeCloudStorageConfig(CloudStorageConfig value)
public PubSubSubscription.Builder mergeCloudStorageConfig(CloudStorageConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
CloudStorageConfig |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
mergeDeadLetterPolicy(DeadLetterPolicy value)
public PubSubSubscription.Builder mergeDeadLetterPolicy(DeadLetterPolicy value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
DeadLetterPolicy |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
mergeExpirationPolicy(ExpirationPolicy value)
public PubSubSubscription.Builder mergeExpirationPolicy(ExpirationPolicy value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ExpirationPolicy |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
mergeFrom(PubSubSubscription other)
public PubSubSubscription.Builder mergeFrom(PubSubSubscription other)| Parameter | |
|---|---|
| Name | Description |
other |
PubSubSubscription |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public PubSubSubscription.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public PubSubSubscription.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
mergeMessageRetentionDuration(Duration value)
public PubSubSubscription.Builder mergeMessageRetentionDuration(Duration value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
mergePushConfig(PushConfig value)
public PubSubSubscription.Builder mergePushConfig(PushConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
PushConfig |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
mergeRetryPolicy(RetryPolicy value)
public PubSubSubscription.Builder mergeRetryPolicy(RetryPolicy value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
RetryPolicy |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PubSubSubscription.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
putAllLabels(Map<String,String> values)
public PubSubSubscription.Builder putAllLabels(Map<String,String> values)Optional. See Creating and managing labels.
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
putLabels(String key, String value)
public PubSubSubscription.Builder putLabels(String key, String value)Optional. See Creating and managing labels.
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
String |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
removeLabels(String key)
public PubSubSubscription.Builder removeLabels(String key)Optional. See Creating and managing labels.
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
removeMessageTransforms(int index)
public PubSubSubscription.Builder removeMessageTransforms(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 |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
setAckDeadlineSeconds(int value)
public PubSubSubscription.Builder setAckDeadlineSeconds(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe ackDeadlineSeconds to set. |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
This builder for chaining. |
setBigqueryConfig(BigQueryConfig value)
public PubSubSubscription.Builder setBigqueryConfig(BigQueryConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
BigQueryConfig |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
setBigqueryConfig(BigQueryConfig.Builder builderForValue)
public PubSubSubscription.Builder setBigqueryConfig(BigQueryConfig.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
BigQueryConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
setCloudStorageConfig(CloudStorageConfig value)
public PubSubSubscription.Builder setCloudStorageConfig(CloudStorageConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
CloudStorageConfig |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
setCloudStorageConfig(CloudStorageConfig.Builder builderForValue)
public PubSubSubscription.Builder setCloudStorageConfig(CloudStorageConfig.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
CloudStorageConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
setDeadLetterPolicy(DeadLetterPolicy value)
public PubSubSubscription.Builder setDeadLetterPolicy(DeadLetterPolicy value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
DeadLetterPolicy |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
setDeadLetterPolicy(DeadLetterPolicy.Builder builderForValue)
public PubSubSubscription.Builder setDeadLetterPolicy(DeadLetterPolicy.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
DeadLetterPolicy.Builder |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
setDetached(boolean value)
public PubSubSubscription.Builder setDetached(boolean value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe detached to set. |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
This builder for chaining. |
setEnableExactlyOnceDelivery(boolean value)
public PubSubSubscription.Builder setEnableExactlyOnceDelivery(boolean value) 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_deliveryis true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinctmessage_idvalues.
bool enable_exactly_once_delivery = 16 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe enableExactlyOnceDelivery to set. |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
This builder for chaining. |
setEnableMessageOrdering(boolean value)
public PubSubSubscription.Builder setEnableMessageOrdering(boolean value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe enableMessageOrdering to set. |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
This builder for chaining. |
setExpirationPolicy(ExpirationPolicy value)
public PubSubSubscription.Builder setExpirationPolicy(ExpirationPolicy value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ExpirationPolicy |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
setExpirationPolicy(ExpirationPolicy.Builder builderForValue)
public PubSubSubscription.Builder setExpirationPolicy(ExpirationPolicy.Builder builderForValue) 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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ExpirationPolicy.Builder |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public PubSubSubscription.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
setFilter(String value)
public PubSubSubscription.Builder setFilter(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public PubSubSubscription.Builder setFilterBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
This builder for chaining. |
setMessageRetentionDuration(Duration value)
public PubSubSubscription.Builder setMessageRetentionDuration(Duration value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
setMessageRetentionDuration(Duration.Builder builderForValue)
public PubSubSubscription.Builder setMessageRetentionDuration(Duration.Builder builderForValue) 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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
setMessageTransforms(int index, MessageTransform value)
public PubSubSubscription.Builder setMessageTransforms(int index, MessageTransform value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
MessageTransform |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
setMessageTransforms(int index, MessageTransform.Builder builderForValue)
public PubSubSubscription.Builder setMessageTransforms(int index, MessageTransform.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
MessageTransform.Builder |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
setName(String value)
public PubSubSubscription.Builder setName(String value) Required. Name of the subscription.
Format is projects/{project}/subscriptions/{sub}.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public PubSubSubscription.Builder setNameBytes(ByteString value) Required. Name of the subscription.
Format is projects/{project}/subscriptions/{sub}.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
This builder for chaining. |
setPushConfig(PushConfig value)
public PubSubSubscription.Builder setPushConfig(PushConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
PushConfig |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
setPushConfig(PushConfig.Builder builderForValue)
public PubSubSubscription.Builder setPushConfig(PushConfig.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
PushConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PubSubSubscription.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
setRetainAckedMessages(boolean value)
public PubSubSubscription.Builder setRetainAckedMessages(boolean value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe retainAckedMessages to set. |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
This builder for chaining. |
setRetryPolicy(RetryPolicy value)
public PubSubSubscription.Builder setRetryPolicy(RetryPolicy value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
RetryPolicy |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
setRetryPolicy(RetryPolicy.Builder builderForValue)
public PubSubSubscription.Builder setRetryPolicy(RetryPolicy.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
RetryPolicy.Builder |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final PubSubSubscription.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
PubSubSubscription.Builder |
|