Packages

t

com.google.pubsub.v1

SnapshotOrBuilder

trait SnapshotOrBuilder extends MessageOrBuilder

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SnapshotOrBuilder
  2. MessageOrBuilder
  3. MessageLiteOrBuilder
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def containsLabels(key: String): Boolean

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


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

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

  2. abstract def findInitializationErrors(): List[String]
    Definition Classes
    MessageOrBuilder
  3. abstract def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    MessageOrBuilder
  4. abstract def getDefaultInstanceForType(): Message
    Definition Classes
    MessageOrBuilder → MessageLiteOrBuilder
  5. abstract def getDescriptorForType(): Descriptor
    Definition Classes
    MessageOrBuilder
  6. abstract def getExpireTime(): Timestamp

    Optional. The snapshot is guaranteed to exist up until this time.
A newly-created snapshot expires no later than 7 days from the time of its
creation. Its exact lifetime is determined at creation by the existing
backlog in the source subscription. Specifically, the lifetime of the
snapshot is `7 days - (age of oldest unacked message in the subscription)`.
For example, consider a subscription whose oldest unacked message is 3 days
old. If a snapshot is created from this subscription, the snapshot -- which
will always capture this 3-day-old backlog as long as the snapshot
exists -- will expire in 4 days. The service will refuse to create a
snapshot that would expire in less than 1 hour after creation.


    Optional. The snapshot is guaranteed to exist up until this time.
A newly-created snapshot expires no later than 7 days from the time of its
creation. Its exact lifetime is determined at creation by the existing
backlog in the source subscription. Specifically, the lifetime of the
snapshot is `7 days - (age of oldest unacked message in the subscription)`.
For example, consider a subscription whose oldest unacked message is 3 days
old. If a snapshot is created from this subscription, the snapshot -- which
will always capture this 3-day-old backlog as long as the snapshot
exists -- will expire in 4 days. The service will refuse to create a
snapshot that would expire in less than 1 hour after creation.

    .google.protobuf.Timestamp expire_time = 3 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The expireTime.

  7. abstract def getExpireTimeOrBuilder(): TimestampOrBuilder

    Optional. The snapshot is guaranteed to exist up until this time.
A newly-created snapshot expires no later than 7 days from the time of its
creation. Its exact lifetime is determined at creation by the existing
backlog in the source subscription. Specifically, the lifetime of the
snapshot is `7 days - (age of oldest unacked message in the subscription)`.
For example, consider a subscription whose oldest unacked message is 3 days
old. If a snapshot is created from this subscription, the snapshot -- which
will always capture this 3-day-old backlog as long as the snapshot
exists -- will expire in 4 days. The service will refuse to create a
snapshot that would expire in less than 1 hour after creation.


    Optional. The snapshot is guaranteed to exist up until this time.
A newly-created snapshot expires no later than 7 days from the time of its
creation. Its exact lifetime is determined at creation by the existing
backlog in the source subscription. Specifically, the lifetime of the
snapshot is `7 days - (age of oldest unacked message in the subscription)`.
For example, consider a subscription whose oldest unacked message is 3 days
old. If a snapshot is created from this subscription, the snapshot -- which
will always capture this 3-day-old backlog as long as the snapshot
exists -- will expire in 4 days. The service will refuse to create a
snapshot that would expire in less than 1 hour after creation.

    .google.protobuf.Timestamp expire_time = 3 [(.google.api.field_behavior) = OPTIONAL];

  8. abstract def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    MessageOrBuilder
  9. abstract def getInitializationErrorString(): String
    Definition Classes
    MessageOrBuilder
  10. abstract def getLabelsCount(): Int

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


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

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

  11. abstract def getLabelsMap(): Map[String, String]

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


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

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

  12. abstract def getLabelsOrDefault(key: String, defaultValue: String): String

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


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

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

  13. abstract def getLabelsOrThrow(key: String): String

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


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

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

  14. abstract def getName(): String

    Optional. The name of the snapshot.


    Optional. The name of the snapshot.

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

    returns

    The name.

  15. abstract def getNameBytes(): ByteString

    Optional. The name of the snapshot.


    Optional. The name of the snapshot.

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

    returns

    The bytes for name.

  16. abstract def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    MessageOrBuilder
  17. abstract def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    MessageOrBuilder
  18. abstract def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    MessageOrBuilder
  19. abstract def getTopic(): String

    Optional. The name of the topic from which this snapshot is retaining
messages.


    Optional. The name of the topic from which this snapshot is retaining
messages.

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

    returns

    The topic.

  20. abstract def getTopicBytes(): ByteString

    Optional. The name of the topic from which this snapshot is retaining
messages.


    Optional. The name of the topic from which this snapshot is retaining
messages.

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

    returns

    The bytes for topic.

  21. abstract def getUnknownFields(): UnknownFieldSet
    Definition Classes
    MessageOrBuilder
  22. abstract def hasExpireTime(): Boolean

    Optional. The snapshot is guaranteed to exist up until this time.
A newly-created snapshot expires no later than 7 days from the time of its
creation. Its exact lifetime is determined at creation by the existing
backlog in the source subscription. Specifically, the lifetime of the
snapshot is `7 days - (age of oldest unacked message in the subscription)`.
For example, consider a subscription whose oldest unacked message is 3 days
old. If a snapshot is created from this subscription, the snapshot -- which
will always capture this 3-day-old backlog as long as the snapshot
exists -- will expire in 4 days. The service will refuse to create a
snapshot that would expire in less than 1 hour after creation.


    Optional. The snapshot is guaranteed to exist up until this time.
A newly-created snapshot expires no later than 7 days from the time of its
creation. Its exact lifetime is determined at creation by the existing
backlog in the source subscription. Specifically, the lifetime of the
snapshot is `7 days - (age of oldest unacked message in the subscription)`.
For example, consider a subscription whose oldest unacked message is 3 days
old. If a snapshot is created from this subscription, the snapshot -- which
will always capture this 3-day-old backlog as long as the snapshot
exists -- will expire in 4 days. The service will refuse to create a
snapshot that would expire in less than 1 hour after creation.

    .google.protobuf.Timestamp expire_time = 3 [(.google.api.field_behavior) = OPTIONAL];

    returns

    Whether the expireTime field is set.

  23. abstract def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  24. abstract def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  25. abstract def isInitialized(): Boolean
    Definition Classes
    MessageLiteOrBuilder
  26. abstract def getLabels(): Map[String, String]

    Use #getLabelsMap() instead.

    Use #getLabelsMap() instead.

    Annotations
    @Deprecated
    Deprecated

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from MessageOrBuilder

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped