SubscriptionOrBuilder (Google Cloud Pub/Sub Parent 1.123.18 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Subscription, Subscription.Builder
```
public interface SubscriptionOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsLabels(String key)` See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
`int`	`getAckDeadlineSeconds()` The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message.
`BigQueryConfig`	`getBigqueryConfig()` If delivery to BigQuery is used with this subscription, this field is used to configure it.
`BigQueryConfigOrBuilder`	`getBigqueryConfigOrBuilder()` If delivery to BigQuery is used with this subscription, this field is used to configure it.
`CloudStorageConfig`	`getCloudStorageConfig()` If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
`CloudStorageConfigOrBuilder`	`getCloudStorageConfigOrBuilder()` If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
`DeadLetterPolicy`	`getDeadLetterPolicy()` A policy that specifies the conditions for dead lettering messages in this subscription.
`DeadLetterPolicyOrBuilder`	`getDeadLetterPolicyOrBuilder()` A policy that specifies the conditions for dead lettering messages in this subscription.
`boolean`	`getDetached()` Indicates whether the subscription is detached from its topic.
`boolean`	`getEnableExactlyOnceDelivery()` 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.
`boolean`	`getEnableMessageOrdering()` 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.
`ExpirationPolicy`	`getExpirationPolicy()` A policy that specifies the conditions for this subscription's expiration.
`ExpirationPolicyOrBuilder`	`getExpirationPolicyOrBuilder()` A policy that specifies the conditions for this subscription's expiration.
`String`	`getFilter()` An expression written in the Pub/Sub [filter language](https://cloud.google.com/pubsub/docs/filtering).
`com.google.protobuf.ByteString`	`getFilterBytes()` An expression written in the Pub/Sub [filter language](https://cloud.google.com/pubsub/docs/filtering).
`Map<String,String>`	`getLabels()` Deprecated.
`int`	`getLabelsCount()` See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
`Map<String,String>`	`getLabelsMap()` See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
`String`	`getLabelsOrDefault(String key, String defaultValue)` See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
`String`	`getLabelsOrThrow(String key)` See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
`com.google.protobuf.Duration`	`getMessageRetentionDuration()` How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.
`com.google.protobuf.DurationOrBuilder`	`getMessageRetentionDurationOrBuilder()` How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.
`String`	`getName()` Required.
`com.google.protobuf.ByteString`	`getNameBytes()` Required.
`PushConfig`	`getPushConfig()` If push delivery is used with this subscription, this field is used to configure it.
`PushConfigOrBuilder`	`getPushConfigOrBuilder()` If push delivery is used with this subscription, this field is used to configure it.
`boolean`	`getRetainAckedMessages()` Indicates whether to retain acknowledged messages.
`RetryPolicy`	`getRetryPolicy()` A policy that specifies how Pub/Sub retries message delivery for this subscription.
`RetryPolicyOrBuilder`	`getRetryPolicyOrBuilder()` A policy that specifies how Pub/Sub retries message delivery for this subscription.
`Subscription.State`	`getState()` Output only.
`int`	`getStateValue()` Output only.
`String`	`getTopic()` Required.
`com.google.protobuf.ByteString`	`getTopicBytes()` Required.
`com.google.protobuf.Duration`	`getTopicMessageRetentionDuration()` Output only.
`com.google.protobuf.DurationOrBuilder`	`getTopicMessageRetentionDurationOrBuilder()` Output only.
`boolean`	`hasBigqueryConfig()` If delivery to BigQuery is used with this subscription, this field is used to configure it.
`boolean`	`hasCloudStorageConfig()` If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
`boolean`	`hasDeadLetterPolicy()` A policy that specifies the conditions for dead lettering messages in this subscription.
`boolean`	`hasExpirationPolicy()` A policy that specifies the conditions for this subscription's expiration.
`boolean`	`hasMessageRetentionDuration()` How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.
`boolean`	`hasPushConfig()` If push delivery is used with this subscription, this field is used to configure it.
`boolean`	`hasRetryPolicy()` A policy that specifies how Pub/Sub retries message delivery for this subscription.
`boolean`	`hasTopicMessageRetentionDuration()` Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Method Detail

getName

String getName()

 Required. The name of the subscription. It must have the format
 `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
 start with a letter, and contain only letters (`[A-Za-z]`), numbers
 (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
 plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
 in length, and it must not start with `"goog"`.

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

Returns:: The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Required. The name of the subscription. It must have the format
 `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
 start with a letter, and contain only letters (`[A-Za-z]`), numbers
 (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
 plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
 in length, and it must not start with `"goog"`.

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

Returns:: The bytes for name.

getTopic

String getTopic()

 Required. The name of the topic from which this subscription is receiving
 messages. Format is `projects/{project}/topics/{topic}`. The value of this
 field will be `_deleted-topic_` if the topic has been deleted.


 string topic = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:: The topic.

getTopicBytes

com.google.protobuf.ByteString getTopicBytes()

 Required. The name of the topic from which this subscription is receiving
 messages. Format is `projects/{project}/topics/{topic}`. The value of this
 field will be `_deleted-topic_` if the topic has been deleted.


 string topic = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:: The bytes for topic.

hasPushConfig

boolean hasPushConfig()

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

.google.pubsub.v1.PushConfig push_config = 4;

Returns:: Whether the pushConfig field is set.

getPushConfig

PushConfig getPushConfig()

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

.google.pubsub.v1.PushConfig push_config = 4;

Returns:: The pushConfig.

getPushConfigOrBuilder

PushConfigOrBuilder getPushConfigOrBuilder()

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

.google.pubsub.v1.PushConfig push_config = 4;

hasBigqueryConfig

boolean hasBigqueryConfig()

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

.google.pubsub.v1.BigQueryConfig bigquery_config = 18;

Returns:: Whether the bigqueryConfig field is set.

getBigqueryConfig

BigQueryConfig getBigqueryConfig()

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

.google.pubsub.v1.BigQueryConfig bigquery_config = 18;

Returns:: The bigqueryConfig.

getBigqueryConfigOrBuilder

BigQueryConfigOrBuilder getBigqueryConfigOrBuilder()

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

.google.pubsub.v1.BigQueryConfig bigquery_config = 18;

hasCloudStorageConfig

boolean hasCloudStorageConfig()

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

.google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22;

Returns:: Whether the cloudStorageConfig field is set.

getCloudStorageConfig

CloudStorageConfig getCloudStorageConfig()

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

.google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22;

Returns:: The cloudStorageConfig.

getCloudStorageConfigOrBuilder

CloudStorageConfigOrBuilder getCloudStorageConfigOrBuilder()

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

.google.pubsub.v1.CloudStorageConfig cloud_storage_config = 22;

getAckDeadlineSeconds

int getAckDeadlineSeconds()

 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;

Returns:: The ackDeadlineSeconds.

getRetainAckedMessages

boolean getRetainAckedMessages()

 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;

Returns:: The retainAckedMessages.

hasMessageRetentionDuration

boolean hasMessageRetentionDuration()

 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 7 days or less than 10
 minutes.

.google.protobuf.Duration message_retention_duration = 8;

Returns:: Whether the messageRetentionDuration field is set.

getMessageRetentionDuration

com.google.protobuf.Duration getMessageRetentionDuration()

 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 7 days or less than 10
 minutes.

.google.protobuf.Duration message_retention_duration = 8;

Returns:: The messageRetentionDuration.

getMessageRetentionDurationOrBuilder

com.google.protobuf.DurationOrBuilder getMessageRetentionDurationOrBuilder()

 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 7 days or less than 10
 minutes.

.google.protobuf.Duration message_retention_duration = 8;