final case class CreateSnapshotRequest(name: String = "", subscription: String = "", labels: Map[String, String] = _root_.scala.collection.immutable.Map.empty, tags: Map[String, String] = _root_.scala.collection.immutable.Map.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[CreateSnapshotRequest] with Product with Serializable

Request for the CreateSnapshot method.

name

Required. User-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See the [resource name rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). Format is projects/{project}/snapshots/{snap}.

subscription

Required. The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the CreateSnapshot request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is projects/{project}/subscriptions/{sub}.

labels

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

tags

Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" See https://docs.cloud.google.com/pubsub/docs/tags for more information on using tags with Pub/Sub resources.

Annotations
@SerialVersionUID()
Source
CreateSnapshotRequest.scala
Linear Supertypes
Updatable[CreateSnapshotRequest], GeneratedMessage, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CreateSnapshotRequest
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CreateSnapshotRequest(name: String = "", subscription: String = "", labels: Map[String, String] = _root_.scala.collection.immutable.Map.empty, tags: Map[String, String] = _root_.scala.collection.immutable.Map.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    name

    Required. User-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See the [resource name rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). Format is projects/{project}/snapshots/{snap}.

    subscription

    Required. The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the CreateSnapshot request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is projects/{project}/subscriptions/{sub}.

    labels

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

    tags

    Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" See https://docs.cloud.google.com/pubsub/docs/tags for more information on using tags with Pub/Sub resources.

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. def addAllLabels(__vs: Iterable[(String, String)]): CreateSnapshotRequest
  5. def addAllTags(__vs: Iterable[(String, String)]): CreateSnapshotRequest
  6. def addLabels(__vs: (String, String)*): CreateSnapshotRequest
  7. def addTags(__vs: (String, String)*): CreateSnapshotRequest
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clearLabels: CreateSnapshotRequest
  10. def clearTags: CreateSnapshotRequest
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  12. def companion: CreateSnapshotRequest.type
    Definition Classes
    CreateSnapshotRequest → GeneratedMessage
  13. def discardUnknownFields: CreateSnapshotRequest
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    CreateSnapshotRequest → GeneratedMessage
  18. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    CreateSnapshotRequest → GeneratedMessage
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. val labels: Map[String, String]
  21. val name: String
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. def productElementNames: Iterator[String]
    Definition Classes
    Product
  26. def serializedSize: Int
    Definition Classes
    CreateSnapshotRequest → GeneratedMessage
  27. val subscription: String
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. val tags: Map[String, String]
  30. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  31. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  32. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  33. def toProtoString: String
    Definition Classes
    CreateSnapshotRequest → GeneratedMessage
  34. val unknownFields: UnknownFieldSet
  35. def update(ms: (Lens[CreateSnapshotRequest, CreateSnapshotRequest]) => Mutation[CreateSnapshotRequest]*): CreateSnapshotRequest
    Definition Classes
    Updatable
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  39. def withLabels(__v: Map[String, String]): CreateSnapshotRequest
  40. def withName(__v: String): CreateSnapshotRequest
  41. def withSubscription(__v: String): CreateSnapshotRequest
  42. def withTags(__v: Map[String, String]): CreateSnapshotRequest
  43. def withUnknownFields(__v: UnknownFieldSet): CreateSnapshotRequest
  44. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  45. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    CreateSnapshotRequest → GeneratedMessage
  46. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Updatable[CreateSnapshotRequest]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped